Модуль:Инвентарный слот/док — различия между версиями
(→Использование) |
Softer (обсуждение | вклад) м (1 версия импортирована) |
(нет различий)
| |
Текущая версия на 00:27, 18 января 2017
Это страница документации, она будет включена в основную страницу этого модуля. Для дополнительной информации см. Шаблон:Документация.
Этот модуль используется для изображения инвентарных слотов с изображениями блоков и предметов. Эти слоты по виду подобны тем, что имеются в игре Minecraft (при стандартном пакете ресурсов). Изображение каждого предмета достаётся из таблицы спрайтов, а если оно там отсутствует — из файла с полным названием в формате Файл:Grid Название предмета [(Модификация игры, если указана)].png[1]
Модуль рекомендуется использовать в других модулях напрямую (через require("Модуль:Инвентарный слот")), а вне их — через шаблон {{Инвентарный слот}}.
Содержание
Использование
Внутри других модулей этот модуль включается через функцию Lua require: require("Модуль:Инвентарный слот"), которая возвращает ассоциативный массив (таблицу) с функциями и параметрами. Основной функцией является slot, именно её и следует вызывать, чтобы отобразить слот.
В других страницах модуль (а конкретно её функция slot) используется преимущественно через шаблон {{Инвентарный слот}}, который вызывает программу через конструкцию {{#invoke: Инвентарный слот|slot}} (при этом параметры шаблона передаются модулю неявно). Именно эту конструкцию необходимо использовать, если модуль нужно вызвать из обычной страницы напрямую (вот только зачем?).
Параметры
Модуль поддерживает следующие параметры:
| Название | Описание | Значение по умолчанию |
|---|---|---|
| Основные параметры | ||
1[2] |
Указывает название блока или предмета (или псевдоним). Можно указывать несколько предметов (до 16), отделяя их точкой с запятой. После названия через запятую можно указывать число предметов в стопке. Перед же названием можно указать в [квадратных скобках] иной всплывающий текст (по умолчанию он такой же, как и название предмета, если только не переопределён псевдонимом). | Пустое (тогда слот создаётся пустым) |
назв |
Переопределяет всплывающий текст для предметов. Следует обратить внимание, что он имеет более низкий приоритет, чем переопределение с помощью квадратных скобок, а значит, если используются оба метода сразу, отображён будет текст из скобок. | Пустое (тогда всплывающие тексты остаются нетронутыми) |
ссылка |
Определяет, на какую страницу ссылаются изображения. | Пустое (тогда изображения ссылаются на одноимённые с ними страницы) |
Зависимости
- Система спрайтов:
- Модуль:Спрайт — главный модуль системы спрайтов.
- Модуль:ИнвСпрайт — данные по используемой модулем таблицы спрайтов ИнвСпрайт.
- Модуль:ИнвСпрайт/ID — названия поддерживаемых предметов.
- Модуль:Инвентарный слот/Псевдонимы — псевдонимы для поддерживаемых названий.
Примечания
- ↑ Курсивом выделен текст, который заменяется на соответствующее значение. В [квадратных скобках] указан фрагмент, который не всегда присутствует.
- ↑ Параметры с числовыми названиями являются порядковыми и обычно указываются без названия, которое тогда соответствует порядковому номеру среди таких аргументов.
