wiki.appsalutecreator.com - Вклад участника [ru]

Notification

2019-04-08T14:40:02Z

Bmor: /* Firebase Cloud Messaging */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние (это обязательное поле, если хотите как-то обработать пуш в приложении)
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

Приложение получает сообщения '''только''' если оно запущено или работает в фоне (т.е. мы его не убили в диспетчере задач / настройках).

При получении приложением сообщения, если заполнено тело пуша (хотя бы параметры eventName и eventMessage), будет показано пуш-уведомление. Если при этом приложение работало в фоне - все дополнительные параметры будут переданы в приложение при его запуске. Если оно уже было запущено - все параметры немедленно будут обработаны.

Все доп. параметры сообщения будут сохранены в опции в виде бандлов:

[[Файл:Notification_bundle_struct.png]]

===Топики: подписка и отписка===
Дабы игрок мог получать сообщения по рассылке он должен подписаться на топик.
Если нужно перестать получать сообщения по рассылке - отписаться.

'''Подписка/отписка:'''
* Записать объекту '''Notification''' в параметр '''topic''' имя топика, на который хотим подписаться/отписаться;
* Вызвать объекту '''Notification''' состояние '''subscribe''' (для подписки) либо '''unsubscribe''' (для отписки)
* Всё.

'''Подписка на необходимые топики должна происходить в каждой сессии, т.к. она не сохраняется после закрытия приложения!'''

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
: Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
: Все параметры бандла будут записаны в машинку ''fcmBundleHandler'' с приставкой "'''fcm_'''"
Например имеем сообщение:
"eventID" : "items_message",
"customTitle" : "FCM RULES",
"customText" : "SuperBananaDebugging 322"
При ''fcm_check_bundle'' машинка-обработчик будет переведена в состояние ''custom_message'' и в неё будут добавлены 2 поля: ''fcm_customTitle'' (отмечено цифрой 1 на скриншоте) и ''fcm_customText'' (2) с соответствующими значениями.

[[Файл:Firebase handler.jpg]]

При начислении монет или предметов мы также указываем их количество (и txtID для предмета) (3)(4).
Экономике в случае начисления ресурсов/монет передаем параметр res_source = 13, как у redeem_message.

'''!ВАЖНО!'''
После использования параметров их нужно вручную обнулить (очистить), дабы у вас же не возникало лишних проблем. (5)

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Notifications]

[http://wiki.appsalutecreator.com/images/c/cb/FCM_Notifications_example.zip Firebase cloud messaging] - содержит проект и сприпт для отправки пушей в топик (без ключа приложения)

[[Category:Options]]

Notification

2018-11-13T08:46:50Z

Bmor: /* Пример */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние (это обязательное поле, если хотите как-то обработать пуш в приложении)
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

Приложение получает сообщения '''только''' если оно запущено или работает в фоне (т.е. мы его не убили в диспетчере задач / настройках).

При получении приложением сообщения, если заполнено тело пуша (хотя бы параметры eventName и eventMessage), будет показано пуш-уведомление. Если при этом приложение работало в фоне - все дополнительные параметры будут переданы в приложение при его запуске. Если оно уже было запущено - все параметры немедленно будут обработаны.

Все доп. параметры сообщения будут сохранены в опции в виде бандлов:

[[Файл:Notification_bundle_struct.png]]

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
: Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
: Все параметры бандла будут записаны в машинку ''fcmBundleHandler'' с приставкой "'''fcm_'''"
Например имеем сообщение:
"eventID" : "custom_message",
"customTitle" : "FCM RULES",
"customText" : "SuperBananaDebugging 322"
При ''fcm_check_bundle'' машинка-обработчик будет переведена в состояние ''custom_message'' и в неё будут добавлены 2 поля: ''fcm_customTitle'' и ''fcm_customText'' с соответствующими значениями.

'''!ВАЖНО!'''
После использования параметров их нужно вручную обнулить (очистить), дабы у вас же не возникало лишних проблем.

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Notifications]

[http://wiki.appsalutecreator.com/images/c/cb/FCM_Notifications_example.zip Firebase cloud messaging] - содержит проект и сприпт для отправки пушей в топик (без ключа приложения)

[[Category:Options]]

Файл:FCM Notifications example.zip

2018-11-13T08:45:12Z

Bmor:

Notification

2018-11-13T08:41:06Z

Bmor: /* Firebase Cloud Messaging */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние (это обязательное поле, если хотите как-то обработать пуш в приложении)
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

Приложение получает сообщения '''только''' если оно запущено или работает в фоне (т.е. мы его не убили в диспетчере задач / настройках).

При получении приложением сообщения, если заполнено тело пуша (хотя бы параметры eventName и eventMessage), будет показано пуш-уведомление. Если при этом приложение работало в фоне - все дополнительные параметры будут переданы в приложение при его запуске. Если оно уже было запущено - все параметры немедленно будут обработаны.

Все доп. параметры сообщения будут сохранены в опции в виде бандлов:

[[Файл:Notification_bundle_struct.png]]

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
: Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
: Все параметры бандла будут записаны в машинку ''fcmBundleHandler'' с приставкой "'''fcm_'''"
Например имеем сообщение:
"eventID" : "custom_message",
"customTitle" : "FCM RULES",
"customText" : "SuperBananaDebugging 322"
При ''fcm_check_bundle'' машинка-обработчик будет переведена в состояние ''custom_message'' и в неё будут добавлены 2 поля: ''fcm_customTitle'' и ''fcm_customText'' с соответствующими значениями.

'''!ВАЖНО!'''
После использования параметров их нужно вручную обнулить (очистить), дабы у вас же не возникало лишних проблем.

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Download]

[[Category:Options]]

Notification

2018-11-13T08:40:55Z

Bmor: /* Обработка в редакторе */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние (это обязательное поле, если хотите как-то обработать пуш в приложении)
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

Приложение получает сообщения '''только''' если оно запущено или работает в фоне (т.е. мы его не убили в диспетчере задач / настройках).

При получении приложением сообщения, если заполнено тело пуша (хотя бы параметры eventName и eventMessage), будет показано пуш-уведомление. Если при этом приложение работало в фоне - все дополнительные параметры будут переданы в приложение при его запуске. Если оно уже было запущено - все параметры немедленно будут обработаны.

Все доп. параметры сообщения будут сохранены в опции в виде бандлов:

[[Файл:Notification_bundle_struct.png]]

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
: Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
: Все параметры бандла будут записаны в машинку ''fcmBundleHandler'' с приставкой "'''fcm_'''"
Например имеем сообщение:
"eventID" : "custom_message",
"customTitle" : "FCM RULES",
"customText" : "SuperBananaDebugging 322"
При ''fcm_check_bundle'' машинка-обработчик будет переведена в состояние ''custom_message'' и в неё будут добавлены 2 поля: ''fcm_customTitle'' и ''fcm_customText'' с соответствующими значениями.

'''!ВАЖНО!'''
После использования параметров их нужно вручную обнулить (очистить), дабы у вас же не возникало лишних проблем.

===Отправка сообщений===
todo

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Download]

[[Category:Options]]

Notification

2018-11-13T08:30:38Z

Bmor: /* Отправка и получение сообщения приложением */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние (это обязательное поле, если хотите как-то обработать пуш в приложении)
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

Приложение получает сообщения '''только''' если оно запущено или работает в фоне (т.е. мы его не убили в диспетчере задач / настройках).

При получении приложением сообщения, если заполнено тело пуша (хотя бы параметры eventName и eventMessage), будет показано пуш-уведомление. Если при этом приложение работало в фоне - все дополнительные параметры будут переданы в приложение при его запуске. Если оно уже было запущено - все параметры немедленно будут обработаны.

Все доп. параметры сообщения будут сохранены в опции в виде бандлов:

[[Файл:Notification_bundle_struct.png]]

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4.0. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
TODO

===Отправка сообщений===
todo

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Download]

[[Category:Options]]

Notification

2018-11-13T08:29:57Z

Bmor: /* Отправка и получение сообщения приложением */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние (это обязательное поле, если хотите как-то обработать пуш в приложении)
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

Приложение получает сообщения '''только''' если оно запущено или работает в фоне (т.е. мы его не убили в диспетчере задач / настройках).

При получении приложением сообщения, если заполнено тело пуша (хотя бы параметры eventName и eventMessage), будет показано пуш-уведомление. Если при этом приложение работало в фоне - все дополнительные параметры будут переданы в приложение при его запуске. Если оно уже было запущено - все параметры немедленно будут обработаны.

Все доп. параметры сообщения будут сохранены в опции:

[[Файл:Notification_bundle_struct.png]]

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4.0. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
TODO

===Отправка сообщений===
todo

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Download]

[[Category:Options]]

Файл:Notification bundle struct.png

2018-11-13T08:27:44Z

Bmor:

Notification

2018-11-13T08:21:08Z

Bmor: /* Структура сообщений */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние (это обязательное поле, если хотите как-то обработать пуш в приложении)
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

Приложение получает сообщения '''только''' если оно запущено или работает в фоне (т.е. мы его не убили в диспетчере задач / настройках).

При получении приложением сообщения, если заполнено тело пуша (хотя бы параметры eventName и eventMessage), будет показано пуш-уведомление. Если при этом приложение работало в фоне - все дополнительные параметры будут переданы в приложение при его запуске. Если оно уже было запущено - все параметры немедленно будут обработаны.

Все доп. параметры сообщения

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4.0. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
TODO

===Отправка сообщений===
todo

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Download]

[[Category:Options]]

Notification

2018-11-13T08:19:57Z

Bmor: /* Отправка и получение сообщения приложением */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

Приложение получает сообщения '''только''' если оно запущено или работает в фоне (т.е. мы его не убили в диспетчере задач / настройках).

При получении приложением сообщения, если заполнено тело пуша (хотя бы параметры eventName и eventMessage), будет показано пуш-уведомление. Если при этом приложение работало в фоне - все дополнительные параметры будут переданы в приложение при его запуске. Если оно уже было запущено - все параметры немедленно будут обработаны.

Все доп. параметры сообщения

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4.0. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
TODO

===Отправка сообщений===
todo

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Download]

[[Category:Options]]

Notification

2018-11-13T08:14:47Z

Bmor: /* Отправка и получение сообщения приложением */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

Отправлять сообщения пользователям можно несколькими способами:
* всем пользователям (вообще всем)
* избирательно по каким-либо критериям/параметрам пользователя: уровень, категория (платящий/неплатящий), язык, регион, возраст и т.п.
* рассылка по топикам (для получения такой рассылки пользователь должен быть подписан на соответствующий топик)

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4.0. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
TODO

===Отправка сообщений===
todo

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Download]

[[Category:Options]]

Notification

2018-11-13T08:03:53Z

Bmor: /* Firebase Cloud Messaging */

{{TOC right}}
[[Object|Объект]] '''Notification''' предназначен для показа push уведомлений на IOS устройствах.

==Параметры объекта==

===Основные параметры===

*'''имя события''' (''name'') - Имя события. Если у двух событий одинаковые имена - сохранится первое. Не обязательный параметр. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''сообщение''' (''message'') - Основной текст события. Перетягивается из редактора текстов. Поле должно быть в состоянии редактирования.

*'''большая картинка''' (''big_picture'') - Имя файла с большой картинкой. Должен лежать не в ресурсах, а рядом с app.icf. Поле затирается после регистрации уведомления

*'''год''' (''year'') - Год, когда сработает оповещение. Минимальное значение - 1971 .

*'''месяц''' (''month'') - Месяц, когда сработает оповещение. Минимальное значение - 0, максимальное - 11 .

*'''день''' (''day'') - День, когда сработает оповещение. Минимальное значение - 1, максимальное - 31 .

*'''час''' (''hour'') - Час, когда сработает оповещение. Минимальное значение - 0, максимальное - 23 .

*'''минута''' (''min'') - Минута, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''секунда''' (''sec'') - Секунда, когда сработает оповещение. Минимальное значение - 0, максимальное - 59 .

*'''задержка''' (''delay'') - Задержка от текущего времени до оповещения. Если задана не -1 - то используется вместо даты.

*'''перед первым init экстеншена''' (''delayInit'') - Задержка в секундах до первой инициализации расширения

*'''цвет заголовка''' (''colorTitle'') - Цвет заголовка - только для кастомных нотификейшенов

*'''цвет текста''' (''colorText'') - Цвет текста - только для кастомных нотификейшенов

===Firebase Cloud Messaging===

*'''Обработчик бандлов''' (''fcmBundleHandler'') - Объект, в который будут записаны параметры бандла и который будет переведен в состояние eventID бандла при fcm_check_bundle (см. дальше)

==Состояния объекта==

*'''set''' - устанавливает нотификацию в очередь

*'''clear''' - очищает очередь нотификации

*'''erase''' - очищает очередь нотификации от уведомления с указаннным ID темы и ID сообщения

*'''fcm_subscribe_topic''' - Firebase only! Подписаться на топик из поля topic

*'''fcm_unsubscribe_topic''' - Firebase only! Отписаться от топика из поля topic

*'''fcm_check_bundle''' - Firebase only! Проверить наличие fcm бандлов

Установка уведомлений (объект notification):
Состояние
"set", - оба способа
"set_native", - устройство
"set_parse", - парс
или через параметр
<property name="отсылать в" type="enum" value="0" id="send" hint="отсылать в" regexp="обе службы=0,только локальный пуш=1,только парс=2" /> (тогда состояние set)

==Пример применения==

Пусть через 5 минут после нажатия на кнопку у пользователя появиится уведомление с текстом "message of notification".

Для этого разместим на сцене объект notification и установим ему следующие параметры:

* задержка - 300

[[Файл:Notification 01.jpg |upright=0.5]]

В текстовую базу занесём новые записи с названием события нотификации и текстом нотификации.

Далее добавим на сцену кнопку, которая будет передавать параметры объекту "notification" и переводить объект "notification" в состояние "set".

[[Файл:Notification 02.jpg |upright=0.5 ]]

Теперь при нажатии на кнопку в очередь будет поставлено извещение, которое покажет система через 5 минут.
На устройстве это выглядит так:

<div class="tleft" style="clear:none"> [[Файл:IMG 0043.PNG | мини |200пкс ]] </div>
<div class="tleft" style="clear:none"> [[Файл:IMG 0046.PNG | мини |200пкс ]] </div>

 

==Информация в логах==

<pre>
I/GNotification GNotification::aviable() GNotification::aviable() - уведомления разрешены
I/GNotification GNotification::state() state(ST_CLEAR) clear all notifications - очистилась
вся очередь уведомлений
I/GNotification GNotification::state() state(ST_SET) - уведомление поставлено в очередь
I/GNotification GNotification::EraseNotification() EraseNotification erase notification title: - уведомление
удалено из очереди
</pre>

==Примечания==

В обычном случае по нажатию на сообщение открывается приложение на экране котором были, или на изначальном экране в зависимости от настроек.
У объекта [[options]] можно задать параметр '''notifScrID''' (значение параметра - id экрана). Если параметр задан, то при открытии приложения из уведомления откроется выбранный экран.

==Firebase Cloud Messaging==

Firebase Cloud Messaging позволяет рассылать кастомные уведомления с определенным набором доп. параметров, которые в последствии будут переданы во вьювер и сохранены в опциях (fcm бандлы).

===Подготовка проекта===

