Шаблон:Сущность/doc - История изменений

Pok в 14:07, 4 апреля 2026

2026-04-04T14:07:06Z

← Предыдущая версия		Версия от 17:07, 4 апреля 2026
Строка 116:		Строка 116:

	Примеры:		Примеры:
	* {{tji\|сущность\|id\|~~ignoreComponents~~{{=}}Item, Sprite}}		* {{tji\|сущность\|id\|showSource{{=}}1}}
	* {{tji\|сущность\|id\|~~ignorePrototypes~~{{=}}Alert, Tag}}		* {{tji\|сущность\|id\|componentBlacklist{{=}}Item, Sprite}}
			* {{tji\|сущность\|id\|prototypeBlacklist{{=}}Alert, Tag}}
			* {{tji\|сущность\|id\|componentWhitelist{{=}}Explosive, Sprite}}
			* {{tji\|сущность\|id\|prototypeWhitelist{{=}}Alert, Tag}}

	== Параметры ==		== Параметры ==
	{{Параметры\|		{{Параметры\|
	{{Параметры/строка\|1\|Id сущности.\|Да}}		{{Параметры/строка\|1\|Id сущности.\|Да}}
			{{Параметры/строка\|showSource\|Показывать источники полей. При значении <code>1</code> источники отображаются.\|Нет}}
	{{Параметры/строка\|whitelist\|Белый список полей в формате <code>режим_поле</code>, перечисленных через запятую.\|Нет}}		{{Параметры/строка\|whitelist\|Белый список полей в формате <code>режим_поле</code>, перечисленных через запятую.\|Нет}}
	{{Параметры/строка\|blacklist\|Чёрный список полей в формате <code>режим_поле</code>, перечисленных через запятую.\|Нет}}		{{Параметры/строка\|blacklist\|Чёрный список полей в формате <code>режим_поле</code>, перечисленных через запятую.\|Нет}}
	{{Параметры/строка\|~~ignoreComponents~~\|~~Список~~ компонентов, которые не нужно учитывать при сборке сущности.\|Нет}}		{{Параметры/строка\|componentWhitelist\|Белый список компонентов, которые нужно учитывать при сборке сущности.\|Нет}}
	{{Параметры/строка\|~~ignorePrototypes~~\|~~Список~~ прототипов, которые не нужно учитывать при сборке сущности.\|Нет}}		{{Параметры/строка\|componentBlacklist\|Чёрный список компонентов, которые не нужно учитывать при сборке сущности.\|Нет}}
			{{Параметры/строка\|prototypeWhitelist\|Белый список прототипов, которые нужно учитывать при сборке сущности.\|Нет}}
			{{Параметры/строка\|prototypeBlacklist\|Чёрный список прототипов, которые не нужно учитывать при сборке сущности.\|Нет}}
	}}		}}

Pok в 17:26, 25 марта 2026

2026-03-25T17:26:24Z

