Модуль:Entity Lookup/doc: различия между версиями

Материал из Space Station 14 Вики
(норм документация чё вы)
мНет описания правки
Строка 3: Строка 3:


Этот модуль должен облегчить жизнь всем тем, кто решился поработать с энтити на вики. С его помощью можно "брать" названия и описания энтити (всех, даже животных и стен) прямо из игры и разворачивать их в удобные шаблоны. Сделано это было для того, чтобы не выискивать в локализации нужные названия и описания энтити. Очень полезно!!!
Этот модуль должен облегчить жизнь всем тем, кто решился поработать с энтити на вики. С его помощью можно "брать" названия и описания энтити (всех, даже животных и стен) прямо из игры и разворачивать их в удобные шаблоны. Сделано это было для того, чтобы не выискивать в локализации нужные названия и описания энтити. Очень полезно!!!
Модули в тексте вызываются с помощью следующей конструкции:<br><br>
Модули в тексте вызываются с помощью следующей конструкции:<br>
'''<nowiki>{{#invoke:Название модуля|Функция модуля|Аргументы функции}}</nowiki>'''<br><br>
'''<nowiki>{{#invoke:Название модуля|Функция модуля|Аргументы функции}}</nowiki>'''<br>
Аргументы могут быть позиционными (зависеть от порядка их указания), именованными (зависеть от ключевого слова перед ними) или необязательными (при их отсутствии функция может повести себя по особому сценарию, к примеру вместо картинки поставить placeholder). '''ВЫ НЕ МОЖЕТЕ ЗАМЕНИТЬ ПОЗИЦИОННЫЙ АРГУМЕНТ ИМЕННЫМ!'''<br>
Аргументы могут быть позиционными (зависеть от порядка их указания), именованными (зависеть от ключевого слова перед ними) или необязательными (при их отсутствии функция может повести себя по особому сценарию, к примеру вместо картинки поставить placeholder). '''ВЫ НЕ МОЖЕТЕ ЗАМЕНИТЬ ПОЗИЦИОННЫЙ АРГУМЕНТ ИМЕННЫМ!'''<br>
<hr>
<hr>
Пример вызова функции createtexttooltip модуля Entity Lookup с аргументами "FreedomImplant|Картинка=Файл:Honks.gif|Статы=Имеет 3 заряда":<br><br>
Пример вызова функции createtexttooltip модуля Entity Lookup с аргументами "FreedomImplant|Картинка=Файл:Honks.gif|Статы=Имеет 3 заряда"
'''<nowiki>{{#invoke:Entity Lookup|createtexttooltip|Текст|FreedomImplant|Картинка=Файл:Honks.gif|Статы=Имеет 3 заряда}}</nowiki>'''<br><br>
'''<nowiki>{{#invoke:Entity Lookup|createtexttooltip|Текст|FreedomImplant|Картинка=Файл:Honks.gif|Статы=Имеет 3 заряда}}</nowiki>'''<br>
Результат: <br><br>
Very easy to use. Подробнее смотрите на [https://www.mediawiki.org/wiki/Extension:Scribunto сайте mediawiki].<br><br>
{{#invoke:Entity Lookup|createtexttooltip|Текст|FreedomImplant|Картинка=Файл:Honks.gif|Статы=Имеет 3 заряда}}<br>
Very easy to use. Подробнее смотрите на [https://www.mediawiki.org/wiki/Extension:Scribunto сайте mediawiki].


==Функции модуля==
==Функции модуля==
Строка 29: Строка 27:
*'''Мета''' (именной, опциональный) - "Метаданные" для обработки картинки (например "64x64px|left|middle|link=")
*'''Мета''' (именной, опциональный) - "Метаданные" для обработки картинки (например "64x64px|left|middle|link=")
*'''Статы''' (именной, опциональный) - Дополнительный текст, идущий после основного описания энтити (к примеру у эмага там подписывается количество зарядов и время их восстановления, а у стопок материалов - количество листов в стопке)
*'''Статы''' (именной, опциональный) - Дополнительный текст, идущий после основного описания энтити (к примеру у эмага там подписывается количество зарядов и время их восстановления, а у стопок материалов - количество листов в стопке)
<hr>
===getname===
getname позволяет получить имя предмета в том же виде, в котором оно записано в игре.
'''<nowiki>{{#invoke:Entity Lookup|getname|ID}}</nowiki>'''<br>
* '''ID''' - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1)
<hr>
===getdesc===
getdesc позволяет получить описание предмета в том же виде, в котором оно записано в игре.
'''<nowiki>{{#invoke:Entity Lookup|getdesc|ID}}</nowiki>'''<br>
* '''ID''' - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1)

Версия от 08:30, 22 сентября 2023

Викиделам привет, остальным рекомендую вернуться на главную.

Этот модуль должен облегчить жизнь всем тем, кто решился поработать с энтити на вики. С его помощью можно "брать" названия и описания энтити (всех, даже животных и стен) прямо из игры и разворачивать их в удобные шаблоны. Сделано это было для того, чтобы не выискивать в локализации нужные названия и описания энтити. Очень полезно!!! Модули в тексте вызываются с помощью следующей конструкции:
{{#invoke:Название модуля|Функция модуля|Аргументы функции}}
Аргументы могут быть позиционными (зависеть от порядка их указания), именованными (зависеть от ключевого слова перед ними) или необязательными (при их отсутствии функция может повести себя по особому сценарию, к примеру вместо картинки поставить placeholder). ВЫ НЕ МОЖЕТЕ ЗАМЕНИТЬ ПОЗИЦИОННЫЙ АРГУМЕНТ ИМЕННЫМ!


Пример вызова функции createtexttooltip модуля Entity Lookup с аргументами "FreedomImplant|Картинка=Файл:Honks.gif|Статы=Имеет 3 заряда" {{#invoke:Entity Lookup|createtexttooltip|Текст|FreedomImplant|Картинка=Файл:Honks.gif|Статы=Имеет 3 заряда}}
Very easy to use. Подробнее смотрите на сайте mediawiki.

Функции модуля

createtexttooltip

createtexttooltip позволяет нам создать шаблон Tooltip и наклеить его на указанный в аргументах текст.
{{#invoke:Entity Lookup|createtexttooltip|Текст|ID|Картинка=Файл:mousegif.gif|Статы=Что-то полезное}}

  • Текст - Текст, к которому нужно добавить Tooltip
  • ID - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1)
  • Картинка (именной, опциональный) - Ссылка на картинку, начинающаяся с "Файл:" или "File:". Картинка будет использована как иконка в шаблоне Tooltip.
  • Статы (именной, опциональный) - Дополнительный текст, идущий после основного описания энтити (к примеру у эмага там подписывается количество зарядов и время их восстановления, а у стопок материалов - количество листов в стопке)

createimagetooltip

createimagetooltip позволяет нам создать шаблон Tooltip и наклеить его на указанное в аргументах изображение.
{{#invoke:Entity Lookup|createimagetooltip|Картинка|ID|Мета=мета|Статы=статы}}

  • Картинка - Ссылка на картинку, начинающаяся с "Файл:" или "File:". Картинка с наложенным Tooltip будет отображаться там, где вы вызовете модуль.
  • ID - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1)
  • Мета (именной, опциональный) - "Метаданные" для обработки картинки (например "64x64px|left|middle|link=")
  • Статы (именной, опциональный) - Дополнительный текст, идущий после основного описания энтити (к примеру у эмага там подписывается количество зарядов и время их восстановления, а у стопок материалов - количество листов в стопке)

getname

getname позволяет получить имя предмета в том же виде, в котором оно записано в игре. {{#invoke:Entity Lookup|getname|ID}}

  • ID - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1)

getdesc

getdesc позволяет получить описание предмета в том же виде, в котором оно записано в игре. {{#invoke:Entity Lookup|getdesc|ID}}

  • ID - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1)