Denizen/0.7/Interact Scripts/Commands

Interact Script Commands are used to make the Denizen perform actions in an Interact Script. They are written in a YAML sequence under the Script node of an Interact Trigger. A single entry in the sequence contains a Command and Modifiers. Some commands have no available modifiers.

Syntax

Syntax is very important for proper execution.

• Placing a caret ^ in front of the command name causes that command to ignore the normal 0.5 second delay between commands.
• The command must be upper-case (i.e CHAT not chat)
• Modifiers are not case sensitive.
• Modifiers in [Brackets] are required for the command to execute. [A or B] means either A or B is required.
• Modifiers in (Parentheses) are optional, and generally change the default behavior of the command.
• Modifiers that take a value are of the form MODIFIER:VALUE.
  • If the VALUE of the modifier contains a space, such as in the case of a NPC or script name, the whole modifier must be put in quotes.

Example: - TELEPORT BOOKMARK:Bob:Bobshouse is okay, but - TELEPORT 'BOOKMARK:Bob Jones:Bobshouse' requires the quotes to function properly.

Example:

Some Trigger:
  Script:
  - COMMAND1 MODIFIER1 MODIFIER2:VALUE
  - COMMAND2 'MODIFIER1:Value With Spaces'
  - ^COMMAND3 'This will run instantly after COMMAND2'

List of Commands

Script Flow

These commands have no external effect on the world, but can control the flow of scripts within Denizen. Though not required, and with the exception of WAIT, it is generally recommended to run these as Instant Commands to ensure smooth Script feedback to players.

	CANCELTASK	['SCRIPT:Name of Script']
