> For the complete documentation index, see [llms.txt](https://edseries-plugins.gitbook.io/p/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edseries-plugins.gitbook.io/p/eddungeons/essential/placeholders.md). # Placeholders ### Currency Placeholders #### %eddungeons\_currency\_balance\_{currency}% Returns the player's balance for the specified currency #### %eddungeons\_currency\_name\_{currency}% Returns the display name of the specified currency #### %eddungeons\_currency\_primarycolor\_{currency}% Returns the primary colour code configured for the specified currency #### %eddungeons\_currency\_secondarycolor\_{currency}% Returns the secondary colour code configured for the specified currency *** ### Leveling Placeholders #### %eddungeons\_leveling\_level\_{levelid}% Returns the player's current level in the specified leveling track #### %eddungeons\_leveling\_bar\_{levelid}% Returns the progress bar for the specified leveling track #### %eddungeons\_leveling\_progress\_{levelid}% Returns the progress percentage (0-100) for the next level #### %eddungeons\_leveling\_currencyrequired\_{levelid}% Returns the currency amount needed to level up once *** ### Enchant Placeholders #### %eddungeons\_enchant\_level\_{enchant}% Returns the player's current level in the specified enchant #### %eddungeons\_enchant\_name\_{enchant}% Returns the display name of the specified enchant #### %eddungeons\_enchant\_material\_{enchant}% Returns the material/item type of the specified enchant #### %eddungeons\_enchant\_color\_{enchant}% Returns the colour code configured for the specified enchant #### %eddungeons\_enchant\_chance\_{enchant}% Returns the current chance/probability for the enchant to trigger #### %eddungeons\_enchant\_maxlevel\_{enchant}% Returns the maximum level available for the specified enchant #### %eddungeons\_enchant\_cost\_{enchant}\_{levels}% Returns the cost to upgrade the enchant by the specified number of levels #### %eddungeons\_enchant\_maxlevels\_{enchant}% Returns the maximum number of levels the player can afford to buy #### %eddungeons\_enchant\_maxcost\_{enchant}% Returns the cost to buy all affordable levels for the enchant #### %eddungeons\_enchant\_status\_{enchant}% Returns the status/state of the enchant (`enabled` or `disabled`) #### %eddungeons\_enchant\_proc\_message\_{enchant}% Returns true/false depending on whether the enchant's proc messages are enabled for the player #### %eddungeons\_enchant\_currencyname\_{enchant}% Returns the display name of the currency used for this enchant #### %eddungeons\_enchant\_currencyprimarycolor\_{enchant}% Returns the primary colour code of the currency used for this enchant #### %eddungeons\_enchant\_currencysecondarycolor\_{enchant}% Returns the secondary colour code of the currency used for this enchant *** ### Enchant Prestige Placeholders #### %eddungeons\_enchant\_prestige\_{enchant}% Returns the player's current prestige level for the specified enchant #### %eddungeons\_enchant\_prestige\_enabled\_{enchant}% Returns true/false depending on whether the enchant has prestige configured #### %eddungeons\_enchant\_prestige\_canprestige\_{enchant}% Returns true/false depending on whether the player can prestige the enchant right now #### %eddungeons\_enchant\_prestige\_chancebonus\_{enchant}% Returns the total proc-chance bonus the player currently gets from their prestige on this enchant #### %eddungeons\_enchant\_prestige\_perlevel\_{enchant}% Returns the proc-chance bonus granted per prestige level for this enchant #### %eddungeons\_enchant\_prestige\_requirements\_{enchant}% Returns the formatted requirement lines for the enchant's next prestige (see `enchant-prestige` in `config.yml`) #### %eddungeons\_enchant\_prestige\_stars\_{enchant}% Returns the repeated star string for the player's current prestige on this enchant #### %eddungeons\_enchant\_maxprestige\_{enchant}% Returns the maximum prestige level available for the specified enchant *** ### Sword System Placeholders #### %eddungeons\_damage% Returns the player's current sword damage #### %eddungeons\_sword\_skin% Returns the player's currently selected sword skin ID #### %eddungeons\_sword\_skintolevel% Returns the player's currently selected sword skin as an integer level. wooden-sword -> 1, stone-sword-> 2 etc... #### %eddungeons\_sword\_skin\_selected\_{skinid}% Returns true/false if the specified skin is currently selected #### %eddungeons\_sword\_ishigher\_{skinid}% Returns true/false if player's current sword is higher tier than specified skin #### %eddungeons\_sword\_islower\_{skinid}% Returns true/false if player's current sword is lower tier than specified skin #### %eddungeons\_sword\_canupgrade\_{skinid}% Returns true/false if the player can upgrade to the specified sword skin #### %eddungeons\_sword\_tier\_selected\_{tier}% Returns true/false if the specified tier is currently selected #### %eddungeons\_sword\_tier\_isselected\_{skinid}\_{tier}% Returns true/false if the specified skin and tier combination is selected #### %eddungeons\_sword\_material\_{skinid}% Returns the material type of the specified sword skin #### %eddungeons\_sword\_color\_{skinid}% Returns the colour code configured for the specified sword skin #### %eddungeons\_sword\_name\_{skinid}% Returns the display name of the specified sword skin #### %eddungeons\_sword\_modeldata\_{skinid}% Returns the custom model data value for the specified sword skin #### %eddungeons\_sword\_tier% Returns the player's current sword tier #### %eddungeons\_sword\_damage\_{skinid}% Returns the damage value for the specified sword skin #### %eddungeons\_sword\_price\_{skinid}% Returns the price to purchase/upgrade the specified sword skin #### %eddungeons\_sword\_nextprice\_{skinid}% Returns the price for the next upgrade of the specified sword skin #### %eddungeons\_sword\_tier\_damage\_{skinid}\_{tier}% Returns the damage value for a specific sword skin and tier combination #### %eddungeons\_sword\_tier\_price\_{skinid}\_{tier}% Returns the price for a specific sword skin and tier combination #### %eddungeons\_sword\_tier\_{skinid}% Returns the current tier for the specified sword skin #### %eddungeons\_sword\_maxtier\_{skinid}% Returns the maximum tier available for the specified sword skin #### %eddungeons\_sword\_stars\_{skinid}% Returns the number of stars/upgrades for the specified sword skin #### %eddungeons\_sword\_leftstars\_{skinid}% Returns the remaining stars/upgrades available for the specified sword skin *** ### Number Formatting Placeholders #### %eddungeons\_notation\_{value}% Formats the number using the default notation system #### %eddungeons\_parse\_{value}% Parses and returns the numeric value as a BigDecimal #### %eddungeons\_singlenotation\_{value}% Formats the number using single number notation (commas) #### %eddungeons\_abbrevnotation\_{value}% Formats the number using abbreviated notation (k, M, B, etc.) #### %eddungeons\_calc\_{expression}% Calculates and returns the result of a mathematical expression *** ### Random Generation Placeholders #### %eddungeons\_random\_{min}|{max}% Generates a random integer between min and max values #### %eddungeons\_randompos\_{anchor}|{offset}% Generates a random position vector based on anchor point and offset #### %eddungeons\_randomwithdecimals\_{decimals}\_{min}|{max}% Generates a random number with specified decimal places between min and max *** ### Zone System Placeholders #### %eddungeons\_zone\_stage\_{zoneid}% Returns the player's current stage in the specified zone #### %eddungeons\_zone\_in% Returns the ID of the zone the player is currently in #### %eddungeons\_zone\_in\_name% Returns the display name of the zone the player is currently in #### %eddungeons\_zone\_unlocked% Returns the ID of the zone the player has latest unlocked #### %eddungeons\_zone\_unlocked\_name% Returns the display name of the zone the player has latest unlocked #### %eddungeons\_zone\_unlocked\_stage% Returns the stage ID of the player latest unlocked zone #### %eddungeons\_zone\_unlocked\_{zoneid}\_{stageid}% Returns true/false if the specified zone stage is unlocked for the player *** ### Booster System Placeholders #### %eddungeons\_boosters\_global\_enchants% Returns the current global enchant boost multiplier #### %eddungeons\_boosters\_global\_{currency}% Returns the current global boost multiplier for the specified currency #### %eddungeons\_boosters\_names\_enchants% Returns the names of active global enchant boosters #### %eddungeons\_boosters\_names\_{currency}% Returns the names of active boosters for the specified currency #### %eddungeons\_boosters\_multiplier\_{booster-id}% Returns the specific multiplier of a booster ID. Returns "0" if the booster doesn't exist #### %eddungeons\_boosters\_boost\_{booster-id}% Returns the id of the boosted currency from a booster ID. Returns "none" if the booster doesn't exist. *** ### Attribute Placeholders #### %eddungeons\_attribute\_level% Returns the player's active attribute tier/level #### %eddungeons\_attribute\_attackspeed% Returns the flat auto-hit reduction (in milliseconds) granted by the player's active attribute tier. Returns "0" when none is unlocked. #### %eddungeons\_attribute\_boost\_{currency}% Returns the percentage currency boost the player gets from their active attribute tier for the specified currency *** ### Ability Placeholders #### %eddungeons\_ability\_selected% Returns the display name of the player's currently selected ability #### %eddungeons\_ability\_selected\_id% Returns the ID of the player's currently selected ability. Returns "none" if none is selected. *** ### Summary System Placeholders #### %eddungeons\_summary\_{currency}% Returns the sell summary total for the specified currency *** ### Utility Placeholders #### %eddungeons\_pluginenabled\_{pluginname}% Returns true/false if the specified plugin is enabled #### %eddungeons\_haspermission\_{permission}% Returns true/false if the player has the specified permission *** ### Automatic Formatting All numeric placeholders support automatic formatting by adding suffixes: #### \_{placeholder}\_formatted Applies default number formatting to the result #### \_{placeholder}\_formatted\_single Applies single number formatting (commas) to the result #### \_{placeholder}\_formatted\_abbrev Applies abbreviated formatting (k, M, B, etc.) to the result *** ### Usage Examples **Currency with formatting:** * `%eddungeons_currency_balance_money_formatted%` * `%eddungeons_currency_balance_gems_formatted_abbrev%` **Random values in mob rewards:** * `%eddungeons_random_1|1000%` - Random 1 to 1000 * `%eddungeons_randomwithdecimals_2_0.5|5.0%` - Random 0.50 to 5.00 **Conditional rewards:** * `%eddungeons_random_0|100% < 50` - 50% chance condition **Zone progression:** * `%eddungeons_zone_unlocked_barn-zone_5%` - Check if stage 5 is unlocked --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://edseries-plugins.gitbook.io/p/eddungeons/essential/placeholders.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.