2734
правки
Изменения
Новая страница: «{{Документация/Шапка}} <!-- Документацию следует размещать здесь --> Этот модуль использует…»
{{Документация/Шапка}}
<!-- Документацию следует размещать здесь -->
Этот модуль используется для изображения [[инвентарь|инвентарных]] слотов с изображениями блоков и предметов. Эти слоты по виду подобны тем, что имеются в игре ''Minecraft'' (при стандартном [[пакет ресурсов|пакете ресурсов]]). Изображение каждого предмета достаётся из [[Модуль:ИнвСпрайт/ID|таблицы спрайтов]], а если оно там отсутствует — из файла с полным названием в формате <code>Файл:Grid ''Название предмета'' [(''[[Модификации|Модификация игры]], если указана'')].png</code><ref>''Курсивом'' выделен текст, который заменяется на соответствующее значение. В [квадратных скобках] указан фрагмент, который не всегда присутствует.</ref>
Модуль рекомендуется использовать в других модулях напрямую (через <code>require("Модуль:{{BASEPAGENAME}}")</code>), а вне их — через шаблон {{шс|Инвентарный слот}}.
== Использование ==
{{См. также|Справка:Модули}}
Внутри других модулей этот модуль включается через функцию Lua <code>require</code>: <code>require("Модуль:{{BASEPAGENAME}}")</code>, которая возвращает ассоциативный массив (таблицу) с функциями и параметрами. Основной функцией является slot, именно её и следует вызывать, чтобы отобразить слот.
В других страницах модуль (а конкретно её функция slot) используется преимущественно через шаблон {{шс|Инвентарный слот}}, который вызывает программу через конструкцию {{шк|#invoke: {{BASEPAGENAME}}|slot}} (при этом параметры шаблона передаются модулю неявно). Именно эту конструкцию необходимо использовать, если модуль нужно вызвать из обычной страницы напрямую (вот только зачем?).
=== Параметры ===
Модуль поддерживает следующие параметры:
{| class="wikitable sortable" width=75%
! width=25% | Название !! width=35% | Описание !! Значение по умолчанию
|-
! colspan=3 | Основные параметры
|-
| <code>1</code><ref>Параметры с числовыми названиями являются порядковыми и обычно указываются без названия, которое тогда соответствует порядковому номеру среди таких аргументов.</ref> || Указывает название блока или предмета (или [[Модуль:Инвентарный слот/Псевдонимы|псевдоним]]). Можно указывать несколько предметов (до 16), отделяя их точкой с запятой. После названия через запятую можно указывать число предметов в стопке. Перед же названием можно указать в [квадратных скобках] иной всплывающий текст (по умолчанию он такой же, как и название предмета, если только не переопределён псевдонимом). || Пустое (тогда слот создаётся пустым)
|-
| <code>назв</code> || Переопределяет всплывающий текст для предметов. Следует обратить внимание, что он имеет более низкий приоритет, чем переопределение с помощью квадратных скобок, а значит, если используются оба метода сразу, отображён будет текст из скобок. || Пустое (тогда всплывающие тексты остаются нетронутыми)
|-
| <code>ссылка</code> || Определяет, на какую страницу ссылаются изображения. || Пустое (тогда изображения ссылаются на одноимённые с ними страницы)
|}
== Зависимости ==
* [[Minecraft Wiki:Система спрайтов|Система спрайтов]]:
** [[Модуль:Спрайт]] — главный модуль системы спрайтов.
** [[Модуль:ИнвСпрайт]] — данные по используемой модулем таблицы спрайтов ИнвСпрайт.
*** [[Модуль:ИнвСпрайт/ID]] — названия поддерживаемых предметов.
* [[Модуль:Инвентарный слот/Псевдонимы]] — псевдонимы для поддерживаемых названий.
== Примечания ==
{{Примечания}}
<includeonly>
<!-- Здесь следует размещать категории и интервики шаблона -->
[[Категория:Модули]]
[[en:Module:Inventory slot]]
</includeonly>
<noinclude>
<!-- Здесь следует размещать категории и интервики документации -->
[[en:Module:Inventory slot/doc]]
</noinclude>
<!-- Документацию следует размещать здесь -->
Этот модуль используется для изображения [[инвентарь|инвентарных]] слотов с изображениями блоков и предметов. Эти слоты по виду подобны тем, что имеются в игре ''Minecraft'' (при стандартном [[пакет ресурсов|пакете ресурсов]]). Изображение каждого предмета достаётся из [[Модуль:ИнвСпрайт/ID|таблицы спрайтов]], а если оно там отсутствует — из файла с полным названием в формате <code>Файл:Grid ''Название предмета'' [(''[[Модификации|Модификация игры]], если указана'')].png</code><ref>''Курсивом'' выделен текст, который заменяется на соответствующее значение. В [квадратных скобках] указан фрагмент, который не всегда присутствует.</ref>
Модуль рекомендуется использовать в других модулях напрямую (через <code>require("Модуль:{{BASEPAGENAME}}")</code>), а вне их — через шаблон {{шс|Инвентарный слот}}.
== Использование ==
{{См. также|Справка:Модули}}
Внутри других модулей этот модуль включается через функцию Lua <code>require</code>: <code>require("Модуль:{{BASEPAGENAME}}")</code>, которая возвращает ассоциативный массив (таблицу) с функциями и параметрами. Основной функцией является slot, именно её и следует вызывать, чтобы отобразить слот.
В других страницах модуль (а конкретно её функция slot) используется преимущественно через шаблон {{шс|Инвентарный слот}}, который вызывает программу через конструкцию {{шк|#invoke: {{BASEPAGENAME}}|slot}} (при этом параметры шаблона передаются модулю неявно). Именно эту конструкцию необходимо использовать, если модуль нужно вызвать из обычной страницы напрямую (вот только зачем?).
=== Параметры ===
Модуль поддерживает следующие параметры:
{| class="wikitable sortable" width=75%
! width=25% | Название !! width=35% | Описание !! Значение по умолчанию
|-
! colspan=3 | Основные параметры
|-
| <code>1</code><ref>Параметры с числовыми названиями являются порядковыми и обычно указываются без названия, которое тогда соответствует порядковому номеру среди таких аргументов.</ref> || Указывает название блока или предмета (или [[Модуль:Инвентарный слот/Псевдонимы|псевдоним]]). Можно указывать несколько предметов (до 16), отделяя их точкой с запятой. После названия через запятую можно указывать число предметов в стопке. Перед же названием можно указать в [квадратных скобках] иной всплывающий текст (по умолчанию он такой же, как и название предмета, если только не переопределён псевдонимом). || Пустое (тогда слот создаётся пустым)
|-
| <code>назв</code> || Переопределяет всплывающий текст для предметов. Следует обратить внимание, что он имеет более низкий приоритет, чем переопределение с помощью квадратных скобок, а значит, если используются оба метода сразу, отображён будет текст из скобок. || Пустое (тогда всплывающие тексты остаются нетронутыми)
|-
| <code>ссылка</code> || Определяет, на какую страницу ссылаются изображения. || Пустое (тогда изображения ссылаются на одноимённые с ними страницы)
|}
== Зависимости ==
* [[Minecraft Wiki:Система спрайтов|Система спрайтов]]:
** [[Модуль:Спрайт]] — главный модуль системы спрайтов.
** [[Модуль:ИнвСпрайт]] — данные по используемой модулем таблицы спрайтов ИнвСпрайт.
*** [[Модуль:ИнвСпрайт/ID]] — названия поддерживаемых предметов.
* [[Модуль:Инвентарный слот/Псевдонимы]] — псевдонимы для поддерживаемых названий.
== Примечания ==
{{Примечания}}
<includeonly>
<!-- Здесь следует размещать категории и интервики шаблона -->
[[Категория:Модули]]
[[en:Module:Inventory slot]]
</includeonly>
<noinclude>
<!-- Здесь следует размещать категории и интервики документации -->
[[en:Module:Inventory slot/doc]]
</noinclude>