Skip to content

Placeholders List🔗

This page lists all the placeholders that are available in BetonQuest. Some of them are only useful when exported for use in other plugins through the support for PlaceHolderAPI.

Placeholders marked as static can be resolved without a player specified.

BetonQuest Elements🔗

Objective Property Placeholder🔗

Using this placeholder you can display a property of an objective. The first argument is an ID of the objective as defined in the objectives section (not the type). Make sure that the player has this objective active or it will be replaced with nothing (""). Second argument is the name of a property you want to display. All properties are described in "Objectives List" chapter.

%objective.kill_zombies.left%

Condition Placeholder🔗

You can expose BetonQuest's conditions to 3rd party plugins by using the condition placeholder together with the PAPI support. The placeholder will return true or false by default. If you add papiMode to the instruction it will return yes or no.
You can translate the papiMode's result by changing the values of condition_placeholder_met condition_placeholder_not_met in the messages.yml config.

%condition.myCondition%
%condition.myCondition.papiMode%

Constant Placeholder🔗

Constants are a bit different from other placeholders, as you can freely define the values of them. They are defined in the constants section like this:

constants:
  village_location: 100;200;300;world
  village_name: Concrete

To use a constant placeholder, you must use %constant.constantName%:

%constant.village_location%
%constant.village_name%

If you want to parse a placeholder from a different package, follow the same syntax as you would working across packages. The proper syntax is %questPackage>constant.constantName%.

BetonQuest Data Types🔗

Point Placeholder🔗

This placeholder displays the amount of points you have in some category or amount of points you need to have to reach a number. The first argument is the name of a category and the second argument is either amount or left:x, where x is a number.

%point.reputation.amount%
%point.reputation.left:15%

Global Point Placeholder🔗

static

This placeholder displays the amount of global points in some category or the amount of points needed to reach a number. The first argument is the name of a category and the second argument is either amount or left:x, where x is a number.

%globalpoint.global_knownusers.amount%
%globalpoint.global_knownusers.left:100%

Tag Placeholder🔗

This placeholder displays whether the player has a tag or not. The placeholder will return true or false by default. If you add papiMode to the instruction it will return yes or no. You can translate the papiMode's result by changing the values of condition_placeholder_met and condition_placeholder_not_met in the messages.yml config.

%tag.test%
%tag.test.papiMode%

Global Tag Placeholder🔗

static

This placeholder displays whether a global tag is set or not. The placeholder will return true or false by default. If you add papiMode to the instruction it will return yes or no. You can translate the papiMode's result by changing the values of condition_placeholder_met and condition_placeholder_not_met in the messages.yml config.

%globaltag.test%
%globaltag.test.papiMode%

Custom Text Placeholder🔗

It is possible to save text per player. This works by using the placeholder objective and the placeholder event.

Other Placeholders🔗

Eval Placeholder🔗

static

This placeholder allows you to resolve an expression containing placeholders, and the result will then be interpreted again as a placeholder. You need to escape the % inside eval with a backslash \ to prevent it from being interpreted as a delimiter. You can nest multiple evals, but this leads you to an escape hell. If you do so, you need to add one escape level with each nesting level, this means normally you write \% and in the next level you need to write \\\%.

%eval.player.\%objective.placeholderStore.displayType\%%
%eval.player.\%eval.objective.\\\%objective.otherStore.targetStore\\\%.displayType\%%

Item Placeholder🔗

With this placeholder you can display different properties of a specific QuestItem. The first argument is the name of the item (as defined in the items section). The amount argument displays the number of items in the players inventory and backpack, the left:x gives the difference to the x value (when the amount is higher than the value it will be negative). The name argument simply gives the defined name or an empty String, when not set and lore:x displays the lore row with index x (starting with 0). Both name and lore supports the raw subargument to get the text without formatting.

%item.stick.amount%
%item.stick.left:32%
%item.epic_sword.name%
%item.epic_sword.lore:0.raw%

Item durability placeholder🔗

With this placeholder you can display the durability of an item. The first argument is the slot. An optional argument is relative which will display the durability of the item relative to the maximum from 0 to 1, where 1 is the maximum. You can specify the amount of digits with the argument digits:x, where x is a whole number. This default is 2 digits. Additionally, you get the output in percent (inclusive the '%' symbol).

%itemdurability.HAND%
%itemdurability.CHEST.relative%
%itemdurability.CHEST.relative.percent%
%itemdurability.HEAD.relative.digits:5%

Location Placeholder🔗

This placeholder resolves to all aspects of the player's location. The x, y and z coordinates, the world name, the yaw and pitch (head rotation). There are also modes for the Unified Location Formatting (ULF from now on) which means that this placeholder can also be used in events, conditions etc. If you just specify %location% the placeholders will resolve to a ULF with yaw and pitch. You can add two options to that base, one will give back parts of the ULF and the other will set to how many decimal places the placeholder will resolve. 

