Denizen/Replaceable Tags

From Citizens Wiki

< Denizen

Revision as of 16:00, 7 July 2013 by Morphan1 (talk | contribs)

Flags

<flag.g:flag_name> Returns the value of a flag attached to the server. NOTE: In 0.9, it's more preferred to use <server.flag[flag_name]>
<flag.n:flag_name> Returns the value of a flag attached to the current NPC. NOTE: In 0.9, it's more preferred to use <npc.flag[flag_name]>
<flag.p:flag_name> Returns the value of a flag attached to the current player. NOTE: In 0.9, it's more preferred to use <player.flag[flag_name]>

Location

All location tags require coordinates. You can have tags in the brackets [] or you can specify exact locations by yourself. For example, you could use

<location[<npc.location>].biome.temperature>

to get the temperature at the NPC's location.

<location[x,y,z,world].biome.formatted> The formatted name of the biome at coordinates.
<location[x,y,z,world].biome.humidity> The current humidity at the coordinates.
<location[x,y,z,world].biome.temperature> The current temperature at the coordinates.
<location[x,y,z,world].distance[x,y,z,world]> The distance between 2 coordinates.
<location[x,y,z,world].formatted> The coordinates in an easier-to-read format.
<location[x,y,z,world].is_liquid> Whether or not the block at the coordinates are a liquid. Can be true or false.
<location[x,y,z,world].light> The light level at the coordinates.

NPC

NOTE: You can reference an NPC other than the one in the current script by using <npc[npc_id]>... So for example, <npc[2].id> (which would be completely useless) would return '2'.

<npc.flag[flag_name]> Returns the value of a flag attached to an NPC.
<npc.id> The ID number of the NPC.
<npc.location> The coordinates of the NPC. [x,y,z,world]
<npc.location.previous_location> The last location the NPC was at.
<npc.location.standing_on> The Bukkit block name that the NPC is standing on.
<npc.location.standing_on_display> The formatted block name that the NPC is standing on.
<npc.location.world> The name of the world the NPC is in.
<npc.location.world_spawn> The coordinates of the spawn of the world that the NPC is currently in.
<npc.location.x> The x coordinate the NPC is at.
<npc.location.y> The y coordinate the NPC is at.
<npc.location.z> The z coordinate the NPC is at.
<npc.name> The NPC's name.
<npc.name.nickname> The NPC's nickname.
<npc.owner> The owner of the NPC.

Player

NOTE: You can reference a player other than the one in the current script by using <player[player_name]>... So for example, <player[Morphan1].name> (which would be completely useless) would return 'Morphan1'.

<player.chat_history> Last message the player sent.
<player.chat_history[X]> Message the player sent X times ago.
<player.equipment.boots> The Bukkit name for the boots the player is wearing. Can also be used for chestplate, leggings, and helmet.
<player.equipment.boots.formatted> The formatted name for the boots the player is wearing. Can also be used for chestplate, leggings, and helmet.
<player.flag[flag_name]> Returns the value of a flag attached to a player.
<player.health> The player's health, 1-20. Each number is half of a heart.
<player.health.formatted> The player's formatted health. Can be healthy, scraped, injured, seriously wounded, and dying.
<player.health.percentage> The player's health as a percentage.
<player.inventory.contains.display[display_name]> Checks if the player's inventory contains an item with a name chosen on an anvil. You can also add .qty[X] to check if the player has an X amount of the item. Can be true or false.
<player.inventory.contains[item_id]> Checks if the player's inventory contains an item. You can also add .qty[X] to check if the player has an X amount of the item. Can be true or false.
<player.food_level> The player's food level, 1-20. Each number is half of a thing-on-the-hunger-bar.
<player.food_level.formatted> The player's formatted food level. Can be healthy, parched, hungry, and famished.
<player.food_level.percentage> The player's food level as a percentage.
<player.group[group_name]> Checks if the player is in a group via Vault. Can be true or false.
<player.group[group_name].global>> Checks if the player is in a global group via Vault. Can be true or false.
<player.item_in_hand.enchantments> List of enchantments on item in player's hand.
<player.item_in_hand.enchantments_with_level> List of enchantments and their levels on item in player's hand.
<player.item_in_hand.enchantments_with_level_only> List of levels of enchantments on item in player's hand.
<player.item_in_hand> Contains all details of the item in the player's hand.
<player.item_in_hand.data> The material data of the item the player is holding.
<player.item_in_hand.display> The name chosen on an anvil for the item the player is holding.
<player.item_in_hand.durability> The durability of the item the player is holding.
<player.item_in_hand.id> The ID of the block or item the player is holding. All block and item IDs are found here.
<player.item_in_hand.lore> List of lore on item in the player's hand.
<player.item_in_hand.max_stack> The maximum amount you can have in one inventory slot of the item the player is holding.
<player.item_in_hand.material> Bukkit material name of the item in the player's hand.
<player.item_in_hand.material.formatted> Formatted material name of the item in the player's hand.
<player.item_in_hand.qty> The current amount of the inventory slot of the item the player is holding.
<player.is_banned> Whether the player is banned. Can be true or false.
<player.is_online> Whether the player is online. Can be true or false.
<player.is_op> Whether the player is an operator. Can be true or false.
<player.location> The coordinates of the player. [x,y,z,world]
<player.location.bed_spawn> The coordinates of the last bed the player slept in, if any.
<player.location.cursor_on[X]> The location of the block the player's cursor is on, within X range.
<player.location.standing_on> The Bukkit block name that the player is standing on.
<player.location.standing_on.formatted> The formatted block name that the player is standing on.
<player.location.world> The name of the world the player is in.
<player.location.world_spawn> The coordinates of the spawn of the world that the player is currently in.
<player.location.x> The x coordinate the player is at.
<player.location.y> The y coordinate the player is at.
<player.location.z> The z coordinate the player is at.
<player.money> The amount of money in this player's account. Requires Vault and an economy plugin.
<player.name> The player's name.
<player.name.display> The player's display name. (The one that shows in chat.)
<player.mcmmo.level[skill_name]> The player's current level for an McMMO skill.
<player.money> How much money the player has, as a number. (0.0, 1.5, 2.25, etc.)
<player.money.asint> How much money the player has, as an integer. (0, 1, 2, etc.)
<player.money.currency> The currency set in this server's economy plugin.
<player.money.currency.plural> The currency set in this server's economy plugin, in its plural form.

Examples: Dollars, pounds, coins

<player.money.currency.singular> The currency set in this server's economy plugin, in its singular form.

Examples: Dollar, pound, coin

<player.script[script_name].failed> Checks if the player has failed a script. Can be true or false.
<player.script[script_name].finished> Checks if the player has finished a script. Can be true or false.
<player.time> The player's time in ticks, from 0 to 23999. For a quick view of what different tick values mean in real life hours, look here.
<player.time.period> The time period for this player. Can be "day" or "night".
<player.xp> The total experience of a player.
<player.xp.level> The current experience level of a player.
<player.weather> The current weather in this player's world. Is "storming" if there's a storm, "sunny" if the weather is clear and it's daytime, and "clear" if the weather is clear and it's nighttime.

Util

Text

Colors

<aqua>
<black>
<blue>
<dark_aqua>
<dark_blue>
<dark_gray>
<dark_green>
<dark_purple>
<dark_red>
<gold>
<gray>
<green>
<light_purple>
<red>
<white>
<yellow>

Pssst...

http://pastebin.com/KBADLinZ
Here is a summary of them :)
-Jeebs