NanoUi
| Тихо! Идёт работа! |
|---|
Статья или раздел находится в процессе написания и использовать её на сервере необходимо с осторожностью, информация может быть неточной. Вы можете помочь с её заполнением.
|
Код Dream Maker
Мы начнём с создания простейшего NanoUi. Чтобы понять как писать индусский код оно работает.
Для начала создадим простейший интерфейс для объекта "womdinger".
Вот файл нашего объекта:
/obj/item/device/wombdinger name = "womdinger" desc = "It's some kind of crude alien device." icon = 'icons/obj/wombdinger.dmi' icon_state = "0"
Создадим для него прок attack_self куда мы будем передавать, как mob, того кто использовал предмет.
Файл теперь выглядит так:
/obj/item/device/wombdinger name = "womdinger" desc = "It's some kind of crude alien device." icon = 'icons/obj/wombdinger.dmi' icon_state = "0" /obj/item/device/wombdinger/attack_self(mob/user as mob)
Теперь чтобы открыть NanoUi нужно поместить в attack_self прок вызова Ui, то есть ui_interact, которому нужно передать пользователя.
Файл теперь выглядит так:
/obj/item/device/wombdinger name = "womdinger" desc = "It's some kind of crude alien device." icon = 'icons/obj/wombdinger.dmi' icon_state = "0"
/obj/item/device/wombdinger/attack_self(mob/user as mob) ui_interact(user)
Теперь нужно создать сам прок ui_interact, создадим его в этом же файле:
/obj/item/device/wombdinger/ui_interact(mob/user, ui_key = "main", var/datum/nanoui/ui = null, var/force_open = 1)
Создав его нам нужно поместить в него что-то, если точнее это данные и логику создания/обновления интерфейса.
Массив data передаёт значения в нужный темплейт. О темплейтах позже.
/obj/item/device/wombdinger/ui_interact(mob/user, ui_key = "main", var/datum/nanoui/ui = null, var/force_open = 1) var/list/data = list() // Добавим простые данные в массив data["myName"] = name data["myDesc"] = desc data["someString"] = "I am a string." data["aNumber"] = 123
data["assocList"] = list("key1" = "Value1", "key2" = "Value2")
// Обратный слэш говорит компилятору игнорировать перенос строки, полезно для улучшения читабельности кода. data["arrayOfAssocLists"] = list(\ list("key1" = "ValueA1", "key2" = "ValueA2"),\ list("key1" = "ValueB1", "key2" = "ValueB2"),\ list("key1" = "ValueC1", "key2" = "ValueC2") )
data["emptyArray"] = list()
// обновляет ui с данными переданными данными если они переданы, возврашает null если ui не найдено, или ui не передаётся, или если force_open == 1 или true ui = nanomanager.try_update_ui(user, src, ui_key, ui, data, force_open) //Если ui не открыт то мы открываем его: if (!ui) // Список параметров ui можно найти в \code\modules\nano\nanoui.dm ui = new(user, src, ui_key, "womdinger.tmpl", "Womdinger UI", 520, 410) // Если ui открыт первый раз то мы используем эти данные: ui.set_initial_data(data) // Открываем новое окно ui ui.open()
Две важные вещи в коде выше это data, а точнее список ассоциаций и создание NanoUi: ("ui = new(user, src, ui_key, "womdinger.tmpl", "Womdinger UI", 520, 410)")
Первые три параметра nanoui никогда не меняются user(пользователь), src(цель пользователя), ui_key(ui ключ(уточнить)).
Остальные четыре параметра это темплейт который будет использоваться, заголовок окна, ширина и высота:
Темплейт должен именоваться именем файла в \nano\templates\
Ширина - это ширина как ни странно окна ui в пикселях.
Высота - высота окна ui в пикселях
Это всё что нам нужно в DM файле, прейдём к темплейтам.
Создаём темплейт и учим HTML[править]
NanoUI разделяет разметку отображения и код логики (файлы DM) и помещает его в файлы шаблонов (.tmpl). Файлы шаблонов - это в основном HTML-документы с разметкой, добавленной для динамических элементов, такие как кнопки.
В предыдущем разделе мы настроили наш файл womdinger.dm. В этом файле, в рамках процедуры ui_interact, имеется ссылка на файл «womdinger.tmpl». Нам нужно создать этот файл в папке \nano\templates\
Примечание: начиная с последнего обновления библиотеки NanoUI больше нет необходимости добавлять файлы шаблонов в клиентский процесс send_resources, поскольку это обрабатывается автоматически.
Теперь создадим темплейт кода для womdinger.tmpl:
Шаблон представляет собой стандартный HTML4 с дополнительными тегами разметки (заключенными в фигурные скобки { {...} }(Без пробелов в скобках, из-за вики тут они превращаются в шаблоны так что должно выглядеть как {{}}, а между ними содержимое)) для динамического содержимого (печать, условные операторы { {if} }, циклы { {for} } { {while} } и т. Д.).
Стиль по умолчанию для шаблона предоставляется файлом shared.css в папке /nano/css
Вот и все, самый простой пользовательский интерфейс, который вы можете создать в NanoUI. В следующем разделе мы рассмотрим использование дополнительных тегов разметки для динамического содержимого.
Спец тэги разметки темплейтов[править]
Специальный тэги разметки используются для добавления в темплейт динамических элементов зависящих от .dm части кода.
Тэг вывода[править]
Формат:[править]
{{:data.variable}}
Тэг вывода выводит на окно значение переменной как сроку
Пример 1:[править]
В womdinger.dm, в ui_interact, мв ставим значение для "someString" ключа массива Data:
data["someString"] = "I am a string"
И в womdinger.tmpl мы запрашиваем доступ к data с ключём:
{{:data.someString}}
Когда интерфейс прогрузится, тэг будет прогружен как:
I am a string.
I am a string.
Пример 2:[править]
В womdinger.dm, в ui_interact, мы делаем список асоциаций:
data["assocList"] = list("key1" = "Value1", "key2" = "Value2")
Вы можете получать доступ к элементам списка используя точку (.):
{{:data.assocList.key1}} and {{:data.assocList.key2}}
Когда интерфейс прогрузится, тэг будет заменён на:
Value1 and Value2
Тэг If[править]
Формат:[править]
{{if expression}}
<То что будет отображаться при истинности expression>
{{/if}}
{{if expression}}
<То что будет отображаться при истинности expression>
{{else}}
<То что будет отображаться при ложность expression>
{{/if}}
{{if expression1}}
<То что будет отображаться при истинности expression>
{{else expression2}}
<То что будет отображаться при истинности expression2>
{{/if}}
Тэг If отображает информацию в зависимости от правдивости данного выражения. Если вы видите Шаблон:If data.is prog, то это проверка на присутствие переменной is_prog (если is_prog равен null или 0 или не обозначен, то действие не выполняется).
Комбинируя if и тэг else можно отображать другую информацию если выражение равно True. "{{else expression2}}"), выдача выражения тэгу else даёт тэгу else функционал elseif
Пример 1:[править]
Пример темплейта:
{{if data.aNumber}}data.aNumber существует (не null) и положительный{{/if}}
Когда интерфейс прогрузится, при истинности выражения, тег будет заменён на:
data.aNumber существует (не null) и положительный
Пример 2:[править]
Пример темплейта:
{{if data.someString == "Who goes there?"}} Some string is "Who goes there?" {{else}} Some string is not "Who goes there?" {{/if}
Когда интерфейс прогрузится тэг будет заменён на:
Some string is not "Who goes there?"
Потому что выражение (someString == "Who goes there?") не истинно.
Пример 3:[править]
Пример темплейта:
{{if data.aNumber < 50}} data.aNumber меньше 50 {{else data.aNumber < 100}} data.aNumber меньше 100 {{else data.aNumber < 150}} data.aNumber меньше 150 {{else}} None of the expressions above are true. {{/if}
Когда интерфейс прогрузится тэг будет заменён на:
data.aNumber is less than 150
Потому что выражение подходит под второй else тэг (data.aNumber < 150).
Тэг for[править]
Формат:[править]
{{for array}} <list entry content> {{/for}}
{{for array}} <list entry content> {{empty}} <empty list content> {{/for}}
Цикл по элементам массива (массив - список с нумерацией элементов начинающейся с 0 (it does not use strings as keys).
Каждый раз, когда тег for выполняет проходит по массиву, он устанавливает переменную ("value" по умолчанию) для данных текущей записи (другая переменная, значение по умолчанию «index», содержит индекс (номер элемента в массиве)).
И примером этого является использование тега вывода для печати содержимого (например, Value.key1 и Value.key2).
В сочетании с empty тегом тег for может отображать содержимое, когда массив пуст.
Пример 1[править]
Пример темплейта:
{{for data.arrayOfAssocLists}}
{{:index}} -> {{:value.key1}} and {{:value.key2}}
{{/for}
Когда интерфейс прогрузится, тэги будут заменены на:
0 -> ValueA1 and ValueA2 1 -> ValueB1 and ValueB2 2 -> ValueC1 and ValueC2
Пример 2[править]
Пример темплейта:
{{for data.emptyArray}}
{{:value.key}}
{{empty}}
Этот список пуст.
{{/for}
Когда интерфейс прогрузится, тэги будут заменены на:
Этот список пуст.
Template Helpers[править]
Helpers - функции написанные на JavaScript, которые можно вызывать вместе с темплейтами.
Link Helper[править]
Формат:
{{:helper.link(text, icon, parameters, status, elementClass, elementId)}}
Генерирует ссылку (которая стандартно стилизована как кнопка). При нажатии на кнопку будут отправлены настроенные параметры на сервер.
Аргументы:
- text - строка - Текст на кнопке.
- icon - строка - Иконка в начале кнопки. Примеры: 'refresh', 'shuffle', 'radiation', 'power'.
- parameters - JSON - Параметры отсылаемые серверу по нажатию.
- status - null/строка - Опциональный статус ссылки. Может быть null для активной, 'disabled' для неактивной или 'selected' для выбранных.
- elementClass - null/строка - Если предоставленно, то кнопке будет присвоен класс (используется для стилизации CSS или JavaScript селекторов).
- elementId - null/строка - Если предоставленно, то кнопке будет присвоен идентификатор (используется для стилизации CSS или JavaScript селекторов).
Example 1: Basic usage
{{:helper.link('Toggle Power', 'power', { 'option' : 'togglePower' })}}
Если нажать на эту кнопку, в получающем объекте в переменной прока Topic href_list появятся следующие записи:
list("src" = "\ref[src]", "option" = "togglePower")
Example 2: Multiple parameters
{{:helper.link('Cut Red Wire', 'scissors', { 'wireColor' : 'red', 'action' : 'cut' })}}
Если нажать на эту кнопку, в получающем объекте в переменной прока Topic href_list появятся следующие записи:
list("src" = "\ref[src]", "wireColor" = "red", "action" = "cut")
Bar Helper[править]
Format:
{{:helper.displayBar(value, rangeMin, rangeMax, styleClass, styleClass, showText)}}
This helper creates a bar.
Parameters:
- value - number - Current value of progress bar
- rangeMin - number - Lower bound of value
- rangeMax - number - Upper bound of value
- styleClass - optional string - List of styles to apply, seperated by spaces. Acceptable styles include alignRight, good, notgood, average, bad, and highlight.
- showText - optional string - The text that is shown. Do not include the number itself.
Example 1: Health
{{if data.occupant.health >= 0}}
{{:helper.displayBar(data.occupant.health, 0, data.occupant.maxHealth, 'good')}}
{{else}}
{{:helper.displayBar(data.occupant.health, 0, data.occupant.minHealth, 'average alignRight')}}
{{/if}}