%location%           # -> 325;121;814;myWorldName;12;6
%location.xyz%       # -> 325 121 814 
%location.x%         # -> 325
%location.y%         # -> 121
%location.z%         # -> 814
%location.yaw%       # -> 12
%location.pitch%     # -> 6
%location.world%     # -> myWorldName
%location.ulfShort%  # -> 325;121;814;myWorldName
%location.ulfLong%   # -> 325;121;814;myWorldName;12;6

%location.x.2%       # -> 325.16
%location.ulfLong.5% # -> 325.54268;121.32186;814.45824;myWorldName;12.0;6.0

Math Placeholder🔗

static

This placeholder allows you to perform a calculation based on other placeholders (for example point or objective placeholders) and resolves to the result of the specified calculation. The placeholder always starts with math.calc:, followed by the calculation which should be calculated. Supported operations are +, -, *, /, ^ and %. You can use ( ) and [ ] braces and also calculate absolute values with | |. But be careful, don't use absolute values in the command event as it splits the commands at every | and don't nest them without parenthesis (|4*|3-5|| won't work, but |4*(|3-5|)| does). Additionally, you can use the round operator ~ to round everything left of it to the number of decimal digits given on the right. So 4+0.35~1 will produce 4.4 and 4.2~0 will produce 4.

To use placeholders in the calculation you have two options: First just write the placeholder, but without % around them; In cases where this doesn't work, e.g. if the placeholder contains mathematical operators, you can surround it with curly braces { }. Inside the curly braces you have to escape with \, so to have a \ in your placeholder you need to write \\, to have a } inside your placeholder you need to write \}.

When the calculation fails 0 will be returned and the reason logged.

Warning

The modulo operator needs to be escaped with a backslash \ to prevent it from being interpreted as a placeholder delimiter. If you don't want to escape the percentage and actually want to write a backslash you can use \\%. Don't forget to escape the backslash itself with another backslash if you are inside a double-quoted string ".

%math.calc:100*(15-point.reputation.amount)%
%math.calc:objective.kill_zombies.left/objective.kill_zombies.total*100~2%
%math.calc:-{ph.myplugin_stragee+placeholder}%
%math.calc:64\%32%

Npc Placeholder🔗

static

This placeholder resolves information about a Npc. Specifying an argument determines the return: the Npc name, or full name (with formatting).

Arguments:
* name - Return Npc name
* full_name - Return Npc name with formatting

Example
%npc.bob.name%        # Bob
%npc.bob.full_name%   # &eBob

Npc Location Placeholder🔗

This placeholder resolves to all Npc location. For details see the location placeholder. The general syntax is %npc.<id>.location.<mode>.<precision>%.

Example
%npc.mayor.location%           # -> 325;121;814;npcWorldName;12;6
%npc.mayor.location.xyz%       # -> 325 121 814 
%npc.mayor.location.ulfLong.5% # -> 325.54268;121.32186;814.45824;npcWorldName;12.0;6.0

Player Name Placeholder🔗

The placeholder %player% is the same as %player.name% and will display the name of the player. %player.display% will use the display name used in chat and %player.uuid% will display the UUID of the player.

%player%
%player.name%
%player.display%
%player.uuid%

Quester Name (Conversation)🔗

When the player is in a conversation, this placeholder will contain the quester's name in the player's quest language. If the player is not in a conversation, the placeholder is empty.

%quester%

Random Number Placeholder🔗

static

This placeholder gives a random number from the first value to the second. The first argument is whole or decimal, the second and third arguments are numbers or placeholders, separated by a ~. Like the math placeholder you can round the decimal value by using instead of decimal the argument decimal~x where x is the maximal amount of decimal places. Placeholders can be used with {} instead of %%. Note that the first value is returned when it is higher than the second.

%randomnumber.whole.0~10%
%randomnumber.whole.-70~70%
%randomnumber.decimal~3.3.112~100%
%randomnumber.decimal~1.0~{location.y}%

Forced Sync Placeholder🔗

static

This placeholder forces an evaluation on the server's main thread. Its syntax is identical to the eval placeholder, but you should only use it if syncing is required. If you encapsule multiple evaluations with sync, all sub-evaluations will be executed on the server's main thread and should be done with eval instead. 

%sync.player.\%objective.placeholderStore.displayType\%%
%sync.player.\%eval.objective.\\\%objective.otherStore.targetStore\\\%.displayType\%%

Version Placeholder🔗

static

This placeholder displays the version of the plugin. You can optionally add the name of the plugin as an argument to display version of another plugin.

%version.Citizens%