Cancels a task that has been scheduled for the interacting player using RUNTASK DELAY Example Usages - CANCELTASK SCRIPT:RaceEnd

	COOLDOWN	[# or DURATION:#] (GLOBAL) ('SCRIPT:Name of Script')
Sets a cooldown period for this script. Defaults to the currently running script and the interacting player. Until the script has cooled down, it will not be selected to run again. Requires a number of seconds to be specified with or without the DURATION: modifier name. Modifiers: GLOBAL makes the script unavailable to everyone, instead of just the interacting player. SCRIPT: Sets the cooldown a different script. Example Usages - COOLDOWN 60 - COOLDOWN GLOBAL 100 - COOLDOWN 'SCRIPT:A Different Script' 600 - COOLDOWN DURATION:15

	DISENGAGE	(NPCID:#)
Allowed an ENGAGED Denizen to be interacted with again, the counterpart to the ENGAGE command. Can also specify the NPCID of a different Denizen Example Usages - ENGAGE - (Other Commands) - DISENGAGE - DISENGAGE NPCID:7

	ENGAGE	(DURATION:#) (NPCID:#)
Blocks player interaction from triggering the NPC. This may be useful if a long script required the player to listen or watch a series of events and you didn't want the Player to be able to interact while these commands were being taken out. Use with either a DURATION or DISENGAGE. DURATION will automatically DISENGAGE after the specified amount of seconds. If no NPCID is included, the Denizen triggered is used. Remember: While ENGAGED, no scripts will trigger, so be diligent in using! Example Usages - ENGAGE - (Other Commands) - DISENGAGE - ENGAGE DURATION:12 - ENGAGE NPCID:2

	FAIL	('SCRIPT:Name of Script')
Marks a script as 'Failed' to check against with the FAILED requirement. This is identical to the FINISH command, except keeps track of 'fails' instead. Again, this is kind of like a built-in flag for scripts, and acts much like a Counter, ie. You can FAIL a script multiple times and it will keep track of the total number, unless RESET. Note: A script can be both 'finished' and 'failed', the two commands work independently. Example Usages - FAIL - FAIL 'SCRIPT:Magic Feathers'

	FINISH	('SCRIPT:Name of Script')
Marks a script as 'Finished' to check against with the FINISHED requirement. This is kind of like a built-in flag for scripts, and acts much like a Counter, ie. You can FINISH a script multiple times and it will keep track of the total number, unless RESET. Example Usages - FINISH - FINISH 'SCRIPT:Another Script'

	FLAG	['Flag Name' or 'Flag Name:Flag Value' or 'Flag Name:++' or 'Flag Name:--'] (PLAYER or DENIZEN or GLOBAL) (DURATION:#)
Requires one of the above arguments. FLAG stores variables, or 'flags', by default to a Player. This can be used to keep track of information that can be check against with the FLAGGED requirement. Usage of the command is easy, and can be used in 3 different ways. A Boolean (true/false) value can be set with only a flag name. If set, the value is TRUE. When RESET, it is FALSE. FLAG can also set Integer (or number) variables, and easily increment or decrease them with the use of the ++ and -- arguments accordingly. The command can also store a String value, see the example below. Using a DURATION will revert the value of the flag to the previous value, if during the duration the flag has not changed. Using the PLAYER modifier will set the flag on the Player (which is the default behavior). Using the DENIZEN modifier will set a flag on the Denizen instead of the Player. Using the GLOBAL modifier will set a flag independent of a Player or Denizen. Example Usages - FLAG 'Sample Boolean Flag' - FLAG Alignment:++ - FLAG Alignment:-- - FLAG 'Active Item:60 Feathers' - FLAG WorldBossDead GLOBAL - FLAG HasHealingFlag DURATION:180

	IF	(EXACTLY) (PLAYER or DENIZEN or GLOBAL) (-)[FLAG:Name or FLAG:Name:Value] (IS_NUMBER) ['SCRIPT:Script Run When Condition Met'] (QUEUETYPE:TRIGGER or QUEUETYPE:TASK) (APPEND) (ELSE 'SCRIPT:Script Run When Condition Not Met')
Checks the value of a FLAG and runs a TASK script if the condition is met. By default the TASK script will run before the interact script continues. Modifiers: EXACTLY - For integer flags, the IF condition is met only if the value matches exactly. By default, the condition is met if the flag's value is greater than or equal to the value it is checked against, i.e. IF 'FLAG:AGE:13' will pass for any AGE that is at least 13, but IF EXACTLY 'FLAG:AGE:13' will only pass if the AGE is 13. PLAYER - Check a flag set on this Player (which is the default behavior) DENIZEN - Check a DENIZEN flag set on the Denizen itself instead of a flag on this Player GLOBAL - Check a GLOBAL flag instead of a flag on this Player IS_NUMBER - The IF condition is met only if the value of the flag is an integer or double. APPEND - Runs the TASK after this script completes, instead of before the next command. QUEUETYPE - Specify which queue to run the commands, defaults to the executing queue type. ELSE - Choose a TASK script to run when the IF condition is not met. Example Usages - IF FLAG:BossDead SCRIPT:Reward APPEND - IF EXACTLY FLAG:Stage:4 SCRIPT:Stage4Instructions - IF 'FLAG:AGE:13' 'SCRIPT:Meets Minimum Age' ELSE 'SCRIPT:Does Not Meet Minimum Age'

	RANDOM	[#]
Selects a single command to run from the next # lines in the script and discards the rest. Example Usages - CHAT "I'm going to say the name of an animal" - RANDOM 3 - CHAT "Cow" - CHAT "Zebra" - CHAT "Elephant" - CHAT "Wasn't that fun?"

	RESET	[FINISHED or FAILED or FLAG:FlagName] ('SCRIPT:Name of Script')
Sets the FINISHED or FAILED count of the specified script to 0, or sets the specified boolean flag to False. Remember: Script and Flag names are case sensitive! Example Usages - RESET FINISHED 'SCRIPT:Magic Feathers' - RESET FLAG:SomeFlag

	RUNTASK	['SCRIPT:Name of Script'] (DELAY:#) (NPCID:#)
Runs a TASK script as the Denizen on the interacting player. Modifiers: DELAY waits this number of seconds before running the task. specific to the interacting player. If this task is already pending for this player, it is canceled and re-applied with the new delay. NPCID runs the task as a different Denizen. Example Usages - RUNTASK 'SCRIPT:Apple Reward' - RUNTASK SCRIPT:RaceEnd DELAY:60

	WAIT	[# of Seconds] (QUEUE:TASK) (QUEUE:TRIGGER)
Pauses a Queue for a specified amount of seconds. If no QUEUE is specified, the sending queue is used. For example, if the command is sent from an Interact (Triggered) Script, the queue that will be held is the 'Trigger Queue'. Could be useful in advanced usage situations when using both Task Scripts and Interact Scripts together. Example Usages - WAIT 6 - WAIT 30 QUEUE:TASK

	ZAP	(Step #) ('SCRIPT:Name of Script') (DURATION:#) (RANDOM:#-#)
A very powerful command, indeed. This is how Scripts progress through their steps. It is not done automatically, instead, you get to decide how to progress. ZAP used alone will simply progress the Player to the next step in the Script. Note: Denizen does not check whether the step exists, so you can use that to your advantage in an Overlay Script Assignment. If an Integer is used, that step will be used. Specify a SCRIPT to change the active step for a Player in a specific Script. If not specified, the triggering Script is used. A DURATION can be set to provide an automatic "DEZAP" of sorts, reverting the step back after a specific amount of seconds, unless, in that duration another ZAP command has taken place. This can be used as a 'timeout' of sorts. RANDOM can be used to let chance select the step to progress the Player to. If one Integer is included, steps 1 through the chosen number will be randomly selected. You can also use a range of numbers if two Integers are used. Example Usages - ZAP - ZAP 5 - ZAP RANDOM:6 - ZAP RANDOM:3-6 DURATION:60 - ZAP 6 'SCRIPT:Another Script'

Server

	EXECUTE	[ASPLAYER or ASSERVER or ASNPC] ["command and arguments"]
Runs a Minecraft/Bukkit command. Specifying ASPLAYER, ASSERVER, or ASNPC defines how the command should be executed. ASNPC will run the command as the Denizen interacting, temporarily granting OP privileges, if the Denizen NPC is a Human-type NPC. Running ASSERVER will run as a console command, and running ASPLAYER will simply run the command as the Player. When specifying the command and arguments, it is not necessary to use the '/' that is generally used when running commands in-game. You may also use <PLAYER>, <WORLD>, or <NPCID> as variables inside the command arguments. Example Usages EXECUTE ASSERVER 'gamemode <PLAYER> 2' EXECUTE ASNPC 'toggledownfall' EXECUTE ASPLAYER 'spawn'

The commands below require [Vault] and a valid permissions system.

	PERMISS	[permission.node or 'GROUP:Group Name'] (WORLD) ('WORLD:World Name')
Gives the Player either a permissions node or adds a group, if supported by your permissions system. Note: You should not include both a permissions node and a group. If you specify a WORLD argument, it will apply the permissions node/group only to the current world. You can alternatively specify a world with WORLD:worldName. Example Usages - PERMISS modifyworld.* - PERMISS GROUP:HillsideEnemy - PERMISS citizens.* WORLD:testworld

	REFUSE	[permission.node or 'GROUP:Group Name'] (WORLD) ('WORLD:World Name')
Removes from the Player either a permissions node or a group, if supported by your permissions system. Note: You should not include both a permissions node and a group. If you specify a WORLD argument, it will remove the permissions node/group only to the current world. You can alternatively specify a world with WORLD:worldName. Generally, however you add your permissions or group with PERMISS, you should do the same when removing with REFUSE. Example Usages - REFUSE modifyworld.* - REFUSE GROUP:HillsideEnemy - REFUSE citizens.* WORLD:testworld

Speech

These commands show some text to the player interacting, and usually to bystanders around. Text commands also have some auto-formatting, such as making sure no words will be cut off on long messages, and applying color codes. See: Denizen Color Codes. Formatting for how NPCs and Players talk can be customized in the Denizen/config.yml.

• All Speech commands require quotes (single (' ') or double (" ")) around the text. If your text has an apostrophe (') in it, you MUST use double quotes (" ")!!

You can use the following placeholders to fill in specific information:

• <NPC> - The Denizens's name.
• <PLAYER> - The interacting Player's name
• <DISPLAYNAME> - The interacting Player's display name
• <HEALTH> - The interacting Player's heath
• <WORLD> - The name of the Denizen's world

If you use the NOPLAYER modifier on a text command the <PLAYER>, <DISPLAYNAME> and <HEALTH> tags are not available.

	ANNOUNCE	['The text to announce.']
Sends the text as a sever announcement to all players, regardless of their place in the world. Could be especially useful for any kind of administration script. Example Usages - ANNOUNCE "<PLAYER> has found a secret!"

	CHAT	["The text to chat."] (NPCID:#) (NOPLAYER)
Makes the Denizen talk to the player. This is the standard chat mechanism in Denizen. You can also change the NPC doing the talking by specifying a Denizen's C2 NPCID. If you would rather the Denizen NPC not speak to the Player directly, use the NOPLAYER argument. Example Usages - CHAT NOPLAYER "Here ye, hear ye!" - CHAT "Hello there, children!" - CHAT NPCID:6 'I only supply tools to builders!'

	EMOTE	['The text to emote.'] (NPCID:#)
Let's the Denizen NPC show emotion. Similar to the /me command in IRC, for example. Could be useful for describing to the player what an NPC Denizen may need, or how the NPC Denizen is feeling. NPCID can be specified to change the Denizen NPC doing the 'emote'. Example Usages - EMOTE 'is looking a bit nervous.' - EMOTE NPCID:82 'thinks you should ask a few questions.' - EMOTE "could use a stiff drink."

	HINT	(SHORT)
If called from an Interact Script Step with a Chat Trigger, this will output a list of all possible things the player can say to activate a chat trigger. Modifiers: SHORT The Denizen will only say the list of trigger words, instead of the full sentence. Example Usages - HINT - HINT SHORT

	NARRATE	['The text to narrate.']
Makes a message appear to player without sender information. Example Usages - NARRATE "There is a small mailbox here."

	SHOUT	["The text to chat."] (NPCID:#) (NOPLAYER)
Shouts the text to players nearby. The range that a bystander can hear an NPC Denizen shout is larger then that of a standard CHAT, so it also has some technical advantages. NPCID can be specified. Using NOPLAYER will drop reference to the Player when talking. You can still reference <PLAYER>, however, if need be. See the example below for an idea for usage. Example Usages - SHOUT "EEEK! a spider!" - SHOUT NOPLAYER "<PLAYER> is a thief! Get him!"

	WHISPER	["The text to whisper."] (NPCID:#) (NOPLAYER)
Whispers the text to the player. Really just an alternative to CHAT. By default, bystanders can't hear what the NPC whispers to the interacting Player. As with the CHAT command, NPCID can be specified. Using NOPLAYER is possible too, since it may be of use in some circumstances. But remember: by default, no bystanders can see the actual text the NPC Denizen whispers. This can be changed in the config.yml. Example Usages - WHISPER "The password is.. 42." - WHISPER NPCID:2 "Hey, I didn't want to blurt this out so everyone could hear, but..."

Denizen Interaction

Denizen interaction commands are meant to help bring your Denizen to life by allowing fine control of movement and actions during scripts. These are not meant for making the Denizen do continuous movement and actions, that should instead be done via Activities.

	HOLD	[ID or ID:Data or MATERIAL or MATERIAL:Data]
Makes the Denizen hold a specific block or item. Example Usages - HOLD IRON_PICKAXE - HOLD 98:3

	LOOK	[DIRECTION or BOOKMARK:BookamrkName or 'BOOKMARK:Denizen Name:BookmarkName' or CLOSE or AWAY] (NPCID:#) (DURATION:#)
This command controls where the NPC Denizen is looking. It requires either a Direction, Bookmark, or look-close trait state. Valid directions: UP, DOWN, LEFT, RIGHT, NORTH, SOUTH, EAST, WEST, AT, and BACK. Looking AT or BACK takes the Player's position for reference. AT will look at the Player, BACK will look away from the player. Using CLOSE

	PAUSE	(DURATION:#)
Causes the Denizen to stop any pathing or activities. Useful for keeping it in place during an interaction. Modifiers: DURATION: Automatically RESUME after the specified number of seconds. Example Usages - PAUSE - PAUSE DURATION:30

	RESUME
Cancels a previous PAUSE command. Example Usages - RESUME

	RETURN	(SPEED:#)
Makes the denizen walk back to the position it was at before a call to WALKTO or WALK. Will resume NPC pathing if set. Modifiers: SPEED: is the movement speed, generally should be between 0.1 and 1.5 Example Usages - WALKTO BOOKMARK:Somewhere - RETURN

	WALK	(FORWARD:#) (NORTH:#) (SOUTH:#) (EAST:#) (WEST:#) (UP:#) (DOWN:#) (X:#) (Y:#) (Z:#) (SPEED:#)
Makes the denizen walk some distance from its current position. Interrupts any current movement, and pauses the NPC pathing if active. All provided directions are added into one movement. Decimal and negative values are accepted. Modifiers: SPEED: is the movement speed, generally should be between 0.1 and 1.5 FORWARD: makes the Denizen walk in whatever direction it is currently facing. Combine LOOK CLOSE and a negative value to walk directly away from the player. +X is the same as EAST +Y is the same as UP +Z is the same as NORTH Example Usages - WALK NORTH;4 EAST:2.5 - WALK FORWARD:1

	WALKTO	[BOOKMARK:LocationBookmark or 'BOOKMARK:DenizenName:LocationBookmark' or PLAYER] (SPEED:#)
Makes the denizen walk to the specified location bookmark, or to the interacting player. Interrupts any current movement, and pauses the NPC pathing if active. Modifiers: SPEED: is the movement speed, generally should be between 0.1 and 1.5 Example Usages - WALKTO PLAYER - WALKTO 'BOOKMARK:Gary:GarysHouse'

World Interaction

	DROP	[ID or ID:Data or MATERIAL or MATERIAL:Data] (QTY:#) (BOOKMARK:LocationBookmark)
Drop an item at the Denizen's location, or at a location bookmark if one is specified. Example Usages - DROP DIAMOND QTY:3 - DROP 18:3 QTY:1 BOOKMARK:LargeTree

	LISTEN KILL	[TYPE:GROUP or TYPE:PLAYER or TYPE:ENTITY or TYPE:NPC] [NAME:Name or NPCID:#] (QTY:#) [SCRIPT:Task Script] (ID:Name)
This command starts the Denizen listening for the player to kill the specified number of specified targets, then runs a task script. Use the NAME:Name modifier when specifying a group name, player name, or entity type (like 'ZOMBIE'). Use NPCID:# modifier when using TYPE:NPC. Optional Modifiers: QTY: - The number things the player must kill before the script is run. Example Usages - LISTEN KILL TYPE:ENTITY NAME:ZOMBIE QTY:5 SCRIPT:ZombitReward - LISTEN KILL TYPE:NPC NPCID:12 'SCRIPT:Kill Boss Reward'

	SPAWN	[ENTITY_TYPE] (QTY:#) (BOOKMARK:LocationBookmark) ('BOOKMARK:Denizen Name:LocationBookmark') (SPREAD:#) ('EFFECT:[POTION_EFFECT] [LEVEL]') ('OPTION:[OPTIONS]')
Spawns a specified amount of entities. If the location bookmark is missing, they will spawn near the Denizen. Modifiers: SPREAD:[#] Increases the 'spread' of the area that the monster can spawn. 'EFFECT:[POTION_EFFECT] [LEVEL]' Applies a potion effect on the monster when spawning. 'OPTION:OptionName OptionsValue' Applies a flag to the Mob. Note: Only works for mobs that can accept the flag. Valid OptionNames are: POWERED, SADDLED, BABY, 'PROFESSION [PROFESSION_TYPE]', SHEARED, 'COLORED [DYE_COLOR]', ANGRY') CREEPER can have POWERED PIG can have SADDLED PIG, SHEEP, COW, VILLAGER, CHICKEN, OCELOT and WOLF can have BABY VILLAGER can have PROFESSION Valid PROFESSION_TYPEs: FARMER, LIBRARIAN, PRIEST, BLACKSMITH, BUTCHER SHEEP can have SHEARED and COLORED WOLF and PIG_ZOMBIE can have ANGRY Example Usages - SPAWN BOAT - SPAWN QTY:3 COW BOOKMARK:Cage - SPAWN VILLAGER 'BOOKMARK:El Notcho:Gate' - SPAWN QTY:10 PIG_ZOMBIE SPREAD:5 - SPAWN QTY:25 ZOMBIE SPREAD:20 'EFFECT:INCREASE_DAMAGE 2' - SPAWN QTY:2 SHEEP 'OPTION:COLORED RED'

	STRIKE	(DENIZEN) (BOOKMARK:LocationBookmark) ('BOOKMARK:Denizen Name:LocationBookmark') (NODAMAGE) (NPCID:#)
Lightning at your fingertips. Modifiers: DENIZEN Strike lightning at the Denizen's location instead of the player. LocationBookmark Strike lightning at the location bookmark instead of the player. NPCID:# Strike lightning at the location of the specified NPC (using the npc id) NODAMAGE Lightning is cosmetic and does no damage. Example Usages - STRIKE - STRIKE BOOKMARK:BigTree - STRIKE DENIZEN NODAMAGE

	SWITCH	[BOOKMARK:BlockBookmark] or [BOOKMARK:DenizenName:BlockBookmark] (DURATION:#)
This command will activate a button, switch or pressure plate at the designated block bookmark. Modifiers: DURATION:# Will switch the device again after the specified number of seconds. Example Usages - SWITCH BOOKMARK:LightSwitch DURATION:30 - SWITCH BOOKMARK:Jimbo:JimbosButton

	WEATHER	[SUNNY or STORMY or PRECIPITATING]
Changes the Denizen's world's weather to the designated type. Example Usages - WEATHER SUNNY

Player Interaction

These commands default to affecting the interacting player. Most have modifiers to affect the executing Denizen instead.

	CAST	[SpellName] (DURATION:#) (POWER:#) (NPC:#) (PLAYER:PlayerName)
Gives the specified target a potion effect. Valid potion names are the same as the Alchemist's. Modifiers: DURATION:# The effect duration, in seconds. Default is 60. POWER:# The level of the effect, usually 1-5. Default is 1. NPC:# The NPC to cast the effect on, instead of the interacting player. Specify with the NPC id. PLAYER:PlayerName The Player to cast the effect on, instead of the interacting player. Example Usages - CAST SPELL:confusion DURATION:300 POWER:3 - CAST SPELL:speed

	FEED	(AMOUNT:#)
Feeds the interacting player. Provides food and saturation. Modifiers: AMOUNT: The amount to feed. Default is 20. Example Usages - FEED - FEED 5

	GIVE	[MONEY or XP or HEROESEXP or ID or ID:Data or MATERIAL or MATERIAL:Data] (QTY:#)
Gives something to the Player. If QTY: is not specified, its default value is 1. You can also give Minecraft XP by using 'XP'. Using HEROESEXP type will give the Player (or Hero) Questing Experience. Note: This requires HEROES to be installed on your server! Example Usages - GIVE MONEY QTY:10 - GIVE 17:2 QTY:3 - GIVE LEAVES:2 - GIVE HEROESEXP QTY:25

	HARM	(DENIZEN) (AMOUNT:#)
Hurts the the interacting player. Modifiers: DENIZEN Hurts the Denizen instead of the player. AMOUNT: The amount to hurt, if not specified defaults to 1 point. Example Usages - HARM AMOUNT:5 - HARM DENIZEN

	HEAL	(DENIZEN) (AMOUNT:#)
Heals the interacting player. Modifiers: DENIZEN Heals the Denizen instead of the player. AMOUNT: The amount to heal, will not heal beyond the maximum. Defaults to a full heal if not specified. Example Usages - HEAL - HEAL DENIZEN AMOUNT:1

	TAKE	[MONEY or ITEMINHAND or ID or ID:Data or MATERIAL or MATERIAL:Data] (QTY:#)
Takes something from the Player. If QTY: is not specified, its default value is 1. Example Usages - TAKE MONEY QTY:1000 - TAKE 17:2 QTY:1 - TAKE LOG:2 - TAKE ITEMINHAND

	TELEPORT	(DENIZEN) [BOOKMARK:LocationBookmark or 'BOOKMARK:Denizen Name:LocationBookmark']
Teleports the interacting to player or denizen to the specified bookmark. Modifiers: DENIZEN Teleport the Denizen instead of the player. Example Usages - TELEPORT BOOKMARK:FarAwayPlace - TELEPORT DENIZEN 'BOOKMARK:Jim:JimsBasement'