diff --git a/mods/SYSTEM/HelperLib/src/Lib.lua b/mods/SYSTEM/HelperLib/src/Lib.lua index d881f6a..c9d04a2 100644 --- a/mods/SYSTEM/HelperLib/src/Lib.lua +++ b/mods/SYSTEM/HelperLib/src/Lib.lua @@ -7,6 +7,7 @@ require('Lib.activeFormspecs') require('Lib.globalStep') require('Lib.color') require('Lib.itemStackInventory') +require('Lib.nodeSuperClasses') require('Lib.getObjectByGUID') require('Lib.receiveFields') require('Lib.registeredItems') diff --git a/mods/SYSTEM/HelperLib/src/Lib/nodeSuperClasses.lua b/mods/SYSTEM/HelperLib/src/Lib/nodeSuperClasses.lua new file mode 100644 index 0000000..95bbe8b --- /dev/null +++ b/mods/SYSTEM/HelperLib/src/Lib/nodeSuperClasses.lua @@ -0,0 +1,36 @@ +---This is an interface representing classes that act as add-ons for nodes. +---Each instance of such a class registers one or more nodes and implements their logic. +--- +---**Note**: An instance is static for all nodes it registers. +---@interface NodeSuperClass + +---@type table +local nodeSuperClasses = {} + +---Adds the `NodeSuperClass` to the private table +---so that it can be retrieved at any time in the future. +---@param nodeName string +---@param superclass NodeSuperClass +function Smc.addNodeSuperclass(nodeName, superclass) + nodeSuperClasses[nodeName] = superclass +end + +---Returns the `NodeSuperClass` corresponding to the node. +--- +---If the node has no `NodeSuperClass`, it returns `nil`. +---@param nodeName string +---@return NodeSuperClass? +function Smc.getNodeSuperclassByName(nodeName) + return nodeSuperClasses[nodeName] +end + +---Returns the `NodeSuperClass` corresponding to the node. +--- +---If the node has no `NodeSuperClass`, it returns `nil`. +---@param pos MapVector +---@return NodeSuperClass? +function Smc.getNodeSuperclassByPos(pos) + local nodeName = core.get_node(pos).name + + return Smc.getNodeSuperclassByName(nodeName) +end