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

Better clarify DOCS from previous commit

Browse Source
This commit is contained in:
marco_a 2024-02-12 18:44:56 +01:00
parent 55f49cf95c
commit adbbbb0620
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
DOCS.md
View File

@ -338,7 +338,7 @@ These properties are removed
Same as above, but for teams. They can accessed through `yourarena.teams[<teamID>].property_name`. Like `temp_properties`, team properties are emptied when the match ends.
### 1.6 Audio
`arena_lib` uses [audio_lib](https://gitlab.com/zughy-friends-minetest/audio_lib) as a library to simplify and improve audio management. Built on top of such libraries, there are three functions that allow modders to easily play sounds to players and their spectators inside an arena. Sounds must be registered first through `audio_lib.register_sound(..)` in order to work.
`arena_lib` uses [audio_lib](https://gitlab.com/zughy-friends-minetest/audio_lib) as a library to simplify and improve audio management. Built on top of such libraries, there are three functions that allow modders to easily play sounds directly to players and their spectators inside an arena (so not for positional sounds). Sounds must be registered first through `audio_lib.register_sound(..)` in order to work. See `audio_lib` for the optional `override_params` argument.
* `arena_lib.sound_play(p_name, sound, <override_params>, <ephemeral>)`: plays `sound` to `p_name` and their spectators
* `arena_lib.sound_play_team(arena, teamID, sound, <override_params>, <ephemeral>)`: plays `sound` to all the players and spectators of team `teamID`
* `arena_lib.sound_play_all(arena, sound, <override_params>, <ephemeral>)`: plays `sound` to all the players and spectators in the arena