NPC Actions | Denizen Meta Documentation

Denizen Script NPC Actions

NPC Actions go in 'assignment' scripts, and work like 'events' but linked to the assigned NPC.
Learn about how NPC Actions work in The Beginner's Guide.

Showing all 39 NPC Actions...

Action Lines	assignment
Triggers	when the assignment script is added to an NPC.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/AssignmentTrait.java#L72

Action Lines	attack attack on <entity>
Triggers	when the NPC is about to attack an enemy.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L133

Action Lines	begin navigation
Triggers	when the NPC has received a 'walk' command, or is about to follow a path.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L100

Action Lines	cancel navigation cancel navigation due to <reason>
Triggers	when a plugin or script cancels an NPC's navigation.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L153

Action Lines	cast fishing rod
Triggers	when the NPC casts a fishing rod. See also Command:fish.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/FishingTrait.java#L172

Action Lines	catch fish
Triggers	when the NPC catches a fish. See also Command:fish.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/FishingTrait.java#L236

Action Lines	chat
Triggers	when a player chats to the NPC.
Contexts	`<context.message>` returns the triggering message `<context.keyword>` returns the keyword matched by a RegEx trigger
Determine	"CANCELLED" to stop the player from chatting. ElementTag to change the message.
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/ChatTrigger.java#L110

Action Lines	click
Triggers	when the NPC is clicked by a player.
Contexts	None
Determine	"cancelled" to cancel the click event completely.
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/ClickTrigger.java#L68

Action Lines	complete navigation
Triggers	when the NPC has finished a 'walk' command, or has reached a path point.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L77

Action Lines	damage
Triggers	when the NPC is damaged by a player and the Damage trigger fires. Action does not run if you do not enable the Damage trigger.
Contexts	`<context.damage>` returns how much damage was done.
Determine	"cancelled" to cancel the damage event.
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/DamageTrigger.java#L56

Action Lines	damaged
Triggers	when the NPC is damaged by an entity.
Contexts	`<context.damage>` returns how much damage was done. `<context.damager>` returns the entity that did the damage.
Determine	"cancelled" to cancel the damage event.
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/DamageTrigger.java#L70

Action Lines	death death by entity death by <entity> death by block death by <cause>
Triggers	when the NPC dies.
Contexts	`<context.killer>` returns the entity that killed the NPC (if any) `<context.shooter>` returns the shooter of the killing projectile (if any) `<context.damage>` returns the last amount of damage applied (if any) `<context.death_cause>` returns the last damage cause (if any)
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L206

Action Lines	despawn
Triggers	when the NPC is despawned. This can be because a command was issued, or a chunk has been unloaded.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/DenizenNPCHelper.java#L114

Action Lines	dig
Triggers	when the NPC breaks a block with the Break Command
Contexts	`<context.location>` returns the location the NPC Dug `<context.material>` Returns the Block dug
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/commands/npc/BreakCommand.java#L106

Action Lines	enter proximity
Triggers	when a player enters the NPC's proximity trigger's radius.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/ProximityTrigger.java#L43

Action Lines	exhausted
Triggers	when the NPC is exhausted (Requires the Hunger trait)
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/HungerTrait.java#L54

Action Lines	exit proximity
Triggers	when a player exits the NPC's proximity trigger's radius.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/ProximityTrigger.java#L53

Action Lines	hit hit on <entity>
Triggers	when the NPC hits an enemy.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L262

Action Lines	kill kill of <entity>
Triggers	when the NPC kills an enemy.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L273

Action Lines	mob enter proximity <entity> enter proximity
Triggers	when a mob enters the proximity of the NPC (Requires MobProx trait).
Contexts	`<context.entity>` returns the mob that entered the proximity
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/MobproxTrait.java#L68

Action Lines	mob exit proximity <entity> exit proximity
Triggers	when a mob exits the proximity of the NPC (Requires MobProx trait).
Contexts	`<context.entity>` returns the mob that exited the proximity
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/MobproxTrait.java#L79

Action Lines	mob move proximity <entity> move proximity
Triggers	when a mob moves in the proximity of the NPC (Requires MobProx trait). (Fires at a rate of specified by the 'mobprox_timer' flag, default of 2 seconds)
Contexts	`<context.entity>` returns the mob that entered the proximity
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/MobproxTrait.java#L90

Action Lines	move proximity
Triggers	when a player moves inside the NPC's proximity trigger's radius.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/ProximityTrigger.java#L63

Action Lines	no click trigger
Triggers	when the NPC is clicked but no click trigger fires.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/ClickTrigger.java#L57

Action Lines	no damage trigger
Triggers	when the NPC is damaged by a player but no damage trigger fires.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/DamageTrigger.java#L44

Action Lines	proximity
Triggers	when a player moves inside the NPC's proximity trigger's radius.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/scripts/triggers/core/ProximityTrigger.java#L74

Action Lines	push
Triggers	when the NPC is pushed by a player
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/PushableTrait.java#L136

Action Lines	push return
Triggers	when the NPC returns to its center after being pushed by a player.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/PushableTrait.java#L181

Action Lines	reel in fishing rod
Triggers	when the NPC reels in its fishing rod. See also Command:fish.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/FishingTrait.java#L225

Action Lines	remove
Triggers	when the NPC is removed.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/DenizenNPCHelper.java#L140

Action Lines	remove assignment
Triggers	when the assignment script is removed from an NPC.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/AssignmentTrait.java#L94

Action Lines	sit
Triggers	when the NPC sits down.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/SittingTrait.java#L99

Action Lines	sneak
Triggers	when the NPC starts sneaking.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/SneakingTrait.java#L22

Action Lines	spawn
Triggers	when the NPC is spawned. This will fire whenever an NPC's chunk is loaded, or a spawn command is issued.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/DenizenNPCHelper.java#L89

Action Lines	stand
Triggers	when the NPC stands up.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/SittingTrait.java#L175

Action Lines	start fishing
Triggers	when the NPC starts fishing. See also Command:fish.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/FishingTrait.java#L86

Action Lines	stop fishing
Triggers	when the NPC stops fishing. See also Command:fish.
Contexts	None
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/FishingTrait.java#L111

Action Lines	stuck
Triggers	when the NPC's navigator is stuck.
Contexts	`<context.action>` returns 'teleport' or 'none'
Determine	"NONE" to do nothing. "TELEPORT" to teleport.
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/tags/core/NPCTagBase.java#L174

Action Lines	unavailable
Triggers	when a trigger fires but the NPC is engaged.
Contexts	`<context.trigger_type>` return the type of trigger fired
Source	https://github.com/DenizenScript/Denizen/blob/dev/plugin/src/main/java/com/denizenscript/denizen/npc/traits/TriggerTrait.java#L186