: 1. Создайте и настройте проект в Firebase консоли ([https://console.firebase.google.com/project/ Link])
: 2. Скачайте из консоли файл конфигураций проекта google-services.json
: 3. Перенесите параметры из ''google-services.json'' в ''project\conf\pom\sdl\google_params.json'' в поле ''extra_strings''
google_app_id >> {YOUR_CLIENT}/client_info/mobilesdk_app_id
gcm_defaultSenderId >> project_info/project_number
default_web_client_id >> {YOUR_CLIENT}/oauth_client/client_id (client_type == 3)
ga_trackingId >> {YOUR_CLIENT}/services/analytics-service/analytics_property/tracking_id
firebase_database_url >> project_info/firebase_url
google_api_key >> {YOUR_CLIENT}/api_key/current_key
google_crash_reporting_api_key >> {YOUR_CLIENT}/api_key/current_key
project_id >> project_info/project_id
google_storage_bucket >> project_info/storage_bucket
: 4. В app.icf сборки добавить раздел '''[Firebase]''', дабы при сборке подтянулся нужный экстеншн.

===Структура сообщений===
Сообщения firebase имеют два основных блока:
* '''notification''' - стандартный пуш, содержит заголовок и текст сообщения;
* '''data payload''' - содержит произвольный набор параметров ключ-зачение (с ограничением 4Кб в firebase и 50 штук в наших реалиях)

Сообщение может содержать либо один из этих блоков, либо оба сразу.

При наличии в сообщении блока '''notification''' оно автоматически трактуется системой как пуш и при получении такого на устройстве - сразу закидывает его в системный трей (т.е. без нашей обработки). Мы никак не властны над подобными сообщениями и их параметрами (с параметрами то отдельная тема), а значит никаких кастомизаций в виде цветного шрифта и/или картинки не будет.

Если сообщение имеет только '''data payload''' - оно всецело обрабатывается нашим движком, а значит мы имеем полный контроль над его отображением и всеми его параметрами. '''Но''' такие сообщения невозможно отправить из firebase консоли (т.к. там всегда должен присутствовать текст пуша), только скриптом (либо из нашей одминки).

Для корректной работы всегда нужно использовать только '''data payload''' со структурой:

Тело пуша: # блок параметров, необходимых для отображения пуша
"eventName" : "EVENT_TITLE", # заголовок сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventMessage" : "EVENT_BODY", # текст сообщения, ОБЯЗАТЕЛЬНО для отображения пуша
"eventType" : "1", # 0 - показать только заголовок и сообщение; 1 - показать красивое сообщение со всеми плюшками
"eventPriority" : "2" # приоритет пуша [-2:2], по дефолту 2
"eventTime" : "1541507205" # время запуска пуша в UTC секундах (если отсутствует или меньше текущего времени - сразу показать)
"evetBigPicture" : "https://apps.absolutist.com/images/profile/no_avatar.png", # бекграунд пуша - НЕ имя ресурса, НЕ id ресурса, ТОЛЬКО ссылка
"eventTitleColor" : "#FF0000FF", # ARGB цвет заголовка
"eventTextColor" : "#FFFF0000", # ARGB цвет текста
Тело данных
"eventID" : "EVENT_ID", # id ивента, машинка-обработчик будет переведена в это состояние
Далее может быть произвольный набор параметров-значений, которые будут переданы в машинку-обработчик

===Отправка и получение сообщения приложением===
''(Далее речь идет только про data payload)''

ЕЕЕ

===Обработка в редакторе===

: 0. Определиться, какие евенты вы хотите обрабатывать (поле '''eventID''' в пуше) и с какими параметрами ('''эт важно!''')
: 1. Создать объект '''Notifications''', т.к. вся коммуникация идет через него
: 2. Создать машинку-обработчик и указать её в поле ''Обработчик бандлов (fcmBundleHandler)'' объекта '''Notifications'''
: 3. Создать машинку, которая будет раз в определенный период дёргать '''Notifications''' в состояние '''fcm_check_bundle'''
: 4.0. В состоянии ''fcm_check_bundle'' объект '''Notifications''' проверяет опции на наличие бандлов из firebase сообщений.
Если бандл имеется - '''Notifications''' переводит машинку ''fcmBundleHandler'' в состояние из параметра '''eventID''' бандла.
TODO

===Отправка сообщений===
todo

== Пример ==

[http://fs5.absolutist.com/files/wikisample/notification.rar Download]

[[Category:Options]]

Notification

2018-11-12T16:02:06Z

Bmor: /* Обработка в редактора */

Notification

2018-11-12T15:54:03Z

Bmor: /* Подготовка проекта */

Notification

2018-11-12T15:52:08Z

Bmor: /* Firebase Cloud Messaging */

Notification

2018-11-12T15:43:55Z

Bmor: /* Особенности использования */

Notification

2018-11-12T15:43:49Z

Bmor: /* Отправка сообщений */

Notification

2018-11-12T15:43:44Z

Bmor: /* Обработка в редактора */

Notification

2018-11-12T15:43:39Z

Bmor: /* Подготовка проекта */

Notification

2018-11-12T15:43:21Z

Bmor: /* Firebase Cloud Messaging */

Notification

2018-11-12T15:30:48Z

Bmor:

Notification

2018-11-12T15:30:11Z

Bmor: /* Состояния объекта */

Notification

2018-11-12T15:27:08Z

Bmor: /* Параметры объекта */

HiddenList

2018-06-20T13:00:54Z

Bmor: /* Добавляемые параметры */

{{TOC right}}
HiddenList является менеджером поисковых [[Object|объектов]]. На сегодня HiddenList не просто управляет объектами на сцене - он отвечает за все штрафы и поощрения. В связке с такими объектами как [[HiddenHint]] + [[Effect]] HiddenList дает возможность реализовать систему подсказок, а также такие графические эффекты как: "ночь", "трансформация цвета" и т.д. с одним набором графики.

==Общие параметры==
(см. описание [[Object|Object]])

[[Файл:HOList_1.jpg|right]]

*'''имя''' ('' nm '') - Имя объекта HiddenList в дереве проекта. Может быт произвольным.
*'''id-объекта''' - Уникальный номер объекта HiddenList, который можно увидеть в строке "имя" либо при наведении курсора на неё.
*'''синхронизация''' ('' sync '') - Применяется для синхронизации между лейаутами. Если указан параметр "нет", то объект будет активен только на текущем лейауте. По умолчанию указан параметр "да".
*'''сохранение параметров''' ('' sv '') - Настройка этого параметра актуальна, если приложение в дальнейшем будет сворачиваться в системную панель («трей»). Выбирается значение этого параметра из выпадающего списка. Возможны следующие варианты: "нет", "только объект", "объект с подобъектами", "только подобъекты". При выходе из трэя будут восстановлены ранее измененные/установленные (при переходе с одного экрана на другой)параметры объектов или подобъектов в зависимости от выбранного варианта для этого параметра. По умолчанию указан параметр "нет". Следует помнить, что если выбирается для объекта некоторой сцены значения этого параметра отличное от "нет", то должно и предусматриваться соответствующее значение этого параметра и для этой сцены, и для экрана, содержащего эту сцену.
*'''z''' ('' z '') - Параметр порядка рисования объекта. Сначала рисуются объекты с большим z, затем, поверх них - с меньшим.
*'''память''' ('' memo ''):
:'''1''' - при повторном открытии экрана объект не обновляет свои параметры (помнит текущие параметры, оставшиеся от предыдущего посещения экрана);
:'''0''' - обновит свои параметры, при повторном открытии экрана.
*'''группа''' ('' gr '') - Группа, в которую входит текущий объект.

У листа также есть группы стандартных параметров такие как '''положение''', '''размер''', '''модификаторы'''. Но, по сути, они не важны. Главное, чтобы лист не перекрывал на сцене другие объекты. Поэтому ему лучше находиться за пределами сцены.

==Основные параметры==

*'''Картинка''' ('' res '') - Графический ресурс для отображения объекта. Перетаскивается мышкой из редактора ресурсов (поле должно находится в состоянии редактирования). Обычно не используется, а применяется для отображения table; 
*'''Таблица''' ('' table '') - Объект типа [[table]], который является визуальным отображением списка. '''Должна быть обязательно'''; 
*'''Подсказка''' ('' hint '') — объект типа [[HiddenHint]], который является менеджером хинтов; 
*'''highlighter''' ('' hl '') — объект типа [[HiddenHighLighter|hiddenhighlighter]], который подсвечивает не найденные объекты.; 
*'''Счетчик''' ('' hdncnt '') — объект типа [[Counter]], который отображает количество найденных объектов. 
В самом счетчике в параметрах нужно указать val = 0, поскольку изначально нет найденных объектов;
*'''Таймер''' ('' timer '') — объект типа [[Timer]], который отображает время игры.
При инициализации листа он передаст состояние "start" таймеру.
*'''отладка''' ('' trace '') — Отображать в окне состояний текущий объект.

'''Группа - внешний вид'''

*'''вычеркнуть''' ('' cross ''):
:'''1''' - найденный объект вычеркивается, оставаясь в списке(таблице);
:'''число''' - найденный объект удаляется из списка;
*'''листать''' ('' scroll '')
:'''1''' - список можно листать (скролировать);
:'''число''' - ищутся только те объекты, которые видны в списке (таблице);
*'''тип списка''' ('' kind '') - Тип поиска объектов:
:'''1''' - слово;
:'''2''' - предложение;
:'''3''' - удаляемая пиктограмма;
:'''4''' - пиктограмма;
:'''5''' - поиск различий.
*'''поиск пар''' ('' pair '') - Если 1, то идет поиска пар объектов с одинаковым типом, иначе обычный режим
:'''пары''' - поиск пар;
:'''одиночные''' - поиск по одному объекту.

'''Группа - звуки'''

*'''обычный''' ('' sndNrm '') - Звук при нахождении обычного [[HiddenObject]].
*'''коллекционный''' ('' sndCol '') - Звук при нахождении коллекционного [[HiddenObject]](объекту должна быть установлена коллекция).

'''Группа - параметры поиска'''

*'''объектов''' ('' num '') - Максимальное количество доступных для поиска объектов в одной игровой сессии. (ВАЖНО!!! Таблице нужно установить общее количество ячеек равное(или больше) количеству доступных для поиска объектов).
*'''активных объектов''' ('' numact '') - Максимальное количество активных объектов в одной игровой сессии.
*'''видимых объектов''' ('' numvis'') - Максимальное количество видимых объектов в одной игровой сессии.
*'''одного типа''' ('' max ''):
:'''число''' - Максимальное количество объектов одного типа - поле тип в [[hiddenObject]] или хидден объекты с одинаковыми текстовыми ID могут считаться объектами одного типа;
:'''-1''' - игнорируется.
*'''прятать''' ('' hide '') - Делать невидимыми объекты, не участвующие в поиске.
*'''оставлять''' ('' stay '') - Оставлять найденный объект на месте (вызывая только флаеры) при удачном клике.
*'''актёр-иконка''' ('' actorIco '') - если "да", то во время полёта найденного хидден-объекта вместо него летит иконка которая помечена как "main picture" и указана в текстовом id хидден-объекта. 
*'''актер''' ('' actor '') - машина состояний, которая управляет процессом полета к таблице найденных [[HiddenObject]] .
*'''z актера''' ('' actorZ '') - z актера. Будет применено только если не равен 0.
*'''актер стартует из таблицы''' ('' actorTable '') - если настройка включена, то актер стартует не из позиции хиддена, а из ячейки таблицы .
*'''целевой объект''' (''trg'') - Если задан, [[HiddenObject]] после нахождения летит не в ячейку таблицы, а к нему.

'''Группа - скорость'''

Отвечают за скорость перемещения найденного объекта.
*'''полета''' ('' vf '') - Скорость полета в пикселях в секунду.
*'''вращения''' ('' vr '') - Скорость вращения в градусах в секунду.

'''Группа - равномерное распределение'''

*'''включить''' ('' undist '') - Равномерно распределять объекты по площади сцены.
*'''дополнительные сортировки''' ('' altern_algo '') - Использовать альтернативный алгоритм равномерного распределения.
*'''максимальное перекрытие''' ('' max_overlapping '') - Максимальная допустимая площадь перекрытия в пикселях.
*'''количество итераций''' ('' fix_overlapping_iter_num '') - Максимальное количество итераций фикса перекрытия объектов.
*'''удалять перекрытия''' ('' del_after_fix '') - Удалять оставшиеся перекрытия после последней итерации фикса.

Рекомендации по использованию:

*Если включать "Удалять перекрытия", то нужно для счетчика кол-ва оставшихся хидденов считывать значение из "num".
*Оптимальное значение максимальной площади - 1024 пикселей, т.е. допускаем перекрытие в 32 на 32 пикселя, что совсем не влияет на визуальное перекрытие объектов.
*Количество итераций можем ставить 20-50. Если перекрытий не останется раньше, то фикс перекрытий остановится, если выполнится все количество - отобразится количество перекрытий в логах. Большое количество итераций фикса негативно сказывается на скорости загрузки сцены.

Логи:

*"Deleting a hidden object with textID: %i" - удаление объекта с текстовым ID
*"Overlapping detected! Area: %f px" - обнаружения перекрытия в столько-то пикселей
*"fixOverlapping() Iterations num: %i / %i; Overlaps num: %i" - итерации, итоговое количество перекрытий

==Дополнительные параметры==

*'''скалирование объектов''' ('' scale_object '') - При нахождении во время полета объект будет скалироватся:
:'''0''' - отключено;
:'''1''' - включено.
*'''пропадание объектов''' ('' alpha_object '') - При нахождении во время полета объект будет менять альфу:
:'''0''' - отключено;
:'''1''' - включено.
*'''реагировать на отпускание''' ('' touch_up '') - Объекты связанные с этим хидденлистом будут реагировать на отпускание, а не на нажатие:
:'''0''' - отключено;
:'''1''' - включено (То есть реагировать на четкий клик, если кликнули и сместили область клика объект не реагирует!).
*'''реагировать на finger tap''' ('' finger_tap '') - Объекты, связанные с этим хидденлистом, будут реагировать на отпускание после ожидания даблтача.
*'''задержка срабатывания''' ('' touch_delay '') - только для реакции на нажатие. Время между нажатием и реакцией списка объектов.
*'''объединять одинаковые тексты''' ('' same_txt '') - Объекты с одинаковым текстом будут жить в одной ячейке таблицы с добавлением множителя xN.
:'''0''' - отключено;
:'''1''' - включено.
*'''множитель для иконок''' ('' ico_res '') - Графический ресурс(анимация) для отображения множителя у иконок для типа списка 4(поиск по иконкам) и включенного объединения одинаковых текстов. Первый фрейм - х2, второй - х3 и т.д.
*'''исключать одинаковые тексты''' ('' unTxtID '') - исключает или не исключает из поиска объекты с одинаковыми txtID, используется совместно с '''одного типа'''.
*'''вероятность пассивного предпочитаемого объекта''' ('' prefProb '') - вероятность выпадения пассивного объекта, если у объекта стоит параметр "предпочитаемый" используется при исключении объектов с одинаковыми текстовыми ID.
*'''вероятность активного предпочитаемого объекта''' ('' prefProbAct '') - вероятность выпадения активного объекта, если у объекта стоит параметр "предпочитаемый" используется при исключении объектов с одинаковыми текстовыми ID.
*'''реагировать на невидимые''' ('' canInvis '') - реагировать или нет на объекты, которые в момент игры не видны в таблице. (Кликаются только те [[hiddenObject]] которые отображены в таблице, остальные нет!).
*'''прятать актеров при старте''' ('' hideact '') - Устанавливать актерам видимость false при старте (по умолчанию - да)(То есть всем актерам которые находятся на сцене при запуске принудительно установиться vis = 0).
*'''аномалия''' ('' anom '') - для всех аномалий кроме текстовой [[HiddenObject]] и игровой фон должны быть подобъектами [[Effect]]):
:'''0''' - нет;
:'''1''' - текстовая;
:'''2''' - ночь; В машине которая выставляет эффект ночь, должны передавать сцене с объектом аномалия ( obj="scene"; par="drag"; val="0" ) и ( obj="scene"; st="update");
:'''3''' - трансформация цвета;
:'''4''' - дым.
При применении аномалии "блитц" через объект [[Economics]] набор параметров: anom="0", is_blitz="1".
*'''флурри''' ('' flurry '') - Нужно ли отправлять статистику флурри "regexp=":
:'''0''' - нет;
:'''1''' - да.
*'''вероятность инверсии''' ('' invProb '') - Вероятность того, что сцена будет перевернута по x;
*'''набор''' ('' kit '') - Набор, из которого берутся объекты.
*'''поведение дифференсов''' (''difbeh'') - Поведение найденных объектов в режиме поиск отличий.

'''Группа - появление новых объектов'''

*'''время''' ('' acttm '') - Время появления объекта (мс);
*'''начальный скейл''' ('' actsc '') - Начальный скейл;
*'''начальная альфа''' ('' actal '') - Начальная альфа.

'''Группа - сессии'''

*'''сессионность''' ('' ses ''):
:'''0''' - нет;
:'''1''' - да.
*'''ограничение сессий''' ('' sesLim '') - Максимальное количество сессий, в которые можно играть.
*'''набор объектов''' ('' sesSet '') - Набор объектов при заходе в хидден после последней сессии:
:'''0''' - случайный;
:'''1''' - последний фон;
:'''2''' - пустой.

'''Группа - цвета'''

*'''Цвет обязательных''' ('' c_forced '') — цвет текста для обязательных объектов, указывается код цвета, если строку не заполнять цвет не используется.
*'''Цвет найденных''' ('' c_found '') — цвет текста для найденных объектов, указывается код цвета, если строку не заполнять цвет не используется.
*'''Время перехода''' ('' c_time '') - Время изменения цвета.

'''Группа - время'''

*'''игры''' ('' tmGm '') - Общее время игры. Если оно истекает, идет переход на экран [время вышло] (см.ниже):
:'''-1''' - игнорируется;
:'''число''' - время игры.
*'''прерывать''' ('' tmInt ''):
:'''1''' - по окончанию времени игра будет прервана;
:'''0''' - по окончанию времени игра продолжится, но переход все равно будет на неудачную ветку.
*'''паузы''' ('' tmWt '') - Время перед закрытием окна после разбора (для осмысления результата);
*'''полета актера''' ('' tmActor '') - Время работы актера, после которого обрабатываются ячейки таблицы;
*'''перед исчезновением''' ('' tmWtHide '') - Время, в течение которого объект остается видимым после обработки.

'''Группа - ошибки'''

*'''flyer при ошибке''' ('' fl '') - обычно объект типа flyer (летуны которых надо показать в точке клика, если этот клик ошибочный). Можно в принципе любой объект который обладает состоянием "beg". Ошибочный клик - все клики мимо [[hiddenObject]].
*'''вычет времени при ошибке''' ('' tmPen '') - Сколько отнять миллисекунд за ошибочный клик.

'''Группа - переход'''

*'''при разборе''' ('' scrOk '') - Экран на который надо перейти, если все объекты найдены.
*'''время вышло''' ('' scrOv '') - Экран на который надо перейти если время вышло, а не все объекты найдены.

'''Группа - система очков'''

*'''Счетчик''' ('' score_counter '') — счетчик, отображающий набранные очки.
*'''счетчик (test)''' ('' score_counter_test '') — счетчик, отображающий набранные очки.
*'''ID пака''' ('' pack_id '') — строковый идентификатор пака(для записи набранных очков в [[options]] должен быть заполнен); используется для вытаскивания суммарных очков в счетчики и дальнейшего их отображения.
*'''ID игры''' ('' game_id '') — строковый идентификатор игры (сцены).
'''Обязательно должен иметь префикс ID пака. Например, если pack_id = "pack1", то game_id = "pack1.game1"'''.
*'''мультипликатор очков''' ('' scoreM '') — Мультипликатор очков за объект, если все собрано за отведенное время.
*'''Очки''' ('' score '') — количество очков, которые даются за каждый найденный [[hiddenObject]].
*'''Бонус за скорость''' ('' bonusS '') — бонус за быстро найденный [[hiddenObject]].
*'''Бонусный интервал''' ('' bonusT '') — время, за которое нужно найти [[hiddenObject]] для получения бонуса.
*'''бонус за время''' ('' bonusTime '') - бонус за оставшееся время игры = коэффициент который введем * оставшееся время таймера.
*'''Бонусный мультипликатор''' ('' grow ''):
:'''1''' - умножать очки за второй быстро найденный предмет на 2, за третий на 3, и т. д.
:'''0''' - не умножать.
*'''Количество кликов для штрафа''' ('' wrngC '') — количество неверных кликов, после которых запустится блокатор (см. ниже).
*'''Интервал для штрафа''' ('' wrngT '') — время, за которое нужно совершить неверные клики.
*'''Штраф (очки)''' ('' delS '') — Сколько отнимаем очков за ошибочный клик.
*'''Штраф (время)''' ('' delT '') — Сколько отнимаем времени за ошибочный клик.
*'''блокатор''' ('' blockImg '') - Объект, блокирующий сцену при серии ошибочных кликов. (Обычно маска растянутая на весь экран. '''ДОЛЖНА иметь состояние "beg"''').
*'''время блокировки''' ('' blockTime '') - Время блокировки при серии ошибочных кликов по истечении переводит "блокатор" в состояние '''end'''.
*'''порог touch move''' ('' mvSens '') - Порог, начиная с которого движение пальца воспринимается как мув и сбрасываются неправильные клики.
*'''touch move как штраф''' ('' tchMvPen '') - Считать ли touch move за ложное попадание:
:'''0''' - нет;
:'''1''' - да.
*'''клик на найденный как штраф''' ('' clkFndPen '') - Считать ли клик на найденный объект за ложное попадание(актуально если объекты остаются на сцене).
*'''аниматор очков''' ('' scoreAnim '') - машина, которая анимирует полученные очки, должна иметь состояние '''anim'''.
*'''коэффициент комбо''' ('' cmbCoef '') - коэффициент для расчёта комбо очков по формуле s(n) = k * n * (n + 1).
*'''счётчик очков за объект''' ('' objScCnt '') - счётчик который показывает очки за последний полученный объект (учитывая бонусы).
*'''счётчик комбо-очков''' ('' cmbScCnt '') - счётчик очков полученных за комбо-серию.
*'''счётчик комбо-серий''' ('' cmbRwCnt '') - счётчик который показывает комбо-серию (комбо из 2-х, 3-х и т.д. найденных объектов).
*'''комбо2 прогресс''' ('' cmb2Pr '') - комбо2 прогресс;
*'''комбо2 время''' ('' cmb2Tm '') - комбо2 время;
*'''комбо2 кол-во''' ('' cmb2Num '') - комбо2 кол-во.
*'''очки 3.0''' (''score30'') - Использовать систему очков, придуманную Степановым в августе 2015.
*'''очки 3.0 коэф. комбо''' (''score30lc'') - в конце комбо даем за него очков n * s * l * (n-1) - где n число предметов в комбо, s - очки за один предмет, l - этот коэффициент
*'''очки 3.0 коэф. аккуратности''' (''score30la'') - в конце игры начисляем очки за точность по формуле s * la / (1 + Nmiss / N)
*'''очки 3.0 коэф. времени 1 (l)''' (''score30lt'') - в конце игры начисляем очки за время по формуле s * lt / (1 + T / (tt * N))
*'''очки 3.0 коэф. времени 2 (t)''' (''score30tt'') - в конце игры начисляем очки за время по формуле s * lt / (1 + T / (tt * N))

'''Группа - звезды'''

*'''combo num''' ('' comboNum '') - Количество быстро найденных объектов, нужное для получения звезды Combo.
*'''combo time''' ('' comboInt '') - Интервал между кликами, считающимися быстрыми для Combo.
*'''accuracy''' ('' accuracy '') - Точность кликов для получения звезды Accuracy (1 = 100%, все клики должны быть только удачные).
*'''лимит ложных кликов''' ('' starWrAcc '') - Лимит ложных кликов.
Формула расчета проста, количество верных кликов делим на общее количество получаем коэффициент если он равен или больше указного нами то в опции пишем параметр, если нет то не пишем.

==Параметры бота и мультиплеера==

'''Группа - Хидден бот'''

*'''тип бота''' - тип бота:
:'''нет''' - обычная одиночная игра, бот выключен;
:'''на одном поле''' - игра с ботом на одном поле, у обоих одинаковый список предметов;
:'''с маленьким полем''' - бот будет играть на отдельном поле (??????);
:'''горячий стул''' - hotsit, игра двух живых игроков на одном девайсе, передача хода по очереди;
:'''мультиплеер''' - игра через сервер с живым оппонентом;
*'''файл уровня''' - xml файл с настройками сложности бота ([[HiddenList#Настройка сложности бота|пример]]);
*'''номер уровня''' - номер уровня в файле (начиная с 0);
*'''номер уровня max''' - если задан больше предыдущего номера - выбирается рандомное значение;
*'''multiplayer''' - объект мультиплеера;
*'''кнопка хинта''' - кнопка хинта для 2го игрока \ бота;
*'''проверять интернет''' - проверять интернет при игре с ботом (так же, как при игре с живым игроком);
*'''первый ход (вероятность)''' - вероятность первого хода игрока при игре с ботом (в процентах);
*'''t min abs ms''' - самая минимальная задержка между ходами бота;
*'''t1 min ms''' - минимальное время для быстрого нахождения предмета ботом;
*'''t1 max ms''' - максимальное время для быстрого нахождения предмета ботом;
*'''t1 prob %''' - вероятность быстрого нахождения предмета ботом;
*'''t2 min ms''' - минимальное время для нахождения предмета ботом;
*'''t2 max ms''' - максимальное время для нахождения предмета ботом;
*'''t coef delta''' - коэффициент сложности (кажется от -1 до 1, могу ошибаться);
*'''t wrong min ms''' - минимальное время между ложными кликами (мимо объекта) бота;
*'''t wrong max ms''' - максимальное время между ложными кликами бота;
*'''bot hint chance (percent)''' - шанс бота использовать хинт (в процентах);
*'''bot hint num''' - максимальное кол-во использования хинтов ботом на игру;
*'''доп. поле x''' - координаты доп. поля по Х;
*'''доп. поле y''' - координаты доп. поля по Y;
*'''доп. поле sx''' - масштаб доп. поля;
*'''доп. поле sy''' - масштаб доп. поля;
*'''указатель хода''' - указатель хода бота\оппонента. Должен иметь состояние ''beg'' и находитсья в сцене с хидденами;
*'''родитель''' - родитель, в который поместим клонированную сцену (доп. поле);
*'''счетчик очков бота''' - счетчик, выводящий очки;
*'''счетчик без бонусов бота''' - счетчик, выводящий очки без бонусов за время и точность;
*'''комбо2 прогресс бота''' - комбо2 прогресс;
*'''аниматор очков бота''' - машина, которая при нахождении хиддена анимирует полученные очки;
*'''счетчик очков за объект бот''' - счетчик, выводящий очки за объект;
*'''счетчик комбо-серий (макс) бот''' - счетчик, выводящий макс. количество комбо-серий;
*'''счетчик комбо-серий (тек) бот''' - счетчик, выводящий текущее количество комбо-серий;
*'''flyer при ошибке''' - объект типа ''flyer'' который надо показать в точке клика, если этот клик ошибочный;
*'''таймер хода бота''' - таймер хода бота;
*'''таймер хода игрока''' - таймер хода игрока;
*'''длительность хода ms''' - длительность хода игрока \ бота. Если задан 0 - игроки ходят одновременно;
*'''длительность паузы между ходами ms''' - длительность паузы при смене хода игрока\бота.

=== Настройка сложности бота ===

Файл уровней для хидден-бота должен иметь такую структуру:
<bots>
<obj id="0">
<bot weight="3" t1min="1000" t1max="2000" t1percent="15" t2min="3000" t2max="21000" twrongmax="10000" />
<bot weight="1" t1min="1000" t1max="2000" t1percent="15" t2min="3000" t2max="5000" twrongmax="10000" />
</obj>
<obj id="1">
<bot weight="1" t1min="1000" t1max="2000" t1percent="10" t2min="10000" t2max="25000" twrongmax="10000" />
<bot weight="1" t1min="1000" t1max="2000" t1percent="15" t2min="3000" t2max="7000" twrongmax="10000" />
</obj>
<obj id="2">
<bot weight="1" t1min="1000" t1max="2000" t1percent="10" t2min="7000" t2max="21000" twrongmax="10000" />
<bot weight="2" t1min="1000" t1max="2000" t1percent="15" t2min="3000" t2max="5000" twrongmax="10000" />
</obj>
</bots>

*bots - основной таг
*obj > id - номер уровня
*bot - содержит те же параметры, что и настройки бота в хидден листе

==Режим "блиц" с бесконечными объектами==

'''Правила аномалии "блиц"''':

*Блиц заканчивается победой, если игрок нашел хотя бы один предмет за отведенное время игры блиц.
*Если время вышло, но не было найдено ни одного предмета, то засчитывается поражение.
*В аномалии блиц количество возможных предметов ограничивается максимальным количеством уникальных хидден-предметов на сцене (считываем из хидден-листа, параметр num). А количество видимых предметов ограничивается количеством предметов, заданных на уровне мастерства локации. При постепенном разборе предметов добавляются новые пока не будет разобрано максимальное количество предметов на хидден сцене, либо, пока не закончится время, но одновременно видно предметов не больше, чем заданных на конкретном уровне мастерства локации.

Для включения такого режима блиц используем поле в настройках хидден-листа:
*'''блиц с бесконечными объектами''' ('' endlessBlitz '') - При блице ставим максимальное количество объектов и засчитываем победу, если найден хоть один. (да - использовать режим, нет - не использовать).

Если в этом поле настройка "нет", то режим блиц работает по-старому: объектов столько, сколько указано в уровне мастерства.

Прочитать, находится ли хидден в режиме блиц можно из поля "is_blitz" хидден листа (возможные значения - 0 или 1). Заполняется экономикой в момент старта локации.

Для отображения в счетчике максимального количества уникальных хидден-предметов на сцене (считываем из хидден-листа, параметр num) вычитывать измененный num можно ТОЛЬКО ПОСЛЕ прихода start hiddenlist, т.е. не в ините.

В экономике указываем блиц, как отдельную аномалию.

==Состояния==

Состояния которые есть у листа. Мы можем передавать их с помощью различных объектов:
*'''invert''' - горизонтально отображает изображение;
*'''run''' - переводит хидден в состояние активности, если до этого был на паузе;
*'''pause''' -переводит хидден в состояние паузы, объекты не кликаются!
*'''swap_hiddens''' -меняет отображаемые в таблице поисковые объекты на случайные другие.
*'''get_visible_ho''' - вернуть id активного HO объекта (объект пишет в себя два параметра - '''randomHO_id''' и '''randomHO_vis''' (id объекта и виден ли он сейчас юзеру)); Приоритет выбора HO объекта: с начала видимые юзеру, если таких нет - выводим невидимый на текущий момент HO (до предмета нужно фокусировать сцену).

==Примечания==

*HiddenList должен располагаться в дереве проекта ниже всех своих поисковых объектов.

*Единственный '''обязательный объект''' о котором должен знать лист это [[Table]] для отображения списка поиска, даже если таблица не будет использоваться быть все равно должна!

*После завершения хидден-игры (по разбору или по времени)при переходе на другой экран HiddenList записывает данные в опции в два места: первое - это то, которое указано у настройках (ID пака, ID уровня, тип списка), для каждой локации свое; а второе - это last_game. 
Например, 
'''last_game.time_spent''' (либо же '''pck_N.lvl_N.kind_N.time_spent''') - время последней игры, 
'''last_game.clicks''' (либо же '''pck_N.lvl_N.kind_N.clicks''') - количество найденных объектов и т.д. 
Все их можно увидеть в опциях. last_game был придуман для того, чтобы было удобно задавать счетчики в окне результатов. Также эти данные могут быть сохранены в опциях, если задать листу состояние '''wait'''.

*Для проверки кликабельности хидденобъектов можно воспользоваться следующими настройками в app.icf:

<pre>
[GHiddenList]
HitTest=0
HitTestDx=1 - шаг по х
HitTestDy=1 - шаг по y
</pre>

в результате после перехода на сцену с хидденом появится файл, в котором будет казан объекты и координаты в которых они не тапаются.

== Добавляемые параметры ==

[[Файл:+.png]] '''появляется новый объект: изменить состояние объекта''' ('' actst ''):
:'''объект''' ('' obj '') - Объект, состояние которого нужно изменить;
:'''состояние''' ('' st '') - Новое состояние объекта.

[[Файл:HOList_3.jpg|right]]

[[Файл:+.png]] '''разбор: если был экран''' ('' wscrOk '') - При нахождении всех объектов, переходим на определенный экран, если некоторый экран был уже хотя бы раз посещен:
:'''был экран''' ('' was '') - Экран, который мы проверяем на то, был ли он уже открыт хотя бы один раз;
:'''перейти на''' ('' scr '') - Переходим на этот экран, если экран из предыдущего поля уже открывался.

[[Файл:+.png]] '''разбор: изменить состояние объекта''' ('' nstOk '') - При нахождении всех объектов, перевести объект в новое состояние:
:'''объект''' ('' obj '') - Перевести объект в состояние из следующего поля;
:'''состояние''' ('' st '') - Новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''разбор: изменить параметр объекта''' ('' chgOk '') - При нахождении всех объектов, изменить параметр объекта:
:'''объект''' ('' obj '') - этот объект меняет свой параметр;
:'''свойство''' ('' par '') - Параметр, который мы изменяем;
:'''значение''' ('' val '') - Новое значение параметра.

[[Файл:+.png]] '''нет предметов (при создании из динамического конфига)''' ('' nstNoObjects '') - при загрузке локации без хидден-объектов (например не подтянулся пак либо нет локализации) перевести объект в новое состояние:
:'''объект''' ('' obj '') - Перевести объект в состояние из следующего поля;
:'''состояние''' ('' st '') - Новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''не успел: если был экран''' ('' wscrOv '') - Если вышло время, а объекты не найдены, переходим на определенный экран, если некоторый экран был уже хотя бы раз посещен:
:'''был экран''' ('' was '') - Экран, который мы проверяем на то, был ли он уже открыт хотя бы один раз;
:'''перейти на''' ('' scr '') - Переходим на этот экран, если экран из предыдущего поля уже открывался.

[[Файл:+.png]] '''не успел: изменить состояние объекта''' ('' nstOv '') - Если вышло время, а объекты не найдены, перевести объект в новое состояние:
:'''объект''' ('' obj '') - перевести объект в состояние из следующего поля;
:'''состояние''' ('' st '') - Новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''не успел: изменить параметр объекта''' ('' chgOv '') - Если вышло время, а объекты не найдены, изменить параметр объекта:
:'''объект''' ('' obj '') - этот объект меняет свой параметр;
:'''свойство''' ('' par '')- Параметр, который мы изменяем;
:'''значение''' ('' val '') - Новое значение параметра.

[[Файл:+.png]] '''счетчик очков''' ('' scoreCnt ''):
:'''счетчик''' ('' cnt '') - Каунтер, которому приходят очки.

[[Файл:+.png]] '''группа extra bonus''' ('' extraBonus ''). Используется для economics, при нахождении объекта с некой вероятностью может выпасть бонус. Объект который анимирует появление бонуса должен иметь состояние show, время на анимацию бонуса - 10 секунд:
:'''монетки объект''' ('' coinsObj '') - объект который анимирует получение монет;
:'''монетки вероятность''' ('' coinsProb '') - вероятность по нахождению объекта получить дополнительно монетки;
:'''опыт объект''' ('' expObj '') - объект который анимирует получение опыта;
:'''опыт вероятность''' ('' expProb '') - вероятность по нахождению объекта получить дополнительно опыт;
:'''энергия объект''' ('' energyObj '') - объект который анимирует получение энергии;
:'''энергия вероятность''' ('' energyProb '') - вероятность по нахождению объекта получить дополнительно энергию.

[[Файл:+.png]] '''Объект, который срабатывает, если долго не находить хидден''' ('' notfnd ''):
:'''объект''' ('' obj '') - Объект, который переводится в указанное состояние, если долго не находить хидден;
:'''состояние''' ('' st '') - Состояние, в которое переводится объект;
:'''время''' ('' tm '') - Время от последнего нахождения хиддена, после которого срабатывает объект.

[[Файл:+.png]] '''параметры аномалии с исчезновением букв''' ('' hlPars ''):
:'''оставшиеся буквы''' ('' min '') - Минимальное количество оставшихся букв в предложении;
:'''задержка''' ('' wait '') - Момент времени, начиная с которого аномалия будет проявляться;
:'''задержка 2''' ('' wait2 '') - Задержка для появившихся слов, изначально недоступных;
:'''время''' ('' time '') - Время, за которое должны исчезнуть все буквы (если -1, то до конца времени в хиддене);
:'''промежутки''' ('' dt '') - промежутки времени между каждой итерацией;
:'''флайер''' ('' fl '') - Флайер, анимирующий исчезающую букву (должен иметь '''текстовый''' тип).

[[Файл:+.png]] '''параметры аномалии ночь''' ('' nightPars ''):
:'''effect''' ('' ef '') - эффект, управляющий трансформацией цвета;
:'''tag''' ('' eftag '') - Тег эффекта, реализующего ночь.

[[Файл:+.png]] '''параметры аномалии трансформации цвета''' ('' colInvPars ''):
:'''effect''' ('' ef '') - Эффект, управляющий трансформацией цвета;
:'''tags''' ('' eftags '') - Теги эффектов, реализующих трансформацию цвета, из которых будет выбран один.

[[Файл:+.png]] '''параметры аномалии дым''' ('' smokePars ''):
:'''effect''' ('' ef '') - Машина, управляющая эффектом дыма;
:'''tag''' ('' eftag '') - Тег эффекта, реализующего дым.

Все аномалии кроме текстовой должны быть настроены с помощью объекта [[Effect]]

== Get Started==
Минимальный набор ресурсов:
* Фоновая картинка для поисковой сцены
* Комплект картинок, с которых будут сделаны поисковые [[HiddenObject|объекты]]
* Текстовые объекты для идентификации спрятанных объектов

Минимальный набор объектов редактора:
* [[Image]] который будет изменен в хидден-лист
* [[Table|Таблица]] в которой будут отображаться тексты/картинки (зависит от режима) спрятанных объектов.
* По одному [[Image]] для каждого спрятанного объекта (будут созданы автоматически при добавлении картинок из базы ресурсов на сцену)

Наши действия:
# откроем [[Интерфейс_ScenceEditor|редактор сцен]] и создадим новый проект,
# добавим новый экран с именем ''scrHList''
# создадим в этом экране сцену ''stgHList''
# перейдём в [[Интерфейс_ResourceEditor|редактор ресурсов]]
## создаём папку ''HList''
## добавим в ней картинку для фона и картинки для спрятанных объектов.
## выделим все картинки в дереве ресурсов и перенесем их на нашу сцену ''stgHList'', при этом для каждой картинки автоматически создастся объект [[Image]].
## закроем редактор ресурсов
# перейдём в [[Интерфейс_TextEditor|редактор текстов]]
## создаём папку ''HListText''
## добавим в нее текстовые объекты, по одному на каждый поисковый объект.
## сохраним внесенные изменения.
# перейдём в редактор сцен.
# создадим в сцене stgHList объект [[Table]] и назовем его HOT
## настроим размер и положение таблицы, согласно нашего дизайна
## установим параметры колонок = "50", колонок видно = "5", строчек = "5", строчек видно = "1" (таким образом в таблице будут отображаться 5 поисковых предметов, а максимальное количество объектов для поиска будет равно 250)
## установим параметры скорость листания = "650", добавлять по строкам = "0", центрировать = "растянуть", сдвигать ячейки при удалении ="да"
# создадим в сцене stgHList объект '''HiddenList''', напоминаем что его размер и положение на сцене не имеют значения, по этому расположим его где-нибудь за границей экрана. '''Важно''' В дереве проекта хидден-лист должен быть ниже всех своих поисковых объектов.
## в поле таблица указываем нашу HOT
## установим параметр объектов = "10"
## установим параметр пропадание объектов = "да"
## установим параметр реагировать на отпускание = "да"
## установим параметр реагировать на невидимые = "нет"
## установим параметр набор = "1"
# Настроим объекты, которые будут прятаться. Для этого выделим картинки поисковых объектов, добавленные нами ранее, и изменим им тип на "hiddenObject". Оставляя группу этих объектов выделенной, настроим им параметры:
## в поле list укажем наш HiddenList
## параметр набор = "1"
## Теперь снимаем выделение и каждому объекту в поле текстID перетаскиваем мышкой соответствующий текстовый объект из текстовой базы (поле текстID должно быть активно для редактирования - по нему нужно кликнуть мышкой)
# сохраним проект
# запустим [[Интерфейс_Viewer|вьювер]]

== Динамический HG==
Функционал позволяет генерировать HL самостоятельно HO объекты из файла конфига.

П.С. - вся графика д.б. динамической. Данные файлы может создавать HO_Manager ( http://wiki/index.php/HO_Manager )

[[Файл:D485ecbbbb.jpg|right]]
*'''файл уровня''' ('' configFile'') — указываем путь к файлу конфигу, где перечисляем файлы с HG.
*'''список графических ресурсов''' — служебное, пока не используется;
*'''список текстовых ресурсов''' — служебное, пока не используется;
*'''номер уровня''' ('' hiddenLevelNum '') — номер уровня из файла;
*'''образец хиддена''' ('' hiddenTemplate '') — obj_id HO объект, должен иметь нужные параметры (остальные возьмутся из конфига) ;
*'''образец нашлёпки''' ('' hiddenPatchTempl '') — obj_id нашлёпки на HO объект, должна иметь нужные параметры (остальные возьмутся из конфига);
*'''корневой объект''' ('' hiddenRoot '') — obj_id корневого объект в который сложим всех клонов;
*'''точечный спецэффект''' ('' hiddenEffect '') — ;
*'''фоновый объект ''' ('' hiddenBG '') — obj_id объекта которому поменяем ресурс;

Требования, вся графика HO,BG отрисовывается без учёта пивоты;

Файлы конфиги имеют вид:
Файл уровня имеет вид:
{
"levels": [
{
"file": "ViewerFiles/DynHid/hidden0.cfg",
"pack":3
}
]
}

:Где "levels" - линки на файлы уровней.
:::"file" - путь к файлу;
:::"pack" - пак в который попадут ресурсы;

Файл конкретного уровня имеет вид:
{
"bg": {
"src": "bg.png",
"w": 2048,
"h": 1151,
"id": 16,
"color": "#ffffff",
"tile": ""
},
"hiddens": [
{
"id": 1022,
"nm": "bucket_01",
"res": 129,
"bg": 666,
"rect": {
"x": 1393,
"y": 653,
"w": 115,
"h": 137
},
"objs": [{
"res": 1488,
"rect": {
"x": 1393,
"y": 653,
"w": 115,
"h": 137
}
}],
},
{
"x": 1537,
"y": 409,
"id": 1023,
"res": 329,
"nm": "bucket_02",
"rect": {
"x": 1493,
"y": 366,
"w": 81,
"h": 87
}
}
],
"res": {
"images": [16, 129, 1488, 329],
"texts": [1022, 1023],
"sounds": [],
}
}

:Где "bg" - настройки фона.
:::"src" - сорс графического файла в ресурсной базе;
:::"color" - цвет которым будет залито под фоном, нужное если фон имеет дырки;
:::"tile" - тайлинг фона;
:::"id" - id ресурса из ресурсной базы;
::"hiddens" - перечень HO с их настройками
::::"id" - TxtId;
::::"nm" - имя HO;
::::"res" - графический ресурс HO;
::::"bg" - графический ресурс тени;
::::"rect" - настройки "res";
:::::"x" - координата x, в координатах корневого объекта;
:::::"y" - координата y, в координатах корневого объекта;
:::::"w" - ширина;
:::::"h" - высота;
::::"objs" - перечень нашлёпок;
:::::"res" - графический ресурс нашлёпки;
:::::"rect" - настройки графического ресурса нашлёпки;
::::::"x" - координата x, в координатах HO;
::::::"y" - координата y, в координатах HO;
::::::"w" - ширина;
::::::"h" - высота;
::"res" - ресурсы которые входят в пак уровня ( будут вырезаны при экспорте в пак уровня)
::::"images" - перечень графических ресурсов
::::"texts" - перечень текстовых ресурсов
::::"sounds" - перечень звуковых ресурсов

== Авто тест HL ==
Для запуска автотеста, нам нужно указать в app.icf параметры:

[GHiddenList]
:'''HitTest''' - мода автотеста; (0- выкл.; 1 - разовая логика, пишется в файл раз в сессию для одного хидден листа ; 2 - при каждом init любого хидн листа дописывается статистика в файл);
:'''HitTestDx''' = 5 - шаг с которым проходит автокликер по X;
:'''HitTestDy''' = 5 - шаг с которым проходит автокликер по Y;

Для HitTest==2, очень помогает параметр "allow_background". Остаётся только написать скриптулину, которая ходит сама между экранами.

== Пример ==

S:\!MOBILE\!!!EditorGames\Wiki_sample

HiddenList.rar

[[Category:Game mechanic]]

[[Category:Get Started]]

Cloud

2018-02-19T09:54:49Z

Bmor: /* Состояния */

Объект необходим для синхронизации приложения с облаком.

=Параметры объекта Cloud=

==parse general==

*'''app''' - Код приложения из parse
*'''key''' - Ключ приложения из parse
*'''имя игры''' - Наше внутреннее имя игры в parse
*'''имя игрока''' - Имя игрока. Заполнить до любых вызовов состояний
*'''cloud major field''' - Главное поле в опциях, по которому будет выбираться версия опций в cloud при кофликте (наибольшее из значений будет приоритетнее)
*'''автоприменение''' - Применять лучшие опции автоматически. Если "нет" то нужно подтверждение пользователя.
*'''esocial''' - объект типа esocial для получения списка друзей.
*'''повторять лоад раз''' - количество повторов parse_load при неуспехе, если не отсутствие интернета.
*'''автолоад''' - автоматически вызывать parse_load при логине в социальной сети.

==parse leaderboards==

*'''лидерборд''' - id таблицы на сервере, в которую будет засылать очки. Начинается с латинской буквы! Не содержит левых символов!
*'''очки''' - Очки для отправки. Валидное целое число!
*'''таблица''' - объект-таблица, в который сложим очки. Должна иметь три колонки (место-имя-очки), заполнение по строкам - в случае если не указан "шаблон".
*'''шаблон''' - объект типа leaderboardsitem для помещения в таблицу
*'''свое место''' - каунтер в котором будет место игрока
*'''свои очки''' - каунтер в котором будут очки игрока
*'''своя иконка''' - иконка игрока
*'''запрашивать записей''' - сколько записей запросить из таблицы
*'''всегда запрашивать''' - запрашивать лидерборды даже если есть кешированные данные (нет=0, да=1)
*'''дефолтное имя''' - если у нас все еще нет имени человека, вместо него будет эта строка
*'''специальная сортировка''' ( special_sort ) - специальная сортировка, по лвлу ( задаём "1" когда открываем лидерборды глобальные/ друзей; ставим "0" в лидерах монстров/локаций)
*'''анимация смены мест''' - анимация смены мест игроком (нет=0, да=1)

*'''периодический лидерборд''' - Периодический лидерборд в parse
*'''(периодический) таблица''' - объект-таблица, в который сложим очки за текущий период. Должна иметь три колонки (место-имя-очки), заполнение по строкам - в случае если не указан "шаблон"
*'''(периодический) таблица предыдущая''' - объект-таблица, в который сложим очки предыдущего периода. Должна иметь три колонки (место-имя-очки), заполнение по строкам - в случае если не указан "шаблон"
*'''(периодический) шаблон''' - объект типа leaderboardsitem для помещения в таблицу текущего лидерборда
*'''(периодический) шаблон предыдущий''' - объект типа leaderboardsitem для помещения в таблицу предыдущего лидерборда
*'''(периодический) свое место''' - каунтер в котором будет место игрока
*'''(периодический) свои очки''' - каунтер в котором будут очки игрока
*'''(периодический) своя иконка''' - иконка игрока
*'''(периодический) таймер''' - иконка игрока
*'''(периодический) запрашивать записей''' - сколько записей запросить из таблицы
*'''(периодический) анимация смены мест''' - Анимация смены мест игроком (нет=0, да=1)
*'''(периодический) в предыдущую таблицу только себя''' - в предыдущую таблицу только себя (нет=0, да=1)
*'''(периодический) таблица наград''' - объект-таблица, в который сложим шаблоны наград
*'''(периодический) шаблон награды''' - объект типа rewarditem

==parse голосовалка==

*'''таблица''' - объект-таблица, в который сложим ответы;
*'''шаблон''' - объект типа pollitem для помещения в таблицу;
*'''название''' - текстовый объект, куда мы сложим название опроса;
*'''таблица пред.''' - объект-таблица, в который сложим ответы;
*'''шаблон пред.''' - объект типа pollitem для помещения в таблицу;
*'''название пред.''' - текстовый объект, куда мы сложим название опроса;
*'''время''' - объект типа таймер, куда мы сложим оставшееся время опроса;
*'''текст шаринга''' - текст шаринга.

==parse друзья и подарки==

*'''таблица''' - объект-таблица, в который сложим шаблон leaderbordsitem;
*'''шаблон''' - объект типа leaderboardsitem для помещения в таблицу;
*'''добавить приглашаемых''' - "сколько приглашаемых друзей добавить к играющим друзьям;
*'''прятать одаренных''' - нет - в таблице все друзья; да - в таблице скрыты те, кому дарили подарок.

==parse запросы дружбы==

*'''текст запроса дружбы''' - Текстовый айди для исходящего запроса дружбы;
*'''окно''' - Само окно. Должно иметь состояние show;
*'''иконка''' - Портрет приглашающего;
*'''имя''' - Имя приглашающего;
*'''таблица инвайтов''' - таблица, в которую сложим все инвайты;
*'''шаблон инвайта (inviteitem)''' - Шаблон инвайта для помещения в таблицу.

==parse окно обгона в таблице лидеров==

*'''кого leaderboardsitem''' - кого leaderboardsitem
*'''кто leaderboardsitem''' - кто leaderboardsitem
*'''машина''' - собственно машина окна (или просто обработчик обгона). Должна иметь состояния show_up и show_down, соответственно при обгоне вверх и вниз.

==parse окно обгона для периодических лидербордов==

*'''кого leaderboardsitem''' - кого leaderboardsitem
*'''кто leaderboardsitem''' - кто leaderboardsitem
*'''машина''' - собственно машина окна (или просто обработчик обгона). Должна иметь состояния show_up и show_down, соответственно при обгоне вверх и вниз.

==Приглашение в мультиплеер==
*'''multiplayer''' - объект мультиплеера
*'''информация''' - информация о приглашающем, объект типа leaderboardsitem

==Боты для лидербордов==
*'''конфиг''' - файл с настройками ботов
*'''имена ботов в оффлайне''' - имена ботов, если они генерятся в оффлайне
*'''имена игрока в оффлайне''' - имя игрока в оффлайне

Файл конфига умеет создавать "economicalCycle" (пока только боты для локаций, ModeWorkEconomicalCycle="2" + указываем нужное количество ботов - "bot_loc=k_sc0=1.077#k_scMax=0.71#name=bot1").

=Добавляемые свойства=

==Обработчики для синхронизации==

[[Файл:+.png]] '''параметр, синхронизируемый параметр между приложениями устройства''' - позволяет синхронизировать конкретный параметр между разными приложениями через parse.
*'''группа''' - имя группы, общее для различных приложений, которые синхронизируют данный параметр
*'''параметр''' - имя параметра в группе, общее для различных приложений
*'''объект''' - объект у которого синхронизируем параметр.
*'''параметр объекта''' - параметр который синхронизируем.

[[Файл:+.png]] '''нечего загружать из cloud: изменить состояние объекта''' - обработчик успеха ''parse_load'' в случае отсутствия данных на сервере, не требует дополнительных запросов.
*'''объект''' - объект у которого мы меняем состояние.
*'''состояние''' - Значение нового состояния.

[[Файл:+.png]] '''в cloud опции хуже, не применям их: изменить состояние объекта''' - обработчик успеха ''parse_load'' в случае, когда данные на сервере хуже, чем на текущем устройстве, не требует дополнительных запросов.
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''подтверждение применения данных из cloud: изменить состояние объекта''' - обработчик успеха ''parse_load'' в случае наличия данных на сервере с таким же ''device_id'', показываем игроку окно с предложением синхронизироваться. В окне 2 кнопки: синхронизировать - ''parse_apply'', не синхронизировать - ''parse_isolate''.
*'''объект''' - объект у которого мы меняем состояние.
*'''состояние''' - Значение нового состояния.

[[Файл:+.png]] '''применены данные из cloud: изменить состояние объекта''' - обработчик успеха ''parse_apply'', необходимо перегрузить лайаут.
*'''объект''' - объект у которого мы меняем состояние.
*'''состояние''' - Значение нового состояния.

[[Файл:+.png]] '''подтверждение применения данных из cloud при наличии двух комплектов данных в сети: изменить состояние объекта''' - обработчик успеха ''parse_load'' в случае наличия двух комплектов данных на сервере (например, по facebook_id), показываем игроку окно с предложением синхронизироваться. В окне 2 кнопки: синхронизировать - ''parse_apply_server'', не синхронизировать - ''parse_isolate''.
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''успешно проведен серверный resolve''' - обработчик успеха ''parse_apply_server'', необходимо перезагрузить лэйаут.
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''успешно проведена изоляция''' - обработчик успеха ''parse_isolate'', необходимо вызывать ''parse_save''.
*'''объект''' - объект, состояние которого меняем.
*'''состояние'''- новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''успешно проведена разизоляция''' - обработчик успеха ''parse_un_isolate'', необходимо вызывать ''parse_load''.
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''ошибка, нужно обновить приложение''' - обработчик успеха ''parse_load'', когда версия текущего приложения ниже, чем версия опциях на сервере, показываем окно с кнопкой, ведущей на стор для обновления приложения.
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''ошибка загрузки данных из cloud: изменить состояние объекта''' - сейчас не применяется, т.к. используем '''ErrorManager'''.
*'''объект''' - объект у которого мы меняем состояние.
*'''состояние''' - Значение нового состояния.

==Обработчики голосования==

[[Файл:+.png]] '''голосование загружено: изменить состояние объекта''' - обработчик успеха ''parse_poll''
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''успешно проголосовали: изменить состояние объекта''' - обработчик успеха ''parse_vote''
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

==Обработчики для лидербордов==

[[Файл:+.png]] '''успешно загружены лидерборды''' - обработчик успеха ''parse_leaderboards'', ''parse_leaderboards_friends'' и ''parse_leaderboards_friends_param'', выключаем "крутилку"
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''невозможно загрузить лидерборды из-за objectId''' - обработчик неуспеха ''parse_leaderboards'', ''parse_leaderboards_friends'' и ''parse_leaderboards_friends_param'', которая происходит из-за неуспешного ''parse_load'' (в этом случае ''parse_load'' необходимо повторить)
*'''объект''' - объект, состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''добавляемые лидерборды''' - дополнительная группа настроек визуализации лидербордов, используется для смены таблиц при вызове лидербордов по локациям, монстрам и т.д.
*'''id''' - Идентификатор набора интерфейсных элементов, указывать нужно '''default''' для таблицы, в которую помещаются общие лидеры, для остальных не нужно
*'''имя лидербордов''' - Имя лидербордов, соотв. конфигу. Будет применено, если строка не пустая. Это имя задается в param при вызове ''parse_leaderbords_friends_param''
*'''таблица''' - объект-таблица, в который сложим очки
*'''шаблон''' - объект типа leaderboardsitem для помещения в таблицу
*'''свое место''' - каунтер в котором будет место игрока
*'''свои очки''' - каунтер в котором будут очки игрока
*'''своя иконка''' - иконка игрока
*'''кого leaderboardsitem''' - кого leaderboardsitem" hint="кого leaderboardsitem
*'''кто leaderboardsitem''' - кто leaderboardsitem" hint="кто leaderboardsitem
*'''машина''' - собственно машина окна. Должна иметь состояние show
*'''анимация смены мест''' - Анимация смены мест игроком (нет=0, да=1)

==Обработчики для друзей и подарков==

[[Файл:+.png]] '''успешно загружены друзья''' - обработчик успеха ''parse_friends'', выключаем "крутилку"
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''отправлен запрос дружбы''' - обработчик успеха ''parse_friend_request_lb'', ''parse_friend_request_public'', ''parse_friend_request_param'', показываем информационное окно
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''отправлен подарок''' - обработчик успеха всех состояний отправки подарков через Cloud, показываем информационное окно
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

==Обработчики для временных лидербордов (соревнований)==

[[Файл:+.png]] '''загружена информация о всех лидербордах - соревнования сменились''' - обработчик успеха ''parse_all_leaderboards'', вызываем ''parse_leaderboards_temporary'' и ''parse_leaderboards_temporary_prev''
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''загружена информация о всех лидербордах - соревнования НЕ сменились''' - обработчик успеха ''parse_all_leaderboards'', вызываем ''parse_leaderboards_temporary'' и ''parse_leaderboards_temporary_prev'' при условии, что находимся не в окне соревнований
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''игрок потенциально попал в лидерборды прошлого периода''' - обработчик успеха ''parse_all_leaderboards'' - неинформативный, решили не использовать
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''у игрока призовое место в лидербордах прошлого периода и не забрана награда''' - обработчик успеха ''parse_all_leaderboards'', можно повести игрока забрать награду за предыдущий период соревнований
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''завершились лидерборды предыдущего периода''' - обработчик успеха ''parse_leaderboards_temporary'', вызываем ''parse_all_leaderboards'', показываем информационное окно с информацией о том, что идет подсчет результатов
*'''объект''' - объект - состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''невозможно загрузить лидерборды из-за levelId''' - обработчик неуспеха ''parse_leaderboards_temporary'', которая происходит из-за неуспеха ''parse_all_leaderboards'' (в этом случае ''parse_all_leaderboards'' желательно повторить)
*'''объект''' - объект, состояние которого меняем,
*'''состояние''' - состояние - значение нового состояния.

[[Файл:+.png]] '''индикатор награды за временные лидерборды''' - визуализация награды за временные лидерборды
*'''res1''' - счетчик - награда за лидерство в res1,
*'''res2''' - счетчик - награда за лидерство в res2,
*'''item''' - иконка предмета - награды за лидерство,
*'''item num''' - счетчик предмета - награды за лидерство.

[[Файл:+.png]] '''лидеры предыдущего этапа временных лидербордов''' - визуализация лидеров предыдущего этапа временных лидербордов (пъедестал)
*'''leaderboardsitem''' - объект типа leaderboardsitem.

[[Файл:+.png]] '''периодические лидерборды''' - добавляемые периодические лидерборды используются для разделения игроков по группам в соответствии с уровнем опыта из экономики
*'''имя''' - Периодический лидерборд в parse (название таблицы)
*'''min''' - Минимальный уровень экономики
*'''max''' - Максимальный уровень экономики

==Общие обработчики==

[[Файл:+.png]] '''запрос в парсе успешно выполнен (любой)''' - обработчик успеха любого запроса.
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

==Обработчики для мультиплеера==

[[Файл:+.png]] '''приглашение в мультиплеер''' - когда мы получили приглашение поиграть.
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

[[Файл:+.png]] '''подтверждение приглашения в мультиплеер''' - когда приняли наше приглашение поиграть.
*'''объект''' - объект, состояние которого меняем.
*'''состояние''' - новое состояние для объекта из предыдущего поля.

=Особенности использования=

Для пользователей, которые не логиняться в социальные сети и соответственно не сохраняют в игре свои имя и аватарку, существует система присвоения дефолтных имен и иконок. Это происходит при вызове ''parse_load''. В этом случае человек попадает в таблицы лидербордов (ранее игроки без имени и без иконки отфильтровывались).

=Состояния=

*'''0 - local_device_synchronization''' - синхронизация параметров между приложениями одного устройства;

*'''1 - parse_resolve''' - ресолвим конфликт и ждем подтверждения;

*'''2 - parse_idle''' - состояние простоя, означает, что мы не ждем ответа ни на один запрос;

*'''3 - parse_load''' - загрузить опции из парса (вызываться должно снаружи, после ввода имени) ;

*'''4 - parse_save''' - сохранить опции в парс c учетом предохранительной задержки SAVE_DELAY_SEC (на 2014-09-17 вызывается из единственного места - GOptions::save);

*'''5 - parse_leaderboards''' - загрузить лидерборды из парса и сложить в соответствующую таблицу;

*'''6 - parse_leaderboards_friends''' - загрузить лидерборды из парса и сложить в соответствующую таблицу;

*'''7 - parse_submit''' - заслать очки в парс взяв очки из поля score и уровень из поля level;

*'''8 - parse_apply''' - применить скачанные опции;

*'''9 - parse_get_public_lb''' - скопировать паблик данные кликнутого юзера из лидербордов в доступную область;

*'''10 - parse_poll''' - получить данные о текущем опроснике от клауда. Заполнить таблицу ответов;

*'''11 - parse_poll_prev''' - получить данные о предыдущем опроснике от клауда. Заполнить таблицу ответов №2;

*'''12 - parse_vote''' - проголосовать в текущем опроснике (номер ответа возьмем из таблицы) TODO - не нужно ли состояний против и за?;

*'''13 - parse_share_poll''' - зашарить результаты текущего опроса;

*'''14 - parse_forced_save''' - сохранить опции в парс незамедлительно (на 2014-09-17 вызывается из единственного места - GOptions::save);

*'''15 - parse_apply_server''' - применить опции и отправить ресолв;

*'''16 - parse_clear_notifications''' - отписаться от уведомлений;

*'''17 - parse_add_notification''' - добавить уведомление (не требует действий с сетью, реальная отправка - по потере фокуса);

*'''18 - parse_time''' - запросить время;

*'''19 - parse_friends''' - заполнить таблицу всех друзей (новые подарки);

*'''20 - parse_isolate''' - отказаться от слияния аккаунтов;

*'''21 - parse_un_isolate''' - отменить изоляцию;

*'''22 - parse_cancel_apply''' - отменить синхронизацию и разрешить сейвы;

*'''23 - scroll_friends_to_lb''' - проскролить таблицу друзей на юзера кликнутого в таблице лидербордов;

*'''24 - '''номер зарезервирован

*'''25 - '''номер зарезервирован

*'''26 - '''номер зарезервирован

*'''27 - parse_flush_notifications''' - принудительно зафлушить нотификейшены, если мы этого не делали ранее;

*'''28 - parse_all_leaderboards''' - получение информации по всем лидербордам, возможное обнуление текущих очков.

*'''29 - parse_submit_temporary''' - сабмит очков в temporary лидерборд;

*'''30 - parse_leaderboards_temporary''' - получение таблицы temporary лидерборда;

*'''31 - parse_leaderboards_temporary_prev''' - получение таблицы результатов предыдущего периода в temporary лидерборде;

*'''32 - parse_leaderboards_claim''' - начисление награды по кнопке получения награды в шаблоне лидерборда за предыдущий период в temporary лидерборде;

*'''33 - parse_leaderboards_animation''' - старт анимации перемещения ячеек таблицы в temporary лидерборде;

*'''34 - parse_friend_request_param''' - приглашение дружить, в param указать object_id;

*'''35 - parse_friend_request_lb''' - приглашение дружить по кнопке пригласить в друзья из шаблона лидербордов;

*'''36 - parse_friend_confirm''' - подтверждение дружбы из окна ''parse запросы дружбы'';

*'''37 - parse_friend_cancel''' - отмена дружбы из окна ''parse запросы дружбы'';

*'''38 - parse_friend_confirm_table''' - подтверждение дружбы из таблицы инвайтов ''parse запросы дружбы'';

*'''39 - parse_friend_cancel_table''' - отмена дружбы из таблицы инвайтов ''parse запросы дружбы'';

*'''40 - parse_friend_request_public''' - запрос дружбы из окна Инфо (parse_get_public_lb), проверять параметр ''selected_public.cloud_is_friend'' у объекта cloud: 0 - я сам, 1 - не друг, 2 - друг (для показа-прятания кнопок);

*'''41 - parse_friend_delete_public''' - запрос на отмену дружбы из окна Инфо (parse_get_public_lb), проверять параметр ''selected_public.cloud_is_friend'' у объекта cloud: 0 - я сам, 1 - не друг, 2 - друг (для показа-прятания кнопок);

*'''42 - parse_friend_check_requests''' - проверить входящие запросы (инвайты, подарки...);

*'''43 - parse_leaderboards_friends_param''' - показать лидерборд по друзьям, предварительно изменив контролы для отображения таблицы лидербордов и т.п.;

*'''44 - parse_get_public_fr''' - скопировать паблик данные кликнутого юзера из таблицы парсовых друзей из лидербордов в доступную область;

*'''45 - parse_scroll_temporary_on_me''' - промотка таблицы периодических лидербордов на ячейку с моим результатом до указателя (если он задан);

*'''46 - parse_bots_info''' - получить информацию о ботах отдельно от периодических лидербордов.

*'''47 - get_country''' - получить страну

*'''48 - parse_scroll_default_on_me''' - промотать таблицу default на меня

*'''49 - parse_info''' - получить инфо о пользователе взяв objectId из param

*'''50 - parse_invitable''' - заполнить таблицу приглашаемых друзей

=Сообщения в лог=

Объект пишет в опции строки:
I/GCloud GCloud::state() state val = 2 state = 3

Где val = 2 - это состояние в которое хотим перейти в дальнейшем ( в зависимости от текущего состояния, или станет в очередь или выполниться следующим тиком), state = 3 - это состояние в котором сейчас находиться объект.

==Коды ошибок:==

*'''6''' - опрос закончился;
*'''7''' - ошибка версионности;
*'''1000''' - отсутсвие интернета.
В прочих случаях код ошибки будет '''2000 + номер состояния''', т.е. для лоада, например ошибка будет 2000 + 3 = 2003

Дополнительно клауд будет отправлять коды ошибок по таймауту ( превышению времени ответа - сейчас равен 60 сек):
'''4000 + номер состояния''', т.е. для запроса лидербордов, например ошибка будет 4000 + 5 = 4005 ( глобальные) или 4000 + 6 = 4006 (друзья)

Для обработки ошибок использовать [[Errormanager|ErrorManager]].

[[Category:Options|*]]

Economics

2018-02-06T13:34:06Z

Bmor: /* Состояния */

[[Object|Объект]] '''Economics''' служит для реализации сложной игровой механики типа "ферма". Он осуществляет связь между игровыми локациями, накопленным опытом, текущим количеством энергии, денег и кристаллов (можно использовать и другие названия ресурсов), а также управляет объектами коллекций, магазина, инвентаря и игровых заданий.

= Свойства =

*'''предметы''' - Объект типа [[eitems]].
*'''задачи''' - Объект типа [[taskorganizer]].

==Параметры==
===Основные параметры===
*'''disable''' - выключена ли экономика, если 1 - то экономика не реагирует на состояния и не сейвится в опции. Чтобы изменить параметр, меняем его и вызываем сост. "init"
*'''Сдвиг уровней''' ( ''levels_shift'' ) - число на которое сдвинется анлок уровней в economics setup; после задания параметра нужно проинитить экономику;
*'''Уровни''' - опыт, необходимый для перехода на следующий уровень. Последовательность чисел через запятую.
*'''Уровни парабола''' - Три числа через запятую, задающие коэффициенты параболы, которые определяют необходимый опыт после уже перечисленных уровней.
*'''Энергия''' - максимум энергии на каждом из уровней. Последовательность чисел через запятую. Последнее значение будет зациклено для всех последующих уровней.
*'''Энергия прибавка''' - Число определяющее прибавку к максимуму энергии после уже перечисленных уровней.
*'''Ресурс 1''' - количество ресурса 1 добавляемое за уровень. Последовательность чисел через запятую. Последнее значение будет зациклено для всех последующих уровней.
*'''Ресурс 2''' - количество ресурса 2 добавляемое за уровень. Последовательность чисел через запятую. Последнее значение будет зациклено для всех последующих уровней.
*'''Перезарядка''' - время за которое восстанавливается единица энергии в ms.
*'''нач. ресурс 1''' - Начальное значение ресурса 1.
*'''нач. ресурс 2''' - Начальное значение ресурса 2.
*'''время напоминания''' - время напоминания о задачах на каждом из уровней. Записывается в виде последовательности чисел через запятую. Последнее значение будет зациклено для всех последующих уровней. Время изменяется в часах.
*'''напоминание об энергии''' - уведомление перетаскивается с текстового редактора, представляет собой напоминание о том что энергия восстановилась. Например, "Ваше энергия полностью восстановлена".
*'''опции для facebook''' - поле в опциях, куда мы будем записывать 32 битное целое: Уровень + Коллекции.ESocial добавит к ним число друзей и засабмит при вызове соотв. состояние
*'''перегрузить очки из опций''' - если поле не пустое - будут взяты очки из поля опций текущего пользователя, указаного в этой строке.
*'''во временные отправлять''' - какие очки будут отправлены во временные лидерборды esocial'ом. При выборе '''кастомное заполнение''' будут отправлены очки из поля temporary_lb_score в опциях текущего пользователя (p0.temporary_lb_score например). Кастомные очки нужно добавлять вручную, по окончанию периода они будут обнулены автоматически.

===Основные счетчики===
Этот раздел содержит необходимые объекты для подсчета (counter, timer, progressbar).

*'''Уровень''' - счетчик текущего уровня игрока.
*'''Прогресс в уровне (счетчик)''' - Набранный на этом уровне опыт и остаток до следующего уровня (счетчик).
*'''Прогресс в уровне (бар)''' - Набранный на этом уровне опыт и остаток до следующего уровня (прогрессбар).
*'''Опыта до уровня''' - счетчик показывающий сколько опыта необходимо для перехода с текущего уровня на следующий.
*'''Текущая энергия''' - прогрессбар текущей энергии.
*'''Максимальная энергия''' - счетчик, который отображает значение максимальной энергии.
*'''Таймер энергии''' - таймер отображающий время до восстановления единицы энергии.
*'''Таймер всей энергии''' - таймер, который отображает время до восстановления всей энергии.
*'''Ресурс 1''' - счетчик первого ресурса (денег).
*'''Ресурс 2''' - счетчик второго ресурса (кристаллов).
*'''анимация рес.1''' - Анимационный объект награды в ресурсе 1. Должен иметь состояние show.
*'''анимация рес.2''' - Анимационный объект награды в ресурсе 2. Должен иметь состояние show.
*'''анимация опыт''' - Анимационный объект награды в опыте. Должен иметь состояние show.

===Окно перед локацией===
Настройка окна, которое всплывает перед посещением локации. В этом окне отображается информация о локации которую мы хотим посетить.

*'''Окно''' - некая машина, олицетворяющая собой само окно превью. Должна иметь состояния ''open'' - открыта, ''open_lvl'' - не хватает лвл, ''open_buy'' - разница в уровнях позволяет нам купить анлок, ''open_item'' - не хватает предмета для анлока, ''open_unlock'' - состояние вызываемое окну перед локацией после успешной покупки предмета для анлока, ''open_energy'' - состояние вызываемое окну перед локацией в случае нехватки энергии.
*'''Превью локации''' - графический ресурс для отображения превью локации. В это поле можно поставить любую картинку для того, чтобы корректно разместить ее в "окне перед локацией". Далее экономикс сам будет подставлять нужные превью.
*'''Название локации''' - текстовый объект, в который будет подставляться название локации.
*'''Описание локации''' - текстовый объект, в который будет подставляться описание локации.
*'''Уровень мастерства''' - счетчик уровня мастерства.
*'''Прогрессбар уровня мастерства''' - прогрессбар, который отображает уровень мастерства.
*'''Текущий уровень''' - счетчик текущего уровня мастерства.
*'''Необходимая энергия''' - счетчик необходимой энергии.
*'''Аномальная энергия''' - счетчик, который отображает дополнительную энергию при наличии аномалии в локации.
*'''Призовой ресурс 1''' - счетчик призовых денег.
*'''Аномальный ресурс 1''' - счетчик, который отображает количество дополнительных призовых денег, которые даются за игру в локацию с наличием аномалии.
*'''Призовой ресурс 2''' - счетчик призовых кристаллов.
*'''Призовой опыт''' - счетчик призового опыта.
*'''Аномальный опыт''' - счетчик, который отображает значение дополнительного опыта, который дается за игру в локацию с наличием аномалии.
*'''Таблица коллекции''' - таблица, в которой будут отображаться предметы, которые можно найти в данной локации.

''для закрытой по уровню локации''
*'''Режим игры''' - машина, которой будут устанавливаться состояния в зависимости от режима игры (может быть смешанный, текст или силуэт). TODO пока обладает только режимом text и icon. Эта машина будет передавать настройки таблице, в которую помещаются поисковые объекты, поэтому важно, чтобы к этой таблице был доступ (например она может находится на глобальном экране).

*'''индикатор уровня''' - счетчик с необходимым для локации уровнем.

''для локации c ценой''

*'''цена ресурс 1''' - Стоимость анлока локации в ресурсе 1.
*'''цена ресурс 2''' - Стоимость анлока локации в ресурсе 2.

''для локации c требуемым предметом''

*'''предмет''' - иконка необходимого для локации предмета.
*'''название предмета''' - в этом поле указывается название, необходимого для локации предмета.
*'''счетчик цены''' - счетчик, который отображает стоимость предмета.
*'''иконка цены''' - иконка цены предмета, представляет собой картинку, которая перетаскивается из базы ресурсов.
*'''кнопка купить''' - Будет видна, если предмет нужно купить. Передает экономиксу состояние unlock_item.
*'''кнопка искать''' - Будет видна, если предмет поисковый.
*'''блок аномалии''' - контейнер, представляющий собой машину, которая содержит всю информацию про аномалию. Должна содержать в себе состояния hide, show и remov (состояние после прогона аномалии, чтобы сделать красивые эффекты, после которого машина попадет в состояние hide).
*'''иконка аномалии''' - иконка аномалии.
*'''название аномалии''' - текстовый объект, который будет отображать название аномалии.
*'''описание аномалии''' - текстовый объект, который будет отображать описание аномалии.
*'''иконка предмета''' - иконка предмета, необходимого для того что бы прогнать аномалию.
*'''кнопка прогнать предметом''' - кнопка по нажатию которой, можно прогнать аномалию используя предмет.
*'''кнопка купить предмет''' - кнопка по нажатию которой, можно купить предмет для прогона аномалии.
*'''кнопка прогнать миниигрой''' - кнопка по нажатию которой, можно прогнать аномалию мини игрой.
*'''корневой объект''' - некая машина, олицетворяющая собой блок перехода в связанную локацию. Должно иметь состояния enable и disable.
*'''таблица артефактов''' - в таблицу будут сложены предметы, необходимы для переключения локации.
*'''галочка в таблице''' - графический ресурс поверх найденных предметов.
*'''иконка ключа''' - сюда сложим иконку предмета необходимого для переключения на альтернативную локацию.

===Окно после локации===

Настройка окна, которое всплывает после посещения локации. В этом окне отображается информация о полученных очках и предметах за исследование локации.

*'''Окно''' - некая машина, олицетворяющая собой само окно превью. Должна иметь состояние ''open''.
*'''Название локации''' - текстовый объект, в который будет подставляться название локации.
*'''Описание локации''' - текстовый объект, в который будет подставляться описание локации.
*'''Уровень мастерства''' - счетчик уровня мастерства.
*'''Прогрессбар мастерства''' - прогрессбар, который отображает уровень мастерства.
*'''Текущий уровень''' - счетчик текущего уровня мастерства.
*'''Призовой ресурс 1''' - счетчик призовых денег.
*'''Аномальный ресурс 1''' - счетчик, который отображает количество дополнительных денег за прохождение локации с аномалией.
*'''Призовой ресурс 2''' - счетчик призовых кристаллов.
*'''Призовой опыт''' - счетчик призового опыта.
*'''Аномальный опыт''' - счетчик, отображающий дополнительный призовой опыт, который дается за прохождение локации с аномалией.
*'''Таблица коллекции''' - таблица, в которой будут отображаться предметы, которые можно найти в данной локации.
*'''ничего не найдено''' - Любой объект, так или иначе сообщающий игроку, что он не нашел ничего ценного.

===Окно перед монстром===
*'''окно''' - некая машина, олицетворяющая собой само окно превью. Должна иметь состояние open - все условия выполнены, open_energy - не хватает энергии для игры, но предмет для прогона есть, open_item - есть энергия, но не хватает предмета для прогона, open_item_energy - не хватает энергии для игры и нет предмета для прогона.
*'''превью монстра ''' - картинка, отображающая превью монстра.
*'''название монстра''' - текстовый объект, показывающий название монстра.
*'''описание монстра''' - текстовый объект, показывающий описание монстра.
*'''необходимая энергия''' - счетчик, отображающий количество необходимой энергии.
*'''призовой ресурс 1''' - счетчик, отображающий количество призовых денег.
*'''призовой опыт''' - счетчик, отображающий количество призового опыта.
*'''таблица коллекции''' - таблица, в которой будут отображаться предметы, которые можно отжать у данного монстра.
*'''иконка предмета''' - картинка, которая отображает предмет необходимый для игры с монстром.
*'''нужно предметов''' - счетчик, который отображает необходимое количество предметов.
*'''есть предметов''' - счетчик, который отображает текущее количество предметов, находящееся в наличии.
*'''суммарная стоимость''' - счетчик, который отображает суммарную стоимость недостающих предметов.
*'''кнопка купить''' - кнопка, по нажатию которой, происходит покупка недостающих предметов.
*'''кнопка прогнать''' - кнопка, по нажатию которой, можно прогнать монстра не играя в игру, эту кнопку можно не задавать.

===Окно после монстра===

*'''окно''' - некая машина, олицетворяющая собой само окно превью. Должна иметь состояние open.
*'''превью монстра''' - картинка, отображающая превью монстра.
*'''название монстра''' - текстовый объект, показывающий название монстра.
*'''описание монстра''' - текстовый объект, показывающий описание монстра.
*'''призовой ресурс 1''' - счетчик, отображающий количество призовых денег.
*'''призовой опыт''' - счетчик, отображающий количество призового опыта.
*'''таблица коллекции''' - таблица, в которой будут отображаться предметы, которые можно отжать у данного монстра.
*'''ничего не найдено''' - любой объект, сообщающий игроку, так или иначе, что он не нашел ничего ценного на данной локации.

===Окно коллекций===

*'''Шаблон коллекции''' - ссылка на объект типа ecollection который будет использоваться в качестве исходного для всех коллекций.
*'''Таблица''' - таблица, куда по ссылке будут добавлены шаблоны коллекции.
*'''алерт''' - некая машина, олицетворяющая собой само окно предмета. Должна иметь состояние open. Окно с информацией о предмете всплывает в окне с коллекциями.
*'''иконка''' - Иконка предмета.
*'''текст (объект)''' - Текстовый объект в окошке.
*'''описание (объект)''' - Текстовый объект в окошке, в который сложим описание предмета.
*'''имя коллекции (объект)''' - В это поле будет записано имя коллекции, к которой относится предмет.
*'''цифры''' - фреймовая анимация содержащая в себе цифры. Последний фрейм анимации - отметка много.

===Окошко коллекционного предмета===

*'''окно''' - Некая машина, олицетворяющая собой само окно предмета. Должна иметь состояние open. Окошко всплывает при клике на предмет в таблице окна перед/после локации.
*'''иконка''' - Иконка предмета.
*'''текст (объект)''' - Текстовый объект в окошке.
*'''описание (объект)''' - Текстовый объект в окошке, в который сложим описание предмета.
*'''имя коллекции (объект)''' - В это поле будет записано имя коллекции, к которой относится предмет.

===Окошко поздравления со сдачей коллекции===

*'''окно''' - некая машина,содержащая необходимую информацию, олицетворяющая само окно предмета. Должна иметь в себе состояние open.
*'''иконка''' - картинка отображающая иконку предмета-награды ( в параметр reward_text_id - запишется текстовый ID итогового предмета из текстовой базы);
*'''текст(объект)''' - текстовый объект, отображающий название коллекции.
*'''призовой ресурс 1''' - счетчик, отображающий количество призовых денег.
*'''призовой опыт''' - счетчик, отображающий количество призовых денег.

===Окошко инвентарного предмета===

*'''окно''' - Некая машина, олицетворяющая собой само окно предмета. Должна иметь состояние open. Окошко всплывает при клике на предмет в таблице окна перед/после локации.
*'''иконка''' - Иконка предмета.
*'''текст (объект)''' - Текстовый объект в окошке.
*'''описание (объект)''' - Текстовый объект в окошке, в который сложим описание предмета.

===Окошко поздравления с получением уровня===

*'''окно''' - некая машина, содержащая необходимую информацию, олицетворяющая собой само окно предмета. Должна иметь состояние open.
*'''уровень''' - счетчик, отображающий номер полученного уровня.
*'''энергия''' - счетчик, отображающий количество энергии, которая прибавляется к максимуму.
*'''ресурс 1''' - счетчик, отображающий количество денег.
*'''ресурс 2''' - счетчик, отображающий количество кристаллов.

===Окошко поздравления с получением уровня и открытием локации===

*'''окно''' - некая машина, содержащая необходимую информацию, олицетворяющая собой само поздравительное окошко. Должна иметь состояние open.

*'''уровень''' - счетчик, отображающий номер полученного уровня.

*'''энергия''' - счетчик, отображающий количество энергии, которая прибавляется к максимуму.

*'''ресурс 1''' - счетчик, отображающий количество денег.

*'''ресурс 2''' - счетчик, отображающий количество кристаллов.

*'''иконка локации''' - картинка, отображающая иконку локации, которая стала доступна

*'''описание локации''' - текстовый объект, который отображает описание локации, которая стала доступна.

===Окошко получения уровня на локации===

*'''окно''' - некая машина, содержащая необходимую информацию, олицетворяющая собой само поздравительное окошко. Должна иметь состояние open.
*'''спецпредмет''' - объект, в который положится иконка коллекционного предмета, полученного за достижение очередного уровня мастерства на локации (настройки предмета в уровнях мастерства).
*'''опции''' - поле в опциях, в которое записывается уровень по локации.

===Окошко, когда не хватает чарджера (общее) ===

*'''окно''' - некая машина, содержащая необходимую информацию, олицетворяющая собой само уведомительное окошко. Должна иметь состояние open.
*'''иконка''' - картинка, отображающая иконку предмета, который игрок получит за сдачу коллекции.
*'''текст''' - текстовый объект, который будет отображать описание коллекции.
*'''суммарная цена ресурса 1''' - счетчик, отображающий суммарную цену всех необходимых чарджеров, представлена в виде ресурса 1 (деньги).
*'''суммарная цена ресурса 2''' - счетчик, отображающий суммарную цену всех необходимых чарджеров, представлена в виде ресурса 2 (кристаллы).
*'''кнопка купить все''' - кнопка, по нажатию которой, происходит покупка необходимых предметов. Если в кнопке есть необходимость она будет появляться, в противном случае - сама исчезать.

===Окошко, которое выезжает когда найден коллекционный предмет ===

*'''окно''' - некая машина, содержащая необходимую информацию, олицетворяет собой само поздравительное окошко. Должна иметь состояние show.
*'''текст''' - текстовый объект, который используется для отображения названия коллекции.
*'''таблица''' - таблица, в которую складываются объекты коллекции.

===Окошко покупки артефакта===

Кратко об артефактах. Артефакты это инвентарные предметы, которые можно найти либо купить. Они необходимы для того, чтобы была возможность играть в связанную локацию. Связанная локация - локация, которая имеет свой уникальный порядковый номер в списке локаций, но тем не менее логически привязана к локации с другим порядковым номером. Когда все артефакты, необходимые для игры в связанную локацию собраны, то при вызове состояния ''location'' объекту economics локация выбирается случайным образом между оригинальной и связанной. При этом есть возможность сменить локацию (ротация между оригинальной и связанной локацией) вызвав состояние ''location_switch''. Чтобы сменить локацию нужен предмет, который перетаскивается в поле "предмет переключения" настроек локации.

*'''окно''' - Некая машина, олицетворяющая собой само окошко покупки. Должна иметь состояние show
*'''таблица''' - Таблица должна иметь две строки и заполнение по столбцам. В верхнюю попадут иконки артефактов, в нижнюю - кнопки купить
*'''кнопка 1''' - Купить артефакт. Должна в param2 - номер артефекта и вызывать состояние экономике buy_artefact
*'''кнопка 2''' - Купить артефакт. Должна в param2 - номер артефекта и вызывать состояние экономике buy_artefact
*'''кнопка 3''' - Купить артефакт. Должна в param2 - номер артефекта и вызывать состояние экономике buy_artefact
*'''кнопка 4''' - Купить артефакт. Должна в param2 - номер артефекта и вызывать состояние экономике buy_artefact

===Дополнительные достижения ===

В этом разделе указаны некоторые достижение, которые отправляются объектом economics в gamecenter.

*'''достижение на трату ресурса 1''' - id достижения, отправляемого за трату ресурса 1 (когда игрок потратит сумму ресурса из следующего поля отправляется достижение 100%).
*'''количество ресурса 1''' - сумма ресурса 1, которую необходимо потратить для получения достижения.
*'''достижение на трату ресурса 2''' - id достижения, отправляемого за трату ресурса 2 (когда игрок потратит сумму ресурса из следующего поля отправляется достижение 100%).
*'''количество ресурса 2''' - сумма ресурса 2, которую необходимо потратить для получения достижения.
*'''достижение на число открытых локаций''' - id достижения, отправляемого за открытия количества локаций из следующего поля (при открытии нужного количества локаций отправляется 100% достижения).
*'''количество локаций''' - кол-во локаций, которое необходимо открыть для получения достижения.
*'''достижение за покупки чего-либо''' - id достижения, отправляемого за совершенное количество покупок из следующего поля (при покупке нужного количества отправляется 100% достижения).
*'''количество покупок''' - количество покупок, которое необходимо свершить для получения достижения.

===Покупка рандомного предмета===

При вызове объекту economics состояния ''buy_random_col'' покупается случайный коллекционный предмет. Визуализацией покупки служит выпадающий на сцену объект из вкладки настроек "Летающий объект"

*'''res1''' - цена предмета в ресурсе 1.
*'''исключения''' - id предметов, которые не попадут в случайный выбор. Перетаскиваются из текстовой базы.
*'''каунтер''' - объект типа counter в который сложится цена предмета.

=== Статус ===
Статус - дополнительный экономический параметр игрока, который зависит от внутриигровых действий. Статус определяется кол-вом статусных очков, которые начисляются за совершение in-app покупки и при достижении нового уровня (exp).

Тесно связан с [[Wallet|Wallet]].

*'''очки для повышения''' - массив чисел, указываем через запятую. Обозначает нужное кол-во очков статуса для перехода на следующий уровень. Пример: 0, 150, 3850. Изначальный уровень уже получен при инициализации экономики. Для перехода на следующий (2-й) нужно получить 150 очков. На 3-й - 3850 и т.д.
*'''множитель статуса при покупке''' - массив чисел, указываем через запятую. Обозначает коэф., на который домножим базовое значение статусных очков при покупке. Зависит от текущего статуса. Пример: 1,2,3. Базовое значение за покупку - 18 очков статуса. При совершении покупки, имея 1-й статус - получаем 18 очков. Имея второй статус - 36, третий - 54.
*'''множитель монет при покупке''' - Аналогично предыдущему пункту.
*'''прибавка за уровень''' - массив чисел, указываем через запятую. Показывает сколько статусных очков будет получено при достижении уровня exp, учитывая текущий статус.
*'''множитель дейли-бонуса''' - массив чисел, указываем через запятую. Множитель, который можно использовать при начислении ежедневного бонуса. Зависит только от текущего статуса.

'''Поля в опциях'''
* ecomics%d.stlev - текущий уровень статуса (начиная с 0!)
* ecomics%d.stpoints - поинты внутри текущего уровня
* comics%d.stdaily - множитель для дейли бонуса
* ecomics%d.stmult - множитель для монеток

=== Настройки симуляции ===

*'''время''' - время симуляции, измеряется в секундах.

*'''минимум в локации''' - нижняя граница диапазона времени проводимого игроком в хиддене. Отображается в виде доли от времени из настроек локации.

*'''максимум в локации''' - верхняя граница диапазона времени проводимого игроком в хиддене. Отображается в виде доли от времени из настроек локации.
*'''порог покупки''' - число, указывающее какую долю, от ресурсов игрока, должна составлять цена локации, что бы он решился её купить.
*'''порог покупки предмета''' - число, указывающее какую долю,от ресурсов игрока, должна составлять цена предмета, что бы он решился его купить.
*'''вероятность задачи''' - число, отображающее вероятность того, что симуляция будет выбирать не из всех доступных локаций, а из связанных с заданиями.
*'''вероятность матча''' - число, отображающее вероятность того, что симуляция будет играть в матч.
*'''изначально хинтов''' - изначальное количество хинтов.
*'''предметов на хинт''' - на сколько найденных предметов игрок израсходует хинт.
*'''цена хинта монеты''' - сколько монет (ресурс 1), стоит некий усредненный хинт.
*'''цена хинта кристаллы''' - сколько кристаллов (ресурс 2), стоит некий усредненный хинт.
*'''хидденов подряд''' - игрок будет пытаться пройти не менее данного числа хидденов подряд.
*'''восстановить энергии''' - некое усредненное количество энергии для восстановления.
*'''цена энергии монеты''' - сколько монет стоит энергия (цена в ресурсе 1).
*'''цена энергии кристаллы''' - сколько кристаллов стоит энергия (цена в ресурсе 2).
*'''вероятность победы в матче'' - число, отображающее вероятность победы в матче.
*'''время в матче''' - условное время пребывания в матче.
*'''вероятность покупки за реал''' - каждый раз когда игроку не хватает денег или кристаллов - проверяем эту вероятность.
*'''цена монеты в деньгах''' - цена монеты в деньгах.
*'''количество монет в покупке''' - количество монет в покупке.
*'''цена кристаллов в деньгах''' - цена кристаллов деньгах.
*'''количество кристаллов в покупке''' - количество кристаллов в покупке.

=== Настройки равномерной экономики ===

Нужно в случае, если мы хотим давать за локации и монстров одинаковую награду (опыт, затрата энергии, вне зависимости от настроек в economics_setup). Награда может отличаться только для монстров (если в economics_setup мы укажем монстру в поле награда опыт - 0, то экономика начислять опыт не будет).

*'''локация энергия''' - стоимость энергии на игру хидн или монстр;
*'''локация опыт''' - награда за успешное прохождение локации/монстра ( при условии что для монстра в поле награды не стоит 0 );
*'''коллекция опыт min''' - минимальный опыт за успешную сдачу коллекции;
*'''коллекция опыт max''' - максимальный опыт за успешную сдачу коллекции;
*'''коллекция монеты min''' - минимальная награда за успешную сдачу коллекции;
*'''коллекция монеты max''' - максимальная награда за успешную сдачу коллекции;

==Поле economics setup==
По клику на "..." открывается редактор экономикса. В этом редакторе можно задать все настройки локациям и коллекциям, которые используются в игре.

[[Файл:Economics 1.jpg|500px]]

Economics setup содержит 11 вкладок : локация хидден, коллекция, предметы, окошко когда не хватает чарджера (чарджер), нехватка ресурсов на чарджер, монстр, летающий объект, аномалия, сдача коллекции, временный эффект, достижение.
Вверху можно увидеть ряд кнопок для добавления и удаления: справа для локаций, слева для уровней мастерства.

===Локация хидден===

Форма редактора экономикса разделена на 4 колонки. В первой колонке мы видим список локаций, используемых в игре. Имена локаций можно изменять. Добавляются новые локации по нажатию на кнопку ''Добавить локацию'', удаляются кнопкой ''Удалить локацию''. Во второй колонке отображаются свойства выделенной локации.

[[Файл:Economics 2.jpg|right]]
*'''Объект на карте''' - это объект ведущий в локацию с карты. Должен иметь как минимум состояния open и closed, которые ему будет вызывать экономикс.
*'''индиктор уровня''' - каунтер, который будет отображать номер уровня, начиная с которого локация доступна.
*'''Экран''' - экран, в котором расположен локация.
*'''Превью локации''' - графический ресурс для отображения превью локации из базы ресурсов.
*'''Имя локации''' - название локации, перетаскивается из текстовой базы.
*'''Описание локации''' - описание, перетаскивается из текстовой базы.
*'''Уровень''' - уровень требуемый для того, чтобы играть в локацию.
*'''Результат''' - имя поля в опциях, куда локацией будет занесен результат. Расчитываем найти там число.
*'''Связанный хидден лист''' - хидден-лист, связанный с локацией.
*'''необходимый предмет''' - предмет необходимый для входа в локацию. Может быть как коллекционным, так и инвентарным.
*'''разница в уровнях''' - разница в уровнях, при которой можно купить доступ в локацию.
*'''цена ресурс 1''' - если наш уровень ниже необходимого на разницу из верхнего поля, мы можем разлочить локацию за деньги.
*'''цена ресурс 2''' - если наш уровень ниже необходимого на разницу из верхнего поля, мы можем разлочить локацию за кристаллы.
*'''достижение''' - достижение, которое будет открываться по мере игры в эту локацию.
*'''процент''' - проценты достижения из предыдущего поля.
*'''объект для музыки''' ('''musObj''') - объект которому в поле "location_music" будет записан id музыки из поля "музыка", при запуске локации;
*'''музыка''' ('''musId''') - id музыки локации;

В третей колонке записываются уровни мастерства. Их можно переименовать. Добавляются кнопкой ''Добавить уровень мастерства''. Удаляются кнопкой ''Удалить уровень мастерства''. В четвертой колонке настраивается выделенный уровень мастерства.

[[Файл:Economics 3.jpg|right]]
*'''энергия''' - энергия требуемая для того, чтобы играть в локацию.
*'''ресурс 1''' - деньги даваемые за прохождение локации.
*'''ресурс 2''' - кристаллы даваемые за прохождение локации.
*'''опыт''' - опыт даваемый за прохождение локации.
*'''кол-во объектов''' - максимальное количество доступных для поиска объектов в одной игровой сессии.
*'''время игры''' - общее время игры (если -1, то игнорируется).
*'''время игры (блиц)''' - время игры с аномалией "блиц".
*'''время игры (аном)''' - время игры с остальными аномалиями.
*'''режим игры''' - режим игры: 0 - случайный, 1- слова, 2 - силуэты, 3 - поиск отличий;
*'''использовать различия''' - да - будут генирироватся режим поиска отличий, нет - не будут; Для корректной работы, следующей за сценой с хидн предметами, должна находиться пустая сцена с такими же параметрами как и у сцены с хидн предметами. Также между двумя сценами ( хидн и fake-сценой) должна быть связь по тасканию;
*'''аномалия''' - вероятность возникновения аномалии в локациях.
*'''доступные аномалии''' - перечень доступных на данном уровне мастерства аномалий. Записываются в виде чисел через запятую. Доступные значения 0, 1, 2, 3.
*'''множитель''' - коэффициент, на который умножаются набранные очки. при расчете перехода на следующий уровень. Может быть меньше 1.
*'''постоянный прирост''' - постоянный прирост, если он больше 0, то будет использоваться ВМЕСТО реально набранных в хиддене очков и множителя.
*'''очки''' - очки, которые нужно набрать для перехода на следующий уровень мастерства. Набранные в локции очки умножаются на множитель и суммируются. Когда превысят это значение - произойдет переход.
*'''Предметы''' - id коллекционных предметов, которые можно найти на локации. Не обязаны принадлежать к одной коллекции. Перетаскиваются из текстового редактора. Будет использоваться их иконка.
*'''Вероятность''' - вероятность найти один из коллекционных предметов из предыдущего поля.
*'''Вероятность 2''' - вероятность найти один из коллекционных предметов из предыдущего поля.
*'''Вероятность 3''' - вероятность найти один из коллекционных предметов из предыдущего поля.
*'''Инвентарь''' - id инвентарных предметов, которые можно найти на локации. Перетаскиваются из текстового редактора.
*'''Вероятность инв.''' - вероятность найти один из инвентарных предметов из предыдущего поля.
*'''Вероятность инв. 2''' - вероятность найти один из инвентарных предметов из предыдущего поля.
*'''Вероятность инв. 3''' - вероятность найти один из инвентарных предметов из предыдущего поля.
*'''Коллекционный предмет''' - предмет из коллекций, который будет дан игроку по достижению этого уровня мастерства.

===Коллекция===

Во вкладке ''Коллекция'' используются только первые две колонки. В первой колонке отображаются добавленные коллекции. Добавляются кнопкой ''Добавить локацию''. Удаляются кнопкой ''Удалить локацию''. Коллекции можно переименовывать. Второй столбик содержит id предметов входящих в коллекции. Перетаскиваются из текстового редактора. Будет использоваться их иконка. Ресурс 1 и ресурс 2 - ресурсы, которые даются за сдачу коллекции. Опыт - опыт, который дается за сдачу коллекции.

*'''имя''' - Имя (а также - описание, если нужно) конкретно коллекции.
*'''предметы''' - id предметов входящих в коллекции. Перетаскиваются из текстового редактора. Будет использоваться их иконка.
*'''ресурс 1''' - деньги даваемые за сдачу коллекции.
*'''ресурс 2''' - кристаллы даваемые за сдачу коллекции.
*'''опыт''' - опыт даваемый за сдачу коллекции.
*'''награда''' - предмет даваемый за сдачу коллекции. Перетаскивается из текстовой базы.
*'''заряжатели''' - Предметы инвентаря, необходимые для сдачи коллекции. ВНИМАНИЕ: будут использоваться не более первых 4х элементов списка.
*'''достижение''' - достижение, которое будет открываться по мере сдачи этой коллекции.
*'''процент''' - проценты достижения из предыдущего поля.
*'''уровень для подарка''' - уровень, начиная с которого предметы этой коллекции можно дарить

===Предметы===

Раздел "Предметы" позволяет добавлять список инвентарных предметов, которые могут использоваться в процессе игры, предоставлять различные бонусы. В первой колонке список предметов. Добавляется кнопкой "Добавить локацию", удаляется кнопкой "Удалить локацию". Предметы могут быть переименованы. Во второй колонке записаны свойства каждого предмета.

[[Файл:Economics 4.jpg|350px|right]]

*'''nm''' - имя предмета

*'''section''' - категория предмета.

*'''use''' - если 1, то предмет может использоваться (кнопка Use видимая).

*'''nm''' - имя предмета (txtID).

*'''опции''' - если это поле задано, то в него будет записываться актуальное количество объектов.

*'''начальное количество''' - начальное количество предметов данного типа в инвентаре.

*'''можно продать''' - возможность продавать предмет: 1 - можно продать, 0 - нельзя продать.

*'''уникальный''' - если 1 - то предмет уникальный пропадает после покупки, если 0 - предмет после покупки не пропадает, если 3 - предмет покупается один раз, остальные разы только применяется

*'''res1''' - цена предмета в ресурсе 1.

*'''res2''' - цена предмета в ресурсе 2.

*'''sres1''' - продажа - цена предмета в ресурсе 1.

*'''sres2''' - продаже - цена предмета в ресурсе 2.

*'''en''' - восстанавливает энергии единовременно.

*'''tm''' - длительность действия в секундах. Если поставить "-1", то действие предмета будет вечным, отображаться в таблице амулетов он не будет.

*'''dTm''' - уменьшение времени восстановления энергии в %.

*'''dFnd''' - увеличение вероятности нахождения предмета в %.

*'''dExp''' - увеличение начисляемого опыта в %.

*'''dRes1''' - увеличение полученного ресурса 1 в %.

*'''dRes2''' - увеличение полученного ресурса 2 в %.

*'''dOvP''' - увеличение перегруженной вероятности нахождения предметов в %.

*'''dMaxEn''' - увеличение максимума энергии в %.

*'''dBonus1''' - накопительный монетный бонус (в случае, если предмет дает ежедневный денежный прирост). Суммируется (от всех предметов имеющих это поле отличное от 0) и записывается в поле total_amulet_bonus1 экономикса. Автоматически не начисляется.

*'''dBonus1''' - накопительный кристальный бонус (в случае, если предмет дает ежедневный денежный прирост). Суммируется (от всех предметов имеющих это поле отличное от 0) и записывается в поле total_amulet_bonus2 экономикса. Автоматически не начисляется.

*'''dPurchase''' - к каждой покупке предмета добавляется еще столько таких же предметов. Актуально в тех случаях, когда приобретение предмета активирует акцию 1+1.

*'''num''' - число предметов в сундуке. Выбираются случайно из следующего поля. При 0 - следующее поле не используется.

*'''items''' - предметы, которые можно найти в сундуке. Перетаскиваются из текстовой базы.

*'''use_id''' - задание этого поля говорит о том, что данный предмет является оптовым пучком для предмета указанного у этом поле. Num, в этом случае, - количество.

*'''объект''' - связанный объект, будет добавляться в инвентарь.

*'''достижение''' - достижение, которое будет открываться по мере применения подобный предметов.

*'''процент''' - процент достижения их предыдущего поля.

*'''владелец''' - на данный момент - номер правильной кнопки в окне угадайки (если -1. то игнорируется).

*'''монстр''' - номер монстра, в игре с которым нужно применить этот предмет. Актуально для задач на применение хинтов в мини играх.

*'''обработчик конца действия''' - объект, обработчик конца действия амулета.

*'''состояние обработчика''' - состояние обработчика конца действия амулета (объект из поля выше будет переведен в это состояние по окончанию действия амулета).

*'''дарить с уровня''' - уровень с которого возможно дарить этот предмет

*'''кнопка применить - поле в опциях''' ( '''btn_use_field''' ) - для применяемого предмета, указываем поле для проверки значения, если условие истинно - кнопка применить будет доступна; иначе - выключена ("disable");
*'''кнопка применить - значение''' ( '''btn_use_val''' ) - значение для проверки условия, в поле '''кнопка применить - поле в опциях''';
*'''кнопка применить - НЕ''' ( '''btn_use_not''' ) - от результата сравнения взять обратное;

====Создание предметов (крафт)====

В третьей колонке можно добавлять ингридиенты из которых состоит предмет. Ингридиенты сами по себе являются также инвентарными предметами. В четвертой колонке указывается текстовый id ингридиента и необходимое количество данного ингридиента.

===Окошко когда не хватает чарджера===
Позволяет добавлять окна. Окно добавляется кнопкой "Добавить локацию", окно можно переименовывать, удаляется кнопкой "Удалить локацию".

*'''название''' - текстовый объект в который вкладывается название чарджера.
*'''иконка''' - иконка чарджера.
*'''описание''' - текстовый объект в который вкладывается название чарджера.
*'''купить''' - кнопка покупка чарджера, передает economics состояние buy_charger.
*'''искать''' - кнопка поиска чарджера, передает economics состояние search_charger.
*'''есть''' - счетчик, который показывает сколько чарджеров есть сейчас.
*'''нужно''' - счетчик, который показывает сколько чарджерова необходимо для сдачи коллекции.
*'''цена ресурса 1''' - счетчик, который показывает цену чарджера в ресурсе 1.
*'''цена ресурса 2''' - счетчик, который показывает цену чарджера в ресурсе 2.
*'''достаточно''' - объект, который отображается вместо кнопки, в тот момент, когда чарджеров достаточное количество.

===Нехватка ресурсов на чарджер===
Позволяет изменить состояние выбранному объекту при нехватке ресурсов на чарджер. Добавляется кнопкой "Добавить локацию", можно переименовывать, удаляется кнопкой "Удалить локацию".

===Монстр===
В первой колонке добавляется монстр, добавляется кнопкой "Добавить локацию", если возможность переименовать, удаляется кнопкой "Удалить локацию"
Во второй колонке отображаются свойства выделенной колонки.

*'''Объект на карте''' - объект, который представляет монстра на карте. Как правило окно, которое должно иметь состояние hide (скрыт),show и disappear (прогнали).
*'''Имя монстра''' - текстовый id из которого берется иконка, имя и описание монстра.
*'''Экран''' - экран в котором расположена локация.
*'''min уровень''' - уровень, при достижении которого, появляется монстр.
*'''max уровень''' - уровень, при достижении которого, монстр исчезает.
*'''необходимый предмет''' - предмет необходимый для игры с духом.
*'''количество''' - количество предметов из поля "необходимый предмет".
*'''связанный баттл''' - поле в котором указывается связанный объект типа matchbattle.
*'''связанный матч''' - поле в котором указывается связанный матч.
*'''окно внутри монстра''' - объект, который покажем в экране с мини игрой в случае победы. Должен иметь состояния open - в случае обычной победы, open_win - если перешли на следующий уровень мастерства. Чтобы это окно перешло в одно из этих состояний передаем экономике состояние ''monster_win_wnd''.
*'''текст внутри монстра''' - текстовый объект, в который сложим поздравительный текст о переходе на следующий уровень мастерства.

В третей колонке записываются уровни мастерства. Их можно переименовывать. Добавляются уровни кнопкой "Добавить уровень мастерства", удаляются кнопкой "Удалить уровень мастерства".
В четвертой колонке настраивается выделенный уровень мастерства.

*'''энергия''' - энергия необходимая для того, что бы можно было начать играть в локацию.
*'''ресурс1''' - деньги даваемые за прохождение локации.
*'''опыт''' - опыт даваемый за прохождение локации.
*'''постоянный прирост''' - постоянный прирост.
*'''штраф за поражение''' - кол-во очков, которые отнимаются за проигрыш.
*'''очки''' - количество очков, которое необходимо набрать для перехода на следующий уровень мастерства.
*'''предметы''' - id коллекционных предметов, которые можно найти на локации. Предметы не обязательно должны быть из одной коллекции. Необходимые предметы перетаскиваются из текстового редактора, при этом будет использоваться их иконка.
*'''Вероятность''' - вероятность найти один из коллекционных предметов из поля "предметы".
*'''Вероятность 2''' - вероятность найти один из коллекционных предметов из поля "предметы".
*'''Вероятность 3''' - вероятность найти один из коллекционных предметов из поля "предметы".
*'''Инвентарь''' - id инвентарных предметов, которые можно найти на локации. Перетаскиваются из текстового редактора.
*'''Вероятность инв.''' - вероятность найти один из инвентарных предметов из поля "инвентарь".
*'''Вероятность инв. 2''' - вероятность найти один из инвентарных предметов из поля "инвентарь".
*'''Вероятность инв. 3''' - вероятность найти один из инвентарных предметов из поля "инвентарь".
*'''текст при разлочке уровня''' - текстовый id из которого возьмем поздравительный текст о разлочке нового уровня.
*'''жизни врага''' - записываются значения вражеских жизней.
*'''начальные жизни врага''' - начальное значение вражеских жизней.
*'''регенерация врага''' - время (в ms), за которое у противника отрастает жизнь. Если установлено -1, то отрастания жизни противника на происходит.
*'''число цветов''' - это число будет записываться в параметр numTokenNums матча.

Автоматические уровни мастерства отличаются всего несколькими дополнительными полями.

*'''количество''' - количество автоматических уровней.
*'''энергия''' - начальное значение энергии за игру.
*'''энергия прирост''' - прирост энергии за каждый уровень мастерства.
*'''ресурс 1''' - начальное значение ресурса1, который мы получаем за прохождение.
*'''ресурс 1 прирост''' - прирост ресурса1 за каждый уровень мастерства.
*'''опыт''' - начальное значение опыта, который мы получаем за прохождение.
*'''опыт прирост''' - прирост опыта за каждый уровень мастерства.
*'''нулевой штраф каждые n уровней''' - раз в столько уровней штраф за поражение будет нулевым (-1 - не использовать).

Также есть возможность перегружать некоторые параметры уровней мастерства. Для этого нужно выбрать монстра и в выпадающем списке вверху выбрать пункт "перегрузка параметров".Перегрузок может быть несколько.

Для настройки перегрузки нужно выбрать ее в 3 колонке, при этом в 4 колонке отобразятся параметры перегрузки.
Сейчас перегрузку можно привязать к уровням XP игрока и к уровню монстра. Под уровнем монстра имеется ввиду уровень мастерства, отсчет начинается с 0. Перегружать можно энергию, затрачиваемую на монстра, награду (золото и опыт), а также инвентарные и коллекционные предметы.

''Важно!'' Если поля инвентарных и коллекционных предметов оставить пустыми - то предметы выпадать не будут.

===Летающий объект===
Впервой колонке кнопкой "Добавить локацию" добавляется летающий объект - объекты которые вылетают после прохождения локации или после покупки сундуков. Удаляется кнопкой "Удалить локацию". Во второй колонке добавляется объект выделенного летающего объекта. Состояния hide, wait, inventory и collection - обязательны для этого предмета.

''hide'' - состояние, когда объект не видно на экране. В этом состоянии можно указать свойство alpha=0.

''wait'' - состояние, в которое попадают летающие объекты, которые отображают коллекционные предметы до того, как объекту economics будет вызвано состояние col_item_found.

''collection'' - состояние, которое будет вызвано летающему объекту, который отображает коллекционный предмет после того как объекту economics будет вызвано состояние col_item_found (он может лететь в таблицу с нужной коллекцией).

''inventory'' - состояние, которое вызывается летающему объекту в случае, если он отображает инвентарный объект (в этом состоянии предмет становится видимым и в дальнейшем может перемещаться).

===Аномалия===

В хидден-локации могут присутствовать аномалии, затрудняющие ее прохождение.
Впервой колонке добавляется аномалия, добавляется кнопкой "Добавить локацию", можно переименовывать, удаляется кнопкой "Удалить локацию".
Во второй колонке отображаются свойства выделенной аномалии.
*'''id''' - поле в которое перетаскивается текстовый id, из которого используется название, описание и иконка аномалии.
*'''предмет''' - предмет необходимый для того, что бы изгнать аномалию.
*'''экран''' - в этом поле указывается экран, в котором расположена мини игра.
*'''прибавка к энергии''' - указывается прибавка к энергии, поскольку для игры в аномалию будет нужно больше энергии. Например, при значении 0,5 - энергии потребуется больше в полтора раза.
*'''прибавка к опыту''' - указывается прибавка к опыту, поскольку игра в локацию с аномалией будет давать больше опыта. Например, при значении 0,5 - опыта приобретается больше в полтора раза.
*'''прибавка к ресурсу 1''' - указывается прибавка к ресурсу 1. поскольку игра в локацию с аномалией будет давать больше ресурса 1. Например, при значении 0,5 - ресурса 1 приобретается больше в полтора раза.

===Сдача коллекции===

В первой колонке добавляется событие на сдачу коллекции кнопкой "Добавить локацию", удаляется кнопкой "Удалить локацию".
Во второй колонке устанавливается состояние объекту сдачи коллекции.

===Временный эффект===

Временный эффект - визуализация действия различных инвентарных объектов, которые применил игрок.
В первой колонке создается временный эффект, добавляется кнопкой "Добавить локацию", удаляется кнопкой "Удалить локацию".
Во второй колонке устанавливаются свойства выделенного временного эффекта.

*'''иконка''' - из редактора ресурсов, перетаскивается иконка временного эффекта
*'''таймер''' - указывается объект типа timer, который соответствует выбранному временному эффекту.
*'''подложка''' - из редактора ресурсов, перетаскивается картинка подложки для таймера указанного в поле "таймер".

===Достижение===
В первой колонке записываются достижения. Добавляются кнопкой "Добавить локацию", удаляются кнопкой "Удалить локацию".
Во второй колонке отображаются свойства выбранного достижения.

*'''достижение''' - достижение, которое будет открываться по мере применения подобных предметов.

*'''процент''' - в виде числа, указывается процент достижения из поля "достижение".

*'''режим игры''' - указывается режим игры, ели 0 - режим игры не важен для достижения, 1 - режим игры слова, 2 - режим игры силуэты.

*'''аномалия''' - указывается аномалия необходимая для достижения, если указывается -2 - то аномалия не важна для достижения, если указывается -1 - то для достижения может использоваться любая аномалия.

==Состояния==

[[Файл:Economics 5.jpg|right]]
Перед вызовом некоторых состояний объекту economics необходимо передать параметр '''param''' и его значение. Например когда нам нужно открыть окно перед локацией мы передаем параметр номера этой локации в списке локаций (начиная с 0).

 
*'''idle''' - состояние по умолчанию.
*'''completed''' - передает состояние окончания исследования локации (необходим параметр номера локации), перед вызовом состояния, можно экономике заполнить поле '''additional_inv''' - перечнем инвентарных предметов которые хотим добавить пользователю ( поместить в таблицу + чтобы экономика поместила их в летающие объекты), через запятую (к примеру additional_inv="12345,25841") .
*'''exp''' - передает состояние начисления опыта (необходим параметр количества опыта). Нужен больше для тестирования, чем для самой игры.
*'''play''' - передает состояния перехода на локацию для исследования(при условии что хватит энергии и выполнены прочие условия).
*'''location''' - открывает окно перед локацией (необходим параметр номера локации).
*'''collection''' - заставляет экономикс заполнить таблицу коллекций. Лучше вызывать сразу перед открытием окна коллекций или во время его открытия. Для применения фильтрации коллекций перед вызовом состояния задать параметр ''collectionFilter'' (0 - все, 1 - все предметы, 2 - не хватает одного, 3 - новые). Для определения коллекции в категорию "новые" указать в настройках коллекции ''cnew'' (''новая'' - признак новизны для фильтра. >0 - новая).
*'''collections_scroll''' - заполняет таблицу коллекций и проматывает на коллекцию содержащую последний предмет для которого было показано окошко с информацией о предмете.
*'''collections_custom''' - перематывает таблицу к нужной коллекции. id коллекции записывается предварительно в param.
*'''item_collections''' - заставляет экономикс показать окошко с информацией о коллекционном предмете. Вызывается при тапе на таблицу в темплейте коллекций (объект ecollection).
*'''item_effect''' - сообщает economics, что необходимо показать окошко предмета от таймэфекта (необходим параметр номера эффекта)
*'''item_preview''' - заставляет экономикс показать окошко с информацией о предмете, который можно найти при обыске локации. Вызывается при тапе на таблицу с предметами в окне перед локацией.
*'''item_review''' - заставляет экономикс показать окошко с информацией о предмете, который нашли после обыска локации. Вызывается при тапе на таблицу с предметами в окне после локации.
*'''item_monster_preview''' - заставляет экономикс показать окошко с информацией о предмете, который можно найти при игре с монстром. Вызывается при тапе на таблицу с предметами в окне перед монстром.
*'''item_monster_review''' - заставляет экономикс показать окошко с информацией о предмете, который нашли после игры с монстром. Вызывается при тапе на таблицу с предметами в окне после монстра.
*'''completed_animation''' - состояние запускает анимацию полученной награды за прохождение локации после "окна после локации". Можно запускать из состояния закрытия окна после локации.
*'''unlock_item''' - передает состояние покупки предмета, необходимого для открытия локации. Как правило, предмет находится в окне перед локацией.
*'''unlock''' - передает состояние при котором происходит разлочка локации если текущий уровень на один ниже, чем необходимый для открытии локации или значение ''разница в уровнях'', позволяет разлочить локацию. Как правило кнопка для разблокирования локации размещается в окне перед локацией. Когда разница уровней достаточна, чтобы разлочить локацию машина локации переводится в состояние '''can_buy'''.
*'''completed_reward''' - вызывается объектом анимации награды после прохождения локации. Если объектов несколько (опыт, монеты, кристаллы), то вызывается только один раз одним из объектов.
*'''search_charger''' - производит поиск недостающего чарджера. Пока только по монстрам. Номер чарджера 0 или 1 - в парам.
*'''buy_charger''' - производит покупку недостающего чарджера (номер в параметре, -1 - купить все).
*'''update''' - обновить все локации на карте.
*'''level_up''' - проверяет получение нового уровня. Чтобы окно с получением нового уровня не открывалось самостоятельно, мы вызываем это состояние, когда нам удобно. Проверяется был ли получен новый уровень, если был, то вызывается окно с получением нового уровня.
*'''res1''' - Добавить ресурс 1 (значение в параметре).
*'''res2''' - Добавить ресурс 2 (значение в параметре).
*'''res1s''' - скорректировать статистику по ресурсу 1 (значение в параметре, когда, например, ресурс не заработан, а выигран в казино).
*'''res2s''' - скорректировать статистику по ресурсу 2 (значение в параметре, когда, например, ресурс не заработан, а выигран в казино).
*'''energy''' - Добавить энергию (значение в параметре).
*'''energy_no_max''' - Добавить энергию перманентно - без ограничения перевала за максимум (значение в параметре).
*'''failed''' - текущая локация провалена (не дается опыта и прочих наград за прохождение локации). Требует параметра локации.
*'''item_effect''' - показать окошко предмета от таймэффекта. В param - номер эффекта.
*'''item_effect_last''' - показать окошко предмета от последнего активированного таймэффекта. У машины окошка должно быть состояние "open_last".
*'''search_collection''' - проскроллить карту на локацию где можно найти коллекционный предмет. При этом машина локации (Объект на карте) будет переведена в состояние highlight, в котором локацию можно посветить или выделить ее каким-то образом.
*'''search_task''' - проскроллить карту на локацию где можно найти предмет из задания. При этом машина локации (Объект на карте) будет переведена в состояние highlight, в котором локацию можно посветить или выделить ее каким-то образом.
*'''search_charger''' - проскролить карту на монстр, в котором можно найти чарджер (необходимо значение чарджера в параметре 0 или 1).
*'''monster''' - Открыть превью для монстра с номером указанном в поле параметр.
*'''monster_play''' - Играть в мини игру выбранного монстра (при условии, что хватит энергии и выполнены прочие условия).
*'''monster_removed''' - Монстра прогнали предметами. Вычесть предметы и успешно завершить.
*'''monster_completed''' - Текущая мини игра так или иначе пройдена, перед вызовом состояния, можно экономике заполнить поле '''additional_inv''' - перечнем инвентарных предметов которые хотим добавить пользователю ( поместить в таблицу + чтобы экономика поместила их в летающие объекты), через запятую (к примеру additional_inv="12345,25841") .
*'''monster_failed''' - Текущая мини игра провалена, отличается от предыдущего тем, что не дается бонусного опыта и прочих наград.
*'''monster_buy''' - попытаться докупить предметы, необходимые для игры с монстром.
*'''col_item_param''' - Добавить коллекционный предмет, взяв его айди из параметра.
*'''anomaly_item''' - попытаться прогнать аномалию в текущей локации предметом. В зависимости от номера аномалии, машина локации (Объект на карте) переводится в состояние anomaly_N, где N - номер аномалии начиная с 0. (anomaly_0, anomaly_1 и т.д.). Таким образом можно визуализировать аномалию на карте.
*'''anomaly_game''' - попытаться прогнать аномалию в текущей локации мини игрой.
*'''anomaly_completed''' - мини игра по прогону аномалии успешно завершена.
*'''anomaly_buy''' - показать окно покупки для предмета прогона аномалии (в текущей локации).
*'''cheat_loc_level''' - "накачать" всем локациям скилл левел до максимума (для тестирования).
*'''chest_animation''' - анимировать последний использованный сундук.
*'''col_item_found''' - показать окошко с коллекцией для одного найденного коллекционного предмета из очереди.
*'''cheat_one_level''' - просимулировать один уровень развития игрока.
*'''purchase_ok''' - сообщает economocs что произошла покупка. Сформировать событие флури.
*'''buy_random_col''' - купить случайный коллекционный предмет.
*'''location_switch''' - переключить локацию на связанную (если есть предмет и собраны все артефакты, необходимые для перехода).
*''' anomaly_set_everywhere''' - генерация аномалии. Если в объекте Economics в параметре param указан номер аномалии, то состояние добавляет аномалию всем локациям, а если -1, то убирает аномалию из всех локаций.
*''' buy_artefact''' - осуществляет покупку артефакта для локации. Для этого у объекта economics в param должен быть записан номер локации, а в param2 номер артефакта (номер по порядку начиная с 0).
*'''show_artefacts''' - Показать таблицу покупки артефактов в param - номер локации
*'''location_buy_all_switchers''' - Купить все артефакты доступные для данной локации
*'''search_ingridient''' - переход в локацию для поиска ингредиента, который указан в param.
*'''search_needitem''' - поиск необходимого для исследования локации предмета из окна перед локацией. В param должен быть указан id необходимого предмета.
*'''copy''' - скопировать основные параметры (опыт, уровень, энергия) и количество предметов из одной экономики в другую. Перед вызовом указать в поле "param" id экономики куда перенесём значение. Если экономика в кот. копируем выключена по disable="1" - нужно с начало установить disable="0", вызвать сост. "init", а уже после в неё копировать.
*'''set_was_visited_flag''' - установить флаг посещаемости локации (loc%n%.wv="1") для календаря. В param должен быть указан id необходимого предмета.
*'''clear_was_visited_flag''' - снять флаг посещаемости локации (loc%n%.wv="0") для календаря.В param должен быть указан id необходимого предмета.
*'''srand_hidden''' - перетряхнуть связанный с хидденом генератор псевдослучайных чисел. Можно вызывать перед локацией, если возникает зацикливание хидденов. '''''КАТЕГОРИЧЕСКИ НЕЛЬЗЯ вызывать его при честном мультиплеере - в нем все определяется сидом от сервера'''''

При начислении экономикой res1 и res2 во флурри отправляются события coins_get, diams_get. Для того чтобы источники монет/кристаллов (параметр source) в событии приходили с адекватными значениями, перед вызовом состояния начисления экономике нужно записать параметр "res_source" в соответствии со значениями в списке:

SOURCE_UNKNOWN = 0, //!< неизвестный источник
SOURCE_PURCHASE = 1, //!< покупка
SOURCE_HIDDEN_WIN = 2, //!< выигрыш в хиддене
SOURCE_MINIGAME_WIN = 3, //!< выигрыш в миниигре
SOURCE_DAILY_BONUS = 4, //!< дейли бонус
SOURCE_SOCIAL_BONUS = 5, //!< бонусы за социалку
SOURCE_CASINO = 6, //!< казино
SOURCE_EXCHANGE = 7, //!< биржа
SOURCE_DEPOSIT = 8, //!< депозит
SOURCE_COLLECTION_GOT = 9, //!< сдача коллекций
SOURCE_GUES = 10, //!< угадайка
SOURCE_TASK_COMPLETE = 11, //!< выполнена задача
SOURCE_TRIVIA = 12, //!< миллионер
SOURCE_REDEEM = 13, //!< начисление из админки
SOURCE_LEVEL_UP = 14, //!< достижение уровня
SOURCE_USE_ITEM = 15, //!< использование предмета
SOURCE_PET_GOLD_COLLECTED = 16, //!< собрали бонус животного у пэта
SOURCE_PET_COLLECTION_GOT = 17, //!< сдача коллекции животных
SOURCE_SLOTMACHINE = 18, //!< слотмашина
SOURCE_RPGBATTLE = 19, //!< псевдоРПГ бой
SOURCE_SLOTFALLING = 20, //!< вторая слотмашина
SOURCE_MAP_CHEST = 21 //!< сундуки на карте

SOURCE_CONTEST_PRIZE = 23 //!< соревнования

П.С. для мануального начисления (уникальный источник под каждый проект)
31 // игровая награда №1
32 // игровая награда №2
33 // игровая награда №3
34 // игровая награда №4
35 // игровая награда №5
36 // игровая награда №6
37 // игровая награда №7
38 // игровая награда №8
39 // игровая награда №9
40 // игровая награда №10

=Сопутствующие объекты=

Объекты, которые используются вместе с объектом economics и имеют с ним непосредственную связь:

* [[Файл:E_items.png]] - [[Eitems]] - объект, служащий для связи инвентаря(магазина) и экономики.
* [[Файл:E_store_item.png]] - [[Estoreitem]] - шаблон для ячейки магазина.
* [[Файл:E_inventory_item.png]] - [[Einventoryitem]] - шаблон для ячейки инвентаря.
* [[Файл:Kub.png]] - [[Ecraftitem]] - шаблон для ячейки создания предмета.
* [[Файл:Taskorganizer.png]] - [[Taskorganizer]] - органайзер заданий.
* [[Файл:E_task_item.png]] - [[Etaskitem]] - шаблон для ячейки задания.
* [[Файл:E_collection.png]] - [[Ecollection]] - шаблон для строки в таблице коллекции.
* [[Файл:Economics.png]] - [[Economics]] - глобальная настройка игр типа ферма\билдер

=Вычитаемые параметры=
Данные параметры можно вычесть с помощью команды "var" в машине состояний. Параметры нужно вычитать из профиля, если не сказано обратное.
[id] - числовой id экономики в проекте, если не указана другая информация.

*'''ecomics[id].res1sp''' - количество потраченного ресурса_1 за все время игры;
*'''ecomics[id].res2sp''' - количество потраченного ресурса_2 за все время игры;
*'''ecomics[id].res1log''' - текущее значение ресурса_1 выраженное в логарифмической шкале;
*'''ecomics[id].res1logfl''' - текущее значение ресурса_1 выраженное в логарифмической шкале с учётом депозитов и биржи;
*'''ecomics[id].level''' - текущий уровень игрока;
*'''ecomics[id].res1''' - текущее количество ресурса_1;
*'''ecomics[id].res2''' - текущее количество ресурса_2;
*'''ecomics[id].res1ea''' - количество заработанного ресурса_1 за все время игры;
*'''ecomics[id].res2ea''' - количество заработанного ресурса_2 за все время игры;
*'''economics[id].stat.energy_spent''' - количество потраченной энергии за все время игры;
*'''ecomics[id].mplayed''' - количество сыгранных миниигр (монстр) за все время;
*'''ecomics[id].lplayed''' - количество сыгранных хидденов за все время;
*'''ecomics[id].total_score''' - количество заработанного опыта за все время игры;
*'''ecomics[id].exp''' - текущий опыт на уровне;
*'''ecomics[id].energy''' - текущий уровень энергии;
*'''ecomics[id].loc[loc_id].an''' - номер аномалии, которая будет в локации loc_id;
*'''amulets_bonus_res1''' - множитель монет за бонусы от амулетов, при начислении по сост. "res1";
*'''amulets_bonus_res2''' - множитель кристаллов за бонусы от амулетов, при начислении по сост. "res2";
*'''amulets_bonus_exp''' - множитель опыта за бонусы от амулетов, при начислении по сост. "exp";

Каждая экономика пишет в пользователя следующие параметры:
*'''public.EconomicsRes1''' - текущее количество ресурса_1;
*'''public.EconomicsRes2''' - текущее количество ресурса_2;
*'''public.EconomicsLevel''' - текущий уровень игрока;
*'''public.EconomicsEnergy''' - текущий уровень энергии;
*'''public.EconomicsTotalScore''' - количество заработанного опыта за все время игры;
*'''public.EconomicsCollectionsUniq''' - количество сданных коллекций ( значение повышается каждый раз при сдаче коллекции), пишется Экономикой только если поле - '''fbopt''' не пустое;

[[Category:Game mechanic]]
[[Category:Economics|*]]

Интерфейс ScenceEditor

2018-02-05T10:09:03Z

Bmor: /* Debug Options */

{{TOC right}}
== [[Файл:Ico_main.png]]Редактор сцен ==

'''Редактор сцен''' — программа, предназначенная для создания, редактирования и экспорта игровых экранов, в котором происходит настройка свойств объектов и игровой логики. 

'''Окно редактора сцен состоит из:'''
*меню редактора;
*рабочей области, в которой размещен объект сцена, на котором размещают другие объекты;
*панель Лэйаут, в которой размещено иерархическое дерево проекта, которое состоит из экранов, на которых находятся игровые объекты;
*панель Свойства, которая отображает свойства объекта, который выбран в дереве проекта;
*панель для построения сплайна;
*панель инструментов;
*строка Координаты, отображающая координаты курсора в текущий момент времени 

Для включения или отключения панели кликаем правой кнопкой мыши по серой области меню редактора и ставим галочку. Панели можно расположить на экране в любом порядке. 

[[Файл:Головна2.PNG|700px]]

=== Меню редактора ===

==== Project (Проект)====
меню, которое содержит список команд, с помощью которых можно создать новый или загрузить уже созданный проект, сохранить проект с указанием места сохранения и т.д.
*'''New project''' - создать новый проект;
*'''Open''' - открыть уже созданный проект (проект обязательно должен находится в подкаталоге редактора);
*'''Recent project...''' - показывает список последних открывавшихся проектов;
*'''Close''' - закрытие проекта (редактор при этом не закрывается);
*'''New project''' - создать новый проект;
*'''Save''' - сохранение проекта;
*'''Save as...''' - сохранение проекта под новым именем или в новом каталоге;
*'''Export...''' - экспорт проекта;
*'''Project options...''' - опции проекта;
*'''Exit''' - закрытие редактора.

==== Edit (Редактирование)====
меню редактирования проекта:
*'''Copy''' - копирование объекта;
*'''Paste into current object''' - вставка объекта в выбранный объект;
*'''Paste after current object''' - вставка объекта после выбранного объекта;
*'''Delete...''' - удаление объекта;
*'''Scale object''' - масштабирование выбранного объекта, если у него есть масштаб (scale x \ scale y);
*'''Rotate object''' - поворот выбранного объекта, если у него есть параметр поворота (angle);
*'''Modify vertex''' - изменение положения точек вертекса у выбранного объекта, если вертексы включены;
*'''Find object...''' - поиск объекта по id или по имени;
*'''Setup Editor...''' - настройки редактора.

[[Файл:SetupEditor.png|right|400px]]

1) Языки - выбор языка редактора.

2) Work mode - выбор режима работы.

3) Syles - выбор темы редактора.

4) Перемещение сцены мышью или клавишами клавиатуры - позволяет перемещать сцену на экране.

5) Рисовать сетку на экране - отображать сетку на экране или нет.

