Repixture/mods/rp_bed/API.md

24 lines
610 B
Markdown
Raw Permalink Normal View History

2022-05-25 09:26:23 -07:00
# API documentation for `rp_bed`
This simple API allows setting some stuff related to (re)spawning.
## Function reference
### `bed.get_spawn(player)`
Returns the current (re)spawn position of `player` or nil if if there is
none set.
### `bed.set_spawn(player, spawn_pos)`
Sets the bed (re)spawn position for `player`.
Returns true if spawn position was set and changed.
Returns false if spawn position was not changed because
it's already used by the player.
### `bed.unset_spawn(player)`
Clears the bed (re)spawn position of `player`. The player will respawn
according to the default Minetest rules.