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 _@ 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}$

Configuration

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

excluding from caching

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.

Players

Placeholder	Description
staffplusplus_player_count	Count of all players that are not currently vanished

Staff

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

Session

Placeholder	Description
staffplusplus_session_muted_@player=<playername>	Returns true/false indicating of the player is muted or not
staffplusplus_session_vanished_@player=<playername>	Returns true/false indicating of the player is vanished or not
staffplusplus_session_frozen_@player=<playername>	Returns true/false indicating of the player is frozen or not
staffplusplus_session_inStaffMode_@player=<playername>	Returns true/false indicating of the player is in staff mode or not
staffplusplus_session_activestaffchatchannel_@player=<playername>_@default=<defaultValue>	Return the active staff chat channel of the given player. Or if no active channel return the default value

Bans

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: id reason targetName targetUuid issuerName issuerUuid unbannedByName unbannedByUuid unbanReason humanReadableDuration serverName

Mutes

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: id reason targetName targetUuid issuerName issuerUuid unmutedByName unmutedByUuid unmuteReason humanReadableDuration serverName

Warnings

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 Possible filters values
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: id reason targetName targetUuid issuerName issuerUuid score severity serverName Filter: Multiple filters can be applied to narrow down the retrieved warnings count Possible filters values

Possible filter values:

Filter	Description	Example
severity	A comma separated list of all included severities as defined in the staff++ config	staffplusplus_warnings_count_@severity=MAJOR,CRITICAL
period	How far back should we go looking for warnings. Possible values. day, week, month, year	staffplusplus_warnings_count_@period=week
reason	Only shows warnings given for a specific reason	staffplusplus_warnings_count_@reason=HACKING
expired	Boolean indicating if we should include expired warnings	staffplusplus_warnings_count_@expired=false
issuerName	Filter warnings based on the name of the staff member that issued the warnings	staffplusplus_warnings_count_@issuerName=myman
targetName	Filter warnings based on the name of the player that got warned	staffplusplus_warnings_count_@targetName=myman
server	Filter warnings based on the server they were issued on.	staffplusplus_warnings_count_@server=MyUniqueServer

Reports

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 Possible filters values
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: id reason targetName targetUuid issuerName issuerUuid score severity serverName Filter: Multiple filters can be applied to narrow down the retrieved warnings count Possible filters values

Possible filter values:

Filter	Description	Example
status	A comma separated list of all statuses on which we should search	staffplusplus_reports_count_@status=IN_PROGRESS,OPEN
period	How far back should we go looking for reports. Possible values. day, week, month, year	staffplusplus_reports_count_@period=week
type	Report type as defined in the config	staffplusplus_reports_count_@type=HACKING
reporter	Find all reports create by the given reportName	staffplusplus_reports_count_@reporter=myman
assignee	Filter all reports assigned to staff member	staffplusplus_reports_count_@assignee=myman
culprit	Filter reports for which the given is reported	staffplusplus_reports_count_@culprit=myman
server	Filter warnings based on the server they were issued on.	staffplusplus_reports_count_@server=MyUniqueServer