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

Fix documentation

Browse Source
This commit is contained in:
Zughy 2023-11-23 17:08:59 +01:00
parent f1aa574819
commit 7c2813d051
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

@ -16,7 +16,7 @@ Because it's always good to understand the API without surfing the code, innit?
### 1.2 Getters
* `parties.get_inviters(p_name)`: (table) returns a table containing as value the name(s) of the player(s) who invited `p_name`
* `parties.get_inviters(p_name)`: (table) returns a table containing as key the name(s) of the player(s) who invited `p_name`
* `parties.get_party_leader(p_name)`: (string) returns the party leader of the party where `p_name` is in, or `nil` if it's not in a party
* `parties.get_party_members(p_name, <online_only>)`: (table) returns a table containing as value the name(s) of the player(s) inside the party where `p_name` is in, or `nil` if it's not in a party. `online_only` is an optional boolean that, when `true`, only returns the members who are currently online