6) Utilities - Подключение утилит.

В редакторе есть возможность подключения утилит в форматах *.bat, *.exe, *.py, *.pyw, *.vbs.

Для примера, подключим bat-файл, открывающий логи вьвера в notepad++.

Для этого создадим файл Logs.bat со следущими командами:

cd C:\Users\<your-user>\AppData\Roaming\Absolutist\Viewer

start "C:\Program Files (x86)\Notepad++\notepad++.exe" "viewer.log"

В настройки редактора добавим утилиту нажав на плюсик. В списке ниже появится поле добавленной утилиты.

Нажмем на многоточие в столбце "Browse". В открывшимся окне "Open utility" откроем Logs.bat файл. После этого в меню редактора появится меню "Utilities" с командой Logs.

==== View (Просмотр)====
*'''Toggle grid''' - включает\выключает отображение сетки на сцене;
*'''open/hide comment''' - показывает\скрывает комментарии к объекту;
*'''Disable object movements''' - выключает\включает возможность перемещать объекты по сцене.

=== Viewer (Вьювер) ===
*'''Start Viewer''' - запуск вьювера;
*'''Start Viewer with changed time''' - запуск вьювера с заданным временем;
*'''Save and run viewer...''' - сохраняет проект и запускает вьювер;
*'''Run Viewer.bat''' - ???;
*'''Delete temp data''' - удаление опций;

