agroups.inc
Original include source with line numbers.
| 1 | #if defined _agroups_included |
| 2 | #endinput |
| 3 | #endif |
| 4 | |
| 5 | #define _agroups_included |
| 6 | |
| 7 | /** |
| 8 | * Gets total number of registered groups. |
| 9 | * |
| 10 | * @return Number of groups. |
| 11 | */ |
| 12 | native agroups_get_groups_num() |
| 13 | |
| 14 | /** |
| 15 | * Gets the number of online players in a specified group. |
| 16 | * |
| 17 | * @param iGroup Group's index. |
| 18 | * @return -1 if the group doesn't exist, otherwise returns the number of players in the group. |
| 19 | */ |
| 20 | native agroups_get_players_in_group(group) |
| 21 | |
| 22 | /** |
| 23 | * Get's the user group. |
| 24 | * |
| 25 | * @param id Player's index. |
| 26 | * @param group Buffer to store the group name in. |
| 27 | * @param len Buffer length. |
| 28 | * @return -2 if the player is not connected, -1 if the player is not in a group, group's index otherwise. |
| 29 | */ |
| 30 | native agroups_get_user_group(id, group[] = "", len = 0) |
| 31 | |
| 32 | /** |
| 33 | * Attempts to open the groups menu. |
| 34 | * |
| 35 | * @param id Player's index. |
| 36 | * @return -2 if the player is not connected, 1 otherwise. |
| 37 | */ |
| 38 | native agroups_open_groups_menu(id) |
| 39 | |
| 40 | /** |
| 41 | * Attempts to play the menu sound. |
| 42 | * |
| 43 | * @param id Player's index. |
| 44 | * @return -2 if the player is not connected, 0 if the sound option is disabled, 1 otherwise. |
| 45 | */ |
| 46 | native agroups_play_menu_sound(id) |
| 47 | |
| 48 | /** |
| 49 | * Updates the user's group. |
| 50 | * |
| 51 | * @param id Player's index. |
| 52 | * @return -2 if the player is not connected, -1 if the player is not in a group, group's index otherwise. |
| 53 | */ |
| 54 | native agroups_update_user_group(id) |