Skip to content
Snippets Groups Projects
Commit f626cb94 authored by tenplus1's avatar tenplus1 Committed by Milan
Browse files

merge upstream commit: Game_api.txt: Add API information for sethome functions

parent 814f3562
No related branches found
No related tags found
No related merge requests found
......@@ -333,6 +333,30 @@ To use it, add the `on_screwdriver` function to the node definition.
* use `on_rotate = screwdriver.disallow` to always disallow rotation
* use `on_rotate = screwdriver.rotate_simple` to allow only face rotation
Sethome API
-----------
The sethome API adds three global functions to allow mods to read a players home position,
set a players home position and teleport a player to home position.
`sethome.get(name)`
* `name` Player who's home position you wish to get
* return value: false if no player home coords exist, position table if true
`sethome.set(name, pos)`
* `name` Player who's home position you wish to set
* `pos` Position table containing coords of home position
* return value: false if unable to set and save new home position, otherwise true
`sethome.go(name)`
* `name` Player you wish to teleport to their home position
* return value: false if player cannot be sent home, otherwise true
Stairs API
----------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment