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

DOCS: grammar

master
Zughy 2020-07-14 14:48:34 +00:00
parent 3ca425bc66
commit 9859a6b78c
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
DOCS.md
View File

@ -8,13 +8,13 @@ Because it's always good to understand the API without surfing the code, init? :
* `parties.is_player_in_party(p_name)`: (bool) checks whether a player is in any party
* `parties.is_player_party_leader(p_name)`: (bool) checks whether a player is the party leader of any party
* `parties.chat_send_party(p_name, msg, as_broadcast)`: (nil) sends a message to every player inside the party where `p_name` is (`p_name` doesn't necessarily have to be the party leader). If `as_broadcast` is true, it'd be sent without following Minetest chat format. If false, `p_name` will be pointed as the sender when formatting the message
* `parties.chat_send_party(p_name, msg, as_broadcast)`: (nil) sends a message to every player inside the party where `p_name` is (`p_name` doesn't necessarily have to be the party leader). If `as_broadcast` is true, it'll be sent without following Minetest chat format. If false, `p_name` will be pointed as the sender when formatting the message
* `parties.change_party_leader(old_leader, new_leader)`: (nil) changes the party leader
### 1.2 Getters
* `parties.get_party_leader(p_name)`: (string) returns the party leader of the party where `p_name` is in
* `parties.get_party_members(party_leader)`: (table) returns a list of every player inside the party of `party_leader`
* `parties.get_party_members(party_leader)`: (table) returns a list of every player inside the party where `party_leader` is in
## 2 Customisation