Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Lua_api.txt: Naming convention for custom item/entity fields
Custom (non-engine) field names of items and entities are allowed.
This is now documented in lua_api.txt. Field names beginning with
an underscore are now reserved for mod use, the engine must not
introduce any fields beginning with an underscore.
  • Loading branch information
Wuzzy authored and paramat committed Nov 15, 2016
1 parent bc3980e commit 8e61c1d
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions doc/lua_api.txt
Expand Up @@ -3529,8 +3529,9 @@ Definition tables
-- ^ Called sometimes; the string returned is passed to on_activate when
-- the entity is re-activated from static state

-- Also you can define arbitrary member variables here
myvariable = whatever,
-- Also you can define arbitrary member variables here (see item definition for
-- more info)
_custom_field = whatever,
}

### ABM (ActiveBlockModifier) definition (`register_abm`)
Expand Down Expand Up @@ -3646,6 +3647,12 @@ Definition tables
end
^ The user may be any ObjectRef or nil.
]]
_custom_field = whatever,
--[[
^ Add your own custom fields. By convention, all custom field names
should start with `_` to avoid naming collisions with future engine
usage.
]]
}

### Tile definition
Expand Down

0 comments on commit 8e61c1d

Please sign in to comment.