Add new itemframes documentation
This commit is contained in:
parent
37cb4ea5ae
commit
10479fea17
23
mods/ITEMS/mcl_itemframes/API.md
Normal file
23
mods/ITEMS/mcl_itemframes/API.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# mcl_itemframes
|
||||||
|
## Functions
|
||||||
|
* mcl_itemframes.register_itemframe(name, itemframe_definition)
|
||||||
|
* mcl_itemframes.remove_entity(pos)
|
||||||
|
* Removes the item entity belonging to the itemframe at `pos`, does not delete the item(inventory) of the itemframe.
|
||||||
|
* mcl_itemframes.update_entity(pos)
|
||||||
|
* Updates the item entity belonging to the itemframe at `pos` according to it's set item (node inventory)
|
||||||
|
|
||||||
|
## Itemframe definition
|
||||||
|
|
||||||
|
```lua
|
||||||
|
{
|
||||||
|
node = {
|
||||||
|
description = "My cool Frame",
|
||||||
|
tiles = { "my_texture.png"},
|
||||||
|
-- ... this can contain any node definition fields which will be used for the itemframe node
|
||||||
|
},
|
||||||
|
object_properties = {
|
||||||
|
glow = 15,
|
||||||
|
-- ... this can contain any object properties which will be applied to the item entity
|
||||||
|
},
|
||||||
|
}
|
||||||
|
```
|
Loading…
x
Reference in New Issue
Block a user