====Layouts (Лейаут, Макеты)====
меню работа с лейаутами проекта (выбор макета устройства для проекта, редактирование экранов):
*'''Add new layout...''' - создание нового лейаута;
*'''Delete layout...''' - удаление лейаута;
*'''Layout settings...''' - настройки лейаута;
*'''Add folder...''' - создание папки в текущем лейаута;
*'''Add screen...''' - создание нового экрана.
==== Tools (Инструменты)====
меню дополнительных редакторов и инструментов для проекта (вызов редактора ресурсов, текстового редактора, анализ проекта). Список этого меню вынесен на панель с кнопками быстрого запуска:
*'''Resources Editor''' - редактор ресурсов;
*'''Texts Editor''' - текстовый редактор;
*'''Analyzer''' - анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов));
*'''Object info...''' - общие свойства объекта (показывает размер памяти занимаемой текстурами);
*'''Options info...''' - информация об опциях.

==== Help (Помощь)====
меню вызова справки.

=== Кнопки панели Инструменты ===
Некоторые инструменты также вызываются горячими клавишами (комбинация клавиш приведена в скобках )

[[Файл:00 6.png]] (Ctrl+N) — создать новый проект; 
[[Файл:00 7.png]](Ctrl+O) — загрузить уже созданный проект; 
[[Файл:00 8.png]](Ctrl+S) — сохранить изменения в проекте; 
[[Файл:00 9.png]] — запустить Viewer; 
[[Файл:009.JPG]] — нормальный вид; 
[[Файл:Ico_text.png|25px]] - вызов текстового редактора; 
[[Файл:Ico_base.png|25px]] — вызов редактора ресурсов; 
[[Файл:013.JPG]] — анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов)); 
[[Файл:014.JPG]]— поиск объекта по id или по имени. 

