Node entity library (`nodeentity`) #

Library for functional node entities, with minimal setup

Namespace reference #

nodeentity = {
  function register(nodename), -- registers a node entity in accordance to a defined node (does not update when definition changes), returns new entity name
  function add(pos, node, noupdate), -- creates a functional node entity at specified position in accordance to specified MapNode table with automatic registration (actually returns an ObjectRef)
  function read_world(pos, anchor, minp, maxp), -- creates a nodeset at <pos> with nodes from <minp> to <maxp> relative to <anchor>
  -- exposed internal tables
  nodeentities = {[entityID] = luaentity}, -- table of node entities, not guaranteed to be active
  fs_context = {
    [formname] = {
      [playername] = {formspec, entity} 
    }
  }, -- table of active forms in nodeentities
  registered = {[nodename] = entityname}, -- map from node names to entity names
}

Position format #

local position = {
  x, y, z -- position components
  relative = entityID -- optional relativity specifier, makes the position relative to the specified node entity or its corresponding node entity set
}

These relative positions should work in most core namespace functions (library feature), if any of them don't work, make an issue

Node entity sets (`"nodeentity:nodeset"`) #

2 node entities attached to the same nodeset are able to access each-other with core namespace functions

To add a node entity to a node set, attach it as specified: nodeobject:set_attach(nodeset, "", pos * 10), the engine requires the pos multiplication, but the automatic inclusion of the entity works as normal

Node definition interface #

local nodedef = {
  ...
  function _nodeentity_step(self, dtime, moveresult), -- runs exclusively on node entities, identical to <step> in entity defintions
  ...
}

Entity fields #

local entity = {
  ...
  function _showfs(playername, formname, formspec), -- used like core.show_formspec, includes the nuances in node forms
  _metadata, -- imitation of NodeMetaRef
  _invname, -- inventory name used in showing current node entity inventory
  _timer, -- lua implementation of NodeTimerRef
  _eID, -- current entity's persistent node entity ID
  ...
}

Node entity library (nodeentity) #