zughy-friends-minetest/arena_lib-cd2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

DOCS: better document set_spawner(..)

Browse Source
This commit is contained in:
marco_a 2024-02-06 19:09:01 +01:00
parent 357f9c074b
commit da23babf7d
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
DOCS.md
View File

@ -551,7 +551,12 @@ If you don't want to rely on the hotbar, or you want both the editor and the com
`arena_lib.toggle_teams_per_arena(sender, mod, arena_name, enable)` enables/disables teams per single arena. `enable` is a boolean.
##### 2.2.2.4 Spawners
`arena_lib.set_spawner(sender, mod, arena_name, <teamID>, <param>, <coords>)` creates a spawner at `coords`, if specified, or where the sender is standing - so be sure to stand where you want the spawn point to be. `param` is a string, specifically `"delete"` or `"deleteall"`. `"delete"` deletes the closest spawner to the player. It requires `teamID` if teams are enabled. If a team ID is specified alongside `"deleteall"`, arena_lib will only delete the spawners belonging to that team.
`arena_lib.set_spawner(sender, mod, arena_name, <teamID>, <param>, <coords>)` can create and delete spawners.
* creation: leave `param` nil. It creates a spawner at `coords`, if specified, or where the sender is standing - so be sure to stand where you want the spawn point to be
* deletion: set `param` equal to `"delete"` or `"deleteall"`
* `"delete"` deletes the closest spawner to the player. It requires `teamID` if teams are enabled
* Single spawners are deleted through `table.remove`, meaning that there won't ever be a gap in the sequence (e.g. removing spawn point n°2 in sequence 1, 2, 3, 4, it won't result in 1, 3, 4 but in 1, 2, 3, where 2 and 3 previously were 3 and 4)
* If a team ID is specified alongside `"deleteall"`, arena_lib will only delete the spawners belonging to that team
##### 2.2.2.5 Entering and leaving
To set an entrance, use `arena_lib.set_entrance(sender, mod, arena_name, action, ...)`. For further documentation, see [1.10 Custom entrances](#110-custom-entrances).