Text — различия между версиями
Odyadina (обсуждение | вклад) м (→Параметры) |
Dopryshko (обсуждение | вклад) |
||
(не показано 20 промежуточных версий 6 участников) | |||
Строка 1: | Строка 1: | ||
+ | '''Text''' - [[Object|объект]] для отображения текстовой информации с поддержкой многоязычности. Для управления текстовыми ресурсами используется [[TextEditor]]. <br> | ||
== Введение == | == Введение == | ||
[[Файл:2223.png]]<br> | [[Файл:2223.png]]<br> | ||
− | + | ||
Если необходимо разместить текст на сцене необходимо создать объект с типом text и перетащить на поле текстID текстовую строку из TextEditor. Также можно просто перенести их TextEditor выбранную текстовую запись, при этом автоматически создастся объект с типом Text.<br> | Если необходимо разместить текст на сцене необходимо создать объект с типом text и перетащить на поле текстID текстовую строку из TextEditor. Также можно просто перенести их TextEditor выбранную текстовую запись, при этом автоматически создастся объект с типом Text.<br> | ||
+ | '''Обязательно в тексте ТекстовойБазы, после символа '|' должен стоять другой символ. Если делаем два переноса, это будет выглядеть: "текст| |тест".''' | ||
== Параметры объекта == | == Параметры объекта == | ||
Строка 14: | Строка 16: | ||
*'''res''' - Графический ресурс подложки на которой выводится текст. Перетаскивается мышкой из редактора текста (поле должно находится в состоянии редактирования). Может отсутствовать. | *'''res''' - Графический ресурс подложки на которой выводится текст. Перетаскивается мышкой из редактора текста (поле должно находится в состоянии редактирования). Может отсутствовать. | ||
− | *'''текстID''' - Выводимый текст перетаскивается из ресурса | + | *'''текстID''' - Выводимый текст перетаскивается из ресурса текстов, для перетягивания поле в объекте Text должно быть в режиме редактирования. Решетка (#) разделяет на страницы, черта (|) - принудительный переход на новую строку. |
*'''текст''' - Выводимый текст без использования базы текстовых ресурсов. Решетка (#) разделяет на страницы, черта (|) - принудительный переход на новую строку. | *'''текст''' - Выводимый текст без использования базы текстовых ресурсов. Решетка (#) разделяет на страницы, черта (|) - принудительный переход на новую строку. | ||
+ | *'''textCanBeOptionsKey''' - позволяет выключить проверку на ключ в опциях (Если в поле '''text''' указать "x" - то с включённым функционалом, текстовый объект покажет значение из опций параметра "x"; Если выключено - отобразит "x"); | ||
*'''состояние''' - в поле указывается состояние текстового объекта, в которое он перейдет при загрузке экрана (это поле часто оставляют пустым, а состояния задают машиной). | *'''состояние''' - в поле указывается состояние текстового объекта, в которое он перейдет при загрузке экрана (это поле часто оставляют пустым, а состояния задают машиной). | ||
Строка 36: | Строка 39: | ||
[[Файл:Text11.png|250px|left]] | [[Файл:Text11.png|250px|left]] | ||
[[Файл:Text22.png|250px|center]] | [[Файл:Text22.png|250px|center]] | ||
+ | |||
+ | <br> | ||
+ | *'''автоматическое уменьшение''' - Функция позволяет уменьшить размер шрифта, чтобы уместить текст внутри прямоугольника ( размеры текстового объекта). | ||
+ | *'''минимальный размер шрифта''' - Минимальный размер до которого уменьшит функция автоскейла. | ||
+ | *'''уменьшать до строк''' - Нужно для функционала автоматического уменьшения. Попытается строку преобразовать в n строк ( исп. для цен). | ||
+ | [[Файл:890a37f3ed.jpg|center]] | ||
<br> | <br> | ||
Строка 53: | Строка 62: | ||
*'''цвет 1''' - Цвет текста начального вида (бледный). | *'''цвет 1''' - Цвет текста начального вида (бледный). | ||
*'''цвет 2''' - Цвет прочитанного текста (контрастный). Чтение делается по буквам. | *'''цвет 2''' - Цвет прочитанного текста (контрастный). Чтение делается по буквам. | ||
− | + | ||
+ | '''Группа - Время''' | ||
+ | *'''до появления символов''' ( '''tmBefore''' ) - Время до появления символов по alpha-каналу. Только для режима спрятанных символов; Пауза перед стартом анимации (по сути отсрочка сост. "start"); | ||
+ | |||
'''Группа - Параметры поведения текста''' | '''Группа - Параметры поведения текста''' | ||
*'''автопромотка''' - Автоматический переход на следующую страницу после завершения отображения текста; | *'''автопромотка''' - Автоматический переход на следующую страницу после завершения отображения текста; | ||
* '''зациклить''' - Зациклить страницы (после последней, перейти опять на первую); | * '''зациклить''' - Зациклить страницы (после последней, перейти опять на первую); | ||
− | *'''подсветка''' - Тип подсветки: | + | *'''подсветка''' - Тип подсветки: 0-не подсвечивать, 1-по слову; 2-по букве слова (караоке); 3-по букве с начала страницы; |
− | |||
− | |||
− | |||
− | |||
*'''звук''' - 1 - есть озвучка, 0 - нет; | *'''звук''' - 1 - есть озвучка, 0 - нет; | ||
*'''случайный выбор''' - 1 - при переключении страницы будет выбираться случайная, 0 - все страницы последовательно. Если выбрана 1 - в редакторе Texts Editor между страницами надо поставить знак #. | *'''случайный выбор''' - 1 - при переключении страницы будет выбираться случайная, 0 - все страницы последовательно. Если выбрана 1 - в редакторе Texts Editor между страницами надо поставить знак #. | ||
+ | *'''прятать % символов''' ( ''' hidesymbols ''' ) - указанный процент символов которые будут спрятаны; | ||
+ | Тонкости исп. ''' hidesymbols ''': | ||
+ | при сост. "init" - буквы будут выставленны моментально | ||
+ | при изменение параметра и передаче сост. "start" - буквы будут проявляться за время "проявления одного символа" ("tmAppear"); | ||
+ | Добавленные буквы после сост. "start" записываются в текстовом объекте в поле "appearingChars" с разделителем "|" ; | ||
+ | П.С. текстовый объект сохраняет маску спрятанных букв в опции ( до тех пор, пока не меняется количество символов - т.е. поменяв txtID или локализацию - маска перегенерируется); | ||
+ | |||
+ | |||
+ | |||
<br>Например: | <br>Например: | ||
Строка 83: | Строка 100: | ||
=== Состояния === | === Состояния === | ||
+ | Все состояния: | ||
− | *''' | + | *'''beg''' - по прохождению времени из поля время->до открытия переходит в состояние ''open''; |
− | + | *'''start''' - форматирует текст, после чего переходит в состояние ''beg''; | |
− | *''' | + | *'''open''' - проявляет текст по альфе за время, указанное в поле время->открытия и переходит в состояние ''first''; |
− | + | *'''run''' - выводит текст из поля txt/txtID по правилам из группы "Подсветка"; | |
− | *''' | + | *'''pause''' - остановка вывода текста в обьект на подсвеченом слове; |
− | + | *'''wait''' - показ последней напечатанной страницы, ожидание следующей команды; | |
− | *'''first''' - | + | *'''first''' - запустить показ первой страницы текста (страницы отделяются в текстовом ID символами #) в соответствии с правилами подсветки; |
− | + | *'''last''' - запустить показ последней страницы текста (страницы отделяются в текстовом ID символами #) в соответствии с правилами подсветки; | |
− | *'''next''' - в этом состоянии | + | *'''next''' - запустить показ следующей страницы текста в соответствии с правилами подсветки (если текущая страница - последняя, то в этом состоянии ничего не произойдет); |
− | + | *'''prev''' - запустить показ предыдущей страницы текста в соответствии с правилами подсветки (если текущая страница - первая, то в этом состоянии ничего не произойдет); | |
− | *'''close''' - плавно растворяет текст | + | *'''close''' - плавно растворяет текст по альфе в течении времени, указанном в поле время->закрытия, после чего переходит в состояние ''end''; |
− | + | *'''cross''' - зачеркнуть текст; | |
− | *'''end''' - | + | *'''end''' - убрать текст из текстового обьекта. |
=== Параметры === | === Параметры === | ||
Строка 126: | Строка 144: | ||
:Другими словами такие значения параметров равносильны нулю. | :Другими словами такие значения параметров равносильны нулю. | ||
'''Для постепенного открытия (закрытия) текста следует указывать временные параметры отличные от значений по умолчанию.''' | '''Для постепенного открытия (закрытия) текста следует указывать временные параметры отличные от значений по умолчанию.''' | ||
+ | |||
+ | |||
+ | === Картинка в тексте === | ||
+ | |||
+ | ---- | ||
+ | |||
+ | :Иконка будет вставлена в текст, если будет символы - $id167$al0.5$dx5. | ||
+ | |||
+ | :Расшифровка: | ||
+ | ::$ - карявка для определения, что впереди что-то есть | ||
+ | ::id167 - указываем отрисовать картинку с id==167 ( картинка должна присутствовать на этом экране, иначе не покажется; Если картинки нету в ресурсной базе - будет выполнено два пробела); | ||
+ | ::$al0.5 - указываем альфу картинки; | ||
+ | ::$dx5 - указываем что картинку смещаем на 5-ть пикселей вправо от точки вставки; | ||
+ | |||
+ | :Примечание: | ||
+ | ::1) Если не указываем $al0.5 или $dx5, то берём стандартное значение ( к примеру $id167 - означает картинка 167 с альфой==1 и без смещения (dx==0)); | ||
+ | ::2) al и dx могут могут быть в любом порядке. | ||
+ | ::3) Записывать в текст спец. символы можно и через переменную; | ||
+ | ::4) Текст по высоте будет смещён на половину высоты самой большой картинки в строке ( если половина высоты больше размера шрифта); | ||
+ | ::5) иконка вставляемая в текст должна быть без лишней альфы ( при отступах учитывается ширина и высота картинки). | ||
+ | |||
+ | :Пример: | ||
+ | |||
+ | [[Файл:Viewer 2.jpg]] | ||
+ | |||
+ | |||
+ | [[Файл:Viewer 3.jpg]] | ||
+ | |||
+ | [[Файл:Viewer.jpg]] | ||
+ | |||
+ | |||
+ | |||
+ | === Цветной текст === | ||
+ | |||
+ | ---- | ||
+ | |||
+ | :Текстовый объект, если встретит в тексте символы $c0xFF46FF26 ( обязательно пробел до символов и после), то последующий текст будет перекрашен в указанный цвет. | ||
+ | '''!!! Нельзя указывать вначале текстовой ячейки или сразу после #.''' | ||
+ | '''После перекрашивания не ставим пробел, должен быть символ ( нельзя так : "текст $c0xFF46FF26 текст2")''' | ||
+ | |||
+ | :Расшифровка: | ||
+ | ::$c0xFF46FF26 | ||
+ | ::$ - карявка для определения, что впереди что-то есть | ||
+ | ::с - типа color | ||
+ | ::0xFF46FF26 - код цвета 0xFF46FF26 ( 0x - обязательно ( указываем 16-тиричную систему исчисления), FF - альфа, 46 - число по Red каналу, FF - Green канал, 26 - Blue канал). | ||
+ | [[Файл:Select Color.jpg]] | ||
+ | |||
+ | :Пример: | ||
+ | ::Текст_1 $c0xFF46FF26 Текст_2 | ||
+ | ::Текст_1 - будет цветом указанным в текстовом объекте, а Текст_2 - будет зелёным. | ||
+ | [[Файл:Viewer 4.jpg]] | ||
+ | |||
+ | |||
+ | [[Category:Main objects]] |
Текущая версия на 12:11, 20 августа 2021
Text - объект для отображения текстовой информации с поддержкой многоязычности. Для управления текстовыми ресурсами используется TextEditor.
Содержание
Введение
Если необходимо разместить текст на сцене необходимо создать объект с типом text и перетащить на поле текстID текстовую строку из TextEditor. Также можно просто перенести их TextEditor выбранную текстовую запись, при этом автоматически создастся объект с типом Text.
Обязательно в тексте ТекстовойБазы, после символа '|' должен стоять другой символ. Если делаем два переноса, это будет выглядеть: "текст| |тест".
Параметры объекта
Общие параметры
(см. описание Object)
Основные параметры
- res - Графический ресурс подложки на которой выводится текст. Перетаскивается мышкой из редактора текста (поле должно находится в состоянии редактирования). Может отсутствовать.
- текстID - Выводимый текст перетаскивается из ресурса текстов, для перетягивания поле в объекте Text должно быть в режиме редактирования. Решетка (#) разделяет на страницы, черта (|) - принудительный переход на новую строку.
- текст - Выводимый текст без использования базы текстовых ресурсов. Решетка (#) разделяет на страницы, черта (|) - принудительный переход на новую строку.
- textCanBeOptionsKey - позволяет выключить проверку на ключ в опциях (Если в поле text указать "x" - то с включённым функционалом, текстовый объект покажет значение из опций параметра "x"; Если выключено - отобразит "x");
- состояние - в поле указывается состояние текстового объекта, в которое он перейдет при загрузке экрана (это поле часто оставляют пустым, а состояния задают машиной).
!!! - Необходимо обязательно сохранять любые изменения с текстом в редакторе TextEditor.
Дополнительные параметры
Группа - форматирования
- dx - Бордюр (отступ текста слева и справа от границы прямоугольника объекта);
- dy - Бордюр (отступ текста сверху и снизу от границы прямоугольника объекта);
- отступ - Вертикальное расстояние между строчками в пикселях;
- h align - Горизонтальное форматирование. Если (c) - центрирование по горизонтали, если (r) - прижатие вправо;
- v align - Вертикальное форматирование. Если (c) - центрирование по вертикали.
- автоматическое уменьшение - Функция позволяет уменьшить размер шрифта, чтобы уместить текст внутри прямоугольника ( размеры текстового объекта).
- минимальный размер шрифта - Минимальный размер до которого уменьшит функция автоскейла.
- уменьшать до строк - Нужно для функционала автоматического уменьшения. Попытается строку преобразовать в n строк ( исп. для цен).
Группа - Параметры отображения текста
- время до открытия - Время перед началом проявления текста (от невидимого до заданной прозрачности);
- время открытия - Время проявления текста и подложки до alpha в начале;
- время закрытия - Время исчезновения текста и подложки от alpha до 0 в конце. Если отрицательно - текст не закрывается;
- буквы - Задержка в ms для перехода к новой букве при подсветке;
- слова - Задержка в ms перед подсветкой следующего слова;
- страницы - Задержка в ms перед переходом к следующей странице или увяданию по alpha-каналу.
Группа - Параметры используемого шрифта
- имя - Номер шрифта - целое число, начиная с 0 (порядковый номер шрифта).
- размер - Размер шрифта в поинтах.
- цвет 1 - Цвет текста начального вида (бледный).
- цвет 2 - Цвет прочитанного текста (контрастный). Чтение делается по буквам.
Группа - Время
- до появления символов ( tmBefore ) - Время до появления символов по alpha-каналу. Только для режима спрятанных символов; Пауза перед стартом анимации (по сути отсрочка сост. "start");
Группа - Параметры поведения текста
- автопромотка - Автоматический переход на следующую страницу после завершения отображения текста;
- зациклить - Зациклить страницы (после последней, перейти опять на первую);
- подсветка - Тип подсветки: 0-не подсвечивать, 1-по слову; 2-по букве слова (караоке); 3-по букве с начала страницы;
- звук - 1 - есть озвучка, 0 - нет;
- случайный выбор - 1 - при переключении страницы будет выбираться случайная, 0 - все страницы последовательно. Если выбрана 1 - в редакторе Texts Editor между страницами надо поставить знак #.
- прятать % символов ( hidesymbols ) - указанный процент символов которые будут спрятаны;
Тонкости исп. hidesymbols : при сост. "init" - буквы будут выставленны моментально при изменение параметра и передаче сост. "start" - буквы будут проявляться за время "проявления одного символа" ("tmAppear"); Добавленные буквы после сост. "start" записываются в текстовом объекте в поле "appearingChars" с разделителем "|" ; П.С. текстовый объект сохраняет маску спрятанных букв в опции ( до тех пор, пока не меняется количество символов - т.е. поменяв txtID или локализацию - маска перегенерируется);
Например:
- голос - голос для озвучки. Звуковой файл для одной реплики.
- позиционирование текста
- горизонтальное - 0 - нет выравнивания; 1 - прижать к левому краю; 2 - центр; 3 - к правому;
- вертикальное - 0 - нет выравнивания; 1 - прижать к верхнему краю; 2 - центр; 3 - к нижнему.
Добавляемые параметры
Меню выбора Добавляемые параметры к объектам активируется по правой кнопки мыши.
голос для озвучки - голос для озвучки 1 реплики. Следить за тем, чтобы количество звуков совпадало с количеством реплик.
Состояния
Все состояния:
- beg - по прохождению времени из поля время->до открытия переходит в состояние open;
- start - форматирует текст, после чего переходит в состояние beg;
- open - проявляет текст по альфе за время, указанное в поле время->открытия и переходит в состояние first;
- run - выводит текст из поля txt/txtID по правилам из группы "Подсветка";
- pause - остановка вывода текста в обьект на подсвеченом слове;
- wait - показ последней напечатанной страницы, ожидание следующей команды;
- first - запустить показ первой страницы текста (страницы отделяются в текстовом ID символами #) в соответствии с правилами подсветки;
- last - запустить показ последней страницы текста (страницы отделяются в текстовом ID символами #) в соответствии с правилами подсветки;
- next - запустить показ следующей страницы текста в соответствии с правилами подсветки (если текущая страница - последняя, то в этом состоянии ничего не произойдет);
- prev - запустить показ предыдущей страницы текста в соответствии с правилами подсветки (если текущая страница - первая, то в этом состоянии ничего не произойдет);
- close - плавно растворяет текст по альфе в течении времени, указанном в поле время->закрытия, после чего переходит в состояние end;
- cross - зачеркнуть текст;
- end - убрать текст из текстового обьекта.
Параметры
- txtID - меняет объекту текстовый id. Перетягиваем из текстового редактора в поле val_txt необходимый текстовый id.
- fc1 - предоставляет возможность изменить цвет шрифта текстового объекта. В поле val вписывается цвет в виде 16-го кода.
- sense - позволяет отображать разные поля текстового id. Если установить значение 0 - у текстового объекта будет отображаться поле word, если 1 - sentence1, если 2 - sentence2.
- textWidth - ширина текущего текста в текстовом объекте в px (с учетом параметров форматирования текстового объекта).
- textHeight - высота текущего текста в текстовом объекте в px.
Пример применения
Примечания и дополнения
- Если у одного текстового ID слишком много страниц или же они должны меняться в запутанном порядке, то лучше создать несколько тестовых ID и по очереди присваивать их одному текстовому объекту с помощью машины состояний: команда set, параметры obj(текстовый объект), par(txtID), val_txt(текстовый ID, перетаскивается кнопкой мыши из редактора текстов).
- Отображать и делать невидимым текст можно несколькими способами, например, менять общие параметры vis или al, но целесообразней использовать состояния текстового объекта start и close.
- Разделение строк в текстовой базе символом # можно использовать, если страниц 2(3). В этом случае для смены страниц используют состояние next. Если страниц больше 2(3), лучше создать несколько текстовых ID и присваивать их текстовому объекту с помощью машины состояний.
- Значения временных параметров по умолчанию:
- время до открытия - 0,
- время открытия - 500,
- время закрытия - 500,
- буквы - 30,
- слова - 30,
- страницы - 500.
- Другими словами такие значения параметров равносильны нулю.
Для постепенного открытия (закрытия) текста следует указывать временные параметры отличные от значений по умолчанию.
Картинка в тексте
- Иконка будет вставлена в текст, если будет символы - $id167$al0.5$dx5.
- Расшифровка:
- $ - карявка для определения, что впереди что-то есть
- id167 - указываем отрисовать картинку с id==167 ( картинка должна присутствовать на этом экране, иначе не покажется; Если картинки нету в ресурсной базе - будет выполнено два пробела);
- $al0.5 - указываем альфу картинки;
- $dx5 - указываем что картинку смещаем на 5-ть пикселей вправо от точки вставки;
- Примечание:
- 1) Если не указываем $al0.5 или $dx5, то берём стандартное значение ( к примеру $id167 - означает картинка 167 с альфой==1 и без смещения (dx==0));
- 2) al и dx могут могут быть в любом порядке.
- 3) Записывать в текст спец. символы можно и через переменную;
- 4) Текст по высоте будет смещён на половину высоты самой большой картинки в строке ( если половина высоты больше размера шрифта);
- 5) иконка вставляемая в текст должна быть без лишней альфы ( при отступах учитывается ширина и высота картинки).
- Пример:
Цветной текст
- Текстовый объект, если встретит в тексте символы $c0xFF46FF26 ( обязательно пробел до символов и после), то последующий текст будет перекрашен в указанный цвет.
!!! Нельзя указывать вначале текстовой ячейки или сразу после #. После перекрашивания не ставим пробел, должен быть символ ( нельзя так : "текст $c0xFF46FF26 текст2")
- Расшифровка:
- $c0xFF46FF26
- $ - карявка для определения, что впереди что-то есть
- с - типа color
- 0xFF46FF26 - код цвета 0xFF46FF26 ( 0x - обязательно ( указываем 16-тиричную систему исчисления), FF - альфа, 46 - число по Red каналу, FF - Green канал, 26 - Blue канал).
- Пример:
- Текст_1 $c0xFF46FF26 Текст_2
- Текст_1 - будет цветом указанным в текстовом объекте, а Текст_2 - будет зелёным.