===Функции рабочей области===

'''1) Масштабирование рабочей области '''
Ctrl + колесико мышки крутим вперед - увеличиваем объекты , назад - уменьшаем объекты. 

'''2)Перемещение по рабочей области '''
После масштабирования возникает необходимость переместиться с левого уголка экрана в далекий правый, переместиться к выбраному обьекту, вверх или вниз. 

Кликаем правой кнопкой мыши по горизонтальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll left / right - функция перемещает экран на маленькое расстояние вправо / влево;
*left / right edge — функция перемещает экран в левый / правый угол экрана;
*page left / right - функция показывает левую/правую часть экрана 

Кликаем правой кнопкой мыши по вертикальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll up / down - функция перемещает экран на маленькое расстояние вверх / вниз;
*top/bottom - функция перемещает экран вверх / вниз;
*page up / down - функция перемещает экран верхнюю / нижнюю часть экрана. 

Меню прокрутки скрывается по нажатию клавиши Alt 

===Функции панели Лэйаут===
[[Файл:Лэйаут_1.JPG|right]]
При клике правой кнопкой мыши по выбранному лэйауту (см. рисунок справа)
*Создать папку в текущем объекте;
*Создать экран в текущем объекте - создание объекта в текущем лэйауте;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает / разворачивает дерево объектов всех экранов 

При клике правой кнопкой мыши по выбранному экрану, сцене или объекту возможно:
*Lock (Unlock) screen - золочивание (разлочивание) экрана: нельзя перемещать, удалять и изменять объекты (сцены) экрана, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых экранах в панели проекта появляется замочек;
*Lock (Unlock) scene - золочивание (разлочивание) сцены: нельзя перемещать, удалять и изменять объекты (машины, картинки и др.) сцены, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых сценах также появляется замочек;
*Создать сцену в текущем объекте - создание экран в текущем экране;
*Создать экран в текущем объекте - создание экран в текущем лэйауте;
*Создать объект сцены в текущем объекте - создание объекта в текущем объекте;
*Удалить объект - удаление объекта из проекта;
*Копировать объект — копирование объекта;
*Вставить в текущий объект — вставка объекта в текущий объект верхнего уровня ;
*Вставить как ссылку в текущий объект — вставка объекта в текущий объект для создания расшареной сцены;
*Вставить как ссылку после текущего объекта — вставка объекта после текущего объекта для создания расшареной сцены;
*Вставить после текущего объекта - вставка объекта после текущего объекта;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает /разворачивает дерево объектов экрана или сцены;

====Функция Расположить сцену в соответствии с изображением ====
Пусть на сцене будет находится очень много картинок, которые должны находиться в строго определенных местах. Переместим нашу картинку в нужную точку на сцене. Но у нас картинок очень много и мы потратим много времени на их расстановку. Для уменьшения времени на расстановку картинок воспользуемся функцией расположить сцену в соответствии с изображением. 
Функция расположить сцену в соответствии с изображением перемещает картинку в заданную точку художниками. Художник решил, что клумба должна быть в правом нижнем углу, после применения функции расположить сцену в соответствии с изображением, картинка станет именно на указанное художником место. 
Данная функция вызывается кликом правой кнопкой мыши по объекту [[Файл:панель_свойства_1.JPG|right]]

===Функции панели Свойства===

*При клике на тип или имя некоторых объектов вызываются дополнительные окна.Например, при клике на тип Machine открывается окно, где прописываются функции объекта типа Machine.
*При наведении на поле тип выпадет подсказка с уникальным номером объекта.
*При клике правой мышкой по названию свойства объекта выпадает меню с дополнительными свойствами объекта
*Некоторые свойства объектов объединены в группы (см. рисунок справа)

=== Создание проекта ===

1. Для создания нового игрового проекта необходимо запустить редактор сцен SceneEditor. 
2. В верхнем меню Проект выбрать Новый (т.е. создать новый проект). 
3. В появившемся окне указываем имя проекта и имя базы ресурсов.Выбираем папку для сохранения проекта 
4. В этом окне выбираем устройство для которого создаётся проект, а затем выбираем тип магазина и вариант версии игры 
[[Файл:020.JPG]] [[Файл:021.JPG]]

5. В редакторе сцен в меню Проект → Сохранить → проект с именем Learning. 
Эту методику действий можно брать за шаблон для создания других проектов. 
Результат: Создана база ресурсов и проект для выполнения Уроков.

====Важное замечание по созданию проекта====
[[Файл:2_лэйаута.JPG|right]] 
Предположим нам необходимо создать игру для магазина А и магазина Б. Игра будет отличаться только 10 функциями. Мы можем создать игру для магазина А., а потом скопировать папку с проектом, проект переименовать, внести изменения и получить игру для магазина Б. Результат: 2 игры и 2 папки с ресурсами. Такой подход не приветствуется. 
Для уменьшения времени на создание проекта, подключение ресурсов, внесения одинаковых объектов и удобства отслеживания багов и прочего в Редакторе Сцен существует возможность создания двух лэйаутов в одном проекте.
При создании проекта мы выбираем оба магазина, после чего в панели Лэйаут появится два лэйаута для магазина А и магазина Б(см. рисунок справа. При этом текстовая база проекта и база ресурсов у них будут идентичны. При создании новых объектов в одном лэйауте они же будут создаваться и в другом, при этом можно изменять свойства объекта каждого лэйаута независимо от второго. 
За применение изменений между лэйаутами отвечает параметр "синхронизация", который есть у каждого объекта. Если стоит "синхронизировать", то объект будет одинаков в каждом из лэйаутов. Если стоит "не синхронизировать", то объект будет уникальным для каждого экрана, его изменения не будут применены на других лэйаутах, не синхронизируемые объекты можно даже удалять, т.к. они уникальны для лэйаута.

===Экспорт проекта===

'''Этапы экспорта проекта'''
*Выполняется сжатие графики при необходимости
*Очистка базы ресурсов от неиспользуемой графики
*Запаковка графики в текстуры и контейнер
*При необходимости конвертирование файлов в pvr форматы 
С целью экономии оперативной памяти на устройстве возможно сжатие графики, упаковка графики в текстуры, создание нескольких исполняемых файлов, проекта, содержащих в себе несколько сцен проекта, и загружаемых в оперативную память устройства по мере прохождения игры. 

Процедура экспорта проекта вызывается через меню редактора Проект - Экспортировать проект 

[[Файл:Scene editor export window.jpg|right]]
'''Параметры экспорта проекта:''' 
''Настройки параметров графики''
*Ось Х, ось У — параметры сжатия графики по оси Х,У. Значения параметра от 0 до 1.
*При выполнении сжатия рекомендуется обращать внимания на размер лэйаута
*Сжатие графики возможно и непропорциональное . Используется редко

''Параметры запаковки графики''
*Common textures size - максимальный размер графической текстуры для графики, которая не находится в контейнерах и попадает в одну текстуру, или максимальный размер графического файла, если он не в контейнере и не попадает в текстуру.
*Create dat container - упаковка ресурсов в файл с типом DAT. Обеспечиваем защиту ресурсов проекта от несанкционированного доступа. Увеличиваем производительность при операциях чтения файлов ресурсов с твердотельного носителя.
*Quality - Качество графики, которая не находится в контейнерах
*Optimization - оптимизация графики для лучшего быстродействия(speed) или для занимаемого дискового пространства в распакованном виде(size)

''Тип экспорта''
*One project file - формируется один XML файл описывающий проект.
*Split project on screens, load partly' - проект будет разбит на отдельные файлы описывающие экраны, загружаться файлы будут в порядке использования (вызова) в проекте. В результате получаем увеличение начальной загрузки проекта и использование меньшего объема оперативной памяти.
*Release build - оптимизация по размеру файла базы ресурсов и основного файла проекта.

''Export to folder'' - Путь для экспорта. Если указан путь экспорта проекта - производится экспорт согласно настройкам для выбранной платформы. Если не указан - проект экспортируются под выбранную платформу и автоматически запускается сборка проекта.
Структура папки:
[[Файл:TreeFolder.png|TreeFolder.png]] 
'''Select platform''' - необходимо выбрать платформу для которой будем собирать проект. При экспорте на все платформы необходимо установить Marmalade SDK [[Установка и настройка|см. инструкцию]] при этом не нужно указывать путь для экспорта (оставить поле пустым). В результате запустится скрипт сборки исполняемого пакета, это будет видно по черным экранам с ходом выполнения процесса сборки.Процесс экспорта будет отображаться в окне.

Таблица результирующих форматов для платформ
{| border="1"
|-
|качество, оптимизация
|IOS
|Android
|Windows Phone8
|BlackBerry
|Windows
|-
|Best, size
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|-
|Best, speed
|jxr
|jxr
|jxr
|jxr
|jxr
|-
|Medium, size
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Medium, speed
|PVRTC + jxr
|ETC1 + jxr
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|-
|Low, size
|PVRTC + png(a)
|ETC1 + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Low, speed
|PVRTC(RGBA) + hitmask
|ETC1 + PVRA8
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|}

*'''ETC''' - Ericsson Texture Compression : для устройств Android
*'''PVR''' - PowerVR Texture Compression : для устройств IOS
*'''bc3(dxt)''' - DirectX Texture : Windows, Windows Phone 8 

=== Режим отладки ===

Включение режима отладки:

[[Файл:SE debug0.JPG]]

Инструменты отладки:

[[Файл:SE debug1.JPG]]

* '''Debug dock''' - установка брейкпоинтов (точек остановки) и вывод отладочного лога от сервера.
* '''Logging''' - вывод логов вьювера (параллельно с viewer.log) с подсветкой и фильтрами.
* '''Debug Options''' - вывод дерева опций, подсветка изменений (при работе вьювера), слежение за конкретными параметрами.
* '''Debug Properties''' - вывод параметров объекта под курсором по хоткею (из вьювера) - на момент написания не реализовано.

==== Debug dock ====

[[Файл:SE debug2.JPG]]

Принцип работы брейкпоинтов (точек остановки):
* Добавляем в табличку брейкпоинтов новый пункт
* Задает objectID интересующего объекта
** Задаем название состояния, при переходе на которое вьювер станет на паузу
** ИЛИ задаем название параметра, при изменении которого вьювер станет на паузу
* Запускаем вьювер с отладкой
*: [[Файл:SE debug3.jpg]]
* После перехода в заданное состояние вьювер станет за паузу, а в редактре сцен откроется окно машинки с этим состоянием.

==== Logging ====

[[Файл:SE debug4.JPG]]

* Сие логирование происходит только с запущеным в режиме отладки вьювером;
* Логи с ворнингами выделены оранжевым цветом ('''не игнорируйте их''');
* Логи с ошибками выделены красным цветом ('''а их уж тем более не игнорируйте!''');
* Кнопка ''Clear log'' - очищает логи из данного окна;
* Кнопка ''(...)'' - открыть лог из файла
* Флаг ''Autoscroll'' - при добавлении новой записи листает список в конец

'''Фильтрация логов'''
* Фильтр задается для каждого поля отдельно;
* Можно фильтровать по нескольким полям одновременно;
* Для фильтрации по какому-либо полю просто нажмите на его заглавие (Level / Time / ...)
* '''Как правильно задавать фильтр''':
** ''[value]'' - поиск по полному совпадению - будут показаны только записи, текст которых в данном поле '''равен''' ''[value]''
**: [[Файл:SE debug log1.jpg]]
** ''[value]*'' - поиск по началу строки - будут показаны только те записи, текст которых в данном поле '''начинается с''' ''[value]''
**: [[Файл:SE debug log2.jpg]]
** ''*[value]'' - поиск по окончанию строки - будут показаны только те записи, текст которых в данном поле '''заканчивается на''' ''[value]''
**: [[Файл:SE debug log3.jpg]]
** ''*[value]*'' - поиск по вхождению - будут показаны только те записи, текст которых в данном поле '''содержит''' текст ''[value]''
**: [[Файл:SE debug log4.jpg]]
** ''![filter]'' - исключение - при добавлении знака '''!''' перед фильтром (любой его вариацией), будут показаны все записи, текст которых в данном поле '''НЕ''' подходит под фильтр.
**: [[Файл:SE debug log5.jpg]]
** ''[filter1]&[filter2]&[...]'' - фильтрация по нескольким критериям - будут показаны все записи, текст которых '''подходит хотя бы под один из фильтров'''
**: [[Файл:SE debug log6.jpg]]

==== Debug Options ====

Окно ''Debug options'' предназначено для отслеживания изменений опций в реальном времени.

[[Файл:SE debug6.JPG]]

* Кнопка '''Refresh''' - подгружает опции из файла options.xml
* ''Options update'':
** '''Manual update''' - обновление опций '''ТОЛЬКО''' в ручном режиме (кнопкой '''Refresh''')
** '''Auto Update''' - обновление опций вьювером - все записи, что меняет в опциях вьювер, будут обновлены (так же всё еще можно обновить вручную)
** '''Timer Update''' - обновление опций по таймеру - раз в заданный период автоматически обновляет опции из файла options.xml (команды вьювера игнорируются, все изменения берутся только из файла)
* Кнопка '''Save options''' - создает локальную копию текущего файла с опциями (в том же каталоге, где лежит options.xml)
* Кнопка '''Open options filder''' - открывает папку с опциями.

* '''All options''' - отображает все опции в виде дерева, показывает текущее значение параметров и предыдущее (если было изменено)
* '''Custom params''' - позволяет отслеживать изменений конкретных параметров; в поле ''Custom param tracking'' указывается тот же путь к параметру, что и в машинках:
*: [[Файл:SE debug7.JPG]]

=Горячие клавиши=
* '''Клавиша F10''' - По нажатию разворачивает/сворачивает все объекты и подобъекты в дереве проекта или в свойствах объекта.
* '''Клавиша Num* и Num-''' - По нажатию разворачивают/сворачивают подобъекты у выделенного объекта в дереве проекта или в свойствах объекта.

[[Category:AppSalute]]

Интерфейс ScenceEditor

2018-02-05T10:08:43Z

Bmor: /* Режим отладки */

{{TOC right}}
== [[Файл:Ico_main.png]]Редактор сцен ==

'''Редактор сцен''' — программа, предназначенная для создания, редактирования и экспорта игровых экранов, в котором происходит настройка свойств объектов и игровой логики. 

'''Окно редактора сцен состоит из:'''
*меню редактора;
*рабочей области, в которой размещен объект сцена, на котором размещают другие объекты;
*панель Лэйаут, в которой размещено иерархическое дерево проекта, которое состоит из экранов, на которых находятся игровые объекты;
*панель Свойства, которая отображает свойства объекта, который выбран в дереве проекта;
*панель для построения сплайна;
*панель инструментов;
*строка Координаты, отображающая координаты курсора в текущий момент времени 

Для включения или отключения панели кликаем правой кнопкой мыши по серой области меню редактора и ставим галочку. Панели можно расположить на экране в любом порядке. 

[[Файл:Головна2.PNG|700px]]

=== Меню редактора ===

==== Project (Проект)====
меню, которое содержит список команд, с помощью которых можно создать новый или загрузить уже созданный проект, сохранить проект с указанием места сохранения и т.д.
*'''New project''' - создать новый проект;
*'''Open''' - открыть уже созданный проект (проект обязательно должен находится в подкаталоге редактора);
*'''Recent project...''' - показывает список последних открывавшихся проектов;
*'''Close''' - закрытие проекта (редактор при этом не закрывается);
*'''New project''' - создать новый проект;
*'''Save''' - сохранение проекта;
*'''Save as...''' - сохранение проекта под новым именем или в новом каталоге;
*'''Export...''' - экспорт проекта;
*'''Project options...''' - опции проекта;
*'''Exit''' - закрытие редактора.

==== Edit (Редактирование)====
меню редактирования проекта:
*'''Copy''' - копирование объекта;
*'''Paste into current object''' - вставка объекта в выбранный объект;
*'''Paste after current object''' - вставка объекта после выбранного объекта;
*'''Delete...''' - удаление объекта;
*'''Scale object''' - масштабирование выбранного объекта, если у него есть масштаб (scale x \ scale y);
*'''Rotate object''' - поворот выбранного объекта, если у него есть параметр поворота (angle);
*'''Modify vertex''' - изменение положения точек вертекса у выбранного объекта, если вертексы включены;
*'''Find object...''' - поиск объекта по id или по имени;
*'''Setup Editor...''' - настройки редактора.

[[Файл:SetupEditor.png|right|400px]]

1) Языки - выбор языка редактора.

2) Work mode - выбор режима работы.

3) Syles - выбор темы редактора.

4) Перемещение сцены мышью или клавишами клавиатуры - позволяет перемещать сцену на экране.

5) Рисовать сетку на экране - отображать сетку на экране или нет.

6) Utilities - Подключение утилит.

В редакторе есть возможность подключения утилит в форматах *.bat, *.exe, *.py, *.pyw, *.vbs.

Для примера, подключим bat-файл, открывающий логи вьвера в notepad++.

Для этого создадим файл Logs.bat со следущими командами:

cd C:\Users\<your-user>\AppData\Roaming\Absolutist\Viewer

start "C:\Program Files (x86)\Notepad++\notepad++.exe" "viewer.log"

В настройки редактора добавим утилиту нажав на плюсик. В списке ниже появится поле добавленной утилиты.

Нажмем на многоточие в столбце "Browse". В открывшимся окне "Open utility" откроем Logs.bat файл. После этого в меню редактора появится меню "Utilities" с командой Logs.

==== View (Просмотр)====
*'''Toggle grid''' - включает\выключает отображение сетки на сцене;
*'''open/hide comment''' - показывает\скрывает комментарии к объекту;
*'''Disable object movements''' - выключает\включает возможность перемещать объекты по сцене.

=== Viewer (Вьювер) ===
*'''Start Viewer''' - запуск вьювера;
*'''Start Viewer with changed time''' - запуск вьювера с заданным временем;
*'''Save and run viewer...''' - сохраняет проект и запускает вьювер;
*'''Run Viewer.bat''' - ???;
*'''Delete temp data''' - удаление опций;

====Layouts (Лейаут, Макеты)====
меню работа с лейаутами проекта (выбор макета устройства для проекта, редактирование экранов):
*'''Add new layout...''' - создание нового лейаута;
*'''Delete layout...''' - удаление лейаута;
*'''Layout settings...''' - настройки лейаута;
*'''Add folder...''' - создание папки в текущем лейаута;
*'''Add screen...''' - создание нового экрана.
==== Tools (Инструменты)====
меню дополнительных редакторов и инструментов для проекта (вызов редактора ресурсов, текстового редактора, анализ проекта). Список этого меню вынесен на панель с кнопками быстрого запуска:
*'''Resources Editor''' - редактор ресурсов;
*'''Texts Editor''' - текстовый редактор;
*'''Analyzer''' - анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов));
*'''Object info...''' - общие свойства объекта (показывает размер памяти занимаемой текстурами);
*'''Options info...''' - информация об опциях.

==== Help (Помощь)====
меню вызова справки.

=== Кнопки панели Инструменты ===
Некоторые инструменты также вызываются горячими клавишами (комбинация клавиш приведена в скобках )

[[Файл:00 6.png]] (Ctrl+N) — создать новый проект; 
[[Файл:00 7.png]](Ctrl+O) — загрузить уже созданный проект; 
[[Файл:00 8.png]](Ctrl+S) — сохранить изменения в проекте; 
[[Файл:00 9.png]] — запустить Viewer; 
[[Файл:009.JPG]] — нормальный вид; 
[[Файл:Ico_text.png|25px]] - вызов текстового редактора; 
[[Файл:Ico_base.png|25px]] — вызов редактора ресурсов; 
[[Файл:013.JPG]] — анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов)); 
[[Файл:014.JPG]]— поиск объекта по id или по имени. 

===Функции рабочей области===

'''1) Масштабирование рабочей области '''
Ctrl + колесико мышки крутим вперед - увеличиваем объекты , назад - уменьшаем объекты. 

'''2)Перемещение по рабочей области '''
После масштабирования возникает необходимость переместиться с левого уголка экрана в далекий правый, переместиться к выбраному обьекту, вверх или вниз. 

Кликаем правой кнопкой мыши по горизонтальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll left / right - функция перемещает экран на маленькое расстояние вправо / влево;
*left / right edge — функция перемещает экран в левый / правый угол экрана;
*page left / right - функция показывает левую/правую часть экрана 

Кликаем правой кнопкой мыши по вертикальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll up / down - функция перемещает экран на маленькое расстояние вверх / вниз;
*top/bottom - функция перемещает экран вверх / вниз;
*page up / down - функция перемещает экран верхнюю / нижнюю часть экрана. 

Меню прокрутки скрывается по нажатию клавиши Alt 

===Функции панели Лэйаут===
[[Файл:Лэйаут_1.JPG|right]]
При клике правой кнопкой мыши по выбранному лэйауту (см. рисунок справа)
*Создать папку в текущем объекте;
*Создать экран в текущем объекте - создание объекта в текущем лэйауте;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает / разворачивает дерево объектов всех экранов 

При клике правой кнопкой мыши по выбранному экрану, сцене или объекту возможно:
*Lock (Unlock) screen - золочивание (разлочивание) экрана: нельзя перемещать, удалять и изменять объекты (сцены) экрана, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых экранах в панели проекта появляется замочек;
*Lock (Unlock) scene - золочивание (разлочивание) сцены: нельзя перемещать, удалять и изменять объекты (машины, картинки и др.) сцены, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых сценах также появляется замочек;
*Создать сцену в текущем объекте - создание экран в текущем экране;
*Создать экран в текущем объекте - создание экран в текущем лэйауте;
*Создать объект сцены в текущем объекте - создание объекта в текущем объекте;
*Удалить объект - удаление объекта из проекта;
*Копировать объект — копирование объекта;
*Вставить в текущий объект — вставка объекта в текущий объект верхнего уровня ;
*Вставить как ссылку в текущий объект — вставка объекта в текущий объект для создания расшареной сцены;
*Вставить как ссылку после текущего объекта — вставка объекта после текущего объекта для создания расшареной сцены;
*Вставить после текущего объекта - вставка объекта после текущего объекта;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает /разворачивает дерево объектов экрана или сцены;

====Функция Расположить сцену в соответствии с изображением ====
Пусть на сцене будет находится очень много картинок, которые должны находиться в строго определенных местах. Переместим нашу картинку в нужную точку на сцене. Но у нас картинок очень много и мы потратим много времени на их расстановку. Для уменьшения времени на расстановку картинок воспользуемся функцией расположить сцену в соответствии с изображением. 
Функция расположить сцену в соответствии с изображением перемещает картинку в заданную точку художниками. Художник решил, что клумба должна быть в правом нижнем углу, после применения функции расположить сцену в соответствии с изображением, картинка станет именно на указанное художником место. 
Данная функция вызывается кликом правой кнопкой мыши по объекту [[Файл:панель_свойства_1.JPG|right]]

===Функции панели Свойства===

*При клике на тип или имя некоторых объектов вызываются дополнительные окна.Например, при клике на тип Machine открывается окно, где прописываются функции объекта типа Machine.
*При наведении на поле тип выпадет подсказка с уникальным номером объекта.
*При клике правой мышкой по названию свойства объекта выпадает меню с дополнительными свойствами объекта
*Некоторые свойства объектов объединены в группы (см. рисунок справа)

=== Создание проекта ===

1. Для создания нового игрового проекта необходимо запустить редактор сцен SceneEditor. 
2. В верхнем меню Проект выбрать Новый (т.е. создать новый проект). 
3. В появившемся окне указываем имя проекта и имя базы ресурсов.Выбираем папку для сохранения проекта 
4. В этом окне выбираем устройство для которого создаётся проект, а затем выбираем тип магазина и вариант версии игры 
[[Файл:020.JPG]] [[Файл:021.JPG]]

5. В редакторе сцен в меню Проект → Сохранить → проект с именем Learning. 
Эту методику действий можно брать за шаблон для создания других проектов. 
Результат: Создана база ресурсов и проект для выполнения Уроков.

====Важное замечание по созданию проекта====
[[Файл:2_лэйаута.JPG|right]] 
Предположим нам необходимо создать игру для магазина А и магазина Б. Игра будет отличаться только 10 функциями. Мы можем создать игру для магазина А., а потом скопировать папку с проектом, проект переименовать, внести изменения и получить игру для магазина Б. Результат: 2 игры и 2 папки с ресурсами. Такой подход не приветствуется. 
Для уменьшения времени на создание проекта, подключение ресурсов, внесения одинаковых объектов и удобства отслеживания багов и прочего в Редакторе Сцен существует возможность создания двух лэйаутов в одном проекте.
При создании проекта мы выбираем оба магазина, после чего в панели Лэйаут появится два лэйаута для магазина А и магазина Б(см. рисунок справа. При этом текстовая база проекта и база ресурсов у них будут идентичны. При создании новых объектов в одном лэйауте они же будут создаваться и в другом, при этом можно изменять свойства объекта каждого лэйаута независимо от второго. 
За применение изменений между лэйаутами отвечает параметр "синхронизация", который есть у каждого объекта. Если стоит "синхронизировать", то объект будет одинаков в каждом из лэйаутов. Если стоит "не синхронизировать", то объект будет уникальным для каждого экрана, его изменения не будут применены на других лэйаутах, не синхронизируемые объекты можно даже удалять, т.к. они уникальны для лэйаута.

===Экспорт проекта===

'''Этапы экспорта проекта'''
*Выполняется сжатие графики при необходимости
*Очистка базы ресурсов от неиспользуемой графики
*Запаковка графики в текстуры и контейнер
*При необходимости конвертирование файлов в pvr форматы 
С целью экономии оперативной памяти на устройстве возможно сжатие графики, упаковка графики в текстуры, создание нескольких исполняемых файлов, проекта, содержащих в себе несколько сцен проекта, и загружаемых в оперативную память устройства по мере прохождения игры. 

Процедура экспорта проекта вызывается через меню редактора Проект - Экспортировать проект 

[[Файл:Scene editor export window.jpg|right]]
'''Параметры экспорта проекта:''' 
''Настройки параметров графики''
*Ось Х, ось У — параметры сжатия графики по оси Х,У. Значения параметра от 0 до 1.
*При выполнении сжатия рекомендуется обращать внимания на размер лэйаута
*Сжатие графики возможно и непропорциональное . Используется редко

''Параметры запаковки графики''
*Common textures size - максимальный размер графической текстуры для графики, которая не находится в контейнерах и попадает в одну текстуру, или максимальный размер графического файла, если он не в контейнере и не попадает в текстуру.
*Create dat container - упаковка ресурсов в файл с типом DAT. Обеспечиваем защиту ресурсов проекта от несанкционированного доступа. Увеличиваем производительность при операциях чтения файлов ресурсов с твердотельного носителя.
*Quality - Качество графики, которая не находится в контейнерах
*Optimization - оптимизация графики для лучшего быстродействия(speed) или для занимаемого дискового пространства в распакованном виде(size)

''Тип экспорта''
*One project file - формируется один XML файл описывающий проект.
*Split project on screens, load partly' - проект будет разбит на отдельные файлы описывающие экраны, загружаться файлы будут в порядке использования (вызова) в проекте. В результате получаем увеличение начальной загрузки проекта и использование меньшего объема оперативной памяти.
*Release build - оптимизация по размеру файла базы ресурсов и основного файла проекта.

''Export to folder'' - Путь для экспорта. Если указан путь экспорта проекта - производится экспорт согласно настройкам для выбранной платформы. Если не указан - проект экспортируются под выбранную платформу и автоматически запускается сборка проекта.
Структура папки:
[[Файл:TreeFolder.png|TreeFolder.png]] 
'''Select platform''' - необходимо выбрать платформу для которой будем собирать проект. При экспорте на все платформы необходимо установить Marmalade SDK [[Установка и настройка|см. инструкцию]] при этом не нужно указывать путь для экспорта (оставить поле пустым). В результате запустится скрипт сборки исполняемого пакета, это будет видно по черным экранам с ходом выполнения процесса сборки.Процесс экспорта будет отображаться в окне.

Таблица результирующих форматов для платформ
{| border="1"
|-
|качество, оптимизация
|IOS
|Android
|Windows Phone8
|BlackBerry
|Windows
|-
|Best, size
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|-
|Best, speed
|jxr
|jxr
|jxr
|jxr
|jxr
|-
|Medium, size
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Medium, speed
|PVRTC + jxr
|ETC1 + jxr
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|-
|Low, size
|PVRTC + png(a)
|ETC1 + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Low, speed
|PVRTC(RGBA) + hitmask
|ETC1 + PVRA8
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|}

*'''ETC''' - Ericsson Texture Compression : для устройств Android
*'''PVR''' - PowerVR Texture Compression : для устройств IOS
*'''bc3(dxt)''' - DirectX Texture : Windows, Windows Phone 8 

=== Режим отладки ===

Включение режима отладки:

[[Файл:SE debug0.JPG]]

Инструменты отладки:

[[Файл:SE debug1.JPG]]

* '''Debug dock''' - установка брейкпоинтов (точек остановки) и вывод отладочного лога от сервера.
* '''Logging''' - вывод логов вьювера (параллельно с viewer.log) с подсветкой и фильтрами.
* '''Debug Options''' - вывод дерева опций, подсветка изменений (при работе вьювера), слежение за конкретными параметрами.
* '''Debug Properties''' - вывод параметров объекта под курсором по хоткею (из вьювера) - на момент написания не реализовано.

==== Debug dock ====

[[Файл:SE debug2.JPG]]

Принцип работы брейкпоинтов (точек остановки):
* Добавляем в табличку брейкпоинтов новый пункт
* Задает objectID интересующего объекта
** Задаем название состояния, при переходе на которое вьювер станет на паузу
** ИЛИ задаем название параметра, при изменении которого вьювер станет на паузу
* Запускаем вьювер с отладкой
*: [[Файл:SE debug3.jpg]]
* После перехода в заданное состояние вьювер станет за паузу, а в редактре сцен откроется окно машинки с этим состоянием.

==== Logging ====

[[Файл:SE debug4.JPG]]

* Сие логирование происходит только с запущеным в режиме отладки вьювером;
* Логи с ворнингами выделены оранжевым цветом ('''не игнорируйте их''');
* Логи с ошибками выделены красным цветом ('''а их уж тем более не игнорируйте!''');
* Кнопка ''Clear log'' - очищает логи из данного окна;
* Кнопка ''(...)'' - открыть лог из файла
* Флаг ''Autoscroll'' - при добавлении новой записи листает список в конец

'''Фильтрация логов'''
* Фильтр задается для каждого поля отдельно;
* Можно фильтровать по нескольким полям одновременно;
* Для фильтрации по какому-либо полю просто нажмите на его заглавие (Level / Time / ...)
* '''Как правильно задавать фильтр''':
** ''[value]'' - поиск по полному совпадению - будут показаны только записи, текст которых в данном поле '''равен''' ''[value]''
**: [[Файл:SE debug log1.jpg]]
** ''[value]*'' - поиск по началу строки - будут показаны только те записи, текст которых в данном поле '''начинается с''' ''[value]''
**: [[Файл:SE debug log2.jpg]]
** ''*[value]'' - поиск по окончанию строки - будут показаны только те записи, текст которых в данном поле '''заканчивается на''' ''[value]''
**: [[Файл:SE debug log3.jpg]]
** ''*[value]*'' - поиск по вхождению - будут показаны только те записи, текст которых в данном поле '''содержит''' текст ''[value]''
**: [[Файл:SE debug log4.jpg]]
** ''![filter]'' - исключение - при добавлении знака '''!''' перед фильтром (любой его вариацией), будут показаны все записи, текст которых в данном поле '''НЕ''' подходит под фильтр.
**: [[Файл:SE debug log5.jpg]]
** ''[filter1]&[filter2]&[...]'' - фильтрация по нескольким критериям - будут показаны все записи, текст которых '''подходит хотя бы под один из фильтров'''
**: [[Файл:SE debug log6.jpg]]

==== Debug Options ====

Окно ''Debug options'' предназначено для отслеживания изменений опций в реальном времени.

[[Файл:SE debug6.JPG|right]]

* Кнопка '''Refresh''' - подгружает опции из файла options.xml
* ''Options update'':
** '''Manual update''' - обновление опций '''ТОЛЬКО''' в ручном режиме (кнопкой '''Refresh''')
** '''Auto Update''' - обновление опций вьювером - все записи, что меняет в опциях вьювер, будут обновлены (так же всё еще можно обновить вручную)
** '''Timer Update''' - обновление опций по таймеру - раз в заданный период автоматически обновляет опции из файла options.xml (команды вьювера игнорируются, все изменения берутся только из файла)
* Кнопка '''Save options''' - создает локальную копию текущего файла с опциями (в том же каталоге, где лежит options.xml)
* Кнопка '''Open options filder''' - открывает папку с опциями.

* '''All options''' - отображает все опции в виде дерева, показывает текущее значение параметров и предыдущее (если было изменено)
* '''Custom params''' - позволяет отслеживать изменений конкретных параметров; в поле ''Custom param tracking'' указывается тот же путь к параметру, что и в машинках:
*: [[Файл:SE debug7.JPG]]

=Горячие клавиши=
* '''Клавиша F10''' - По нажатию разворачивает/сворачивает все объекты и подобъекты в дереве проекта или в свойствах объекта.
* '''Клавиша Num* и Num-''' - По нажатию разворачивают/сворачивают подобъекты у выделенного объекта в дереве проекта или в свойствах объекта.

[[Category:AppSalute]]

Файл:SE debug7.JPG

2018-02-05T10:08:27Z

Bmor:

Файл:SE debug6.JPG

2018-02-05T10:02:25Z

Bmor:

Файл:SE debug5.JPG

2018-02-05T10:01:54Z

Bmor:

Файл:SE debug4.JPG

2018-02-05T10:01:20Z

Bmor:

Интерфейс ScenceEditor

2018-02-05T09:44:05Z

Bmor: /* Logging */

{{TOC right}}
== [[Файл:Ico_main.png]]Редактор сцен ==

'''Редактор сцен''' — программа, предназначенная для создания, редактирования и экспорта игровых экранов, в котором происходит настройка свойств объектов и игровой логики. 

'''Окно редактора сцен состоит из:'''
*меню редактора;
*рабочей области, в которой размещен объект сцена, на котором размещают другие объекты;
*панель Лэйаут, в которой размещено иерархическое дерево проекта, которое состоит из экранов, на которых находятся игровые объекты;
*панель Свойства, которая отображает свойства объекта, который выбран в дереве проекта;
*панель для построения сплайна;
*панель инструментов;
*строка Координаты, отображающая координаты курсора в текущий момент времени 

Для включения или отключения панели кликаем правой кнопкой мыши по серой области меню редактора и ставим галочку. Панели можно расположить на экране в любом порядке. 

[[Файл:Головна2.PNG|700px]]

=== Меню редактора ===

==== Project (Проект)====
меню, которое содержит список команд, с помощью которых можно создать новый или загрузить уже созданный проект, сохранить проект с указанием места сохранения и т.д.
*'''New project''' - создать новый проект;
*'''Open''' - открыть уже созданный проект (проект обязательно должен находится в подкаталоге редактора);
*'''Recent project...''' - показывает список последних открывавшихся проектов;
*'''Close''' - закрытие проекта (редактор при этом не закрывается);
*'''New project''' - создать новый проект;
*'''Save''' - сохранение проекта;
*'''Save as...''' - сохранение проекта под новым именем или в новом каталоге;
*'''Export...''' - экспорт проекта;
*'''Project options...''' - опции проекта;
*'''Exit''' - закрытие редактора.

==== Edit (Редактирование)====
меню редактирования проекта:
*'''Copy''' - копирование объекта;
*'''Paste into current object''' - вставка объекта в выбранный объект;
*'''Paste after current object''' - вставка объекта после выбранного объекта;
*'''Delete...''' - удаление объекта;
*'''Scale object''' - масштабирование выбранного объекта, если у него есть масштаб (scale x \ scale y);
*'''Rotate object''' - поворот выбранного объекта, если у него есть параметр поворота (angle);
*'''Modify vertex''' - изменение положения точек вертекса у выбранного объекта, если вертексы включены;
*'''Find object...''' - поиск объекта по id или по имени;
*'''Setup Editor...''' - настройки редактора.

[[Файл:SetupEditor.png|right|400px]]

1) Языки - выбор языка редактора.

2) Work mode - выбор режима работы.

3) Syles - выбор темы редактора.

4) Перемещение сцены мышью или клавишами клавиатуры - позволяет перемещать сцену на экране.

5) Рисовать сетку на экране - отображать сетку на экране или нет.

6) Utilities - Подключение утилит.

В редакторе есть возможность подключения утилит в форматах *.bat, *.exe, *.py, *.pyw, *.vbs.

Для примера, подключим bat-файл, открывающий логи вьвера в notepad++.

Для этого создадим файл Logs.bat со следущими командами:

cd C:\Users\<your-user>\AppData\Roaming\Absolutist\Viewer

