PAPI expansion
Staff++ integrates with the Placeholder API plugin.
You need to install the papi expansion by downloading it from the papi ecloud:
https://api.extendedclip.com/expansions/staffplusplus/versions/staffplusplus-130/
For placeholders with filters: filters are always prefixed with [email protected] and should be placed at the end of the placeholder definition
You can nest other placeholders be wrapping them in
${ and }$ characters.
Example: warnings_score_${player_name}$All placeholders are cached to make sure we don't query the database too much. This depends on how the placeholders is used. The default cache is 30 seconds but can be configured through the config.yml of the PlaceholderAPI plugin.
config.yml
expansions:
staffplusplus:
# How often the placeholder cache should be cleared in milliseconds
cache-clear-interval: 30000
# exclude certain placeholders for the caching mechanism.
cache-disabled-placeholders:
- session
- player_count
Some placeholders are actually safe to use without hitting the database too much. All session variables can be safely excluded from caching. You can exclude other placeholders as well.
Placeholder | Description |
|---|---|
staffplusplus_player_count | Count of all players that are not currently vanished |
Placeholder | Description |
staffplusplus_staff_members_online | amount of staff members online on this server. |
staffplusplus_staff_members_in_mode | amount of staff members in staff mode on this server. |
staffplusplus_staff_members_vanished | amount of staff members currently vanished |
Placeholder | Description |
staffplusp[email protected]=<playername> | Returns true/false indicating of the player is muted or not |
[email protected]=<playername> | Returns true/false indicating of the player is vanished or not |
[email protected]=<playername> | Returns true/false indicating of the player is frozen or not |
[email protected]=<playername> | Returns true/false indicating of the player is in staff mode or not |
[email protected]=<playername>[email protected]=<defaultValue> | Return the active staff chat channel of the given player. Or if no active channel return the default value |
Placeholder | description | Parameters |
staffplusplus_bans_all_count | Returns total amount of bans in the system | |
staffplusplus_bans_active_count | Returns total amount of active bans in the system | |
staffplusplus_bans_newest_<index>_<field> | returns active bans from newest to oldest at the given index | index: which ban do you want to retrieve. For example 1 will return the newest ban. 2 will return the one issued before that. And so on. field: Which field you want to retrieve from the issued ban. (Casing is important here) Possible values:
|
Placeholder | description | Parameters |
staffplusplus_mutes_all_count | Returns total amount of mutes in the system | |
staffplusplus_mutes_active_count | Returns total amount of active mutes in the system | |
staffplusplus_mutes_newest_<index>_<field> | returns active mutes from newest to oldest at the given index | index: which mute do you want to retrieve. For example 1 will return the newest mute. 2 will return the one issued before that. And so on. field: Which field you want to retrieve from the issued mute. (Casing is important here) Possible values:
|
Placeholder | Description | parameters |
staffplusplus_warnings_score_<playername> | Get the total warning score of a player | playername: The name of the player for which we want to get the score |
staffplusplus_warnings_count_<filters> | Retrieve the count of all warnings | Filter: Multiple filters can be applied to narrow down the retrieved warnings count |
staffplusplus_warnings_newest_<index>_<field>_<filters> | returns warnings newest to oldest at the given index. Using filters you can further narrow down the warnings retrieved | index: which mute do you want to retrieve. For example 1 will return the newest mute. 2 will return the one issued before that. And so on. field: Which field you want to retrieve from the issued mute. (Casing is important here) Possible values:
Filter: Multiple filters can be applied to narrow down the retrieved warnings count |
Filter | Description | Example |
severity | A comma separated list of all included severities as defined in the staff++ config | [email protected]=MAJOR,CRITICAL |
period | How far back should we go looking for warnings. Possible values. day, week, month, year | [email protected]=week |
reason | Only shows warnings given for a specific reason | [email protected]=HACKING |
expired | [email protected]=false | |
issuerName | Filter warnings based on the name of the staff member that issued the warnings | [email protected]=myman |
targetName | Filter warnings based on the name of the player that got warned | [email protected]=myman |
server | Filter warnings based on the server they were issued on. | [email protected]=MyUniqueServer |
Placeholder | Description | parameters |
staffplusplus_reports_count_<filters> | Retrieve the count of all reports | Filter: Multiple filters can be applied to narrow down the retrieved warnings count |
staffplusplus_reports_newest_<index>_<field>_<filters> | returns warnings newest to oldest at the given index. Using filters you can further narrow down the warnings retrieved | index: which mute do you want to retrieve. For example 1 will return the newest mute. 2 will return the one issued before that. And so on. field: Which field you want to retrieve from the issued mute. (Casing is important here) Possible values:
Filter: Multiple filters can be applied to narrow down the retrieved warnings count |
Filter | Description | Example |
status | A comma separated list of all statuses on which we should search | [email protected]=IN_PROGRESS,OPEN |
period | How far back should we go looking for reports. Possible values. day, week, month, year | [email protected]=week |
type | Report type as defined in the config | [email protected]=HACKING |
reporter | Find all reports create by the given reportName | [email protected]=myman |
assignee | Filter all reports assigned to staff member | [email protected]=myman |
culprit | Filter reports for which the given is reported | [email protected]=myman |
server | Filter warnings based on the server they were issued on. | [email protected]=MyUniqueServer |
Last modified 8mo ago