Модуль:Entity Lookup/doc: различия между версиями
Mhamster (обсуждение | вклад) мНет описания правки |
Mhamster (обсуждение | вклад) (урааа, документация) |
||
Строка 1: | Строка 1: | ||
__NOINDEX__ | __NOINDEX__ | ||
Викиделам привет, остальным рекомендую [[Заглавная_страница|вернуться на главную]]. | Викиделам привет, остальным рекомендую [[Заглавная_страница|вернуться на главную]].<br><br> | ||
'''[[#Функции_модуля|К функциям]]''' | |||
{{AboutModules}} | |||
==Про этот модуль== | |||
Этот модуль должен облегчить жизнь всем тем, кто решился поработать с энтити на вики. С его помощью можно "брать" названия и описания энтити (всех, даже животных и стен) прямо из игры и разворачивать их в удобные шаблоны. Сделано это было для того, чтобы не выискивать в локализации нужные названия и описания энтити. Очень полезно!!! | Этот модуль должен облегчить жизнь всем тем, кто решился поработать с энтити на вики. С его помощью можно "брать" названия и описания энтити (всех, даже животных и стен) прямо из игры и разворачивать их в удобные шаблоны. Сделано это было для того, чтобы не выискивать в локализации нужные названия и описания энтити. Очень полезно!!! | ||
Пример вызова функции createtexttooltip модуля Entity Lookup с аргументами "FreedomImplant|img=Файл:Honks.gif" | |||
'''<nowiki>{{#invoke:Entity Lookup|createtexttooltip|Текст|FreedomImplant|img=Honks.gif}}</nowiki>'''<br> | |||
{{#invoke:Entity Lookup|createtexttooltip|Текст|FreedomImplant|img=Honks.gif}}<br> | |||
Пример вызова функции createtexttooltip модуля Entity Lookup с аргументами "FreedomImplant| | |||
'''<nowiki>{{#invoke:Entity Lookup|createtexttooltip|Текст|FreedomImplant| | |||
Very easy to use. Подробнее смотрите на [https://www.mediawiki.org/wiki/Extension:Scribunto сайте mediawiki].<br><br> | Very easy to use. Подробнее смотрите на [https://www.mediawiki.org/wiki/Extension:Scribunto сайте mediawiki].<br><br> | ||
Строка 14: | Строка 13: | ||
===createtexttooltip=== | ===createtexttooltip=== | ||
createtexttooltip позволяет нам создать шаблон Tooltip и наклеить его на указанный в аргументах текст.<br> | createtexttooltip позволяет нам создать шаблон Tooltip и наклеить его на указанный в аргументах текст.<br> | ||
'''<nowiki>{{#invoke:Entity Lookup|createtexttooltip|Текст|ID| | '''<nowiki>{{#invoke:Entity Lookup|createtexttooltip|Текст|ID|img=Honks.gif}}</nowiki>'''<br> | ||
* '''Текст''' - Текст, к которому нужно добавить Tooltip | * '''Текст''' - Текст, к которому нужно добавить Tooltip | ||
* '''ID''' - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1) | * '''ID''' - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1) | ||
*''' | *'''img''' (именной, опциональный) - Ссылка на картинку '''БЕЗ ПРИПИСКИ''' "Файл:" или "File:". Картинка будет использована как иконка в шаблоне Tooltip. | ||
<hr> | <hr> | ||
===createimagetooltip=== | ===createimagetooltip=== | ||
createimagetooltip позволяет нам создать шаблон Tooltip и наклеить его на указанное в аргументах изображение.<br> | createimagetooltip позволяет нам создать шаблон Tooltip и наклеить его на указанное в аргументах изображение.<br> | ||
'''<nowiki>{{#invoke:Entity Lookup|createimagetooltip|Картинка|ID|Мета= | '''<nowiki>{{#invoke:Entity Lookup|createimagetooltip|Картинка|ID|Мета=Мета1,Мета2}}</nowiki>'''<br> | ||
*'''Картинка''' - Ссылка на картинку, начинающаяся с "Файл:" или "File:". Картинка с наложенным Tooltip будет отображаться там, где вы вызовете модуль. | *'''Картинка''' - Ссылка на картинку, начинающаяся с "Файл:" или "File:". Картинка с наложенным Tooltip будет отображаться там, где вы вызовете модуль. | ||
* '''ID''' - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1) | * '''ID''' - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1) | ||
*'''Мета''' (именной, опциональный) - "Метаданные" для обработки картинки | *'''Мета''' (именной, опциональный) - "Метаданные" для обработки картинки. То же самое, что вы бы написали после названия картинки в квадратных скобочках на обычной странице. '''Небольшой нюанс''': вместо <code>|</code> мы используем <code>,</code>(например "64x64px,left,middle,link=") | ||
<hr> | <hr> | ||
===getname=== | ===getname=== |
Версия от 18:13, 9 октября 2023
Викиделам привет, остальным рекомендую вернуться на главную.
К функциям
Про модули
Модули - небольшие скрипты, призванные облегчить жизнь всем, кто занимается вики. Модули - почти тоже самое, что и шаблоны, с одним небольшим отличием: модули не просто заменяют один кусочек текста на другой кусочек текста и подставляют в него параметры, но и могут производить некоторые манипуляции с данными, будь то: вычисление сложных математических функций, получение данных из json баз данных и много чего ещё.
Ещё модули отличаются от шаблонов механизмом вызова. Вместо простого {{Название шаблона|Аргументы шаблона}}
вы используете следующую конструкцию:
{{#invoke:Название модуля|Функция модуля|Аргументы функции}}
Заметили кое-что? Всё верно, в этой конструкции добавляется ключевое слово #invoke, а после названия модуля необходимо указать название нужной нам функции. Это необходимо потому, что модули не выполняют одну единственную задачу. Этих задач модуль может выполнять хоть 100 штук (если конечно кому-то не лень создавать 100 функций), поэтому нам необходимо указать модулю то, что мы от него хотим в данный конкретно момент.
Аргументы работают так же, как и в шаблонах. Если в документации аргументы задаются через Аргумент1=ПримерноеЗначение, то и при вызове модуля вы должны писать Аргумент1=ВашеЗначение, где Аргумент1 это название аргумента, указанного в документации, а ВашеЗначение это ваше значение, которое вы хотите передать в модуль.
Если же аргумент написан без знака =
после него, это значит что аргумент зависит от своей позиции. Всё так же, как и с шаблонами.
Про этот модуль
Этот модуль должен облегчить жизнь всем тем, кто решился поработать с энтити на вики. С его помощью можно "брать" названия и описания энтити (всех, даже животных и стен) прямо из игры и разворачивать их в удобные шаблоны. Сделано это было для того, чтобы не выискивать в локализации нужные названия и описания энтити. Очень полезно!!!
Пример вызова функции createtexttooltip модуля Entity Lookup с аргументами "FreedomImplant|img=Файл:Honks.gif"
{{#invoke:Entity Lookup|createtexttooltip|Текст|FreedomImplant|img=Honks.gif}}
ТекстИмплант
Микрочип, который вживляют под кожу.
Very easy to use. Подробнее смотрите на сайте mediawiki.
Функции модуля
createtexttooltip
createtexttooltip позволяет нам создать шаблон Tooltip и наклеить его на указанный в аргументах текст.
{{#invoke:Entity Lookup|createtexttooltip|Текст|ID|img=Honks.gif}}
- Текст - Текст, к которому нужно добавить Tooltip
- ID - ID энтити из игры (к примеру у коричневой мыши ID - MobMouse1)
- img (именной, опциональный) - Ссылка на картинку БЕЗ ПРИПИСКИ "Файл:" или "File:". Картинка будет использована как иконка в шаблоне Tooltip.
createimagetooltip
createimagetooltip позволяет нам создать шаблон Tooltip и наклеить его на указанное в аргументах изображение.
{{#invoke:Entity Lookup|createimagetooltip|Картинка|ID|Мета=Мета1,Мета2}}
- Картинка - Ссылка на картинку, начинающаяся с "Файл:" или "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)