lanxu/MineClone2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add API documentation for screwdriver mod

Browse Source
This commit is contained in:
Wuzzy 2019-12-14 23:50:17 +01:00
parent 92ef7c3b9a
commit 862e3141d9
2 changed files with 24 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
mods/ITEMS/screwdriver/API.md Normal file
View File

@ -0,0 +1,20 @@
Screwdriver API
---------------
The screwdriver API allows you to control a node's behaviour when a screwdriver is used on it.
NOTE: This API is compatible with Minetest Game 5.1.0, but has some extensions.
To use it, add the `on_rotate` function to the node definition.
`on_rotate(pos, node, user, mode, new_param2)`
* `pos`: Position of the node that the screwdriver is being used on
* `node`: that node
* `user`: The player who used the screwdriver
* `mode`: `screwdriver.ROTATE_FACE` or `screwdriver.ROTATE_AXIS`
* `new_param2` the new value of `param2` that would have been set if `on_rotate` wasn't there
* return value: false to disallow rotation, nil to keep default behaviour, true to allow
it but to indicate that changed have already been made (so the screwdriver will wear out)
* use `on_rotate = false` to always disallow rotation
* use `on_rotate = screwdriver.rotate_simple` to allow only face rotation
* use `on_rotate = screwdriver.rotate_3way` (MineClone 2 extension) for pillar-like nodes that should only have 3 possible orientations)

8
mods/ITEMS/screwdriver/README.txt → mods/ITEMS/screwdriver/README.md
View File

@ -1,5 +1,5 @@
Minetest Game mod: screwdriver
==============================
MineClone 2 mod: screwdriver
============================
See license.txt for license information.
License of source code
@ -9,5 +9,5 @@ Various Minetest developers and contributors (LGPL 2.1)
License of media (textures)
---------------------------
Created by Gambit (CC BY-SA 3.0):
screwdriver.png
Created by Wuzzy (CC0):
* `screwdriver.png`