moparisthebest/minetest
1
0
Fork 0
mirror of https://github.com/moparisthebest/minetest synced 2024-12-22 07:38:48 -05:00
Code Issues Releases Wiki Activity

Lua_api.txt: Naming convention for custom item/entity fields

Browse Source 
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.
This commit is contained in:
Wuzzy 2016-11-12 17:49:41 +01:00 committed by paramat
parent bc3980e1d6
commit 8e61c1dfd9
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/lua_api.txt
View File

@ -3529,8 +3529,9 @@ Definition tables
-- ^ Called sometimes; the string returned is passed to on_activate when -- ^ Called sometimes; the string returned is passed to on_activate when
-- the entity is re-activated from static state -- the entity is re-activated from static state
-- Also you can define arbitrary member variables here -- Also you can define arbitrary member variables here (see item definition for
myvariable = whatever, -- more info)
_custom_field = whatever,
} }
### ABM (ActiveBlockModifier) definition (`register_abm`) ### ABM (ActiveBlockModifier) definition (`register_abm`)
@ -3646,6 +3647,12 @@ Definition tables
end end
^ The user may be any ObjectRef or nil. ^ 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 ### Tile definition