Enchant Actions

What Actions Are

Actions are the executable steps inside an enchant. They run in numeric order under actions:.

actions:
  1:
    type: "set-variable"
    variable-name: "bonus"
    value: "{level} * 10"
  2:
    type: "damage-area"
    position: "{target_pos}"
    radius: 2.5
    damage: "{bonus}"

Actions should be numbered sequentially (1, 2, 3...).
The parser reads by numeric key and executes in order.
Every action must include a valid type.

Supported Action Types

Current parser-supported actions:

spawn-entity
spawn-display
display-transform
remove-entity
entity-teleport
select-nearby-mob
delay
loop
add-currency
send-title
send-message
send-actionbar
set-variable
damage-area
instakill-area
particle-effect
particle-beam
sound-effect
conditional
chain-damage
potion-effect
hologram
set-fire
glow
grant-booster
grant-permanent-booster
remove-booster

Entity And Display Actions

`spawn-entity`

type: "spawn-entity"
entity-type: "SLIME"
reference: "my_slime"
position: "{target_pos}"

Required fields:

entity-type
reference
position

`remove-entity`

type: "remove-entity"
entity: "my_slime"

Required fields:

entity (reference name from spawn-entity/spawn-display)

`entity-teleport`

type: "entity-teleport"
entity: "my_slime"
to: "{player_x} + 2, {player_y}, {player_z}"
on-ground: false
look-at: "{player_pos}"

Required fields:

entity
to

Optional fields:

on-ground - true|false, default: true
look-at - position/expression string (same format as to), default: omitted

`spawn-display`

type: "spawn-display"
display-type: "block"
reference: "meteor_core"
position: "{trigger_pos}"
block-data: "minecraft:magma_block"
scale: "1.5, 1.5, 1.5"
translation: "-0.5, -0.5, -0.5"
interpolation-duration: 2

Required fields:

display-type (block or item)
reference
position (defaults to {trigger_pos} if omitted)
block-data when display-type: block
item (or item-material) when display-type: item

Optional fields:

item-display-mode - none|thirdperson_left|thirdperson_right|firstperson_left|firstperson_right|head|gui|ground|fixed, default: omitted
translation - vector string x,y,z, default: omitted
scale - vector string x,y,z, default: omitted
left-rotation - quaternion string x,y,z,w, default: omitted
right-rotation - quaternion string x,y,z,w, default: omitted
right-rotation-euler - Euler degrees string x,y,z (used when right-rotation omitted), default: omitted
billboard - fixed|vertical|horizontal|center, default: omitted
view-range - numeric expression, default: omitted
interpolation-delay - integer ticks, default: omitted
interpolation-duration - integer ticks, default: omitted
teleport-duration - integer ticks, default: omitted

`display-transform`

type: "display-transform"
entity: "meteor_core"
scale: "1.8, 1.8, 1.8"
right-rotation-euler: "0, {iteration} * 25, 0"
interpolation-duration: 2

Required fields:

entity

Optional fields:

translation - vector string x,y,z, default: omitted
scale - vector string x,y,z, default: omitted
left-rotation - quaternion string x,y,z,w, default: omitted
right-rotation - quaternion string x,y,z,w, default: omitted
right-rotation-euler - Euler degrees string x,y,z (used when right-rotation omitted), default: omitted
billboard - fixed|vertical|horizontal|center, default: omitted
view-range - numeric expression, default: omitted
interpolation-delay - integer ticks, default: omitted
interpolation-duration - integer ticks, default: omitted
teleport-duration - integer ticks, default: omitted
item-display-mode - none|thirdperson_left|thirdperson_right|firstperson_left|firstperson_right|head|gui|ground|fixed, default: omitted

`select-nearby-mob`

Selects a mob and stores it as target_mob in context.

type: "select-nearby-mob"
origin: "{player_pos}"
radius: 14
max-candidates: 64
exclude-current-target: true
min-distance: 1.6
random-target: true

Required fields:

origin (default: {trigger_pos})
radius (> 0)

Optional fields:

