diff --git a/mods/CORE/Creature/init.lua b/mods/CORE/Creature/init.lua new file mode 100644 index 0000000..eb5c205 --- /dev/null +++ b/mods/CORE/Creature/init.lua @@ -0,0 +1,4 @@ +local modInfo = Mod.getInfo('smc__core__creature') +local require = modInfo.require + +return require('Creature') diff --git a/mods/CORE/Creature/mod.conf b/mods/CORE/Creature/mod.conf new file mode 100644 index 0000000..c0aea68 --- /dev/null +++ b/mods/CORE/Creature/mod.conf @@ -0,0 +1 @@ +name = smc__core__creature diff --git a/mods/CORE/Entity/src/Entity.lua b/mods/CORE/Creature/src/Creature.lua similarity index 74% rename from mods/CORE/Entity/src/Entity.lua rename to mods/CORE/Creature/src/Creature.lua index 2c592e1..0cd41c6 100644 --- a/mods/CORE/Entity/src/Entity.lua +++ b/mods/CORE/Creature/src/Creature.lua @@ -2,11 +2,11 @@ local getInstance, extend = Class.getInstance, Class.extend local tableCopy, tableMerge = table.copy, table.merge ----@class Entity ----@field entityDef Entity.EntityDefinition +---@class Creature +---@field entityDef Creature.CreatureDefinition ---@field luantiDef EntityDefinition ----@field defaultDef Entity.EntityDefinition -local Entity = { +---@field defaultDef Creature.CreatureDefinition +local Creature = { defaultDef = { settings = { _name = '', @@ -23,7 +23,7 @@ local defMerge = function(...) return tableMerge(...) end ----@param entityDef Entity.EntityDefinition +---@param entityDef Creature.CreatureDefinition ---@return EntityDefinition local function entityDefToLuantiDef(entityDef) entityDef = tableCopy(entityDef) @@ -36,14 +36,14 @@ local function entityDefToLuantiDef(entityDef) end ---The alias `table.merge` for EmmyLua ----@type fun(...):(Entity.EntityDefinition) +---@type fun(...):(Creature.CreatureDefinition) local defMerge = function(...) return tableMerge(...) end ----@param entityDef Entity.EntityDefinition ----@return Entity -function Entity:new(entityDef) +---@param entityDef Creature.CreatureDefinition +---@return Creature +function Creature:new(entityDef) -- Adding default parameters entityDef = defMerge(entityDef, self.defaultDef, true) local s = entityDef.settings @@ -52,7 +52,7 @@ function Entity:new(entityDef) s._name = Mod.getInfo().shortName .. ':' .. s._name end - ---@type Entity + ---@type Creature local instance = getInstance(self, {}) local luantiDef = entityDefToLuantiDef(entityDef) @@ -68,12 +68,12 @@ end ---Allows you to create a child class of an entity by specifying ---default parameters that will be added to the entity's parameters ---when an instance is received. ----@param defaultDef Entity.EntityDefinition ----@return Entity -function Entity:getExtended(defaultDef) +---@param defaultDef Creature.CreatureDefinition +---@return Creature +function Creature:getExtended(defaultDef) defaultDef = defMerge(self.defaultDef, defaultDef) - ---@type Entity + ---@type Creature local ChildClass = extend(self, { defaultDef = defaultDef, }) @@ -81,4 +81,4 @@ function Entity:getExtended(defaultDef) return ChildClass end -return Entity +return Creature diff --git a/mods/CORE/Entity/src/Entity/Callbacks.lua b/mods/CORE/Creature/src/Creature/Callbacks.lua similarity index 76% rename from mods/CORE/Entity/src/Entity/Callbacks.lua rename to mods/CORE/Creature/src/Creature/Callbacks.lua index adfa3c3..876d3c2 100644 --- a/mods/CORE/Entity/src/Entity/Callbacks.lua +++ b/mods/CORE/Creature/src/Creature/Callbacks.lua @@ -1,10 +1,10 @@ ----@class Entity.Callbacks +---@class Creature.Callbacks local Callbacks = {} ---Called when the object is instantiated. --- * `dtime_s` is the time passed since the object was unloaded, ---which can be used for updating the entity state. ----@type fun(self, staticdata:string, dtime_s:number)? +---@type fun(self:LuaEntity, staticdata:string, dtime_s:number)? Callbacks.on_activate = nil ---Called when the object is about to get removed or unloaded. @@ -15,16 +15,15 @@ Callbacks.on_activate = nil ---Note that this won't be called if the object hasn't been activated in the first place. ---In particular, `core.clear_objects({mode = "full"})` won't call this, ---whereas `core.clear_objects({mode = "quick"})` might call this. ----@type fun(self, removal:boolean)? +---@type fun(self:LuaEntity, removal:boolean)? Callbacks.on_deactivate = nil ---Called on every server tick, after movement and collision processing. --- * `dtime`: elapsed time since last call --- * `s`: table with collision info (only available if `physical=true`) ----@type fun(self, dtime:number, moveresult:table)? -- TODO: дописать более точный тип moveresult +---@type fun(self:LuaEntity, dtime:number, moveresult:table)? -- TODO: дописать более точный тип moveresult Callbacks.on_step = nil - ---Called when somebody punches the object. ---Note that you probably want to handle most punches using the automatic armor group system. --- * `puncher`: an `ObjectRef `(can be `nil`) @@ -34,42 +33,40 @@ Callbacks.on_step = nil --- * `damage``: damage that will be done to entity. --- ---Can return `true` to prevent the default damage mechanism. ----@type (fun(self, puncher:ObjectRef|Player|nil, time_from_last_punch:number|nil, tool_capabilities:table|nil, dir:vector, damage:number):boolean)? -- TODO: дописать более точный тип для tool_capabilities +---@type (fun(self:LuaEntity, puncher:ObjectRef|Player|nil, time_from_last_punch:number|nil, tool_capabilities:table|nil, dir:vector, damage:number):boolean)? -- TODO: дописать более точный тип для tool_capabilities Callbacks.on_punch = nil ---Called when the object dies. --- * `killer`: an `ObjectRef` (can be `nil`) ----@type fun(self, killer:ObjectRef|Player|nil)? +---@type fun(self:LuaEntity, killer:ObjectRef|Player|nil)? Callbacks.on_death = nil ---Called when `clicker` pressed the 'place/use' key while ---pointing to the object (not necessarily an actual rightclick) --- * `clicker`: an `ObjectRef` (may or may not be a player) ----@type fun(self, clicker:ObjectRef|Player)? +---@type fun(self:LuaEntity, clicker:ObjectRef|Player)? Callbacks.on_rightclick = nil - ---Called after another object is attached to this object. --- * `child`: an `ObjectRef` of the child ----@type fun(self, child:ObjectRef)? +---@type fun(self:LuaEntity, child:ObjectRef)? Callbacks.on_attach_child = nil ---Called after another object has detached from this object. --- * `child`: an `ObjectRef` of the child ----@type fun(self, child:ObjectRef)? +---@type fun(self:LuaEntity, child:ObjectRef)? Callbacks.on_detach_child = nil - ---Called after detaching from another object. --- * `parent`: an ObjectRef from where it got detached --- ---**Note**: this is also called before removal from the world. ----@type fun(self, parent)? +---@type fun(self:LuaEntity, parent)? Callbacks.on_detach = nil ---Should return a string that will be passed to `on_activate` when the object ---is instantiated the next time. ----@type (fun(self):string)? +---@type (fun(self:LuaEntity):string)? Callbacks.get_staticdata = nil return Callbacks diff --git a/mods/CORE/Creature/src/Creature/CreatureDefinition.lua b/mods/CORE/Creature/src/Creature/CreatureDefinition.lua new file mode 100644 index 0000000..497ebfd --- /dev/null +++ b/mods/CORE/Creature/src/Creature/CreatureDefinition.lua @@ -0,0 +1,6 @@ +---@class Creature.CreatureDefinition +---@field settings Creature.Settings +---@field callbacks Creature.Callbacks? +local CreatureDefinition = {} + +return CreatureDefinition diff --git a/mods/CORE/Entity/src/Entity/Settings.lua b/mods/CORE/Creature/src/Creature/Settings.lua similarity index 91% rename from mods/CORE/Entity/src/Entity/Settings.lua rename to mods/CORE/Creature/src/Creature/Settings.lua index 9d5bf72..fa9ba6e 100644 --- a/mods/CORE/Entity/src/Entity/Settings.lua +++ b/mods/CORE/Creature/src/Creature/Settings.lua @@ -1,4 +1,4 @@ ----@class Entity.Settings +---@class Creature.Settings local Settings = {} ---Registration name for the entity. Must be unique. diff --git a/mods/CORE/Entity/init.lua b/mods/CORE/Entity/init.lua deleted file mode 100644 index 6d18571..0000000 --- a/mods/CORE/Entity/init.lua +++ /dev/null @@ -1,4 +0,0 @@ -local modInfo = Mod.getInfo('smc__core__entity') -local require = modInfo.require - -return require('Entity') diff --git a/mods/CORE/Entity/mod.conf b/mods/CORE/Entity/mod.conf deleted file mode 100644 index 48ee09a..0000000 --- a/mods/CORE/Entity/mod.conf +++ /dev/null @@ -1 +0,0 @@ -name = smc__core__entity diff --git a/mods/CORE/Entity/src/Entity/EntityDefinition.lua b/mods/CORE/Entity/src/Entity/EntityDefinition.lua deleted file mode 100644 index e87113f..0000000 --- a/mods/CORE/Entity/src/Entity/EntityDefinition.lua +++ /dev/null @@ -1,6 +0,0 @@ ----@class Entity.EntityDefinition ----@field settings Entity.Settings ----@field callbacks Entity.Callbacks? -local EntityDefinition = {} - -return EntityDefinition