start "C:\Program Files (x86)\Notepad++\notepad++.exe" "viewer.log"

В настройки редактора добавим утилиту нажав на плюсик. В списке ниже появится поле добавленной утилиты.

Нажмем на многоточие в столбце "Browse". В открывшимся окне "Open utility" откроем Logs.bat файл. После этого в меню редактора появится меню "Utilities" с командой Logs.

==== View (Просмотр)====
*'''Toggle grid''' - включает\выключает отображение сетки на сцене;
*'''open/hide comment''' - показывает\скрывает комментарии к объекту;
*'''Disable object movements''' - выключает\включает возможность перемещать объекты по сцене.

=== Viewer (Вьювер) ===
*'''Start Viewer''' - запуск вьювера;
*'''Start Viewer with changed time''' - запуск вьювера с заданным временем;
*'''Save and run viewer...''' - сохраняет проект и запускает вьювер;
*'''Run Viewer.bat''' - ???;
*'''Delete temp data''' - удаление опций;

====Layouts (Лейаут, Макеты)====
меню работа с лейаутами проекта (выбор макета устройства для проекта, редактирование экранов):
*'''Add new layout...''' - создание нового лейаута;
*'''Delete layout...''' - удаление лейаута;
*'''Layout settings...''' - настройки лейаута;
*'''Add folder...''' - создание папки в текущем лейаута;
*'''Add screen...''' - создание нового экрана.
==== Tools (Инструменты)====
меню дополнительных редакторов и инструментов для проекта (вызов редактора ресурсов, текстового редактора, анализ проекта). Список этого меню вынесен на панель с кнопками быстрого запуска:
*'''Resources Editor''' - редактор ресурсов;
*'''Texts Editor''' - текстовый редактор;
*'''Analyzer''' - анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов));
*'''Object info...''' - общие свойства объекта (показывает размер памяти занимаемой текстурами);
*'''Options info...''' - информация об опциях.

==== Help (Помощь)====
меню вызова справки.

=== Кнопки панели Инструменты ===
Некоторые инструменты также вызываются горячими клавишами (комбинация клавиш приведена в скобках )

[[Файл:00 6.png]] (Ctrl+N) — создать новый проект; 
[[Файл:00 7.png]](Ctrl+O) — загрузить уже созданный проект; 
[[Файл:00 8.png]](Ctrl+S) — сохранить изменения в проекте; 
[[Файл:00 9.png]] — запустить Viewer; 
[[Файл:009.JPG]] — нормальный вид; 
[[Файл:Ico_text.png|25px]] - вызов текстового редактора; 
[[Файл:Ico_base.png|25px]] — вызов редактора ресурсов; 
[[Файл:013.JPG]] — анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов)); 
[[Файл:014.JPG]]— поиск объекта по id или по имени. 

===Функции рабочей области===

'''1) Масштабирование рабочей области '''
Ctrl + колесико мышки крутим вперед - увеличиваем объекты , назад - уменьшаем объекты. 

'''2)Перемещение по рабочей области '''
После масштабирования возникает необходимость переместиться с левого уголка экрана в далекий правый, переместиться к выбраному обьекту, вверх или вниз. 

Кликаем правой кнопкой мыши по горизонтальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll left / right - функция перемещает экран на маленькое расстояние вправо / влево;
*left / right edge — функция перемещает экран в левый / правый угол экрана;
*page left / right - функция показывает левую/правую часть экрана 

Кликаем правой кнопкой мыши по вертикальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll up / down - функция перемещает экран на маленькое расстояние вверх / вниз;
*top/bottom - функция перемещает экран вверх / вниз;
*page up / down - функция перемещает экран верхнюю / нижнюю часть экрана. 

Меню прокрутки скрывается по нажатию клавиши Alt 

===Функции панели Лэйаут===
[[Файл:Лэйаут_1.JPG|right]]
При клике правой кнопкой мыши по выбранному лэйауту (см. рисунок справа)
*Создать папку в текущем объекте;
*Создать экран в текущем объекте - создание объекта в текущем лэйауте;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает / разворачивает дерево объектов всех экранов 

При клике правой кнопкой мыши по выбранному экрану, сцене или объекту возможно:
*Lock (Unlock) screen - золочивание (разлочивание) экрана: нельзя перемещать, удалять и изменять объекты (сцены) экрана, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых экранах в панели проекта появляется замочек;
*Lock (Unlock) scene - золочивание (разлочивание) сцены: нельзя перемещать, удалять и изменять объекты (машины, картинки и др.) сцены, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых сценах также появляется замочек;
*Создать сцену в текущем объекте - создание экран в текущем экране;
*Создать экран в текущем объекте - создание экран в текущем лэйауте;
*Создать объект сцены в текущем объекте - создание объекта в текущем объекте;
*Удалить объект - удаление объекта из проекта;
*Копировать объект — копирование объекта;
*Вставить в текущий объект — вставка объекта в текущий объект верхнего уровня ;
*Вставить как ссылку в текущий объект — вставка объекта в текущий объект для создания расшареной сцены;
*Вставить как ссылку после текущего объекта — вставка объекта после текущего объекта для создания расшареной сцены;
*Вставить после текущего объекта - вставка объекта после текущего объекта;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает /разворачивает дерево объектов экрана или сцены;

====Функция Расположить сцену в соответствии с изображением ====
Пусть на сцене будет находится очень много картинок, которые должны находиться в строго определенных местах. Переместим нашу картинку в нужную точку на сцене. Но у нас картинок очень много и мы потратим много времени на их расстановку. Для уменьшения времени на расстановку картинок воспользуемся функцией расположить сцену в соответствии с изображением. 
Функция расположить сцену в соответствии с изображением перемещает картинку в заданную точку художниками. Художник решил, что клумба должна быть в правом нижнем углу, после применения функции расположить сцену в соответствии с изображением, картинка станет именно на указанное художником место. 
Данная функция вызывается кликом правой кнопкой мыши по объекту [[Файл:панель_свойства_1.JPG|right]]

===Функции панели Свойства===

*При клике на тип или имя некоторых объектов вызываются дополнительные окна.Например, при клике на тип Machine открывается окно, где прописываются функции объекта типа Machine.
*При наведении на поле тип выпадет подсказка с уникальным номером объекта.
*При клике правой мышкой по названию свойства объекта выпадает меню с дополнительными свойствами объекта
*Некоторые свойства объектов объединены в группы (см. рисунок справа)

=== Создание проекта ===

1. Для создания нового игрового проекта необходимо запустить редактор сцен SceneEditor. 
2. В верхнем меню Проект выбрать Новый (т.е. создать новый проект). 
3. В появившемся окне указываем имя проекта и имя базы ресурсов.Выбираем папку для сохранения проекта 
4. В этом окне выбираем устройство для которого создаётся проект, а затем выбираем тип магазина и вариант версии игры 
[[Файл:020.JPG]] [[Файл:021.JPG]]

5. В редакторе сцен в меню Проект → Сохранить → проект с именем Learning. 
Эту методику действий можно брать за шаблон для создания других проектов. 
Результат: Создана база ресурсов и проект для выполнения Уроков.

====Важное замечание по созданию проекта====
[[Файл:2_лэйаута.JPG|right]] 
Предположим нам необходимо создать игру для магазина А и магазина Б. Игра будет отличаться только 10 функциями. Мы можем создать игру для магазина А., а потом скопировать папку с проектом, проект переименовать, внести изменения и получить игру для магазина Б. Результат: 2 игры и 2 папки с ресурсами. Такой подход не приветствуется. 
Для уменьшения времени на создание проекта, подключение ресурсов, внесения одинаковых объектов и удобства отслеживания багов и прочего в Редакторе Сцен существует возможность создания двух лэйаутов в одном проекте.
При создании проекта мы выбираем оба магазина, после чего в панели Лэйаут появится два лэйаута для магазина А и магазина Б(см. рисунок справа. При этом текстовая база проекта и база ресурсов у них будут идентичны. При создании новых объектов в одном лэйауте они же будут создаваться и в другом, при этом можно изменять свойства объекта каждого лэйаута независимо от второго. 
За применение изменений между лэйаутами отвечает параметр "синхронизация", который есть у каждого объекта. Если стоит "синхронизировать", то объект будет одинаков в каждом из лэйаутов. Если стоит "не синхронизировать", то объект будет уникальным для каждого экрана, его изменения не будут применены на других лэйаутах, не синхронизируемые объекты можно даже удалять, т.к. они уникальны для лэйаута.

===Экспорт проекта===

'''Этапы экспорта проекта'''
*Выполняется сжатие графики при необходимости
*Очистка базы ресурсов от неиспользуемой графики
*Запаковка графики в текстуры и контейнер
*При необходимости конвертирование файлов в pvr форматы 
С целью экономии оперативной памяти на устройстве возможно сжатие графики, упаковка графики в текстуры, создание нескольких исполняемых файлов, проекта, содержащих в себе несколько сцен проекта, и загружаемых в оперативную память устройства по мере прохождения игры. 

Процедура экспорта проекта вызывается через меню редактора Проект - Экспортировать проект 

[[Файл:Scene editor export window.jpg|right]]
'''Параметры экспорта проекта:''' 
''Настройки параметров графики''
*Ось Х, ось У — параметры сжатия графики по оси Х,У. Значения параметра от 0 до 1.
*При выполнении сжатия рекомендуется обращать внимания на размер лэйаута
*Сжатие графики возможно и непропорциональное . Используется редко

''Параметры запаковки графики''
*Common textures size - максимальный размер графической текстуры для графики, которая не находится в контейнерах и попадает в одну текстуру, или максимальный размер графического файла, если он не в контейнере и не попадает в текстуру.
*Create dat container - упаковка ресурсов в файл с типом DAT. Обеспечиваем защиту ресурсов проекта от несанкционированного доступа. Увеличиваем производительность при операциях чтения файлов ресурсов с твердотельного носителя.
*Quality - Качество графики, которая не находится в контейнерах
*Optimization - оптимизация графики для лучшего быстродействия(speed) или для занимаемого дискового пространства в распакованном виде(size)

''Тип экспорта''
*One project file - формируется один XML файл описывающий проект.
*Split project on screens, load partly' - проект будет разбит на отдельные файлы описывающие экраны, загружаться файлы будут в порядке использования (вызова) в проекте. В результате получаем увеличение начальной загрузки проекта и использование меньшего объема оперативной памяти.
*Release build - оптимизация по размеру файла базы ресурсов и основного файла проекта.

''Export to folder'' - Путь для экспорта. Если указан путь экспорта проекта - производится экспорт согласно настройкам для выбранной платформы. Если не указан - проект экспортируются под выбранную платформу и автоматически запускается сборка проекта.
Структура папки:
[[Файл:TreeFolder.png|TreeFolder.png]] 
'''Select platform''' - необходимо выбрать платформу для которой будем собирать проект. При экспорте на все платформы необходимо установить Marmalade SDK [[Установка и настройка|см. инструкцию]] при этом не нужно указывать путь для экспорта (оставить поле пустым). В результате запустится скрипт сборки исполняемого пакета, это будет видно по черным экранам с ходом выполнения процесса сборки.Процесс экспорта будет отображаться в окне.

Таблица результирующих форматов для платформ
{| border="1"
|-
|качество, оптимизация
|IOS
|Android
|Windows Phone8
|BlackBerry
|Windows
|-
|Best, size
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|-
|Best, speed
|jxr
|jxr
|jxr
|jxr
|jxr
|-
|Medium, size
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Medium, speed
|PVRTC + jxr
|ETC1 + jxr
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|-
|Low, size
|PVRTC + png(a)
|ETC1 + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Low, speed
|PVRTC(RGBA) + hitmask
|ETC1 + PVRA8
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|}

*'''ETC''' - Ericsson Texture Compression : для устройств Android
*'''PVR''' - PowerVR Texture Compression : для устройств IOS
*'''bc3(dxt)''' - DirectX Texture : Windows, Windows Phone 8 

=== Режим отладки ===

Включение режима отладки:

[[Файл:SE debug0.JPG]]

Инструменты отладки:

[[Файл:SE debug1.JPG]]

1) '''Debug dock''' - установка брейкпоинтов (точек остановки) и вывод отладочного лога от сервера.
2) '''Logging''' - вывод логов вьювера (параллельно с viewer.log) с подсветкой и фильтрами.
3) '''Debug Options''' - вывод дерева опций, подсветка изменений (при работе вьювера), слежение за конкретными параметрами.
4) '''Debug Properties''' - вывод параметров объекта под курсором по хоткею (из вьювера) - на момент написания не реализовано.

==== Debug dock ====

[[Файл:SE debug2.JPG]]

Принцип работы брейкпоинтов (точек остановки):
* Добавляем в табличку брейкпоинтов новый пункт
* Задает objectID интересующего объекта
** Задаем название состояния, при переходе на которое вьювер станет на паузу
** ИЛИ задаем название параметра, при изменении которого вьювер станет на паузу
* Запускаем вьювер с отладкой
*: [[Файл:SE debug3.jpg]]
* После перехода в заданное состояние вьювер станет за паузу, а в редактре сцен откроется окно машинки с этим состоянием.

==== Logging ====

Se_debug4

* Сие логирование происходит только с запущеным в режиме отладки вьювером;
* Логи с ворнингами выделены оранжевым цветом ('''не игнорируйте их''');
* Логи с ошибками выделены красным цветом ('''а их уж тем более не игнорируйте!''');
* Кнопка ''Clear log'' - очищает логи из данного окна;
* Кнопка ''(...)'' - открыть лог из файла
* Флаг ''Autoscroll'' - при добавлении новой записи листает список в конец

'''Фильтрация логов'''
* Фильтр задается для каждого поля отдельно;
* Можно фильтровать по нескольким полям одновременно;
* Для фильтрации по какому-либо полю просто нажмите на его заглавие (Level / Time / ...)
* '''Как правильно задавать фильтр''':
** ''[value]'' - поиск по полному совпадению - будут показаны только записи, текст которых в данном поле '''равен''' ''[value]''
**: [[Файл:SE debug log1.jpg]]
** ''[value]*'' - поиск по началу строки - будут показаны только те записи, текст которых в данном поле '''начинается с''' ''[value]''
**: [[Файл:SE debug log2.jpg]]
** ''*[value]'' - поиск по окончанию строки - будут показаны только те записи, текст которых в данном поле '''заканчивается на''' ''[value]''
**: [[Файл:SE debug log3.jpg]]
** ''*[value]*'' - поиск по вхождению - будут показаны только те записи, текст которых в данном поле '''содержит''' текст ''[value]''
**: [[Файл:SE debug log4.jpg]]
** ''![filter]'' - исключение - при добавлении знака '''!''' перед фильтром (любой его вариацией), будут показаны все записи, текст которых в данном поле '''НЕ''' подходит под фильтр.
**: [[Файл:SE debug log5.jpg]]
** ''[filter1]&[filter2]&[...]'' - фильтрация по нескольким критериям - будут показаны все записи, текст которых '''подходит хотя бы под один из фильтров'''
**: [[Файл:SE debug log6.jpg]]

=Горячие клавиши=
* '''Клавиша F10''' - По нажатию разворачивает/сворачивает все объекты и подобъекты в дереве проекта или в свойствах объекта.
* '''Клавиша Num* и Num-''' - По нажатию разворачивают/сворачивают подобъекты у выделенного объекта в дереве проекта или в свойствах объекта.

[[Category:AppSalute]]

Файл:SE debug log6.jpg

2018-02-05T09:43:37Z

Bmor:

Файл:SE debug log5.jpg

2018-02-05T09:43:23Z

Bmor:

Файл:SE debug log4.jpg

2018-02-05T09:42:57Z

Bmor:

Файл:SE debug log3.jpg

2018-02-05T09:42:42Z

Bmor:

Файл:SE debug log2.jpg

2018-02-05T09:42:26Z

Bmor:

Файл:SE debug log1.jpg

2018-02-05T09:42:08Z

Bmor:

Интерфейс ScenceEditor

2018-02-05T09:23:24Z

Bmor: /* Режим отладки */

{{TOC right}}
== [[Файл:Ico_main.png]]Редактор сцен ==

'''Редактор сцен''' — программа, предназначенная для создания, редактирования и экспорта игровых экранов, в котором происходит настройка свойств объектов и игровой логики. 

'''Окно редактора сцен состоит из:'''
*меню редактора;
*рабочей области, в которой размещен объект сцена, на котором размещают другие объекты;
*панель Лэйаут, в которой размещено иерархическое дерево проекта, которое состоит из экранов, на которых находятся игровые объекты;
*панель Свойства, которая отображает свойства объекта, который выбран в дереве проекта;
*панель для построения сплайна;
*панель инструментов;
*строка Координаты, отображающая координаты курсора в текущий момент времени 

Для включения или отключения панели кликаем правой кнопкой мыши по серой области меню редактора и ставим галочку. Панели можно расположить на экране в любом порядке. 

[[Файл:Головна2.PNG|700px]]

=== Меню редактора ===

==== Project (Проект)====
меню, которое содержит список команд, с помощью которых можно создать новый или загрузить уже созданный проект, сохранить проект с указанием места сохранения и т.д.
*'''New project''' - создать новый проект;
*'''Open''' - открыть уже созданный проект (проект обязательно должен находится в подкаталоге редактора);
*'''Recent project...''' - показывает список последних открывавшихся проектов;
*'''Close''' - закрытие проекта (редактор при этом не закрывается);
*'''New project''' - создать новый проект;
*'''Save''' - сохранение проекта;
*'''Save as...''' - сохранение проекта под новым именем или в новом каталоге;
*'''Export...''' - экспорт проекта;
*'''Project options...''' - опции проекта;
*'''Exit''' - закрытие редактора.

==== Edit (Редактирование)====
меню редактирования проекта:
*'''Copy''' - копирование объекта;
*'''Paste into current object''' - вставка объекта в выбранный объект;
*'''Paste after current object''' - вставка объекта после выбранного объекта;
*'''Delete...''' - удаление объекта;
*'''Scale object''' - масштабирование выбранного объекта, если у него есть масштаб (scale x \ scale y);
*'''Rotate object''' - поворот выбранного объекта, если у него есть параметр поворота (angle);
*'''Modify vertex''' - изменение положения точек вертекса у выбранного объекта, если вертексы включены;
*'''Find object...''' - поиск объекта по id или по имени;
*'''Setup Editor...''' - настройки редактора.

[[Файл:SetupEditor.png|right|400px]]

1) Языки - выбор языка редактора.

2) Work mode - выбор режима работы.

3) Syles - выбор темы редактора.

4) Перемещение сцены мышью или клавишами клавиатуры - позволяет перемещать сцену на экране.

5) Рисовать сетку на экране - отображать сетку на экране или нет.

6) Utilities - Подключение утилит.

В редакторе есть возможность подключения утилит в форматах *.bat, *.exe, *.py, *.pyw, *.vbs.

Для примера, подключим bat-файл, открывающий логи вьвера в notepad++.

Для этого создадим файл Logs.bat со следущими командами:

cd C:\Users\<your-user>\AppData\Roaming\Absolutist\Viewer

start "C:\Program Files (x86)\Notepad++\notepad++.exe" "viewer.log"

В настройки редактора добавим утилиту нажав на плюсик. В списке ниже появится поле добавленной утилиты.

Нажмем на многоточие в столбце "Browse". В открывшимся окне "Open utility" откроем Logs.bat файл. После этого в меню редактора появится меню "Utilities" с командой Logs.

==== View (Просмотр)====
*'''Toggle grid''' - включает\выключает отображение сетки на сцене;
*'''open/hide comment''' - показывает\скрывает комментарии к объекту;
*'''Disable object movements''' - выключает\включает возможность перемещать объекты по сцене.

=== Viewer (Вьювер) ===
*'''Start Viewer''' - запуск вьювера;
*'''Start Viewer with changed time''' - запуск вьювера с заданным временем;
*'''Save and run viewer...''' - сохраняет проект и запускает вьювер;
*'''Run Viewer.bat''' - ???;
*'''Delete temp data''' - удаление опций;

====Layouts (Лейаут, Макеты)====
меню работа с лейаутами проекта (выбор макета устройства для проекта, редактирование экранов):
*'''Add new layout...''' - создание нового лейаута;
*'''Delete layout...''' - удаление лейаута;
*'''Layout settings...''' - настройки лейаута;
*'''Add folder...''' - создание папки в текущем лейаута;
*'''Add screen...''' - создание нового экрана.
==== Tools (Инструменты)====
меню дополнительных редакторов и инструментов для проекта (вызов редактора ресурсов, текстового редактора, анализ проекта). Список этого меню вынесен на панель с кнопками быстрого запуска:
*'''Resources Editor''' - редактор ресурсов;
*'''Texts Editor''' - текстовый редактор;
*'''Analyzer''' - анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов));
*'''Object info...''' - общие свойства объекта (показывает размер памяти занимаемой текстурами);
*'''Options info...''' - информация об опциях.

==== Help (Помощь)====
меню вызова справки.

=== Кнопки панели Инструменты ===
Некоторые инструменты также вызываются горячими клавишами (комбинация клавиш приведена в скобках )

[[Файл:00 6.png]] (Ctrl+N) — создать новый проект; 
[[Файл:00 7.png]](Ctrl+O) — загрузить уже созданный проект; 
[[Файл:00 8.png]](Ctrl+S) — сохранить изменения в проекте; 
[[Файл:00 9.png]] — запустить Viewer; 
[[Файл:009.JPG]] — нормальный вид; 
[[Файл:Ico_text.png|25px]] - вызов текстового редактора; 
[[Файл:Ico_base.png|25px]] — вызов редактора ресурсов; 
[[Файл:013.JPG]] — анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов)); 
[[Файл:014.JPG]]— поиск объекта по id или по имени. 

===Функции рабочей области===

'''1) Масштабирование рабочей области '''
Ctrl + колесико мышки крутим вперед - увеличиваем объекты , назад - уменьшаем объекты. 

'''2)Перемещение по рабочей области '''
После масштабирования возникает необходимость переместиться с левого уголка экрана в далекий правый, переместиться к выбраному обьекту, вверх или вниз. 

Кликаем правой кнопкой мыши по горизонтальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll left / right - функция перемещает экран на маленькое расстояние вправо / влево;
*left / right edge — функция перемещает экран в левый / правый угол экрана;
*page left / right - функция показывает левую/правую часть экрана 

Кликаем правой кнопкой мыши по вертикальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll up / down - функция перемещает экран на маленькое расстояние вверх / вниз;
*top/bottom - функция перемещает экран вверх / вниз;
*page up / down - функция перемещает экран верхнюю / нижнюю часть экрана. 

Меню прокрутки скрывается по нажатию клавиши Alt 

===Функции панели Лэйаут===
[[Файл:Лэйаут_1.JPG|right]]
При клике правой кнопкой мыши по выбранному лэйауту (см. рисунок справа)
*Создать папку в текущем объекте;
*Создать экран в текущем объекте - создание объекта в текущем лэйауте;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает / разворачивает дерево объектов всех экранов 

При клике правой кнопкой мыши по выбранному экрану, сцене или объекту возможно:
*Lock (Unlock) screen - золочивание (разлочивание) экрана: нельзя перемещать, удалять и изменять объекты (сцены) экрана, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых экранах в панели проекта появляется замочек;
*Lock (Unlock) scene - золочивание (разлочивание) сцены: нельзя перемещать, удалять и изменять объекты (машины, картинки и др.) сцены, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых сценах также появляется замочек;
*Создать сцену в текущем объекте - создание экран в текущем экране;
*Создать экран в текущем объекте - создание экран в текущем лэйауте;
*Создать объект сцены в текущем объекте - создание объекта в текущем объекте;
*Удалить объект - удаление объекта из проекта;
*Копировать объект — копирование объекта;
*Вставить в текущий объект — вставка объекта в текущий объект верхнего уровня ;
*Вставить как ссылку в текущий объект — вставка объекта в текущий объект для создания расшареной сцены;
*Вставить как ссылку после текущего объекта — вставка объекта после текущего объекта для создания расшареной сцены;
*Вставить после текущего объекта - вставка объекта после текущего объекта;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает /разворачивает дерево объектов экрана или сцены;

====Функция Расположить сцену в соответствии с изображением ====
Пусть на сцене будет находится очень много картинок, которые должны находиться в строго определенных местах. Переместим нашу картинку в нужную точку на сцене. Но у нас картинок очень много и мы потратим много времени на их расстановку. Для уменьшения времени на расстановку картинок воспользуемся функцией расположить сцену в соответствии с изображением. 
Функция расположить сцену в соответствии с изображением перемещает картинку в заданную точку художниками. Художник решил, что клумба должна быть в правом нижнем углу, после применения функции расположить сцену в соответствии с изображением, картинка станет именно на указанное художником место. 
Данная функция вызывается кликом правой кнопкой мыши по объекту [[Файл:панель_свойства_1.JPG|right]]

===Функции панели Свойства===

*При клике на тип или имя некоторых объектов вызываются дополнительные окна.Например, при клике на тип Machine открывается окно, где прописываются функции объекта типа Machine.
*При наведении на поле тип выпадет подсказка с уникальным номером объекта.
*При клике правой мышкой по названию свойства объекта выпадает меню с дополнительными свойствами объекта
*Некоторые свойства объектов объединены в группы (см. рисунок справа)

=== Создание проекта ===

1. Для создания нового игрового проекта необходимо запустить редактор сцен SceneEditor. 
2. В верхнем меню Проект выбрать Новый (т.е. создать новый проект). 
3. В появившемся окне указываем имя проекта и имя базы ресурсов.Выбираем папку для сохранения проекта 
4. В этом окне выбираем устройство для которого создаётся проект, а затем выбираем тип магазина и вариант версии игры 
[[Файл:020.JPG]] [[Файл:021.JPG]]

5. В редакторе сцен в меню Проект → Сохранить → проект с именем Learning. 
Эту методику действий можно брать за шаблон для создания других проектов. 
Результат: Создана база ресурсов и проект для выполнения Уроков.

====Важное замечание по созданию проекта====
[[Файл:2_лэйаута.JPG|right]] 
Предположим нам необходимо создать игру для магазина А и магазина Б. Игра будет отличаться только 10 функциями. Мы можем создать игру для магазина А., а потом скопировать папку с проектом, проект переименовать, внести изменения и получить игру для магазина Б. Результат: 2 игры и 2 папки с ресурсами. Такой подход не приветствуется. 
Для уменьшения времени на создание проекта, подключение ресурсов, внесения одинаковых объектов и удобства отслеживания багов и прочего в Редакторе Сцен существует возможность создания двух лэйаутов в одном проекте.
При создании проекта мы выбираем оба магазина, после чего в панели Лэйаут появится два лэйаута для магазина А и магазина Б(см. рисунок справа. При этом текстовая база проекта и база ресурсов у них будут идентичны. При создании новых объектов в одном лэйауте они же будут создаваться и в другом, при этом можно изменять свойства объекта каждого лэйаута независимо от второго. 
За применение изменений между лэйаутами отвечает параметр "синхронизация", который есть у каждого объекта. Если стоит "синхронизировать", то объект будет одинаков в каждом из лэйаутов. Если стоит "не синхронизировать", то объект будет уникальным для каждого экрана, его изменения не будут применены на других лэйаутах, не синхронизируемые объекты можно даже удалять, т.к. они уникальны для лэйаута.

===Экспорт проекта===

'''Этапы экспорта проекта'''
*Выполняется сжатие графики при необходимости
*Очистка базы ресурсов от неиспользуемой графики
*Запаковка графики в текстуры и контейнер
*При необходимости конвертирование файлов в pvr форматы 
С целью экономии оперативной памяти на устройстве возможно сжатие графики, упаковка графики в текстуры, создание нескольких исполняемых файлов, проекта, содержащих в себе несколько сцен проекта, и загружаемых в оперативную память устройства по мере прохождения игры. 

Процедура экспорта проекта вызывается через меню редактора Проект - Экспортировать проект 

[[Файл:Scene editor export window.jpg|right]]
'''Параметры экспорта проекта:''' 
''Настройки параметров графики''
*Ось Х, ось У — параметры сжатия графики по оси Х,У. Значения параметра от 0 до 1.
*При выполнении сжатия рекомендуется обращать внимания на размер лэйаута
*Сжатие графики возможно и непропорциональное . Используется редко

''Параметры запаковки графики''
*Common textures size - максимальный размер графической текстуры для графики, которая не находится в контейнерах и попадает в одну текстуру, или максимальный размер графического файла, если он не в контейнере и не попадает в текстуру.
*Create dat container - упаковка ресурсов в файл с типом DAT. Обеспечиваем защиту ресурсов проекта от несанкционированного доступа. Увеличиваем производительность при операциях чтения файлов ресурсов с твердотельного носителя.
*Quality - Качество графики, которая не находится в контейнерах
*Optimization - оптимизация графики для лучшего быстродействия(speed) или для занимаемого дискового пространства в распакованном виде(size)

''Тип экспорта''
*One project file - формируется один XML файл описывающий проект.
*Split project on screens, load partly' - проект будет разбит на отдельные файлы описывающие экраны, загружаться файлы будут в порядке использования (вызова) в проекте. В результате получаем увеличение начальной загрузки проекта и использование меньшего объема оперативной памяти.
*Release build - оптимизация по размеру файла базы ресурсов и основного файла проекта.

''Export to folder'' - Путь для экспорта. Если указан путь экспорта проекта - производится экспорт согласно настройкам для выбранной платформы. Если не указан - проект экспортируются под выбранную платформу и автоматически запускается сборка проекта.
Структура папки:
[[Файл:TreeFolder.png|TreeFolder.png]] 
'''Select platform''' - необходимо выбрать платформу для которой будем собирать проект. При экспорте на все платформы необходимо установить Marmalade SDK [[Установка и настройка|см. инструкцию]] при этом не нужно указывать путь для экспорта (оставить поле пустым). В результате запустится скрипт сборки исполняемого пакета, это будет видно по черным экранам с ходом выполнения процесса сборки.Процесс экспорта будет отображаться в окне.

Таблица результирующих форматов для платформ
{| border="1"
|-
|качество, оптимизация
|IOS
|Android
|Windows Phone8
|BlackBerry
|Windows
|-
|Best, size
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|-
|Best, speed
|jxr
|jxr
|jxr
|jxr
|jxr
|-
|Medium, size
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Medium, speed
|PVRTC + jxr
|ETC1 + jxr
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|-
|Low, size
|PVRTC + png(a)
|ETC1 + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Low, speed
|PVRTC(RGBA) + hitmask
|ETC1 + PVRA8
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|}

*'''ETC''' - Ericsson Texture Compression : для устройств Android
*'''PVR''' - PowerVR Texture Compression : для устройств IOS
*'''bc3(dxt)''' - DirectX Texture : Windows, Windows Phone 8 

=== Режим отладки ===

Включение режима отладки:

[[Файл:SE debug0.JPG]]

Инструменты отладки:

[[Файл:SE debug1.JPG]]

1) '''Debug dock''' - установка брейкпоинтов (точек остановки) и вывод отладочного лога от сервера.
2) '''Logging''' - вывод логов вьювера (параллельно с viewer.log) с подсветкой и фильтрами.
3) '''Debug Options''' - вывод дерева опций, подсветка изменений (при работе вьювера), слежение за конкретными параметрами.
4) '''Debug Properties''' - вывод параметров объекта под курсором по хоткею (из вьювера) - на момент написания не реализовано.

==== Debug dock ====

[[Файл:SE debug2.JPG]]

Принцип работы брейкпоинтов (точек остановки):
* Добавляем в табличку брейкпоинтов новый пункт
* Задает objectID интересующего объекта
** Задаем название состояния, при переходе на которое вьювер станет на паузу
** ИЛИ задаем название параметра, при изменении которого вьювер станет на паузу
* Запускаем вьювер с отладкой
*: [[Файл:SE debug3.jpg]]
* После перехода в заданное состояние вьювер станет за паузу, а в редактре сцен откроется окно машинки с этим состоянием.

==== Logging ====

Se_debug4

* Сие логирование происходит только с запущеным в режиме отладки вьювером;
* Логи с ворнингами выделены оранжевым цветом ('''не игнорируйте их''');
* Логи с ошибками выделены красным цветом ('''а их уж тем более не игнорируйте!''');
* Кнопка ''Clear log'' - очищает логи из данного окна;
* Кнопка ''(...)'' - открыть лог из файла
* Флаг ''Autoscroll'' - при добавлении новой записи листает список в конец

'''Фильтрация логов'''
* Фильтр задается для каждого поля отдельно;
* Можно фильтровать по нескольким полям одновременно;
* Для фильтрации по какому-либо полю просто нажмите на его заглавие (Level / Time / ...)
* '''Как правильно задавать фильтр''':
** [value] - поиск по полному совпадению - будут показаны только записи, текст которых в данном поле '''равен''' [value]
**: IMAGE
** [value]* - поиск по началу строки - будут показаны только те записи, текст которых в данном поле '''начинается с''' [value]
**: IMAGE
** *[value] - поиск по окончанию строки - будут показаны только те записи, текст которых в данном поле '''заканчивается на''' [value]
**: IMAGE
** *[value]* - поиск по вхождению - будут показаны только те записи, текст которых в данном поле '''содержит''' текст [value]
**: IMAGE
** ![filter] - исключение - при добавлении знака '''!''' перед фильтром (любой его вариацией), будут показаны все записи, текст которых в данном поле '''НЕ''' подходит под фильтр.
**: IMAGE
** [filter1]&[filter2]&[...] - фильтрация по нескольким критериям - будут показаны все записи, текст которых '''подходит хотя бы под один из фильтров'''
**: IMAGE

=Горячие клавиши=
* '''Клавиша F10''' - По нажатию разворачивает/сворачивает все объекты и подобъекты в дереве проекта или в свойствах объекта.
* '''Клавиша Num* и Num-''' - По нажатию разворачивают/сворачивают подобъекты у выделенного объекта в дереве проекта или в свойствах объекта.

[[Category:AppSalute]]

Интерфейс ScenceEditor

2018-02-05T09:14:34Z

Bmor: /* Режим отладки */

{{TOC right}}
== [[Файл:Ico_main.png]]Редактор сцен ==

'''Редактор сцен''' — программа, предназначенная для создания, редактирования и экспорта игровых экранов, в котором происходит настройка свойств объектов и игровой логики. 

'''Окно редактора сцен состоит из:'''
*меню редактора;
*рабочей области, в которой размещен объект сцена, на котором размещают другие объекты;
*панель Лэйаут, в которой размещено иерархическое дерево проекта, которое состоит из экранов, на которых находятся игровые объекты;
*панель Свойства, которая отображает свойства объекта, который выбран в дереве проекта;
*панель для построения сплайна;
*панель инструментов;
*строка Координаты, отображающая координаты курсора в текущий момент времени 

Для включения или отключения панели кликаем правой кнопкой мыши по серой области меню редактора и ставим галочку. Панели можно расположить на экране в любом порядке. 

[[Файл:Головна2.PNG|700px]]

=== Меню редактора ===

==== Project (Проект)====
меню, которое содержит список команд, с помощью которых можно создать новый или загрузить уже созданный проект, сохранить проект с указанием места сохранения и т.д.
*'''New project''' - создать новый проект;
*'''Open''' - открыть уже созданный проект (проект обязательно должен находится в подкаталоге редактора);
*'''Recent project...''' - показывает список последних открывавшихся проектов;
*'''Close''' - закрытие проекта (редактор при этом не закрывается);
*'''New project''' - создать новый проект;
*'''Save''' - сохранение проекта;
*'''Save as...''' - сохранение проекта под новым именем или в новом каталоге;
*'''Export...''' - экспорт проекта;
*'''Project options...''' - опции проекта;
*'''Exit''' - закрытие редактора.

==== Edit (Редактирование)====
меню редактирования проекта:
*'''Copy''' - копирование объекта;
*'''Paste into current object''' - вставка объекта в выбранный объект;
*'''Paste after current object''' - вставка объекта после выбранного объекта;
*'''Delete...''' - удаление объекта;
*'''Scale object''' - масштабирование выбранного объекта, если у него есть масштаб (scale x \ scale y);
*'''Rotate object''' - поворот выбранного объекта, если у него есть параметр поворота (angle);
*'''Modify vertex''' - изменение положения точек вертекса у выбранного объекта, если вертексы включены;
*'''Find object...''' - поиск объекта по id или по имени;
*'''Setup Editor...''' - настройки редактора.

[[Файл:SetupEditor.png|right|400px]]

1) Языки - выбор языка редактора.

2) Work mode - выбор режима работы.

3) Syles - выбор темы редактора.

4) Перемещение сцены мышью или клавишами клавиатуры - позволяет перемещать сцену на экране.

5) Рисовать сетку на экране - отображать сетку на экране или нет.

6) Utilities - Подключение утилит.

В редакторе есть возможность подключения утилит в форматах *.bat, *.exe, *.py, *.pyw, *.vbs.

Для примера, подключим bat-файл, открывающий логи вьвера в notepad++.

Для этого создадим файл Logs.bat со следущими командами:

cd C:\Users\<your-user>\AppData\Roaming\Absolutist\Viewer