mob-id - configured mob id string (case-insensitive), default: omitted
max-candidates - integer > 0, default: 64
exclude-current-target - true|false, default: false
min-distance - number >= 0, default: 0.0
random-target - true|false (false = nearest, true = random valid mob), default: false

Damage Actions

`damage-area`

type: "damage-area"
position: "{target_pos}"
radius: 3.0
damage: "{damage} * 2"
show-indicator: false

Fields:

position (default {trigger_pos})
radius (required, > 0)
damage (required expression)
show-indicator (default false)

`instakill-area`

type: "instakill-area"
position: "{target_pos}"
radius: 4.0

Fields:

position (default {trigger_pos})
radius (required, > 0)

`chain-damage`

type: "chain-damage"
position: "{target_pos}"
initial-damage: "200"
chain-radius: 6.0
damage-multiplier: 0.6
max-chains: 4
show-indicator: false

Fields:

position (default {trigger_pos})
initial-damage (required expression)
chain-radius (required, > 0)
damage-multiplier (default 0.5)
max-chains (default 3)
show-indicator (default false)

`explosion`

type: "explosion"
position: "{target_pos}"
radius: 3.5
damage: 150
show-indicator: false

Fields:

position (default {trigger_pos})
radius (required, > 0)
damage (default 0.0)
show-indicator (default false)

`set-fire`

Area fire DoT action (not single-entity duration syntax).

type: "set-fire"
position: "{target_pos}"
radius: 2.0
fire-ticks: 100
damage-per-tick: "10 + {level}"
tick-interval: 10
show-indicator: false

Required fields:

radius (> 0)
fire-ticks (> 0)
damage-per-tick
tick-interval (> 0)

Optional fields:

position - position/expression string, default: {target_pos}
show-indicator - true|false, default: false

Visual And Audio Actions

`particle-effect`

type: "particle-effect"
position: "{target_pos}"
particle: "FLAME"
count: 12
color: "255,120,30"
size: 1.0

Fields:

