CraftSystem: Changing the approach to class inheritance and adding default parameters for crafts
This commit is contained in:
@@ -28,28 +28,32 @@ local CraftSystem = {
|
||||
---@alias CraftSystem.PrimitiveCraftType 'inside_player_inventory'
|
||||
---@alias CraftSystem.ImmersiveCraftType 'workbench'
|
||||
---@alias CraftSystem.ProcessingCraftType 'test' -- DEBUG
|
||||
---@alias CraftSystem.CraftType CraftSystem.PrimitiveCraftType|CraftSystem.ImmersiveCraftType|CraftSystem.ProcessingCraftType
|
||||
|
||||
---@param type CraftSystem.PrimitiveCraftType
|
||||
local function registerPrimitiveCraftType(type)
|
||||
---@param def CraftSystem.PrimitiveCraftHandlerDef
|
||||
local function registerPrimitiveCraftType(type, def)
|
||||
assert(CraftSystem.PrimitiveCraftHandlers[type] == nil, ('A primitive craft type `%s` already exists.'):format(type))
|
||||
|
||||
local handler = PrimitiveCraftHandler:new()
|
||||
local handler = PrimitiveCraftHandler:new(type, def)
|
||||
CraftSystem.PrimitiveCraftHandlers[type] = handler
|
||||
end
|
||||
|
||||
---@param type CraftSystem.ImmersiveCraftType
|
||||
local function registerImmersiveCraftType(type)
|
||||
---@param def CraftSystem.ImmersiveCraftHandlerDef
|
||||
local function registerImmersiveCraftType(type, def)
|
||||
assert(CraftSystem.ImmersiveCraftHandlers[type] == nil, ('A immersive craft type `%s` already exists.'):format(type))
|
||||
|
||||
local handler = ImmersiveCraftHandler:new()
|
||||
local handler = ImmersiveCraftHandler:new(type, def)
|
||||
CraftSystem.ImmersiveCraftHandlers[type] = handler
|
||||
end
|
||||
|
||||
---@param type CraftSystem.ProcessingCraftType
|
||||
local function registerProcessingCraftType(type)
|
||||
---@param def CraftSystem.ProcessingCraftHandlerDef
|
||||
local function registerProcessingCraftType(type, def)
|
||||
assert(CraftSystem.ProcessingCraftHandlers[type] == nil, ('A processing craft type `%s` already exists.'):format(type))
|
||||
|
||||
local handler = ProcessingCraftHandler:new()
|
||||
local handler = ProcessingCraftHandler:new(type, def)
|
||||
CraftSystem.ProcessingCraftHandlers[type] = handler
|
||||
end
|
||||
|
||||
@@ -80,10 +84,11 @@ function CraftSystem:getProcessingCraftHandler(type)
|
||||
return handler
|
||||
end
|
||||
|
||||
--Registration of craft types:
|
||||
registerPrimitiveCraftType('inside_player_inventory')
|
||||
registerImmersiveCraftType('workbench')
|
||||
registerProcessingCraftType('test') -- DEBUG
|
||||
-- Registration of craft types:
|
||||
registerPrimitiveCraftType('inside_player_inventory', {})
|
||||
-- Debug:
|
||||
registerImmersiveCraftType('workbench', {})
|
||||
registerProcessingCraftType('test', {})
|
||||
|
||||
|
||||
--- Registration methods ---
|
||||
|
||||
@@ -1,15 +1,28 @@
|
||||
---Abstract class for craft.
|
||||
---@class CraftSystem.BaseCraft
|
||||
---@class CraftSystem.BaseCraft : Class
|
||||
---@field name string
|
||||
---@field recipe ItemStackString[]
|
||||
---@field output ItemStackString
|
||||
---@field group CraftSystem.CraftGroup
|
||||
local BaseCraft = {}
|
||||
local BaseCraft = Class:extend({})
|
||||
|
||||
---Definition table for the `CraftSystem.BaseCraft`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.BaseCraftDef
|
||||
---@field recipe ItemStackString[]
|
||||
---@field output ItemStackString
|
||||
---@field group CraftSystem.CraftGroup?
|
||||
|
||||
---@param name string
|
||||
---@param def CraftSystem.BaseCraftDef
|
||||
---@return CraftSystem.BaseCraft
|
||||
function BaseCraft:new(name, def)
|
||||
---@type CraftSystem.BaseCraft
|
||||
local instance = self:getInstance({})
|
||||
instance.name = name
|
||||
instance.recipe = def.recipe
|
||||
instance.output = def.output
|
||||
instance.group = def.group
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
return BaseCraft
|
||||
|
||||
@@ -1,30 +1,39 @@
|
||||
local getInstance = Class.getInstance
|
||||
|
||||
local tableInsert = table.insert
|
||||
local stringMatch = string.match
|
||||
|
||||
local PLAYERS_KNOW_ALL_RECIPES = true
|
||||
|
||||
---Abstract class for handling crafting.
|
||||
---@class CraftSystem.BaseCraftHandler
|
||||
---@class CraftSystem.BaseCraftHandler : Class
|
||||
---@field type CraftSystem.CraftType
|
||||
---@field defaultCraftDef CraftSystem.BaseCraftDef
|
||||
---
|
||||
---@field craftsByName table<string, CraftSystem.BaseCraft>
|
||||
---@field craftsByGroup table<CraftSystem.CraftGroup, CraftSystem.BaseCraft[]>
|
||||
---@field craftsList CraftSystem.BaseCraft[]
|
||||
---@field groupedCrafts (CraftSystem.BaseCraft[]|CraftSystem.BaseCraft)[]
|
||||
---@field learnedCrafts table<string, CraftSystem.BaseCraft[]>
|
||||
---@field learnedGroupedCrafts table<string, (CraftSystem.BaseCraft[]|CraftSystem.BaseCraft)[]>
|
||||
local BaseCraftHandler = {
|
||||
local BaseCraftHandler = Class:extend({
|
||||
craftsByName = {},
|
||||
craftsByGroup = {},
|
||||
craftsList = {},
|
||||
groupedCrafts = {},
|
||||
learnedCrafts = {},
|
||||
learnedGroupedCrafts = {},
|
||||
}
|
||||
})
|
||||
|
||||
---@return CraftSystem.BaseCraftHandler
|
||||
function BaseCraftHandler:new()
|
||||
local instance = getInstance(self, {})
|
||||
---@class CraftSystem.BaseCraftHandlerDef
|
||||
---@field defaultCraftDef CraftSystem.BaseCraftDef?
|
||||
|
||||
---@param type CraftSystem.CraftType
|
||||
---@param def CraftSystem.BaseCraftHandlerDef
|
||||
---@return CraftSystem.BaseCraftHandler
|
||||
function BaseCraftHandler:new(type, def)
|
||||
---@type CraftSystem.BaseCraftHandler
|
||||
local instance = self:getInstance({})
|
||||
instance.type = type
|
||||
instance.defaultCraftDef = def.defaultCraftDef or {}
|
||||
|
||||
return instance
|
||||
end
|
||||
|
||||
@@ -20,7 +20,7 @@ local stageTypes = {
|
||||
---@field startStageName string
|
||||
---@field triggerItem ItemStackString
|
||||
---@field stagesByName table<string, CraftSystem.ImmersiveCraftStage>
|
||||
local ImmersiveCraft = extend(BaseCraft, {})
|
||||
local ImmersiveCraft = BaseCraft:extend({})
|
||||
|
||||
---Definition table for the `CraftSystem.ImmersiveCraft`.
|
||||
---
|
||||
@@ -51,12 +51,9 @@ function ImmersiveCraft:new(name, def)
|
||||
end
|
||||
|
||||
---@type CraftSystem.ImmersiveCraft
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = name
|
||||
instance.group = def.group
|
||||
local instance = BaseCraft:new(name, def)
|
||||
instance.startStageName = def.startStageName
|
||||
instance.triggerItem = def.triggerItem
|
||||
instance.output = def.output
|
||||
instance.stagesByName = stagesByName
|
||||
|
||||
-- Subscribe to an event that will determine that the player has completed the crafting stage.
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
local extend = Class.extend
|
||||
|
||||
local tableInsert = table.insert
|
||||
local tableInsert, tableSort, tableJoin = table.insert, table.sort, table.join
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
local require = modInfo.require
|
||||
@@ -13,14 +11,21 @@ local ImmersiveCraft = require('CraftSystem.ImmersiveCraft')
|
||||
---A handler for immersive crafting that requires the player to complete
|
||||
---crafting stages and interact with entities (crafting nodes)
|
||||
---@class CraftSystem.ImmersiveCraftHandler : CraftSystem.BaseCraftHandler
|
||||
---@field defaultCraftDef CraftSystem.BaseCraftDef
|
||||
---
|
||||
---@field craftsByTriggerItem table<string, CraftSystem.ImmersiveCraft[]>
|
||||
---
|
||||
---@field new fun(self:CraftSystem.ImmersiveCraftHandler, type:CraftSystem.ImmersiveCraftType, def:CraftSystem.ImmersiveCraftHandlerDef):CraftSystem.ImmersiveCraftHandler
|
||||
---@field getCraftByName fun(self, craftName:string):CraftSystem.ImmersiveCraft
|
||||
---@field getCraftsByGroup fun(self, craftGroup):CraftSystem.ImmersiveCraft[]
|
||||
---@field getLearnedCrafts fun(self, playerName):table<string, CraftSystem.ImmersiveCraft>
|
||||
local ImmersiveCraftHandler = extend(BaseCraftHandler, {
|
||||
local ImmersiveCraftHandler = BaseCraftHandler:extend({
|
||||
craftsByTriggerItem = {},
|
||||
})
|
||||
|
||||
---@class CraftSystem.ImmersiveCraftHandlerDef : CraftSystem.BaseCraftHandlerDef
|
||||
---@field defaultCraftDef CraftSystem.ImmersiveCraftDef?
|
||||
|
||||
---Register an immersive crafting experience that requires the player to complete
|
||||
---one or more crafting stages that involve interaction with entities (crafting nodes)
|
||||
---@param craftName string
|
||||
@@ -29,6 +34,8 @@ function ImmersiveCraftHandler:registerCraft(craftName, def)
|
||||
assert(self.craftsByName[craftName] == nil, ('A craft named `%s` already exists.'):format(
|
||||
craftName))
|
||||
|
||||
local def = table.merge(def, self.defaultCraftDef)
|
||||
|
||||
-- The craft group to which the craft belongs.
|
||||
local group = 'craft_group:' .. (def.group or 'UNDEFINED')
|
||||
def.group = group
|
||||
@@ -69,4 +76,29 @@ function ImmersiveCraftHandler:getCraftsByTriggerItem(triggerItem)
|
||||
return crafts
|
||||
end
|
||||
|
||||
core.register_on_mods_loaded(function()
|
||||
for groupName, crafts in pairs(ImmersiveCraftHandler.craftsByGroup) do
|
||||
tableSort(crafts, function(a, b)
|
||||
if a.output < b.output then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
|
||||
if groupName ~= 'craft_group:UNDEFINED' then
|
||||
tableInsert(ImmersiveCraftHandler.groupedCrafts, crafts)
|
||||
else
|
||||
ImmersiveCraftHandler.groupedCrafts = tableJoin(ImmersiveCraftHandler.groupedCrafts, crafts)
|
||||
end
|
||||
end
|
||||
|
||||
tableSort(ImmersiveCraftHandler.groupedCrafts, function(a, b)
|
||||
local outputA = (a[1] and a[1].output) or a.output
|
||||
local outputB = (b[1] and b[1].output) or b.output
|
||||
|
||||
if outputA < outputB then
|
||||
return true
|
||||
end
|
||||
end)
|
||||
end)
|
||||
|
||||
return ImmersiveCraftHandler
|
||||
|
||||
@@ -7,16 +7,14 @@ local require = modInfo.require
|
||||
local BaseCraft = require('CraftSystem.BaseCraft')
|
||||
|
||||
---@class CraftSystem.PrimitiveCraft : CraftSystem.BaseCraft
|
||||
---@field recipe CraftSystem.CraftRecipe
|
||||
---@field altRecipes CraftSystem.CraftRecipe[]
|
||||
---@field returnItems ItemStackString[]?
|
||||
local PrimitiveCraft = extend(BaseCraft, {})
|
||||
local PrimitiveCraft = BaseCraft:extend({})
|
||||
|
||||
---Definition table for the `CraftSystem.PrimitiveCraft`.
|
||||
---
|
||||
---**Only for EmmyLua.**
|
||||
---@class CraftSystem.PrimitiveCraftDef : CraftSystem.BaseCraftDef
|
||||
---@field recipe CraftSystem.CraftRecipe
|
||||
---@field altRecipes CraftSystem.CraftRecipe[]?
|
||||
---@field returnItems ItemStackString[]?
|
||||
|
||||
@@ -25,11 +23,7 @@ local PrimitiveCraft = extend(BaseCraft, {})
|
||||
---@return CraftSystem.PrimitiveCraft
|
||||
function PrimitiveCraft:new(name, def)
|
||||
---@type CraftSystem.PrimitiveCraft
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = name
|
||||
instance.group = def.group
|
||||
instance.output = def.output
|
||||
instance.recipe = def.recipe
|
||||
local instance = BaseCraft:new(name, def)
|
||||
instance.altRecipes = def.altRecipes or {}
|
||||
instance.returnItems = def.returnItems
|
||||
|
||||
|
||||
@@ -14,12 +14,19 @@ local PrimitiveCraft = require('CraftSystem.PrimitiveCraft')
|
||||
---A primitive crafting processor that doesn't require much interaction and provides
|
||||
---simple crafting based on a recipe-result scheme.
|
||||
---@class CraftSystem.PrimitiveCraftHandler : CraftSystem.BaseCraftHandler
|
||||
---@field craftsByGroup table<CraftSystem.CraftGroup, CraftSystem.PrimitiveCraft[]>
|
||||
---@field groupedCrafts (CraftSystem.PrimitiveCraft[]|CraftSystem.PrimitiveCraft)[]
|
||||
---@field defaultCraftDef CraftSystem.PrimitiveCraftDef
|
||||
---
|
||||
---@field craftsByGroup table<CraftSystem.CraftGroup, CraftSystem.PrimitiveCraft[]>
|
||||
---@field groupedCrafts (CraftSystem.PrimitiveCraft[]|CraftSystem.PrimitiveCraft)[]
|
||||
---
|
||||
---@field new fun(self:CraftSystem.PrimitiveCraftHandler, type:CraftSystem.PrimitiveCraftType, def:CraftSystem.PrimitiveCraftHandlerDef):CraftSystem.PrimitiveCraftHandler
|
||||
---@field getCraftByName fun(self, craftName:string):CraftSystem.PrimitiveCraft
|
||||
---@field getCraftsByGroup fun(self, craftGroup:string):CraftSystem.PrimitiveCraft[]
|
||||
---@field getLearnedCrafts fun(self, playerName:string):(CraftSystem.PrimitiveCraft[]|CraftSystem.PrimitiveCraft)[]
|
||||
local PrimitiveCraftHandler = extend(BaseCraftHandler, {})
|
||||
local PrimitiveCraftHandler = BaseCraftHandler:extend({})
|
||||
|
||||
---@class CraftSystem.PrimitiveCraftHandlerDef : CraftSystem.BaseCraftHandlerDef
|
||||
---@field defaultCraftDef CraftSystem.PrimitiveCraftDef?
|
||||
|
||||
---Register a primitive craft that does not require special interaction.
|
||||
---@param craftName string
|
||||
@@ -28,6 +35,8 @@ function PrimitiveCraftHandler:registerCraft(craftName, def)
|
||||
assert(self.craftsByName[craftName] == nil, ('A craft named `%s` already exists.'):format(
|
||||
craftName))
|
||||
|
||||
local def = table.merge(def, self.defaultCraftDef)
|
||||
|
||||
local group = 'craft_group:' .. (def.group or 'UNDEFINED')
|
||||
def.group = group
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ local BaseCraft = require('CraftSystem.BaseCraft')
|
||||
---@field startHandler fun()
|
||||
---@field processHandler fun()
|
||||
---@field endHandler fun()
|
||||
local ProcessingCraft = extend(BaseCraft, {})
|
||||
local ProcessingCraft = BaseCraft:extend({})
|
||||
|
||||
---Definition table for the `CraftSystem.ProcessingCraft`.
|
||||
---
|
||||
@@ -29,12 +29,8 @@ local ProcessingCraft = extend(BaseCraft, {})
|
||||
---@return CraftSystem.ProcessingCraft
|
||||
function ProcessingCraft:new(name, def)
|
||||
---@type CraftSystem.ProcessingCraft
|
||||
local instance = getInstance(self, {})
|
||||
instance.name = name
|
||||
instance.recipe = def.recipe
|
||||
instance.group = def.group
|
||||
instance.output = def.output
|
||||
instance.time = def.time
|
||||
local instance = BaseCraft:new(name, def)
|
||||
instance.time = def.time
|
||||
instance.startHandler = def.startHandler or function() end
|
||||
instance.processHandler = def.processHandler or function() end
|
||||
instance.endHandler = def.endHandler or function() end
|
||||
|
||||
@@ -1,7 +1,5 @@
|
||||
local HASH_SEPARATOR = ','
|
||||
|
||||
local extend = Class.extend
|
||||
|
||||
local tableInsert, tableCopy, tableSort, tableConcat, tableIsEmpty = table.insert, table.copy, table.sort, table.concat, table.is_empty
|
||||
|
||||
local modInfo = Mod.getInfo('smc__core__craft_system')
|
||||
@@ -16,14 +14,21 @@ local ProcessingCraft = require('CraftSystem.ProcessingCraft')
|
||||
---A primitive crafting processor that doesn't require much interaction and provides
|
||||
---simple crafting based on a recipe-result scheme.
|
||||
---@class CraftSystem.ProcessingCraftHandler : CraftSystem.BaseCraftHandler
|
||||
---@field defaultCraftDef CraftSystem.ProcessingCraftDef
|
||||
---
|
||||
---@field craftsByHash table<string, CraftSystem.ProcessingCraft>
|
||||
---
|
||||
---@field new fun(self:CraftSystem.ProcessingCraftHandler, type:CraftSystem.ProcessingCraftType, def:CraftSystem.ProcessingCraftHandlerDef):CraftSystem.ProcessingCraftHandler
|
||||
---@field getCraftByName fun(self, craftName:string):CraftSystem.ProcessingCraft
|
||||
---@field getCraftsByGroup fun(self, craftGroup:string):CraftSystem.ProcessingCraft[]
|
||||
---@field getLearnedCrafts fun(self, playerName:string):(CraftSystem.ProcessingCraft[]|CraftSystem.ProcessingCraft)[]
|
||||
local ProcessingCraftHandler = extend(BaseCraftHandler, {
|
||||
local ProcessingCraftHandler = BaseCraftHandler:extend({
|
||||
craftsByHash = {}
|
||||
})
|
||||
|
||||
---@class CraftSystem.ProcessingCraftHandlerDef : CraftSystem.BaseCraftHandlerDef
|
||||
---@field defaultCraftDef CraftSystem.ProcessingCraftDef?
|
||||
|
||||
---@param recipe CraftSystem.CraftRecipe
|
||||
local function getCraftHash(recipe)
|
||||
recipe = tableCopy(recipe)
|
||||
@@ -39,6 +44,8 @@ function ProcessingCraftHandler:registerCraft(craftName, def)
|
||||
assert(self.craftsByName[craftName] == nil, ('A craft named `%s` already exists.'):format(
|
||||
craftName))
|
||||
|
||||
local def = table.merge(def, self.defaultCraftDef)
|
||||
|
||||
local group = 'craft_group:' .. (def.group or 'UNDEFINED')
|
||||
def.group = group
|
||||
|
||||
|
||||
Reference in New Issue
Block a user