start "C:\Program Files (x86)\Notepad++\notepad++.exe" "viewer.log"

В настройки редактора добавим утилиту нажав на плюсик. В списке ниже появится поле добавленной утилиты.

Нажмем на многоточие в столбце "Browse". В открывшимся окне "Open utility" откроем Logs.bat файл. После этого в меню редактора появится меню "Utilities" с командой Logs.

==== View (Просмотр)====
*'''Toggle grid''' - включает\выключает отображение сетки на сцене;
*'''open/hide comment''' - показывает\скрывает комментарии к объекту;
*'''Disable object movements''' - выключает\включает возможность перемещать объекты по сцене.

=== Viewer (Вьювер) ===
*'''Start Viewer''' - запуск вьювера;
*'''Start Viewer with changed time''' - запуск вьювера с заданным временем;
*'''Save and run viewer...''' - сохраняет проект и запускает вьювер;
*'''Run Viewer.bat''' - ???;
*'''Delete temp data''' - удаление опций;

====Layouts (Лейаут, Макеты)====
меню работа с лейаутами проекта (выбор макета устройства для проекта, редактирование экранов):
*'''Add new layout...''' - создание нового лейаута;
*'''Delete layout...''' - удаление лейаута;
*'''Layout settings...''' - настройки лейаута;
*'''Add folder...''' - создание папки в текущем лейаута;
*'''Add screen...''' - создание нового экрана.
==== Tools (Инструменты)====
меню дополнительных редакторов и инструментов для проекта (вызов редактора ресурсов, текстового редактора, анализ проекта). Список этого меню вынесен на панель с кнопками быстрого запуска:
*'''Resources Editor''' - редактор ресурсов;
*'''Texts Editor''' - текстовый редактор;
*'''Analyzer''' - анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов));
*'''Object info...''' - общие свойства объекта (показывает размер памяти занимаемой текстурами);
*'''Options info...''' - информация об опциях.

==== Help (Помощь)====
меню вызова справки.

=== Кнопки панели Инструменты ===
Некоторые инструменты также вызываются горячими клавишами (комбинация клавиш приведена в скобках )

[[Файл:00 6.png]] (Ctrl+N) — создать новый проект; 
[[Файл:00 7.png]](Ctrl+O) — загрузить уже созданный проект; 
[[Файл:00 8.png]](Ctrl+S) — сохранить изменения в проекте; 
[[Файл:00 9.png]] — запустить Viewer; 
[[Файл:009.JPG]] — нормальный вид; 
[[Файл:Ico_text.png|25px]] - вызов текстового редактора; 
[[Файл:Ico_base.png|25px]] — вызов редактора ресурсов; 
[[Файл:013.JPG]] — анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов)); 
[[Файл:014.JPG]]— поиск объекта по id или по имени. 

===Функции рабочей области===

'''1) Масштабирование рабочей области '''
Ctrl + колесико мышки крутим вперед - увеличиваем объекты , назад - уменьшаем объекты. 

'''2)Перемещение по рабочей области '''
После масштабирования возникает необходимость переместиться с левого уголка экрана в далекий правый, переместиться к выбраному обьекту, вверх или вниз. 

Кликаем правой кнопкой мыши по горизонтальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll left / right - функция перемещает экран на маленькое расстояние вправо / влево;
*left / right edge — функция перемещает экран в левый / правый угол экрана;
*page left / right - функция показывает левую/правую часть экрана 

Кликаем правой кнопкой мыши по вертикальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll up / down - функция перемещает экран на маленькое расстояние вверх / вниз;
*top/bottom - функция перемещает экран вверх / вниз;
*page up / down - функция перемещает экран верхнюю / нижнюю часть экрана. 

Меню прокрутки скрывается по нажатию клавиши Alt 

===Функции панели Лэйаут===
[[Файл:Лэйаут_1.JPG|right]]
При клике правой кнопкой мыши по выбранному лэйауту (см. рисунок справа)
*Создать папку в текущем объекте;
*Создать экран в текущем объекте - создание объекта в текущем лэйауте;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает / разворачивает дерево объектов всех экранов 

При клике правой кнопкой мыши по выбранному экрану, сцене или объекту возможно:
*Lock (Unlock) screen - золочивание (разлочивание) экрана: нельзя перемещать, удалять и изменять объекты (сцены) экрана, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых экранах в панели проекта появляется замочек;
*Lock (Unlock) scene - золочивание (разлочивание) сцены: нельзя перемещать, удалять и изменять объекты (машины, картинки и др.) сцены, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых сценах также появляется замочек;
*Создать сцену в текущем объекте - создание экран в текущем экране;
*Создать экран в текущем объекте - создание экран в текущем лэйауте;
*Создать объект сцены в текущем объекте - создание объекта в текущем объекте;
*Удалить объект - удаление объекта из проекта;
*Копировать объект — копирование объекта;
*Вставить в текущий объект — вставка объекта в текущий объект верхнего уровня ;
*Вставить как ссылку в текущий объект — вставка объекта в текущий объект для создания расшареной сцены;
*Вставить как ссылку после текущего объекта — вставка объекта после текущего объекта для создания расшареной сцены;
*Вставить после текущего объекта - вставка объекта после текущего объекта;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает /разворачивает дерево объектов экрана или сцены;

====Функция Расположить сцену в соответствии с изображением ====
Пусть на сцене будет находится очень много картинок, которые должны находиться в строго определенных местах. Переместим нашу картинку в нужную точку на сцене. Но у нас картинок очень много и мы потратим много времени на их расстановку. Для уменьшения времени на расстановку картинок воспользуемся функцией расположить сцену в соответствии с изображением. 
Функция расположить сцену в соответствии с изображением перемещает картинку в заданную точку художниками. Художник решил, что клумба должна быть в правом нижнем углу, после применения функции расположить сцену в соответствии с изображением, картинка станет именно на указанное художником место. 
Данная функция вызывается кликом правой кнопкой мыши по объекту [[Файл:панель_свойства_1.JPG|right]]

===Функции панели Свойства===

*При клике на тип или имя некоторых объектов вызываются дополнительные окна.Например, при клике на тип Machine открывается окно, где прописываются функции объекта типа Machine.
*При наведении на поле тип выпадет подсказка с уникальным номером объекта.
*При клике правой мышкой по названию свойства объекта выпадает меню с дополнительными свойствами объекта
*Некоторые свойства объектов объединены в группы (см. рисунок справа)

=== Создание проекта ===

1. Для создания нового игрового проекта необходимо запустить редактор сцен SceneEditor. 
2. В верхнем меню Проект выбрать Новый (т.е. создать новый проект). 
3. В появившемся окне указываем имя проекта и имя базы ресурсов.Выбираем папку для сохранения проекта 
4. В этом окне выбираем устройство для которого создаётся проект, а затем выбираем тип магазина и вариант версии игры 
[[Файл:020.JPG]] [[Файл:021.JPG]]

5. В редакторе сцен в меню Проект → Сохранить → проект с именем Learning. 
Эту методику действий можно брать за шаблон для создания других проектов. 
Результат: Создана база ресурсов и проект для выполнения Уроков.

====Важное замечание по созданию проекта====
[[Файл:2_лэйаута.JPG|right]] 
Предположим нам необходимо создать игру для магазина А и магазина Б. Игра будет отличаться только 10 функциями. Мы можем создать игру для магазина А., а потом скопировать папку с проектом, проект переименовать, внести изменения и получить игру для магазина Б. Результат: 2 игры и 2 папки с ресурсами. Такой подход не приветствуется. 
Для уменьшения времени на создание проекта, подключение ресурсов, внесения одинаковых объектов и удобства отслеживания багов и прочего в Редакторе Сцен существует возможность создания двух лэйаутов в одном проекте.
При создании проекта мы выбираем оба магазина, после чего в панели Лэйаут появится два лэйаута для магазина А и магазина Б(см. рисунок справа. При этом текстовая база проекта и база ресурсов у них будут идентичны. При создании новых объектов в одном лэйауте они же будут создаваться и в другом, при этом можно изменять свойства объекта каждого лэйаута независимо от второго. 
За применение изменений между лэйаутами отвечает параметр "синхронизация", который есть у каждого объекта. Если стоит "синхронизировать", то объект будет одинаков в каждом из лэйаутов. Если стоит "не синхронизировать", то объект будет уникальным для каждого экрана, его изменения не будут применены на других лэйаутах, не синхронизируемые объекты можно даже удалять, т.к. они уникальны для лэйаута.

===Экспорт проекта===

'''Этапы экспорта проекта'''
*Выполняется сжатие графики при необходимости
*Очистка базы ресурсов от неиспользуемой графики
*Запаковка графики в текстуры и контейнер
*При необходимости конвертирование файлов в pvr форматы 
С целью экономии оперативной памяти на устройстве возможно сжатие графики, упаковка графики в текстуры, создание нескольких исполняемых файлов, проекта, содержащих в себе несколько сцен проекта, и загружаемых в оперативную память устройства по мере прохождения игры. 

Процедура экспорта проекта вызывается через меню редактора Проект - Экспортировать проект 

[[Файл:Scene editor export window.jpg|right]]
'''Параметры экспорта проекта:''' 
''Настройки параметров графики''
*Ось Х, ось У — параметры сжатия графики по оси Х,У. Значения параметра от 0 до 1.
*При выполнении сжатия рекомендуется обращать внимания на размер лэйаута
*Сжатие графики возможно и непропорциональное . Используется редко

''Параметры запаковки графики''
*Common textures size - максимальный размер графической текстуры для графики, которая не находится в контейнерах и попадает в одну текстуру, или максимальный размер графического файла, если он не в контейнере и не попадает в текстуру.
*Create dat container - упаковка ресурсов в файл с типом DAT. Обеспечиваем защиту ресурсов проекта от несанкционированного доступа. Увеличиваем производительность при операциях чтения файлов ресурсов с твердотельного носителя.
*Quality - Качество графики, которая не находится в контейнерах
*Optimization - оптимизация графики для лучшего быстродействия(speed) или для занимаемого дискового пространства в распакованном виде(size)

''Тип экспорта''
*One project file - формируется один XML файл описывающий проект.
*Split project on screens, load partly' - проект будет разбит на отдельные файлы описывающие экраны, загружаться файлы будут в порядке использования (вызова) в проекте. В результате получаем увеличение начальной загрузки проекта и использование меньшего объема оперативной памяти.
*Release build - оптимизация по размеру файла базы ресурсов и основного файла проекта.

''Export to folder'' - Путь для экспорта. Если указан путь экспорта проекта - производится экспорт согласно настройкам для выбранной платформы. Если не указан - проект экспортируются под выбранную платформу и автоматически запускается сборка проекта.
Структура папки:
[[Файл:TreeFolder.png|TreeFolder.png]] 
'''Select platform''' - необходимо выбрать платформу для которой будем собирать проект. При экспорте на все платформы необходимо установить Marmalade SDK [[Установка и настройка|см. инструкцию]] при этом не нужно указывать путь для экспорта (оставить поле пустым). В результате запустится скрипт сборки исполняемого пакета, это будет видно по черным экранам с ходом выполнения процесса сборки.Процесс экспорта будет отображаться в окне.

Таблица результирующих форматов для платформ
{| border="1"
|-
|качество, оптимизация
|IOS
|Android
|Windows Phone8
|BlackBerry
|Windows
|-
|Best, size
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|-
|Best, speed
|jxr
|jxr
|jxr
|jxr
|jxr
|-
|Medium, size
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Medium, speed
|PVRTC + jxr
|ETC1 + jxr
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|-
|Low, size
|PVRTC + png(a)
|ETC1 + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Low, speed
|PVRTC(RGBA) + hitmask
|ETC1 + PVRA8
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|}

*'''ETC''' - Ericsson Texture Compression : для устройств Android
*'''PVR''' - PowerVR Texture Compression : для устройств IOS
*'''bc3(dxt)''' - DirectX Texture : Windows, Windows Phone 8 

=== Режим отладки ===

Включение режима отладки:

[[Файл:SE debug0.JPG]]

Инструменты отладки:

[[Файл:SE debug1.JPG]]

1) '''Debug dock''' - установка брейкпоинтов (точек остановки) и вывод отладочного лога от сервера.
2) '''Logging''' - вывод логов вьювера (параллельно с viewer.log) с подсветкой и фильтрами.
3) '''Debug Options''' - вывод дерева опций, подсветка изменений (при работе вьювера), слежение за конкретными параметрами.
4) '''Debug Properties''' - вывод параметров объекта под курсором по хоткею (из вьювера) - на момент написания не реализовано.

==== Debug dock ====

[[Файл:SE debug2.JPG]]

Принцип работы брейкпоинтов (точек остановки):
* Добавляем в табличку брейкпоинтов новый пункт
* Задает objectID интересующего объекта
** Задаем название состояния, при переходе на которое вьювер станет на паузу
** ИЛИ задаем название параметра, при изменении которого вьювер станет на паузу
* Запускаем вьювер с отладкой
*: [[Файл:SE debug3.jpg]]
* После перехода в заданное состояние вьювер станет за паузу, а в редактре сцен откроется окно машинки с этим состоянием.

==== Logging ====

Se_debug4

* Сие логирование происходит только с запущеным в режиме отладки вьювером;
* Логи с ворнингами выделены оранжевым цветом ('''не игнорируйте их''');
* Логи с ошибками выделены красным цветом ('''а их уж тем более не игнорируйте!''');
* Кнопка ''Clear log'' - очищает логи из данного окна;
* Кнопка ''(...)'' - открыть лог из файла
* Флаг ''Autoscroll'' - при добавлении новой записи листает список в конец

'''Фильтрация логов'''
* Фильтр задается для каждого поля отдельно;
* Можно фильтровать по нескольким полям одновременно;
* Для фильтрации по какому-либо полю просто нажмите на его заглавие (Level / Time / ...)
* '''Как правильно задавать фильтр''':
**

=Горячие клавиши=
* '''Клавиша F10''' - По нажатию разворачивает/сворачивает все объекты и подобъекты в дереве проекта или в свойствах объекта.
* '''Клавиша Num* и Num-''' - По нажатию разворачивают/сворачивают подобъекты у выделенного объекта в дереве проекта или в свойствах объекта.

[[Category:AppSalute]]

Интерфейс ScenceEditor

2018-02-05T09:06:38Z

Bmor: /* Режим отладки */

{{TOC right}}
== [[Файл:Ico_main.png]]Редактор сцен ==

'''Редактор сцен''' — программа, предназначенная для создания, редактирования и экспорта игровых экранов, в котором происходит настройка свойств объектов и игровой логики. 

'''Окно редактора сцен состоит из:'''
*меню редактора;
*рабочей области, в которой размещен объект сцена, на котором размещают другие объекты;
*панель Лэйаут, в которой размещено иерархическое дерево проекта, которое состоит из экранов, на которых находятся игровые объекты;
*панель Свойства, которая отображает свойства объекта, который выбран в дереве проекта;
*панель для построения сплайна;
*панель инструментов;
*строка Координаты, отображающая координаты курсора в текущий момент времени 

Для включения или отключения панели кликаем правой кнопкой мыши по серой области меню редактора и ставим галочку. Панели можно расположить на экране в любом порядке. 

[[Файл:Головна2.PNG|700px]]

=== Меню редактора ===

==== Project (Проект)====
меню, которое содержит список команд, с помощью которых можно создать новый или загрузить уже созданный проект, сохранить проект с указанием места сохранения и т.д.
*'''New project''' - создать новый проект;
*'''Open''' - открыть уже созданный проект (проект обязательно должен находится в подкаталоге редактора);
*'''Recent project...''' - показывает список последних открывавшихся проектов;
*'''Close''' - закрытие проекта (редактор при этом не закрывается);
*'''New project''' - создать новый проект;
*'''Save''' - сохранение проекта;
*'''Save as...''' - сохранение проекта под новым именем или в новом каталоге;
*'''Export...''' - экспорт проекта;
*'''Project options...''' - опции проекта;
*'''Exit''' - закрытие редактора.

==== Edit (Редактирование)====
меню редактирования проекта:
*'''Copy''' - копирование объекта;
*'''Paste into current object''' - вставка объекта в выбранный объект;
*'''Paste after current object''' - вставка объекта после выбранного объекта;
*'''Delete...''' - удаление объекта;
*'''Scale object''' - масштабирование выбранного объекта, если у него есть масштаб (scale x \ scale y);
*'''Rotate object''' - поворот выбранного объекта, если у него есть параметр поворота (angle);
*'''Modify vertex''' - изменение положения точек вертекса у выбранного объекта, если вертексы включены;
*'''Find object...''' - поиск объекта по id или по имени;
*'''Setup Editor...''' - настройки редактора.

[[Файл:SetupEditor.png|right|400px]]

1) Языки - выбор языка редактора.

2) Work mode - выбор режима работы.

3) Syles - выбор темы редактора.

4) Перемещение сцены мышью или клавишами клавиатуры - позволяет перемещать сцену на экране.

5) Рисовать сетку на экране - отображать сетку на экране или нет.

6) Utilities - Подключение утилит.

В редакторе есть возможность подключения утилит в форматах *.bat, *.exe, *.py, *.pyw, *.vbs.

Для примера, подключим bat-файл, открывающий логи вьвера в notepad++.

Для этого создадим файл Logs.bat со следущими командами:

cd C:\Users\<your-user>\AppData\Roaming\Absolutist\Viewer

start "C:\Program Files (x86)\Notepad++\notepad++.exe" "viewer.log"

В настройки редактора добавим утилиту нажав на плюсик. В списке ниже появится поле добавленной утилиты.

Нажмем на многоточие в столбце "Browse". В открывшимся окне "Open utility" откроем Logs.bat файл. После этого в меню редактора появится меню "Utilities" с командой Logs.

==== View (Просмотр)====
*'''Toggle grid''' - включает\выключает отображение сетки на сцене;
*'''open/hide comment''' - показывает\скрывает комментарии к объекту;
*'''Disable object movements''' - выключает\включает возможность перемещать объекты по сцене.

=== Viewer (Вьювер) ===
*'''Start Viewer''' - запуск вьювера;
*'''Start Viewer with changed time''' - запуск вьювера с заданным временем;
*'''Save and run viewer...''' - сохраняет проект и запускает вьювер;
*'''Run Viewer.bat''' - ???;
*'''Delete temp data''' - удаление опций;

====Layouts (Лейаут, Макеты)====
меню работа с лейаутами проекта (выбор макета устройства для проекта, редактирование экранов):
*'''Add new layout...''' - создание нового лейаута;
*'''Delete layout...''' - удаление лейаута;
*'''Layout settings...''' - настройки лейаута;
*'''Add folder...''' - создание папки в текущем лейаута;
*'''Add screen...''' - создание нового экрана.
==== Tools (Инструменты)====
меню дополнительных редакторов и инструментов для проекта (вызов редактора ресурсов, текстового редактора, анализ проекта). Список этого меню вынесен на панель с кнопками быстрого запуска:
*'''Resources Editor''' - редактор ресурсов;
*'''Texts Editor''' - текстовый редактор;
*'''Analyzer''' - анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов));
*'''Object info...''' - общие свойства объекта (показывает размер памяти занимаемой текстурами);
*'''Options info...''' - информация об опциях.

==== Help (Помощь)====
меню вызова справки.

=== Кнопки панели Инструменты ===
Некоторые инструменты также вызываются горячими клавишами (комбинация клавиш приведена в скобках )

[[Файл:00 6.png]] (Ctrl+N) — создать новый проект; 
[[Файл:00 7.png]](Ctrl+O) — загрузить уже созданный проект; 
[[Файл:00 8.png]](Ctrl+S) — сохранить изменения в проекте; 
[[Файл:00 9.png]] — запустить Viewer; 
[[Файл:009.JPG]] — нормальный вид; 
[[Файл:Ico_text.png|25px]] - вызов текстового редактора; 
[[Файл:Ico_base.png|25px]] — вызов редактора ресурсов; 
[[Файл:013.JPG]] — анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов)); 
[[Файл:014.JPG]]— поиск объекта по id или по имени. 

===Функции рабочей области===

'''1) Масштабирование рабочей области '''
Ctrl + колесико мышки крутим вперед - увеличиваем объекты , назад - уменьшаем объекты. 

'''2)Перемещение по рабочей области '''
После масштабирования возникает необходимость переместиться с левого уголка экрана в далекий правый, переместиться к выбраному обьекту, вверх или вниз. 

Кликаем правой кнопкой мыши по горизонтальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll left / right - функция перемещает экран на маленькое расстояние вправо / влево;
*left / right edge — функция перемещает экран в левый / правый угол экрана;
*page left / right - функция показывает левую/правую часть экрана 

Кликаем правой кнопкой мыши по вертикальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll up / down - функция перемещает экран на маленькое расстояние вверх / вниз;
*top/bottom - функция перемещает экран вверх / вниз;
*page up / down - функция перемещает экран верхнюю / нижнюю часть экрана. 

Меню прокрутки скрывается по нажатию клавиши Alt 

===Функции панели Лэйаут===
[[Файл:Лэйаут_1.JPG|right]]
При клике правой кнопкой мыши по выбранному лэйауту (см. рисунок справа)
*Создать папку в текущем объекте;
*Создать экран в текущем объекте - создание объекта в текущем лэйауте;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает / разворачивает дерево объектов всех экранов 

При клике правой кнопкой мыши по выбранному экрану, сцене или объекту возможно:
*Lock (Unlock) screen - золочивание (разлочивание) экрана: нельзя перемещать, удалять и изменять объекты (сцены) экрана, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых экранах в панели проекта появляется замочек;
*Lock (Unlock) scene - золочивание (разлочивание) сцены: нельзя перемещать, удалять и изменять объекты (машины, картинки и др.) сцены, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых сценах также появляется замочек;
*Создать сцену в текущем объекте - создание экран в текущем экране;
*Создать экран в текущем объекте - создание экран в текущем лэйауте;
*Создать объект сцены в текущем объекте - создание объекта в текущем объекте;
*Удалить объект - удаление объекта из проекта;
*Копировать объект — копирование объекта;
*Вставить в текущий объект — вставка объекта в текущий объект верхнего уровня ;
*Вставить как ссылку в текущий объект — вставка объекта в текущий объект для создания расшареной сцены;
*Вставить как ссылку после текущего объекта — вставка объекта после текущего объекта для создания расшареной сцены;
*Вставить после текущего объекта - вставка объекта после текущего объекта;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает /разворачивает дерево объектов экрана или сцены;

====Функция Расположить сцену в соответствии с изображением ====
Пусть на сцене будет находится очень много картинок, которые должны находиться в строго определенных местах. Переместим нашу картинку в нужную точку на сцене. Но у нас картинок очень много и мы потратим много времени на их расстановку. Для уменьшения времени на расстановку картинок воспользуемся функцией расположить сцену в соответствии с изображением. 
Функция расположить сцену в соответствии с изображением перемещает картинку в заданную точку художниками. Художник решил, что клумба должна быть в правом нижнем углу, после применения функции расположить сцену в соответствии с изображением, картинка станет именно на указанное художником место. 
Данная функция вызывается кликом правой кнопкой мыши по объекту [[Файл:панель_свойства_1.JPG|right]]

===Функции панели Свойства===

*При клике на тип или имя некоторых объектов вызываются дополнительные окна.Например, при клике на тип Machine открывается окно, где прописываются функции объекта типа Machine.
*При наведении на поле тип выпадет подсказка с уникальным номером объекта.
*При клике правой мышкой по названию свойства объекта выпадает меню с дополнительными свойствами объекта
*Некоторые свойства объектов объединены в группы (см. рисунок справа)

=== Создание проекта ===

1. Для создания нового игрового проекта необходимо запустить редактор сцен SceneEditor. 
2. В верхнем меню Проект выбрать Новый (т.е. создать новый проект). 
3. В появившемся окне указываем имя проекта и имя базы ресурсов.Выбираем папку для сохранения проекта 
4. В этом окне выбираем устройство для которого создаётся проект, а затем выбираем тип магазина и вариант версии игры 
[[Файл:020.JPG]] [[Файл:021.JPG]]

5. В редакторе сцен в меню Проект → Сохранить → проект с именем Learning. 
Эту методику действий можно брать за шаблон для создания других проектов. 
Результат: Создана база ресурсов и проект для выполнения Уроков.

====Важное замечание по созданию проекта====
[[Файл:2_лэйаута.JPG|right]] 
Предположим нам необходимо создать игру для магазина А и магазина Б. Игра будет отличаться только 10 функциями. Мы можем создать игру для магазина А., а потом скопировать папку с проектом, проект переименовать, внести изменения и получить игру для магазина Б. Результат: 2 игры и 2 папки с ресурсами. Такой подход не приветствуется. 
Для уменьшения времени на создание проекта, подключение ресурсов, внесения одинаковых объектов и удобства отслеживания багов и прочего в Редакторе Сцен существует возможность создания двух лэйаутов в одном проекте.
При создании проекта мы выбираем оба магазина, после чего в панели Лэйаут появится два лэйаута для магазина А и магазина Б(см. рисунок справа. При этом текстовая база проекта и база ресурсов у них будут идентичны. При создании новых объектов в одном лэйауте они же будут создаваться и в другом, при этом можно изменять свойства объекта каждого лэйаута независимо от второго. 
За применение изменений между лэйаутами отвечает параметр "синхронизация", который есть у каждого объекта. Если стоит "синхронизировать", то объект будет одинаков в каждом из лэйаутов. Если стоит "не синхронизировать", то объект будет уникальным для каждого экрана, его изменения не будут применены на других лэйаутах, не синхронизируемые объекты можно даже удалять, т.к. они уникальны для лэйаута.

===Экспорт проекта===

'''Этапы экспорта проекта'''
*Выполняется сжатие графики при необходимости
*Очистка базы ресурсов от неиспользуемой графики
*Запаковка графики в текстуры и контейнер
*При необходимости конвертирование файлов в pvr форматы 
С целью экономии оперативной памяти на устройстве возможно сжатие графики, упаковка графики в текстуры, создание нескольких исполняемых файлов, проекта, содержащих в себе несколько сцен проекта, и загружаемых в оперативную память устройства по мере прохождения игры. 

Процедура экспорта проекта вызывается через меню редактора Проект - Экспортировать проект 

[[Файл:Scene editor export window.jpg|right]]
'''Параметры экспорта проекта:''' 
''Настройки параметров графики''
*Ось Х, ось У — параметры сжатия графики по оси Х,У. Значения параметра от 0 до 1.
*При выполнении сжатия рекомендуется обращать внимания на размер лэйаута
*Сжатие графики возможно и непропорциональное . Используется редко

''Параметры запаковки графики''
*Common textures size - максимальный размер графической текстуры для графики, которая не находится в контейнерах и попадает в одну текстуру, или максимальный размер графического файла, если он не в контейнере и не попадает в текстуру.
*Create dat container - упаковка ресурсов в файл с типом DAT. Обеспечиваем защиту ресурсов проекта от несанкционированного доступа. Увеличиваем производительность при операциях чтения файлов ресурсов с твердотельного носителя.
*Quality - Качество графики, которая не находится в контейнерах
*Optimization - оптимизация графики для лучшего быстродействия(speed) или для занимаемого дискового пространства в распакованном виде(size)

''Тип экспорта''
*One project file - формируется один XML файл описывающий проект.
*Split project on screens, load partly' - проект будет разбит на отдельные файлы описывающие экраны, загружаться файлы будут в порядке использования (вызова) в проекте. В результате получаем увеличение начальной загрузки проекта и использование меньшего объема оперативной памяти.
*Release build - оптимизация по размеру файла базы ресурсов и основного файла проекта.

''Export to folder'' - Путь для экспорта. Если указан путь экспорта проекта - производится экспорт согласно настройкам для выбранной платформы. Если не указан - проект экспортируются под выбранную платформу и автоматически запускается сборка проекта.
Структура папки:
[[Файл:TreeFolder.png|TreeFolder.png]] 
'''Select platform''' - необходимо выбрать платформу для которой будем собирать проект. При экспорте на все платформы необходимо установить Marmalade SDK [[Установка и настройка|см. инструкцию]] при этом не нужно указывать путь для экспорта (оставить поле пустым). В результате запустится скрипт сборки исполняемого пакета, это будет видно по черным экранам с ходом выполнения процесса сборки.Процесс экспорта будет отображаться в окне.

Таблица результирующих форматов для платформ
{| border="1"
|-
|качество, оптимизация
|IOS
|Android
|Windows Phone8
|BlackBerry
|Windows
|-
|Best, size
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|-
|Best, speed
|jxr
|jxr
|jxr
|jxr
|jxr
|-
|Medium, size
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Medium, speed
|PVRTC + jxr
|ETC1 + jxr
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|-
|Low, size
|PVRTC + png(a)
|ETC1 + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Low, speed
|PVRTC(RGBA) + hitmask
|ETC1 + PVRA8
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|}

*'''ETC''' - Ericsson Texture Compression : для устройств Android
*'''PVR''' - PowerVR Texture Compression : для устройств IOS
*'''bc3(dxt)''' - DirectX Texture : Windows, Windows Phone 8 

=== Режим отладки ===

Включение режима отладки:

[[Файл:SE debug0.JPG]]

Инструменты отладки:

[[Файл:SE debug1.JPG]]

1) '''Debug dock''' - установка брейкпоинтов (точек остановки) и вывод отладочного лога от сервера.
2) '''Logging''' - вывод логов вьювера (параллельно с viewer.log) с подсветкой и фильтрами.
3) '''Debug Options''' - вывод дерева опций, подсветка изменений (при работе вьювера), слежение за конкретными параметрами.
4) '''Debug Properties''' - вывод параметров объекта под курсором по хоткею (из вьювера) - на момент написания не реализовано.

==== Debug dock ====

[[Файл:SE debug2.JPG]]

Принцип работы брейкпоинтов (точек остановки):
* Добавляем в табличку брейкпоинтов новый пункт
* Задает objectID интересующего объекта
** Задаем название состояния, при переходе на которое вьювер станет на паузу
** ИЛИ задаем название параметра, при изменении которого вьювер станет на паузу
* Запускаем вьювер с отладкой
*: [[Файл:SE debug3.JPG]]
* После перехода в заданное состояние вьювер станет за паузу, а в редактре сцен откроется окно машинки с этим состоянием.

=Горячие клавиши=
* '''Клавиша F10''' - По нажатию разворачивает/сворачивает все объекты и подобъекты в дереве проекта или в свойствах объекта.
* '''Клавиша Num* и Num-''' - По нажатию разворачивают/сворачивают подобъекты у выделенного объекта в дереве проекта или в свойствах объекта.

[[Category:AppSalute]]

Файл:SE debug3.jpg

2018-02-05T09:06:33Z

Bmor:

Файл:SE debug2.JPG

2018-02-05T09:05:57Z

Bmor:

Файл:SE debug1.JPG

2018-02-05T09:05:37Z

Bmor:

Файл:SE debug0.JPG

2018-02-05T09:05:09Z

Bmor:

Интерфейс ScenceEditor

2018-02-05T07:54:17Z

Bmor: /* Файл:Ico_main.pngРедактор сцен */

{{TOC right}}
== [[Файл:Ico_main.png]]Редактор сцен ==

'''Редактор сцен''' — программа, предназначенная для создания, редактирования и экспорта игровых экранов, в котором происходит настройка свойств объектов и игровой логики. 

'''Окно редактора сцен состоит из:'''
*меню редактора;
*рабочей области, в которой размещен объект сцена, на котором размещают другие объекты;
*панель Лэйаут, в которой размещено иерархическое дерево проекта, которое состоит из экранов, на которых находятся игровые объекты;
*панель Свойства, которая отображает свойства объекта, который выбран в дереве проекта;
*панель для построения сплайна;
*панель инструментов;
*строка Координаты, отображающая координаты курсора в текущий момент времени 

Для включения или отключения панели кликаем правой кнопкой мыши по серой области меню редактора и ставим галочку. Панели можно расположить на экране в любом порядке. 

[[Файл:Головна2.PNG|700px]]

=== Меню редактора ===

==== Project (Проект)====
меню, которое содержит список команд, с помощью которых можно создать новый или загрузить уже созданный проект, сохранить проект с указанием места сохранения и т.д.
*'''New project''' - создать новый проект;
*'''Open''' - открыть уже созданный проект (проект обязательно должен находится в подкаталоге редактора);
*'''Recent project...''' - показывает список последних открывавшихся проектов;
*'''Close''' - закрытие проекта (редактор при этом не закрывается);
*'''New project''' - создать новый проект;
*'''Save''' - сохранение проекта;
*'''Save as...''' - сохранение проекта под новым именем или в новом каталоге;
*'''Export...''' - экспорт проекта;
*'''Project options...''' - опции проекта;
*'''Exit''' - закрытие редактора.

==== Edit (Редактирование)====
меню редактирования проекта:
*'''Copy''' - копирование объекта;
*'''Paste into current object''' - вставка объекта в выбранный объект;
*'''Paste after current object''' - вставка объекта после выбранного объекта;
*'''Delete...''' - удаление объекта;
*'''Scale object''' - масштабирование выбранного объекта, если у него есть масштаб (scale x \ scale y);
*'''Rotate object''' - поворот выбранного объекта, если у него есть параметр поворота (angle);
*'''Modify vertex''' - изменение положения точек вертекса у выбранного объекта, если вертексы включены;
*'''Find object...''' - поиск объекта по id или по имени;
*'''Setup Editor...''' - настройки редактора.

[[Файл:SetupEditor.png|right|400px]]

1) Языки - выбор языка редактора.

2) Work mode - выбор режима работы.

3) Syles - выбор темы редактора.

4) Перемещение сцены мышью или клавишами клавиатуры - позволяет перемещать сцену на экране.

5) Рисовать сетку на экране - отображать сетку на экране или нет.

6) Utilities - Подключение утилит.

В редакторе есть возможность подключения утилит в форматах *.bat, *.exe, *.py, *.pyw, *.vbs.

Для примера, подключим bat-файл, открывающий логи вьвера в notepad++.

Для этого создадим файл Logs.bat со следущими командами:

cd C:\Users\<your-user>\AppData\Roaming\Absolutist\Viewer

start "C:\Program Files (x86)\Notepad++\notepad++.exe" "viewer.log"

В настройки редактора добавим утилиту нажав на плюсик. В списке ниже появится поле добавленной утилиты.

Нажмем на многоточие в столбце "Browse". В открывшимся окне "Open utility" откроем Logs.bat файл. После этого в меню редактора появится меню "Utilities" с командой Logs.

==== View (Просмотр)====
*'''Toggle grid''' - включает\выключает отображение сетки на сцене;
*'''open/hide comment''' - показывает\скрывает комментарии к объекту;
*'''Disable object movements''' - выключает\включает возможность перемещать объекты по сцене.

=== Viewer (Вьювер) ===
*'''Start Viewer''' - запуск вьювера;
*'''Start Viewer with changed time''' - запуск вьювера с заданным временем;
*'''Save and run viewer...''' - сохраняет проект и запускает вьювер;
*'''Run Viewer.bat''' - ???;
*'''Delete temp data''' - удаление опций;

====Layouts (Лейаут, Макеты)====
меню работа с лейаутами проекта (выбор макета устройства для проекта, редактирование экранов):
*'''Add new layout...''' - создание нового лейаута;
*'''Delete layout...''' - удаление лейаута;
*'''Layout settings...''' - настройки лейаута;
*'''Add folder...''' - создание папки в текущем лейаута;
*'''Add screen...''' - создание нового экрана.
==== Tools (Инструменты)====
меню дополнительных редакторов и инструментов для проекта (вызов редактора ресурсов, текстового редактора, анализ проекта). Список этого меню вынесен на панель с кнопками быстрого запуска:
*'''Resources Editor''' - редактор ресурсов;
*'''Texts Editor''' - текстовый редактор;
*'''Analyzer''' - анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов));
*'''Object info...''' - общие свойства объекта (показывает размер памяти занимаемой текстурами);
*'''Options info...''' - информация об опциях.

==== Help (Помощь)====
меню вызова справки.

=== Кнопки панели Инструменты ===
Некоторые инструменты также вызываются горячими клавишами (комбинация клавиш приведена в скобках )

[[Файл:00 6.png]] (Ctrl+N) — создать новый проект; 
[[Файл:00 7.png]](Ctrl+O) — загрузить уже созданный проект; 
[[Файл:00 8.png]](Ctrl+S) — сохранить изменения в проекте; 
[[Файл:00 9.png]] — запустить Viewer; 
[[Файл:009.JPG]] — нормальный вид; 
[[Файл:Ico_text.png|25px]] - вызов текстового редактора; 
[[Файл:Ico_base.png|25px]] — вызов редактора ресурсов; 
[[Файл:013.JPG]] — анализатор ресурсов (показывает количество объектов проекта, их размер занимаемой памяти, сведения о ресурсах каждого объекта (размер, ID номер, название (имя), местонахождение в базе ресурсов)); 
[[Файл:014.JPG]]— поиск объекта по id или по имени. 

===Функции рабочей области===

'''1) Масштабирование рабочей области '''
Ctrl + колесико мышки крутим вперед - увеличиваем объекты , назад - уменьшаем объекты. 