position (default {trigger_pos})
particle (required)
count (default 1)
color (RGB r,g,b or hex #RRGGBB, default 255,0,0)
size (default 1.0)

`particle-beam`

type: "particle-beam"
from: "{player_pos}"
to: "{target_pos}"
particle: "END_ROD"
tta: 0.5
steps: 24
count: 2
spread: 0.12
spiral: false
spiral-radius: 0.35
spiral-turns: 3.0
color: "255,0,0"
size: 1.0

`hologram`

type: "hologram"
position: "{target_pos}"
text: "&c-{damage}"
style: "damage"
duration: 35
float-speed: 0.05
float-distance: 2.0

Fields:

position (default {trigger_pos})
text (required)
style (default phantom)
duration (default 25)
float-speed (default 0.05)
float-distance (default 2.0)

`glow`

type: "glow"
position: "{target_pos}"
radius: 3.0
color: "RED"
duration: 60
remove: false

Fields:

position (default {target_pos})
radius (required, > 0)
color (required unless remove: true; accepted: RED|BLUE|GREEN|GOLD|PURPLE|AQUA|WHITE|GRAY|DARK_RED|DARK_BLUE|DARK_GREEN|DARK_PURPLE)
duration (default 0)
remove (default false

`sound-effect`

type: "sound-effect"
position: "{player_pos}"
sound: "ENTITY_SLIME_JUMP"
volume: 1.0
pitch: 1.0

Fields:

position (default {trigger_pos})
sound (required)
volume (default 1.0)
pitch (default 1.0)

Messaging Actions

`send-message`

type: "send-message"
message: "&aProc! +{bonus}"
variables:
  bonus: "{level} * 10"

Optional fields:

variables - map of named placeholders to expression strings, default: omitted

`send-title`

type: "send-title"
title: "&c&lCRIT"
subtitle: "&7+{damage}"
fade-in: 10
stay: 70
fade-out: 20
variables:
  damage: "{damage}"

Optional fields:

subtitle - string, default: ""
fade-in - integer ticks, default: 10
stay - integer ticks, default: 70
fade-out - integer ticks, default: 20
variables - map of named placeholders to expression strings, default: omitted

`send-actionbar`

type: "send-actionbar"
message: "&aBounced to &f{target}"
variables:
  target: "{target_mob}"

Optional fields:

variables - map of named placeholders to expression strings, default: omitted

Economy And Booster Actions

`add-currency`

type: "add-currency"
currency: "money"
amount: "100 + {level} * 10"

Required fields:

currency
amount

`grant-booster`

type: "grant-booster"
booster-type: "money"
multiplier: "1.25"
duration: "60"
display-name: "&aMoney Boost"

Optional fields:

multiplier - numeric/expression string, default: "1.0"
duration - numeric/expression string (seconds), default: "60"
display-name - string, default: ""

`grant-permanent-booster`

type: "grant-permanent-booster"
booster-type: "damage"
multiplier: "1.1"
display-name: "&cPermanent Damage Boost"

Optional fields:

multiplier - numeric/expression string, default: "1.0"
display-name - string, default: ""

`remove-booster`

type: "remove-booster"
booster-type: "money"

Control Flow Actions

`set-variable`

type: "set-variable"
variable-name: "random_damage"
value: "%phantomdungeons_math_random_100_500%"

Required fields:

variable-name
value

`delay`

type: "delay"
ticks: 20

Optional fields:

ticks - integer ticks, default: 0

`loop`

type: "loop"
iterations: 5
tick-interval: 5
actions:
  1:
    type: "set-variable"
    variable-name: "x"
    value: "{iteration}"

Optional fields:

iterations - integer, default: 1
tick-interval - integer ticks, default: 20
actions - action map, default: empty

`conditional`

Use then and else keys (not then-actions/else-actions).

type: "conditional"
condition-type: "random-chance"
parameter: ""
threshold: 30.0
then:
  1:
    type: "send-message"
    message: "&aSuccess"
else:
  1:
    type: "send-message"
    message: "&cFail"

Condition types:

mob-health-below
random-chance
mob-in-radius
permission
variable-above
variable-below
variable-equals

Player Buff Action

`potion-effect`

type: "potion-effect"
effect: "SPEED"
amplifier: "{level} - 1"
duration: 200
ambient: false
particles: false
icon: true

Required fields:

effect

Optional fields:

amplifier (default 0)
duration (default 999999)
ambient (true|false, default false)
particles (true|false, default false)
icon (true|false, default true)

Notes

This file is parser-accurate for current implementation.
If parser behavior changes, update this reference from ActionParser first.

PreviousCreating Enchants NextEnchant Examples

hashtagWhat Actions Are

hashtagSupported Action Types

hashtagEntity And Display Actions

hashtagspawn-entity

hashtagremove-entity

hashtagentity-teleport

hashtagspawn-display

hashtagdisplay-transform

hashtagselect-nearby-mob

hashtagDamage Actions

hashtagdamage-area

hashtaginstakill-area

hashtagchain-damage

hashtagexplosion

hashtagset-fire

hashtagVisual And Audio Actions

hashtagparticle-effect

hashtagparticle-beam

hashtaghologram

hashtagglow

hashtagsound-effect

hashtagMessaging Actions

hashtagsend-message

hashtagsend-title

hashtagsend-actionbar

hashtagEconomy And Booster Actions

hashtagadd-currency

hashtaggrant-booster

hashtaggrant-permanent-booster

hashtagremove-booster

hashtagControl Flow Actions

hashtagset-variable

hashtagdelay

hashtagloop

hashtagconditional

hashtagPlayer Buff Action

hashtagpotion-effect

hashtagNotes

What Actions Are

Supported Action Types

Entity And Display Actions

`spawn-entity`

`remove-entity`

`entity-teleport`

`spawn-display`

`display-transform`

`select-nearby-mob`

Damage Actions

`damage-area`

`instakill-area`

`chain-damage`

`explosion`

`set-fire`

Visual And Audio Actions

`particle-effect`

`particle-beam`

`hologram`

`glow`

`sound-effect`

Messaging Actions

`send-message`

`send-title`

`send-actionbar`

Economy And Booster Actions

`add-currency`

`grant-booster`

`grant-permanent-booster`

`remove-booster`

Control Flow Actions

`set-variable`

`delay`

`loop`

`conditional`

Player Buff Action

`potion-effect`

Notes