HelperLib: add concatItemDescription function
This commit is contained in:
@@ -21,4 +21,5 @@ doFile('Lib.registeredItems')
|
|||||||
doFile('Lib.requires')
|
doFile('Lib.requires')
|
||||||
|
|
||||||
--- Dependent of SMC methods
|
--- Dependent of SMC methods
|
||||||
|
doFile('Lib.itemHelpers')
|
||||||
doFile('Lib.matchItemDescription')
|
doFile('Lib.matchItemDescription')
|
||||||
|
|||||||
39
mods/SYSTEM/HelperLib/src/Lib/itemHelpers.lua
Normal file
39
mods/SYSTEM/HelperLib/src/Lib/itemHelpers.lua
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
local assert = assert
|
||||||
|
local ItemStack = ItemStack
|
||||||
|
|
||||||
|
---A pattern for describing an item, used when the
|
||||||
|
---item does not have a clearly defined pattern.
|
||||||
|
local DESC_PATTERN = '{title}\n {desc}'
|
||||||
|
|
||||||
|
---Returns the description of the item,
|
||||||
|
---concatenated according to the pattern specified in `settings._description_pattern`.
|
||||||
|
---
|
||||||
|
---If the `meta` parameter is passed, it can retrieve the necessary params from there.
|
||||||
|
---@param settings Item.Settings|Node.Settings
|
||||||
|
---@param meta ItemStackMetaRef?
|
||||||
|
---@param pattern string?
|
||||||
|
---@return string
|
||||||
|
function Smc.concatItemDescription(settings, meta, pattern)
|
||||||
|
-- If the meta is not provided,
|
||||||
|
-- we create an empty item stack in order to get dummy metadata.
|
||||||
|
meta = meta or ItemStack():get_meta()
|
||||||
|
local description = pattern or settings._description_pattern or DESC_PATTERN
|
||||||
|
|
||||||
|
local title = meta:get_string('_title')
|
||||||
|
if title == '' or title == nil then
|
||||||
|
title = settings._title or settings.description or ''
|
||||||
|
end
|
||||||
|
description = description:gsub('{title}', title)
|
||||||
|
|
||||||
|
local desc = meta:get_string('_desc')
|
||||||
|
if desc == '' or desc == nil then
|
||||||
|
desc = settings._description or settings.description or ''
|
||||||
|
end
|
||||||
|
description = description:gsub('{desc}', desc)
|
||||||
|
|
||||||
|
local rarityTitle = settings._rarity_title
|
||||||
|
assert(rarityTitle ~= nil)
|
||||||
|
description = description:gsub('{rarity_title}', rarityTitle)
|
||||||
|
|
||||||
|
return description
|
||||||
|
end
|
||||||
@@ -50,6 +50,7 @@ function Smc.getRegisteredItems()
|
|||||||
return table.copy_with_metatables(registeredItems)
|
return table.copy_with_metatables(registeredItems)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---TODO: описание
|
||||||
---@param itemName ItemStack|ItemStackString
|
---@param itemName ItemStack|ItemStackString
|
||||||
---@return Item.ItemDefinition|Node.NodeDefinition
|
---@return Item.ItemDefinition|Node.NodeDefinition
|
||||||
function Smc.getItemDefinition(itemName)
|
function Smc.getItemDefinition(itemName)
|
||||||
@@ -58,11 +59,14 @@ function Smc.getItemDefinition(itemName)
|
|||||||
end
|
end
|
||||||
|
|
||||||
local item = Smc.getRegisteredItemByName(itemName)
|
local item = Smc.getRegisteredItemByName(itemName)
|
||||||
assert(item ~= nil)
|
if item == nil then
|
||||||
|
return { settings = {} }
|
||||||
|
end
|
||||||
|
|
||||||
return item.itemDef
|
return item.itemDef
|
||||||
end
|
end
|
||||||
|
|
||||||
|
---TODO: описание
|
||||||
---@param itemName ItemStack|ItemStackString
|
---@param itemName ItemStack|ItemStackString
|
||||||
---@return Item.ItemDefinition|Node.NodeDefinition|nil
|
---@return Item.ItemDefinition|Node.NodeDefinition|nil
|
||||||
function Smc.getItemDefinitionOrNil(itemName)
|
function Smc.getItemDefinitionOrNil(itemName)
|
||||||
|
|||||||
Reference in New Issue
Block a user