'''2)Перемещение по рабочей области '''
После масштабирования возникает необходимость переместиться с левого уголка экрана в далекий правый, переместиться к выбраному обьекту, вверх или вниз. 

Кликаем правой кнопкой мыши по горизонтальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll left / right - функция перемещает экран на маленькое расстояние вправо / влево;
*left / right edge — функция перемещает экран в левый / правый угол экрана;
*page left / right - функция показывает левую/правую часть экрана 

Кликаем правой кнопкой мыши по вертикальному scroll и выпадает меню:
*scroll here — функция перемещает экран к объекту, который выделен в Лэйауте;
*scroll up / down - функция перемещает экран на маленькое расстояние вверх / вниз;
*top/bottom - функция перемещает экран вверх / вниз;
*page up / down - функция перемещает экран верхнюю / нижнюю часть экрана. 

Меню прокрутки скрывается по нажатию клавиши Alt 

===Функции панели Лэйаут===
[[Файл:Лэйаут_1.JPG|right]]
При клике правой кнопкой мыши по выбранному лэйауту (см. рисунок справа)
*Создать папку в текущем объекте;
*Создать экран в текущем объекте - создание объекта в текущем лэйауте;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает / разворачивает дерево объектов всех экранов 

При клике правой кнопкой мыши по выбранному экрану, сцене или объекту возможно:
*Lock (Unlock) screen - золочивание (разлочивание) экрана: нельзя перемещать, удалять и изменять объекты (сцены) экрана, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых экранах в панели проекта появляется замочек;
*Lock (Unlock) scene - золочивание (разлочивание) сцены: нельзя перемещать, удалять и изменять объекты (машины, картинки и др.) сцены, причем, если сцена расшареная, то она становиться залоченой и на остальных экранах; на залоченых сценах также появляется замочек;
*Создать сцену в текущем объекте - создание экран в текущем экране;
*Создать экран в текущем объекте - создание экран в текущем лэйауте;
*Создать объект сцены в текущем объекте - создание объекта в текущем объекте;
*Удалить объект - удаление объекта из проекта;
*Копировать объект — копирование объекта;
*Вставить в текущий объект — вставка объекта в текущий объект верхнего уровня ;
*Вставить как ссылку в текущий объект — вставка объекта в текущий объект для создания расшареной сцены;
*Вставить как ссылку после текущего объекта — вставка объекта после текущего объекта для создания расшареной сцены;
*Вставить после текущего объекта - вставка объекта после текущего объекта;
*Импорт/экспорт экранов — импорт/экспорт одного или нескольких экранов;
*Развернуть / Свернуть объекты с подобъектами — сворачивает /разворачивает дерево объектов экрана или сцены;

====Функция Расположить сцену в соответствии с изображением ====
Пусть на сцене будет находится очень много картинок, которые должны находиться в строго определенных местах. Переместим нашу картинку в нужную точку на сцене. Но у нас картинок очень много и мы потратим много времени на их расстановку. Для уменьшения времени на расстановку картинок воспользуемся функцией расположить сцену в соответствии с изображением. 
Функция расположить сцену в соответствии с изображением перемещает картинку в заданную точку художниками. Художник решил, что клумба должна быть в правом нижнем углу, после применения функции расположить сцену в соответствии с изображением, картинка станет именно на указанное художником место. 
Данная функция вызывается кликом правой кнопкой мыши по объекту [[Файл:панель_свойства_1.JPG|right]]

===Функции панели Свойства===

*При клике на тип или имя некоторых объектов вызываются дополнительные окна.Например, при клике на тип Machine открывается окно, где прописываются функции объекта типа Machine.
*При наведении на поле тип выпадет подсказка с уникальным номером объекта.
*При клике правой мышкой по названию свойства объекта выпадает меню с дополнительными свойствами объекта
*Некоторые свойства объектов объединены в группы (см. рисунок справа)

=== Создание проекта ===

1. Для создания нового игрового проекта необходимо запустить редактор сцен SceneEditor. 
2. В верхнем меню Проект выбрать Новый (т.е. создать новый проект). 
3. В появившемся окне указываем имя проекта и имя базы ресурсов.Выбираем папку для сохранения проекта 
4. В этом окне выбираем устройство для которого создаётся проект, а затем выбираем тип магазина и вариант версии игры 
[[Файл:020.JPG]] [[Файл:021.JPG]]

5. В редакторе сцен в меню Проект → Сохранить → проект с именем Learning. 
Эту методику действий можно брать за шаблон для создания других проектов. 
Результат: Создана база ресурсов и проект для выполнения Уроков.

====Важное замечание по созданию проекта====
[[Файл:2_лэйаута.JPG|right]] 
Предположим нам необходимо создать игру для магазина А и магазина Б. Игра будет отличаться только 10 функциями. Мы можем создать игру для магазина А., а потом скопировать папку с проектом, проект переименовать, внести изменения и получить игру для магазина Б. Результат: 2 игры и 2 папки с ресурсами. Такой подход не приветствуется. 
Для уменьшения времени на создание проекта, подключение ресурсов, внесения одинаковых объектов и удобства отслеживания багов и прочего в Редакторе Сцен существует возможность создания двух лэйаутов в одном проекте.
При создании проекта мы выбираем оба магазина, после чего в панели Лэйаут появится два лэйаута для магазина А и магазина Б(см. рисунок справа. При этом текстовая база проекта и база ресурсов у них будут идентичны. При создании новых объектов в одном лэйауте они же будут создаваться и в другом, при этом можно изменять свойства объекта каждого лэйаута независимо от второго. 
За применение изменений между лэйаутами отвечает параметр "синхронизация", который есть у каждого объекта. Если стоит "синхронизировать", то объект будет одинаков в каждом из лэйаутов. Если стоит "не синхронизировать", то объект будет уникальным для каждого экрана, его изменения не будут применены на других лэйаутах, не синхронизируемые объекты можно даже удалять, т.к. они уникальны для лэйаута.

===Экспорт проекта===

'''Этапы экспорта проекта'''
*Выполняется сжатие графики при необходимости
*Очистка базы ресурсов от неиспользуемой графики
*Запаковка графики в текстуры и контейнер
*При необходимости конвертирование файлов в pvr форматы 
С целью экономии оперативной памяти на устройстве возможно сжатие графики, упаковка графики в текстуры, создание нескольких исполняемых файлов, проекта, содержащих в себе несколько сцен проекта, и загружаемых в оперативную память устройства по мере прохождения игры. 

Процедура экспорта проекта вызывается через меню редактора Проект - Экспортировать проект 

[[Файл:Scene editor export window.jpg|right]]
'''Параметры экспорта проекта:''' 
''Настройки параметров графики''
*Ось Х, ось У — параметры сжатия графики по оси Х,У. Значения параметра от 0 до 1.
*При выполнении сжатия рекомендуется обращать внимания на размер лэйаута
*Сжатие графики возможно и непропорциональное . Используется редко

''Параметры запаковки графики''
*Common textures size - максимальный размер графической текстуры для графики, которая не находится в контейнерах и попадает в одну текстуру, или максимальный размер графического файла, если он не в контейнере и не попадает в текстуру.
*Create dat container - упаковка ресурсов в файл с типом DAT. Обеспечиваем защиту ресурсов проекта от несанкционированного доступа. Увеличиваем производительность при операциях чтения файлов ресурсов с твердотельного носителя.
*Quality - Качество графики, которая не находится в контейнерах
*Optimization - оптимизация графики для лучшего быстродействия(speed) или для занимаемого дискового пространства в распакованном виде(size)

''Тип экспорта''
*One project file - формируется один XML файл описывающий проект.
*Split project on screens, load partly' - проект будет разбит на отдельные файлы описывающие экраны, загружаться файлы будут в порядке использования (вызова) в проекте. В результате получаем увеличение начальной загрузки проекта и использование меньшего объема оперативной памяти.
*Release build - оптимизация по размеру файла базы ресурсов и основного файла проекта.

''Export to folder'' - Путь для экспорта. Если указан путь экспорта проекта - производится экспорт согласно настройкам для выбранной платформы. Если не указан - проект экспортируются под выбранную платформу и автоматически запускается сборка проекта.
Структура папки:
[[Файл:TreeFolder.png|TreeFolder.png]] 
'''Select platform''' - необходимо выбрать платформу для которой будем собирать проект. При экспорте на все платформы необходимо установить Marmalade SDK [[Установка и настройка|см. инструкцию]] при этом не нужно указывать путь для экспорта (оставить поле пустым). В результате запустится скрипт сборки исполняемого пакета, это будет видно по черным экранам с ходом выполнения процесса сборки.Процесс экспорта будет отображаться в окне.

Таблица результирующих форматов для платформ
{| border="1"
|-
|качество, оптимизация
|IOS
|Android
|Windows Phone8
|BlackBerry
|Windows
|-
|Best, size
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|png(RGBA)
|-
|Best, speed
|jxr
|jxr
|jxr
|jxr
|jxr
|-
|Medium, size
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Medium, speed
|PVRTC + jxr
|ETC1 + jxr
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|-
|Low, size
|PVRTC + png(a)
|ETC1 + png(a)
|jpg + png(a)
|jpg + png(a)
|jpg + png(a)
|-
|Low, speed
|PVRTC(RGBA) + hitmask
|ETC1 + PVRA8
|BC3 + hitmask
|PVR8888
|BC3 + hitmask
|}

*'''ETC''' - Ericsson Texture Compression : для устройств Android
*'''PVR''' - PowerVR Texture Compression : для устройств IOS
*'''bc3(dxt)''' - DirectX Texture : Windows, Windows Phone 8 

=== Режим отладки ===

=Горячие клавиши=
* '''Клавиша F10''' - По нажатию разворачивает/сворачивает все объекты и подобъекты в дереве проекта или в свойствах объекта.
* '''Клавиша Num* и Num-''' - По нажатию разворачивают/сворачивают подобъекты у выделенного объекта в дереве проекта или в свойствах объекта.

[[Category:AppSalute]]

Интерфейс TextEditor

2018-02-02T15:11:57Z

Bmor: /* Настройка импорта из внешней базы (CSV) */

{{TOC right}}
== [[Файл:Ico_text.png]]Редактор текстов ==

[[Файл:Ico_text.png|40px]] '''Text Editor''' - хранилище всех текстовых ресурсов (надписей) на различных языках. 
Аналогично графике и звукам при помощи мышки они перетаскиваются в соответствующие свойства объектов, находящихся в Scene Editor. 
;См. также: [[Редактор_текстовых_ресурсов|Урок 6]]

Окно редактора имеет следующий вид: 

[[Файл:Text baze main.jpg]]

===Общие свойства и действия с текстом===

'''После сохранения действий в текстовом редакторе база автоматически обновляется в редакторе сцен.'''
*элемент текстовой базы - строка текста, которая может хранить в себе несколько различных фраз,записанных в разные поля
*один текст на разных языках записывается в один элемент текстовой базы
*в текстовой базе может храниться voice
*элемент текстовой базы может хранить в себе несколько иконок, для которых можно выбрать одну из 4-х категорий (mainPicture, icon1, icon2,icon3)
*каждому элементу текстовой базы присваивается уникальный номер.
*при добавлении элемента - присваивается следующий по порядку уникальный номер
*при экспорте экранов в текущий проект элементы текстовой базы добавляются автоматически в базу текущего проекта и присваиваются им следующие по порядку уникальные номера
*может существовать несколько элементов с одинаковыми именами ('''но следует избегать этого!''')
*текст может быть автоматически добавлен в текущий проект или добавлен из другой текстовой базы
*элемент текстовой базы может быть удален, модифицирован, категоризирован

=== Кнопки быстрого запуска ===
Вверху окна приложения расположены кнопки общего меню:
*[[Файл:00 6.png]] — команда создать Новый файл;
*[[Файл:00 7.png]] — команда открыть уже созданный проект;
*[[Файл:00 8.png]] — сохранить изменения в файле;
*[[Файл:TxtEditor open Res base.JPG]] — открыть базу ресурсов;
*[[Файл:00 18.png]] — создать новую папку в корневой базе;
*[[Файл:New record.jpg]] — добавить новую текстовую запись;
*[[Файл:Add new rec fr.jpg]] — добавить новую текстовую запись из базы ресурсов;
*[[Файл:Add url.jpg]] — добавить новую url запись;
*[[Файл:00 19.png]] — удалить текстовую запись;
*[[Файл:Text base find.png]] — найти необходимую текстовую запись в текстовой базе.

=== Меню редактора ===
1. Если нажать в меню кнопку '''File''', выпадет список команд, с помощью которых можно создать новый или загрузить уже созданный файл, сохранить файл с указанием места сохранения и т.д. 
2.Для импорта фраз на другом языке необходимо воспользоваться Функцией Импортировать меню File и выбрать .xml-файл с текстом и выбрать язык 
3. Если нажать в меню кнопку '''Resource''', выпадет список команд: 
* Open Resource - позволяет создать базу по ранее подготовленной графической базе ресурсов с точным совпадением структуры и названием папок и файлов. Используется для Hidden Objects;
* Choose Resource File - позволяет подгрузить базу графических ресурсов для перетаскивания изображений из ResourcesEditor на иконку;
* Choose Categories Config - помогает классифицировать текстовые файлы по категориям.
[[Файл:00_51.PNG]] [[Файл:00_52.PNG]]

=== Создание и заполнение текстовой базы проекта ===
Текстовая база не создается автоматически при создании проекта. 
Для создания и заполнения текстовой базы: 
1. Заходите в пункт меню '''file -> New'''. Появляется пустая база ресурсов, по умолчанию названная '''Untitled'''. 
2. Слева в дереве текстовых объектов кликаем правой кнопкой мыши и выбираем '''Add record'''. Каждый раз при добавлении новой текстовой записи редактор просит нас написать ее имя. Это имя можно будет изменить в любой момент. Запишем имя '''arrow_If_down'''. 
3. Выделить запись и в окне приложения TextEditor справа в столбце Word запишем слово, в столбце Sentence1,Sentence2 - указать подсказку для текстовой записи, в столбце voice - подключить звуковой файл для текстовой записи из ResourcesEditor. 
[[Файл:00_54.PNG]]

'''Необходимо обязательно сохранять любые изменения с текстом в редакторе TextEditor.''' 
Для вызова текстового редактора можно воспользоваться меню '''Инструменты -> Редактор текстов''', либо кнопкой быстрого запуска [[Файл:Text base.png]].

'''Замечание.''' Букву Ё заменяем на Е

=== Импорт текстовой базы ===

Открыть окно импорта можно через меню '''Project''' > '''Import''' > '''Import From XML / CSV'''

[[Файл:TextsEditor_import_menu.jpg]]

==== Настройка импорта ====

Окно импорта:

[[Файл:TextEditor import dialog wnd.jpg]]

* '''Путь к импортируемому файлу''':
** Для выбора импортируемого файла нажмите на кнопку справа поля (...)
** Импорт возможен только из файлов .xml и .csv
* '''Тип импортируемой базы''':
** ''База текущего проекта'' - импорт базы вашего текущего открытого проекта; импорт записей будет осуществлен по их id.
** ''База другого проекта (наша структура xml/csv файла)'' - импорт текстов из другого проекта; импорт записей может быть осуществлен по структуре базы либо по именам записей.
** ''Внешняя база (со своей структурой)'' - импорт внешнего файла с отличающейся от нашей структурой; для данного типа импорта нужна детальная настройка (об этом ниже).
* '''Тип импорта''':
** ''Добавить как новые с сохранением структуры'' - для каждой импортируемой записи создает новую запись в текущей базе; сохраняется изначальная структура записей импортируемого файла.
** ''Добавить как новые в отдельный каталог'' - создает в корне базы новый каталог, для каждой импортируемой записи создает новую запись в каталоге; сохраняется изначальная структура записей импортируемого файла относительно нового каталога.
** ''Обновить записи (дополняет отсутствующие поля)'' - "мягкое" обновление записей - добавляет в существующие записи отсутствующие там поля, если таковые заполнены в импортируемой базе.
** ''Обновить записи (заменяет поля импортированными не-пустыми)'' - "жесткое" обновление записей - добавляет либо заменяет в существующих записях те поля, которые заполнены в импортируемой базе.
** ''Заменить записи'' - перезаписывает все поля записи на импортируемые, даже если в импортируемой записи они пустые.
* '''Добавлять отсутствующие (новые) записи''' - если установлено - добавляет импортируемые записи, отсутствующие в текущей базе, как новые записи (с сохранением структуры).
* '''Импорт по полю''':
** ''ID записи'' - сравнение записей при импорте по их iid.
** ''Путь к записи'' - сравнение записей при импорте по их пути в структуре и имени записи.
** ''Имя записи'' - сравнение записей при импорте по их имени. '''Берётся первое найденное имя!''' Для данного пункта '''КРАЙНЕ ЖЕЛАТЕЛЬНО''' иметь уникальные имена записей во избежание потери данных и лишних проблем.
* '''Выбор импортируемых локализаций'''
** В данном поле показаны все локализации, находящиеся в импортируемом файле.
** Для импорта той или иной локали - '''отметьте её галочкой'''.
** Для импорта всех локалей - отметьте их все.
** Кнопка "Reload locales" перегружает локали импортируемого файла (например если он был изменен в процессе работы с этим окном).
** Зелеными шариками [[Файл:TextsEditor_green_sphere.png | 16px ]] обозначены языки, используемые в проекте (выбранные в Project > Properties > Selected languages...).
** Серыми шариками [[Файл:TextsEditor_gray_sphere.png | 16px ]] обозначены языки, которые на данный момент не используются в проекте. Вы можете их импортировать, но для работы с ними их нужно будет включить.

==== Настройка импорта из внешней базы (XML) ====

Окно импорта внешней XML базы:

[[Файл:TextEditor import custom base.jpg]]

'''Элементы интерфейса''':
* '''(1)''' - структура импортируемого файла
* '''(2)''' - выбранный элемент структуры, отвечающий за текстовую запись
* '''(3)''' - структура выбранного элемента текстовой записи
* '''(4)''' - основные параметра записи - id, имя и каталог
* '''(5)''' - параметры импорта локалей

'''Пошаговая инструкция на примере xml нашей текстовой базы'''
# В структуре импортируемого файла '''(1)''' найдите элемент, отвечающий за текстовую запись, и дважды кликните по нему левой кнопкой мыши (ЛКМ)
# Задайте соответствие между полями в структуре выбранного элемента '''(3)''' и необходимыми полями для нашей текстовой базы '''(4)''':
#: Первый способ сделать это: перетащите строку из структуры '''(3)''' в соответствующее поле '''(4)'''
#: [[Файл:TextEditor import custom dragndrop.jpg | x160px]]
#: Второй способ: выбрать нужную строку '''(3)''' и нажать кнопку напротив соответствующего поля '''(4)'''
#: [[Файл:TextEditor import custom buttonclick.jpg | x160px]]
#: Способ третий (хардкор): вписать путь к полю вручную (делать на свой страх и риск, либо если нужного поля по какой-то причине нет в структурке)
# Выберите тип хранение локали и записей:
## ''Locale is attribute value'' - код локали находится в значении атрибута, например как в нашей базе:
##: [[Файл:TextEditor import custom localeisvalue 1.jpg]]
### ''Select by sentence_id'' или ''Select sentence field'' - покажу на примере
###: [[Файл:TextEditor import custom localeisvalue 2.jpg]]
### ''Locale'' - путь к атрибуту с локалью
### ''sentence_id'' и ''sentence_text'' - путь к атрибуту, содержащему sentnce, и путь к атрибуту, содержащему его текст
### ''_word'', ''_sent1..3'' - пути к атрибутам, содержащим соответствующие данные
## ''Locale is attribute name'' - код локали является самим атрибутом, а его значение - текстом
##: [[Файл:TextEditor import custom localeisattribute 1.jpg | x160px]]
##: [[Файл:TextEditor import custom localeisattribute 2.jpg]]
##: Заполните соответствующие поля для нужных \ присутствующих в файле локалей.

После всех установок нажмите '''ОК'''. Если всё установлено правильно - вы увидите список доступных в файле языков и сможете импортировать файл.

==== Настройка импорта из внешней базы (CSV) ====

Окно импорта из CSV:

[[Файл:TextEditor import custom csv.jpg]]

'''Элементы интерфейса''':
* '''(1)''' - тип разделителя
* '''(2)''' - структура csv файла
* '''(3)''' - поля для импорта

'''Пошаговая инструкция''':
# Выберите тип разделителя '''(1)''' - обычно используется табуляция (Tab \t ), но в некоторых случаях разделителем может быть другой символ.
# Если разделитель был изменен - для применения нажмите '''Reload'''
# Задайте соответствие между структурой импортируемого CSV файла '''(2)''' и полями для импорта '''(3)'''
#* Первый способ: перетащите строку из структуры '''(2)''' в соответствующее поле '''(3)'''
#* Второй способ:выбрать нужную строку '''(2)''' и нажать кнопку напротив соответствующего поля '''(3)'''
#* Третий способ: заполните поля вручную
# Когда все необходимые поля будут заполнены - жмите '''OK'''

----

=== Экспорт текстовой базы ===

Существует два варианта экспорта текстовой базы:
*'''Export into txt . . .''' - в файл с расширением .csv (текстовый файл)
*'''Export into xml . . .''' - в файл с расширением .xml (текстовая база)

Само окно экспорта аналогично окну импорта:

[[Файл:TextsEditor_export_menu.jpg]] 

* Экспорт в xml генерирует файл, идентичный файлу текстовой базы, но лишь с выбранными в окне языками;
* При экспорте в csv создается файл такой структуры:

[[Файл:text_baza_export_5.jpg]] 

Экспортироваться будут лишь те языки, которые были выбраны в данном окне, вне зависимости от их наличия в базе. Пустые поля и языки экспортированы не будут.

При выборе флага '''"Export empty lines"''' будут экспортированы все пустые поля и языки, что очень полезно для перевода базы.

=== Добавление иконок в текстовый элемент ===

Необходимость добавления изображения в текстовый элемент, может возникнуть, например, при формировании элементов hiddenObject, или при работе с элементами economics.
Изображение перетаскивается в текстовый элемент из редактора ресурсов мышкой. Но, в случае необходимости создать множество элементов за один раз, есть более эффективный способ:
*На панели с кнопками быстрого запуска нажимаем ''Add new text records from resource...''.
[[Файл:Add new rec from.jpg|300px|]]
*Открылось окошко ''choose resource file'' в нем следует выбрать необходимый sirx файл.
[[Файл:Choose resource file.jpg]]
*В открывшемся дереве ресурсов выбираем нужную папку
[[Файл:Tree resources.jpg|400px|]]
*Из отмеченной папки файлы преобразуются в текстовые элементы, содержащие строку ''word'' и соответствующее изображение. Причем добавятся они в текстовый редактор в папку, которая создастся в соответствии с папкой, содержащей эти иконки в редакторе ресурсов.

Если вдруг так получилось, что к текстовой записи подвязан ресурс которого больше нет в базе ресурсов -- он будет обозначен как "INVALID RESOURCE":

[[Файл:TextsEditor_invalid_image.JPG]]

=== Поиск записи в текстовой базе ===

Окно поиска текстовой записи активируется при нажатии кнопки быстрого запуска [[Файл:Text base find.png]]. 
[[Файл:Text base find wind.jpg]] 
Поиск проходит по непосредственно содержимому текстового поля. 
Поиск по дереву базы может проходить сверху вниз и снизу вверх, если выбрать один из пунктов группы '''Find direction''': 
*'''down''' - искать сверху вниз;
*'''up''' - искать снизу вверх. 
Для оптимизации процесса поиска можно выбрать в группе '''Find mode''' один из следующих пунктов:
*'''in the whole tree''' - искать во всем дереве;
*'''from the current item''' - искать от текущего элемента. 
Строка, которая вводится в строку поиска может быть подстрокой интересующей нас записи либо же полностью с ней совпадать. Это можно регулировать с помощью пункта '''Only the whole text'''.

[[Category:AppSalute]]

Файл:TextEditor import custom csv.jpg

2018-02-02T15:05:21Z

Bmor:

Интерфейс TextEditor

2018-02-02T14:55:40Z

Bmor: /* Настройка импорта из внешней базы (XML) */

{{TOC right}}
== [[Файл:Ico_text.png]]Редактор текстов ==

[[Файл:Ico_text.png|40px]] '''Text Editor''' - хранилище всех текстовых ресурсов (надписей) на различных языках. 
Аналогично графике и звукам при помощи мышки они перетаскиваются в соответствующие свойства объектов, находящихся в Scene Editor. 
;См. также: [[Редактор_текстовых_ресурсов|Урок 6]]

Окно редактора имеет следующий вид: 

[[Файл:Text baze main.jpg]]

===Общие свойства и действия с текстом===

'''После сохранения действий в текстовом редакторе база автоматически обновляется в редакторе сцен.'''
*элемент текстовой базы - строка текста, которая может хранить в себе несколько различных фраз,записанных в разные поля
*один текст на разных языках записывается в один элемент текстовой базы
*в текстовой базе может храниться voice
*элемент текстовой базы может хранить в себе несколько иконок, для которых можно выбрать одну из 4-х категорий (mainPicture, icon1, icon2,icon3)
*каждому элементу текстовой базы присваивается уникальный номер.
*при добавлении элемента - присваивается следующий по порядку уникальный номер
*при экспорте экранов в текущий проект элементы текстовой базы добавляются автоматически в базу текущего проекта и присваиваются им следующие по порядку уникальные номера
*может существовать несколько элементов с одинаковыми именами ('''но следует избегать этого!''')
*текст может быть автоматически добавлен в текущий проект или добавлен из другой текстовой базы
*элемент текстовой базы может быть удален, модифицирован, категоризирован

=== Кнопки быстрого запуска ===
Вверху окна приложения расположены кнопки общего меню:
*[[Файл:00 6.png]] — команда создать Новый файл;
*[[Файл:00 7.png]] — команда открыть уже созданный проект;
*[[Файл:00 8.png]] — сохранить изменения в файле;
*[[Файл:TxtEditor open Res base.JPG]] — открыть базу ресурсов;
*[[Файл:00 18.png]] — создать новую папку в корневой базе;
*[[Файл:New record.jpg]] — добавить новую текстовую запись;
*[[Файл:Add new rec fr.jpg]] — добавить новую текстовую запись из базы ресурсов;
*[[Файл:Add url.jpg]] — добавить новую url запись;
*[[Файл:00 19.png]] — удалить текстовую запись;
*[[Файл:Text base find.png]] — найти необходимую текстовую запись в текстовой базе.

=== Меню редактора ===
1. Если нажать в меню кнопку '''File''', выпадет список команд, с помощью которых можно создать новый или загрузить уже созданный файл, сохранить файл с указанием места сохранения и т.д. 
2.Для импорта фраз на другом языке необходимо воспользоваться Функцией Импортировать меню File и выбрать .xml-файл с текстом и выбрать язык 
3. Если нажать в меню кнопку '''Resource''', выпадет список команд: 
* Open Resource - позволяет создать базу по ранее подготовленной графической базе ресурсов с точным совпадением структуры и названием папок и файлов. Используется для Hidden Objects;
* Choose Resource File - позволяет подгрузить базу графических ресурсов для перетаскивания изображений из ResourcesEditor на иконку;
* Choose Categories Config - помогает классифицировать текстовые файлы по категориям.
[[Файл:00_51.PNG]] [[Файл:00_52.PNG]]

=== Создание и заполнение текстовой базы проекта ===
Текстовая база не создается автоматически при создании проекта. 
Для создания и заполнения текстовой базы: 
1. Заходите в пункт меню '''file -> New'''. Появляется пустая база ресурсов, по умолчанию названная '''Untitled'''. 
2. Слева в дереве текстовых объектов кликаем правой кнопкой мыши и выбираем '''Add record'''. Каждый раз при добавлении новой текстовой записи редактор просит нас написать ее имя. Это имя можно будет изменить в любой момент. Запишем имя '''arrow_If_down'''. 
3. Выделить запись и в окне приложения TextEditor справа в столбце Word запишем слово, в столбце Sentence1,Sentence2 - указать подсказку для текстовой записи, в столбце voice - подключить звуковой файл для текстовой записи из ResourcesEditor. 
[[Файл:00_54.PNG]]

'''Необходимо обязательно сохранять любые изменения с текстом в редакторе TextEditor.''' 
Для вызова текстового редактора можно воспользоваться меню '''Инструменты -> Редактор текстов''', либо кнопкой быстрого запуска [[Файл:Text base.png]].

'''Замечание.''' Букву Ё заменяем на Е

=== Импорт текстовой базы ===

Открыть окно импорта можно через меню '''Project''' > '''Import''' > '''Import From XML / CSV'''

[[Файл:TextsEditor_import_menu.jpg]]

==== Настройка импорта ====

Окно импорта:

[[Файл:TextEditor import dialog wnd.jpg]]

* '''Путь к импортируемому файлу''':
** Для выбора импортируемого файла нажмите на кнопку справа поля (...)
** Импорт возможен только из файлов .xml и .csv
* '''Тип импортируемой базы''':
** ''База текущего проекта'' - импорт базы вашего текущего открытого проекта; импорт записей будет осуществлен по их id.
** ''База другого проекта (наша структура xml/csv файла)'' - импорт текстов из другого проекта; импорт записей может быть осуществлен по структуре базы либо по именам записей.
** ''Внешняя база (со своей структурой)'' - импорт внешнего файла с отличающейся от нашей структурой; для данного типа импорта нужна детальная настройка (об этом ниже).
* '''Тип импорта''':
** ''Добавить как новые с сохранением структуры'' - для каждой импортируемой записи создает новую запись в текущей базе; сохраняется изначальная структура записей импортируемого файла.
** ''Добавить как новые в отдельный каталог'' - создает в корне базы новый каталог, для каждой импортируемой записи создает новую запись в каталоге; сохраняется изначальная структура записей импортируемого файла относительно нового каталога.
** ''Обновить записи (дополняет отсутствующие поля)'' - "мягкое" обновление записей - добавляет в существующие записи отсутствующие там поля, если таковые заполнены в импортируемой базе.
** ''Обновить записи (заменяет поля импортированными не-пустыми)'' - "жесткое" обновление записей - добавляет либо заменяет в существующих записях те поля, которые заполнены в импортируемой базе.
** ''Заменить записи'' - перезаписывает все поля записи на импортируемые, даже если в импортируемой записи они пустые.
* '''Добавлять отсутствующие (новые) записи''' - если установлено - добавляет импортируемые записи, отсутствующие в текущей базе, как новые записи (с сохранением структуры).
* '''Импорт по полю''':
** ''ID записи'' - сравнение записей при импорте по их iid.
** ''Путь к записи'' - сравнение записей при импорте по их пути в структуре и имени записи.
** ''Имя записи'' - сравнение записей при импорте по их имени. '''Берётся первое найденное имя!''' Для данного пункта '''КРАЙНЕ ЖЕЛАТЕЛЬНО''' иметь уникальные имена записей во избежание потери данных и лишних проблем.
* '''Выбор импортируемых локализаций'''
** В данном поле показаны все локализации, находящиеся в импортируемом файле.
** Для импорта той или иной локали - '''отметьте её галочкой'''.
** Для импорта всех локалей - отметьте их все.
** Кнопка "Reload locales" перегружает локали импортируемого файла (например если он был изменен в процессе работы с этим окном).
** Зелеными шариками [[Файл:TextsEditor_green_sphere.png | 16px ]] обозначены языки, используемые в проекте (выбранные в Project > Properties > Selected languages...).
** Серыми шариками [[Файл:TextsEditor_gray_sphere.png | 16px ]] обозначены языки, которые на данный момент не используются в проекте. Вы можете их импортировать, но для работы с ними их нужно будет включить.

==== Настройка импорта из внешней базы (XML) ====

Окно импорта внешней XML базы:

[[Файл:TextEditor import custom base.jpg]]

'''Элементы интерфейса''':
* '''(1)''' - структура импортируемого файла
* '''(2)''' - выбранный элемент структуры, отвечающий за текстовую запись
* '''(3)''' - структура выбранного элемента текстовой записи
* '''(4)''' - основные параметра записи - id, имя и каталог
* '''(5)''' - параметры импорта локалей

'''Пошаговая инструкция на примере xml нашей текстовой базы'''
# В структуре импортируемого файла '''(1)''' найдите элемент, отвечающий за текстовую запись, и дважды кликните по нему левой кнопкой мыши (ЛКМ)
# Задайте соответствие между полями в структуре выбранного элемента '''(3)''' и необходимыми полями для нашей текстовой базы '''(4)''':
#: Первый способ сделать это: перетащите строку из структуры '''(3)''' в соответствующее поле '''(4)'''
#: [[Файл:TextEditor import custom dragndrop.jpg | x160px]]
#: Второй способ: выбрать нужную строку '''(3)''' и нажать кнопку напротив соответствующего поля '''(4)'''
#: [[Файл:TextEditor import custom buttonclick.jpg | x160px]]
#: Способ третий (хардкор): вписать путь к полю вручную (делать на свой страх и риск, либо если нужного поля по какой-то причине нет в структурке)
# Выберите тип хранение локали и записей:
## ''Locale is attribute value'' - код локали находится в значении атрибута, например как в нашей базе:
##: [[Файл:TextEditor import custom localeisvalue 1.jpg]]
### ''Select by sentence_id'' или ''Select sentence field'' - покажу на примере
###: [[Файл:TextEditor import custom localeisvalue 2.jpg]]
### ''Locale'' - путь к атрибуту с локалью
### ''sentence_id'' и ''sentence_text'' - путь к атрибуту, содержащему sentnce, и путь к атрибуту, содержащему его текст
### ''_word'', ''_sent1..3'' - пути к атрибутам, содержащим соответствующие данные
## ''Locale is attribute name'' - код локали является самим атрибутом, а его значение - текстом
##: [[Файл:TextEditor import custom localeisattribute 1.jpg | x160px]]
##: [[Файл:TextEditor import custom localeisattribute 2.jpg]]
##: Заполните соответствующие поля для нужных \ присутствующих в файле локалей.

После всех установок нажмите '''ОК'''. Если всё установлено правильно - вы увидите список доступных в файле языков и сможете импортировать файл.

==== Настройка импорта из внешней базы (CSV) ====

----

=== Экспорт текстовой базы ===

Существует два варианта экспорта текстовой базы:
*'''Export into txt . . .''' - в файл с расширением .csv (текстовый файл)
*'''Export into xml . . .''' - в файл с расширением .xml (текстовая база)

Само окно экспорта аналогично окну импорта:

[[Файл:TextsEditor_export_menu.jpg]] 

* Экспорт в xml генерирует файл, идентичный файлу текстовой базы, но лишь с выбранными в окне языками;
* При экспорте в csv создается файл такой структуры:

[[Файл:text_baza_export_5.jpg]] 

Экспортироваться будут лишь те языки, которые были выбраны в данном окне, вне зависимости от их наличия в базе. Пустые поля и языки экспортированы не будут.

При выборе флага '''"Export empty lines"''' будут экспортированы все пустые поля и языки, что очень полезно для перевода базы.

=== Добавление иконок в текстовый элемент ===

Необходимость добавления изображения в текстовый элемент, может возникнуть, например, при формировании элементов hiddenObject, или при работе с элементами economics.
Изображение перетаскивается в текстовый элемент из редактора ресурсов мышкой. Но, в случае необходимости создать множество элементов за один раз, есть более эффективный способ:
*На панели с кнопками быстрого запуска нажимаем ''Add new text records from resource...''.
[[Файл:Add new rec from.jpg|300px|]]
*Открылось окошко ''choose resource file'' в нем следует выбрать необходимый sirx файл.
[[Файл:Choose resource file.jpg]]
*В открывшемся дереве ресурсов выбираем нужную папку
[[Файл:Tree resources.jpg|400px|]]
*Из отмеченной папки файлы преобразуются в текстовые элементы, содержащие строку ''word'' и соответствующее изображение. Причем добавятся они в текстовый редактор в папку, которая создастся в соответствии с папкой, содержащей эти иконки в редакторе ресурсов.

Если вдруг так получилось, что к текстовой записи подвязан ресурс которого больше нет в базе ресурсов -- он будет обозначен как "INVALID RESOURCE":

[[Файл:TextsEditor_invalid_image.JPG]]

=== Поиск записи в текстовой базе ===

Окно поиска текстовой записи активируется при нажатии кнопки быстрого запуска [[Файл:Text base find.png]]. 
[[Файл:Text base find wind.jpg]] 
Поиск проходит по непосредственно содержимому текстового поля. 
Поиск по дереву базы может проходить сверху вниз и снизу вверх, если выбрать один из пунктов группы '''Find direction''': 
*'''down''' - искать сверху вниз;
*'''up''' - искать снизу вверх. 
Для оптимизации процесса поиска можно выбрать в группе '''Find mode''' один из следующих пунктов:
*'''in the whole tree''' - искать во всем дереве;
*'''from the current item''' - искать от текущего элемента. 
Строка, которая вводится в строку поиска может быть подстрокой интересующей нас записи либо же полностью с ней совпадать. Это можно регулировать с помощью пункта '''Only the whole text'''.

[[Category:AppSalute]]