@@ Строка 50: / Строка 50: @@
 Если один и тот же режим содержит несколько полей, они просто перечисляются отдельными параметрами. Это лишь пример, лучше получать обрабатывать переданные параметры, чтобы они менялись взависимости от сущности. {{ссылка на раздел|#Какие параметры получает шаблон}}
 == Какие параметры получает шаблон ==
 Кроме режимов и <code>id</code>, модуль передаёт шаблону параметры из JSON-страницы сущности.

Pok в 17:02, 25 марта 2026

2026-03-25T17:02:05Z

← Предыдущая версия		Версия от 20:02, 25 марта 2026
Строка 118:		Строка 118:
	== Примечания ==		== Примечания ==
	* Если нужный шаблон сущности или компонента отсутствует, модуль выводит служебный блок с указанием отсутствующего шаблона.		* Если нужный шаблон сущности или компонента отсутствует, модуль выводит служебный блок с указанием отсутствующего шаблона.
	* В белом и чёрном списках используются режимы из описания шаблона: обычно <code>title</code> и <code>card</code>.
	* Для карточки модуль отдельно вызывает подпись поля и его содержимое, поэтому обычно нужно задавать обе части: <code>cardLabel</code> и <code>cardContent</code>.		* Для карточки модуль отдельно вызывает подпись поля и его содержимое, поэтому обычно нужно задавать обе части: <code>cardLabel</code> и <code>cardContent</code>.

Pok в 09:41, 25 марта 2026

2026-03-25T09:41:09Z

← Предыдущая версия		Версия от 12:41, 25 марта 2026
Строка 1:		Строка 1:
	{{docpage}}		{{docpage}}
	{{OnLua\|Сущность\|module1=Сущность/поля}}		{{OnLua\|Сущность\|module1=Сущность/поля}}
	Модуль предназначен для вывода блоков сущности по её id. Основная его настройка делается не в самом вызове модуля, а в шаблонах сущностей и компонентов вида <code>component/...</code>, <code>prototype/...</code> и их вариантах <code>/store</code>.		Модуль предназначен для вывода блоков сущности по её id. Основная его настройка делается не в самом вызове модуля, а в шаблонах сущностей и компонентов вида <code>component/...</code>, <code>prototype/...</code> и их вариантах <code>/store</code>. Используется на страницах сущностей см. [[:Категория:Сущности]].

	Поля берутся из json страниц		Поля берутся из json страниц

Pok в 08:19, 25 марта 2026

2026-03-25T08:19:25Z

@@ Строка 62: / Строка 62: @@
+         }
      },
-    "soundNoDamage": {
+...
 },
 </pre>

Pok: Новая страница: «{{docpage}} {{OnLua|Сущность|module1=Сущность/поля}} Модуль предназначен для вывода блоков сущности по её id. Основная его настройка делается не в самом вызове модуля, а в шаблонах сущностей и компонентов вида `component/...`, `prototype/...` и их вариантах `/store`....»

2026-03-24T19:25:00Z

Новая страница: «{{docpage}} {{OnLua|Сущность|module1=Сущность/поля}} Модуль предназначен для вывода блоков сущности по её id. Основная его настройка делается не в самом вызове модуля, а в шаблонах сущностей и компонентов вида <code>component/...</code>, <code>prototype/...</code> и их вариантах <code>/store</code>....»

Новая страница

{{docpage}}
{{OnLua|Сущность|module1=Сущность/поля}}
Модуль предназначен для вывода блоков сущности по её id. Основная его настройка делается не в самом вызове модуля, а в шаблонах сущностей и компонентов вида <code>component/...</code>, <code>prototype/...</code> и их вариантах <code>/store</code>.

Поля берутся из json страниц
* <code>Участник:IanComradeBot/component/название</code> (пример: [[Участник:IanComradeBot/component/access.json]])
* <code>Участник:IanComradeBot/prototype/название</code> (пример: [[Участник:IanComradeBot/prototype/tag.json]])

Для подпроектов
* <code>Участник:IanComradeBot/component/Проект/название</code> (пример: [[Участник:IanComradeBot/Goob/component/access.json]])
* <code>Участник:IanComradeBot/prototype/Проект/название</code> (пример: [[Участник:IanComradeBot/Goob/prototype/tag.json]])

== Как устроен шаблон сущности ==
Шаблон должен уметь работать в нескольких режимах. Обычно вся схема полей описывается через {{шс|Модуль:Сущность/поля}}.

Базовый вид:

<pre>
{{#invoke:Сущность/поля|main
|title_* =
|cardLabel_* =
|cardContent_* =
|cardTag =
}}
</pre>

По нему {{шс|сущность}} понимает:
* какие заголовки можно выводить в режиме <code>title</code>;
* какие поля попадут в карточку через режимы <code>cardLabel</code> и <code>cardContent</code>;
* нужно ли добавлять тег карточки через <code>cardTag</code>.

=== Описание полей через Модуль:Сущность/поля ===
{{шс|Модуль:Сущность/поля}} принимает составные параметры вида <code>режим_поле</code>.

Пример:
<pre>
{{#invoke:Сущность/поля|main
|title_Механики = Имеет размер!
|cardLabel_Размер = [[Размер]]
|cardContent_Размер = Маленький
|cardTag = Предмет
}}
</pre>

