Skip to content

Commit

Permalink
Update luckperm placeholder docs (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
PotatoPresident authored Feb 24, 2022
1 parent c6d27c4 commit afbe50f
Showing 1 changed file with 31 additions and 8 deletions.
39 changes: 31 additions & 8 deletions docs/user/mod-placeholders.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,38 @@ Requires [Box of Placeholders addon](https://www.curseforge.com/minecraft/mc-mod
- `%goml:claim_info%`/`%goml:claim_info/[no claim text]/[player can build]/[player can't build]%` - Returns list of trusted players (variables: `${owners}`, `${owners_uuid}`, `${trusted}`, `${trusted_uuid}`, `${anchor}`)

### [Luckperms](https://luckperms.net/)
Requires [Box of Placeholders addon](https://www.curseforge.com/minecraft/mc-mods/box-of-placeholders)
Requires [LuckPerms Fabric PlaceholderAPI addon](https://ci.lucko.me/job/LuckPermsPlaceholders/)

- `%luckperms:prefix%` / `%luckperms:prefix/[number]%` - One or more prefixes of player
- `%luckperms:suffix%` / `%luckperms:suffix/[number]%` - One or more suffixes of player
- `%luckperms:prefix_if_in_group/[group]%` - Returns player's prefix, if they are in selected group (otherwise empty)
- `%luckperms:suffix_if_in_group/[group]%` - Returns player's suffix, if they are in selected group (otherwise empty)
- `%luckperms:primary_group%` - Returns player's primary group
- `%luckperms:group_expiry_time/[group]%` - Time after which player's group is removed
- `%luckperms:permission_expiry_time/[permission]%` - Time after which player's permission is removed
- `%luckperms:prefix%` - Returns the player's prefix
- `%luckperms:suffix%` - Returns the players suffix
- `%luckperms:meta/[meta key]%` - Returns a single value for the given meta key
- `%luckperms:meta_all/[meta key]%` - Returns all assigned values for the given meta key
- `%luckperms:prefix_element/[element]%` - Returns a prefix element using the given "meta stack" element definition. See [Prefix Stacking](https://luckperms.net/wiki/Prefix-&-Suffix-Stacking)
- `%luckperms:suffix_element/[element]%` - Returns a suffix element using the given "meta stack" element definition. See [Prefix Stacking](https://luckperms.net/wiki/Prefix-&-Suffix-Stacking)
- `%luckperms:context/[context key]%` - Returns all of the players current contexts. If a key is given as an argument, then only the values corresponding to the given key are returned.
- `%luckperms:groups%` - Returns a list of the groups directly inherited by the player.
- `%luckperms:inherited_groups%` - Returns a list of all of the groups inherited (directly or indirectly) by the player.
- `%luckperms:primary_group_name%` - Returns the name of the player's primary group.
- `%luckperms:has_permission/[permission]%` - Returns if the player directly has the exact given permission (not the same as a permission check!)
- `%luckperms:inherits_permission/[permission]%%` - Returns if the player inherits the exact given permission (not the same as a permission check!)
- `%luckperms:check_permission/[permission]%%` - Returns the result of a permission check for the given permission on the player.
- `%luckperms:in_group/[group]%` - Returns if the player is directly a member of the given group.
- `%luckperms:inherits_group/[group]%` - Returns if the player is a direct or indirect member of the given group.
- `%luckperms:on_track/[track]%` - Returns if the player's "primary group" is on this track. (deprecated - avoid relying on primary groups, use the placeholder below instead!)
- `%luckperms:has_groups_on_track/[track]%` - Returns if any of the groups the player is directly a member of is on the given track.
- `%luckperms:highest_group_by_weight%` - Returns the name of the players highest weighted group, not including groups they indirectly inherit from others.
- `%luckperms:lowest_group_by_weight%` - Returns the name of the players lowest weighted group, not including groups they indirectly inherit from others.
- `%luckperms:highest_inherited_group_by_weight%` - Returns the name of the players highest weighted group, including groups they indirectly inherit from others.
- `%luckperms:lowest_inherited_group_by_weight%` - Returns the name of the players lowest weighted group, including groups they indirectly inherit from others.
- `%luckperms:current_group_on_track/[track]%` - If the player is currently on the given track, returns the name of the group.
- `%luckperms:next_group_on_track/[track]%` - If the player is currently is currently on the given track, returns the name of the next group (the one they would be promoted to next).
- `%luckperms:previous_group_on_track/[track]%` - If the player is currently is currently on the given track, returns the name of the previous group (the one they would be demoted to next).
- `%luckperms:first_group_on_tracks/[tracks]%` - Given a comma separated list of track names, finds the first group inherited by the player on any of the given tracks.
- `%luckperms:last_group_on_tracks/[tracks]%` - Given a comma separated list of track names, finds the last group inherited by the player on any of the given tracks.
- `%luckperms:expiry_time/[permission]%` - Gets the duration remaining on a temporary permission assigned directly to the player.
- `%luckperms:inherited_expiry_time/[permission]%` - %luckperms_inherited_expiry_time%
- `%luckperms:group_expiry_time/[group name]%` - Gets the duration remaining on a temporary group membership assigned directly to the player.
- `%luckperms:inherited_group_expiry_time/[group name]%` - Gets the duration remaining on a temporary group membership assigned directly to or inherited by the player.

### [PlayerEx](https://www.curseforge.com/minecraft/mc-mods/playerex)
- `%playerex:level%` - Shows current player level
Expand Down

0 comments on commit afbe50f

Please sign in to comment.