Skip to content

Commit 45d77a9

Browse files
Added new Leaderboard Placeholders (#11)
* Added new Leaderboard Placeholders * Corrected documentation * Fixed table craziness * Adjusted language to be more clear
1 parent b579dfd commit 45d77a9

File tree

1 file changed

+54
-4
lines changed

1 file changed

+54
-4
lines changed

docs/gangs/placeholders.md

Lines changed: 54 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Placeholders
1+
# Placeholders
22

33
Remember to get the placeholders from a list corresponding to the placeholders plugin you're using.
44

@@ -13,7 +13,7 @@ Plugin versions required to use these placeholders:
1313
| Gangs+ | 2.27.0 or newer |
1414
| PlaceholderAPI | 2.10.3 or newer |
1515

16-
Placeholders list:
16+
### Placeholders
1717

1818
| Placeholder name | Description |
1919
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|
@@ -43,8 +43,58 @@ Placeholders list:
4343
| %gangsplus_gang_bank_raw% | Returns the player's gang bank balance (raw number) |
4444
| %gangsplus_gang_money% | Returns the player's gang members balance sum |
4545
| %gangsplus_gang_money_raw% | Returns the player's gang members balance sum (raw number) |
46-
| %gangsplus_gangs_top_1_name%<br />%gangsplus_gangs_top_2_name%<br />%gangsplus_gangs_top_3_name%<br />%gangsplus_gangs_top_4_name%<br />%gangsplus_gangs_top_5_name% | Returns name of n-th top gang (from 1 to 5) |
47-
| %gangsplus_gangs_top_1_leader%<br />%gangsplus_gangs_top_2_leader%<br />%gangsplus_gangs_top_3_leader%<br />%gangsplus_gangs_top_4_leader%<br />%gangsplus_gangs_top_5_leader% | Returns leader's name of n-th top gang (from 1 to 5) |
46+
47+
### Leaderboard Placeholders
48+
49+
Leaderboard Placeholders are in the format of ``%gangsplus_gangs_top_<statistic>_<position>_<gang_property>%``.
50+
51+
> ``statistic`` is the rank order of the leaderboard. (eg. most kills)
52+
>
53+
> ``position`` is the leaderboard position number. (eg. '1' for 1st place)
54+
>
55+
> ``gang_property`` is the Gang's statistic you want to display. (eg. gang's kills)
56+
57+
#### Statistics
58+
59+
| Statistic Name | Description |
60+
|----------------|---------------------------|
61+
| kills | Gang Kill Count |
62+
| deaths | Gang Death Count |
63+
| kdr | Gang Kill/Death Ratio |
64+
| wins | Gang Wins |
65+
| losses | Gang Losses |
66+
| wlr | Gang Fight Win/Loss Ratio |
67+
| level | Gang Level |
68+
| members | Gang Member Count |
69+
| members_online | Gang Online Member Count |
70+
| bank | Gang Bank Balance |
71+
| balance | Gang Balance |
72+
| homes | Gang Home Count |
73+
74+
#### Gang Properties
75+
76+
| Gang Property Name | Description |
77+
|--------------------|---------------------------------|
78+
| bank | Gang Bank Balance Formatted |
79+
| bank_raw | Gang Bank Balance |
80+
| deaths | Gang Death Count |
81+
| homes_count | Gang Home Count |
82+
| kdr | Gang Kill/Death Ratio Formatted |
83+
| kdr_raw | Gang Kill/Death Ratio |
84+
| kills | Gang Kill Count |
85+
| leader | Gang Leader's username |
86+
| level | Gang Level |
87+
| loss | Gang Loss Count |
88+
| members_count | Gang Member Count |
89+
| members_list | Gang Member List |
90+
| money | Gang Balance Formatted |
91+
| money_raw | Gang Balance |
92+
| name | Gang Name |
93+
| wins | Gang Win Count |
94+
| wlr | Gang Win/Loss Ratio Formatted |
95+
| wlr_raw | Gang Win/Loss Ratio |
96+
97+
4898

4999
## MVdWPlaceholderAPI
50100

0 commit comments

Comments
 (0)