Это создаст на странице:
* заголовок h2 <code>Механики</code>;
* ячейку карточки с заголовком <code>Размер</code>;
* содержание ячейки карточки <code>1</code>;
* в карточку будет добавлен тег <code>Предмет</code>.

Если один и тот же режим содержит несколько полей, они просто перечисляются отдельными параметрами. Это лишь пример, лучше получать обрабатывать переданные параметры, чтобы они менялись взависимости от сущности. {{ссылка на раздел|#Какие параметры получает шаблон}}

== Какие параметры получает шаблон ==
Кроме режимов и <code>id</code>, модуль передаёт шаблону параметры из JSON-страницы сущности.

Например, json сущности <code>MopItem</code> из [[Участник:IanComradeBot/component/meleeWeapon.json]] выглядит так:
<pre>
"MopItem": {
"damage": {
"types": {
"Blunt": 10
}
},
"soundNoDamage": {
"!type:SoundCollectionSpecifier": {
"collection": "WeakHit"
}
},
"soundHit": {
"!type:SoundCollectionSpecifier": {
"collection": "MetalThud"
}
},
"soundSwing": {
"!type:SoundPathSpecifier": {
"params": {
"variation": 0.025,
"volume": -3
},
"path": "/Audio/Weapons/punchmiss.ogg"
}
}
},
</pre>

то внутри шаблона их можно получать как:
* {{param|damage}} -> "types": {"Blunt": 10}}
* {{param|damage.types}} -> {"Blunt": 10}
* {{param|damage.types.Blunt}} -> 10

То есть модуль передаёт расплющенные параметры записи, и после этого их можно использовать как обычные параметры шаблона, в том числе с точками в имени.

Дальше их можно оставить так, либо использовать json функции из {{шс|Модуль:GetField}}, если нужно обработать вложенность (пример [[Шаблон:Component/meleeWeapon]]).

== Использование модуля ==
Основной вызов:
* {{tji|сущность|id}}

Модуль сам:
* определяет компоненты сущности по <code>component.json</code>;
* определяет связанные прототипы по <code>prototype_store.json</code>;
* подгружает шаблоны <code>component/...</code>, <code>prototype/...</code>, а также <code>/store</code>-варианты;
* собирает итоговые блоки заголовков и карточки.

=== Ограничение вывода ===
Можно управлять тем, какие поля будут выведены, через белый и чёрный списки. Эти параметры принимают список имён через запятую и убирают соответствующие из обработки.

Примеры:
* {{tji|сущность|id|whitelist{{=}}title_Описание, card_Масса}}
* {{tji|сущность|id|blacklist{{=}}title_Описание, card_Масса}}

Формат значения:
* <code>режим_поле</code>
<br>
Иногда нужно скрыть часть шаблонов сущности целиком, не меняя их разметку.

Примеры:
* {{tji|сущность|id|ignoreComponents{{=}}Item, Sprite}}
* {{tji|сущность|id|ignorePrototypes{{=}}Alert, Tag}}

== Параметры ==
{{Параметры|
{{Параметры/строка|1|Id сущности.|Да}}
{{Параметры/строка|whitelist|Белый список полей в формате <code>режим_поле</code>, перечисленных через запятую.|Нет}}
{{Параметры/строка|blacklist|Чёрный список полей в формате <code>режим_поле</code>, перечисленных через запятую.|Нет}}
{{Параметры/строка|ignoreComponents|Список компонентов, которые не нужно учитывать при сборке сущности.|Нет}}
{{Параметры/строка|ignorePrototypes|Список прототипов, которые не нужно учитывать при сборке сущности.|Нет}}
}}

== См. также ==
* {{шс|loc}}
* {{шс|GetField}}
* {{шс|Предмет}}
* {{шс|Модуль:Сущность/поля}}

== Примечания ==
* Если нужный шаблон сущности или компонента отсутствует, модуль выводит служебный блок с указанием отсутствующего шаблона.
* В белом и чёрном списках используются режимы из описания шаблона: обычно <code>title</code> и <code>card</code>.
* Для карточки модуль отдельно вызывает подпись поля и его содержимое, поэтому обычно нужно задавать обе части: <code>cardLabel</code> и <code>cardContent</code>.