added docs and fixed desc loading from item def

This commit is contained in:
GHOST11111100 2025-07-26 17:58:57 +03:00
parent 59d706323a
commit 0caed92baa
5 changed files with 21 additions and 0 deletions

View File

@ -18,6 +18,14 @@ Name of the item model. The model will be loaded automatically.
Default value is `packid:itemname.model`.
If the model is not specified, an automatic one will be generated.
### Caption and Description
`caption` - name of item in inventory
`description` - item description in inventory
this props allow to use `md`
*see [Text Styles](/doc/en/text-styles.md)*
## Behaviour
### *placing-block*

View File

@ -10,6 +10,9 @@ item.index(name: str) -> int
-- Returns the item display name.
block.caption(blockid: int) -> str
-- Returns the item display description.
item.description(itemid: int) -> str
-- Returns max stack size for the item
item.stack_size(itemid: int) -> int

View File

@ -17,6 +17,14 @@
Значение по-умолчанию - `packid:itemname.model`.
Если модель не указана, будет сгенерирована автоматическию
### Имя и Описание
`caption` - имя предмета в инвентаре
`description` - описание предмета в инвентаре
Можно использовать `md`
*см. [Text Styles](/doc/en/text-styles.md)*
## Поведение
### Устанавливаемый блок - `placing-block`

View File

@ -29,6 +29,7 @@ template<> void ContentUnitLoader<ItemDef>::loadUnit(
parentDef->cloneTo(def);
}
root.at("caption").get(def.caption);
root.at("description").get(def.description);
std::string iconTypeStr = "";
root.at("icon-type").get(iconTypeStr);

View File

@ -8,6 +8,7 @@ ItemDef::ItemDef(const std::string& name) : name(name) {
}
void ItemDef::cloneTo(ItemDef& dst) {
dst.caption = caption;
dst.description = description;
dst.stackSize = stackSize;
dst.generated = generated;
std::copy(&emission[0], &emission[3], dst.emission);