User Tools

Site Tools


spelleffects

Spell Effects

Most spells can have spell effects, which are played when the spell is cast and sometimes at other times, depending on the spell. To define a spell effect, you must at least specify a position and an effect name. Some of the positions have additional options that can be specified, and many of the effects also have additional options. You specify the effects under the 'effects' option in each spell configuration.

Example

Use this as an example to format your sound effects. The names '1' and '2' can actually be anything you want, you can use 'bob' and 'jim' if you would like, or use a descriptive name, it doesn't matter.

    effects:
      1:
        position: caster
        effect: hearts
      2:
        position: target
        effect: particles
        particle-name: explode
        horiz-spread: 0.2
        vert-spread: 0.2
        speed: 0.2
        count: 5

Positions

The position is the location where the effect should be positioned. These are valid positions:

Position Description
caster/actor The position of the caster.
target The position of the target of the spell.
position1/pos1 The “first” position (such as the starting position in a teleport spell).
position2/pos2 The “second” position (such as the ending location in a teleport spell).
line/trail The position of the line between the caster and the target (and sometimes used in other situations). Use the distance-between option to define the spacing on the effects.
startcast The position of the caster when the spell starts to cast, for spells with a cast time.
disabled The position of the caster when the spell is disabled (such as when a buff spell runs out).
delayed The position, usually of a target, for a delayed effect of certain spells.
special A special position, generally documented with any spell that uses it.
buff A special position used with buff spells, which continually plays the effect while the buff is active. Use the effect-interval option to define how often the effect plays.
orbit A special position used with buff spells, which causes the effect to orbit the player while the buff is active. Has many options: orbit-radius, orbit-seconds-per-revolution, orbit-counter-clockwise, orbit-tick-interval, orbit-y-offset.

Position Options

Option Description Default
All Positions
delay How long to wait before the effect plays, in ticks. 0
height-offset A vertical offset for the effect position, in blocks. 0
forward-offset A horizontal offset for the effect position, in blocks. A positive number places the effect in front of the caster, negative behind. 0
Line/Trail
distance-between How far apart each effect in the line is. 1
Buff
effect-interval How often the effect is played, in ticks. 20
Orbit
orbit-radius How far away from the caster the effect is positioned. 1
orbit-seconds-per-revolution How long a single revolution takes, in seconds. 3
orbit-counter-clockwise Setting this to true makes the orbit go counter-clockwise instead false
orbit-tick-interval How often an effect plays, in ticks. 2
orbit-y-offset A vertical offset value for the position of the orbit effect. 0

Effects (and effect-specific options)

Effect Name Description Options
angry The villager angry effect. none
blockbreak The effect when a block breaks, including the sound. 'id': the block id of the breaking block
bluesparkle The witch effect. none
broadcast [v3.1] Broadcasts a chat message. 'message': the message to broadcast; 'range': the radius (leave at 0 to broadcast to all)
dragondeath The enderdragon's death animation. none
ender The ground effect from using an eye of ender. none
explosion The explosion graphical effect and sound. No damage will be done. none
fireworks Fireworks. See below.
greensparkle The villager green sparkle effect. none
hearts Causes the “tame” hearts to appear. none
itemspray Causes fake items to 'explode' from the position. See below.
lightning The lightning graphical effect and sound. No damage will be done. none
nova An expanding ring effect, like the firenova spell. See below.
particles Creates a particle effect. See below.
potion The swirly particle effect that appears on a player when affected by a potion. 'color': the color as a hex color; 'duration': the duration in server ticks
smoke A small wisp of smoke. 'dir': the direction the smoke floats (see here - scroll down a bit)
spawn The smoke and fire effect from when a monster spawns at a monster spawner. none
sound Plays a sound effect by name to every player nearby. See below.
soundpersonal Plays a sound effect by name just to the player at the position. Same as sound, see below.
splash The splash potion break effect. 'pot': splash potion type

Fireworks

Option Description Default
flicker Whether to use the flicker effect. false
trail Whether to use the trail effect. false
type The type of effect, as a number from 0-4. 0: small, 1: large, 2: star, 3: creeper, 4: burst 0
flight The duration of the flight. Generally from 0-3, with 0 being instant. 0
colors A list of colors to use initially, as a comma-separated list of hex values. Example: colors: FF0000,00FF00 FF0000
fade-colors A list of colors to fade to, as a comma-separated list of hex values. Example: fade-colors: FFFF00,00FFFF 0000FF

ItemSpray

Option Description Default
type The item type. 331
data The item data/durability value. 0
quantity The number of items to spray. 15
duration How long the items should last, in server ticks. 10
force How hard the items are thrown. 1.0

Nova

Please note that this effect can have a noticeable performance effect on your server.

Option Description Default
type The block type. 51
data The block data. 0
radius The radius of the effect. 3
expand-interval The interval the effect expands, in server ticks. 5

Particles

Option Description Default
particle-name The name of the particle effect (see below). explode
horiz-spread The horizontal spread of the particles, roughly in blocks. 0.2
vert-spread The vertical spread of the particles, roughly in blocks. 0.2
speed The speed of the particles. Also sometimes affects other attributes of the particles, such as color. 0.2
count The number of particles. 5
y-offset A vertical offset value. 0
render-distance How far away the effect can be seen. Is also limited by the client. 32

Particle Names

  • angryVillager (particles after attacking villager)
  • blockcrack_TYPEID_DATA [1.7] (block breaking, fill in the TYPEID and DATA)
  • blockdust_TYPEID_DATA [1.7] (fall effect, fill in the TYPEID and DATA)
  • bubble (water bubble, only works under water)
  • cloud (puff of smoke)
  • crit (critical hit)
  • depthsuspend (small gray particles)
  • dripLava (drip from blocks beneath lava)
  • dripWater (drip from blocks beneath water)
  • enchantmenttable (symbols from bookcases)
  • explode
  • flame
  • fireworksSpark
  • footstep (small gray squares from sprinting)
  • happyVillager (green sparkles)
  • heart
  • hugeexplosion
  • iconcrack_TYPEID (item icon breaking, fill in the TYPEID)
  • instantSpell (white particles)
  • largeexplode
  • largesmoke (doesn't work?)
  • lava (lava pop particles)
  • magicCrit (blue critical hit)
  • mobSpell (potion effect, random colors)
  • mobSpellAmbient (potion effect but more transparent, random colors)
  • note (note block note, random colors)
  • portal (purple nether portal particles)
  • reddust (smokey dust particles of (ironically) many random colors)
  • slime (green slime jump particles)
  • smoke
  • snowballpoof
  • snowshovel (white particles)
  • spell (white particles)
  • splash
  • suspended (doesn't work?)
  • tilecrack_TYPEID_DATA [renamed to blockcrack in 1.7] (block breaking, fill in the TYPEID and DATA)
  • townaura (small gray particles)
  • witchMagic (purple sparks)

Sound

Volume and pitch info

Option Description Default
sound The sound name (see below). random.pop
volume The volume of the sound. 1.0
pitch The pitch of the sound. 1.0

Sound Names

  • ambient.cave.cave
  • ambient.weather.rain
  • ambient.weather.thunder
  • damage.fallbig
  • damage.fallsmall
  • damage.hit
  • dig.cloth
  • dig.grass
  • dig.gravel
  • dig.sand
  • dig.snow
  • dig.stone
  • dig.wood
  • fire.fire
  • fire.ignite
  • fireworks.blast
  • fireworks.blast_far
  • fireworks.largeBlast
  • fireworks.largeBlast_far
  • fireworks.launch
  • fireworks.twinkle
  • fireworks.twinkle_far
  • liquid.lava
  • liquid.lavapop
  • liquid.splash
  • liquid.swim
  • liquid.water
  • minecart.base
  • minecart.inside
  • mob.bat.death
  • mob.bat.hurt
  • mob.bat.idle
  • mob.bat.loop
  • mob.bat.takeoff
  • mob.blaze.breathe
  • mob.blaze.death
  • mob.blaze.hit
  • mob.cat.hiss
  • mob.cat.hitt
  • mob.cat.meow
  • mob.cat.purr
  • mob.cat.purreow
  • mob.chicken.hurt
  • mob.chicken.plop
  • mob.chicken.say
  • mob.chicken.step
  • mob.cow.hurt
  • mob.cow.say
  • mob.cow.step
  • mob.creeper.death
  • mob.creeper.say
  • mob.enderdragon.end
  • mob.enderdragon.growl
  • mob.enderdragon.hit
  • mob.enderdragon.wings
  • mob.endermen.death
  • mob.endermen.hit
  • mob.endermen.idle
  • mob.endermen.portal
  • mob.endermen.scream
  • mob.endermen.stare
  • mob.ghast.affectionate_scream
  • mob.ghast.charge
  • mob.ghast.death
  • mob.ghast.fireball
  • mob.ghast.moan
  • mob.ghast.scream
  • mob.horse.angry
  • mob.horse.armor
  • mob.horse.breathe
  • mob.horse.death
  • mob.horse.donkey.angry
  • mob.horse.donkey.death
  • mob.horse.donkey.hit
  • mob.horse.donkey.idle
  • mob.horse.gallop
  • mob.horse.hit
  • mob.horse.idle
  • mob.horse.jump
  • mob.horse.land
  • mob.horse.leather
  • mob.horse.skeleton.death
  • mob.horse.skeleton.hit
  • mob.horse.skeleton.idle
  • mob.horse.soft
  • mob.horse.wood
  • mob.horse.zombie.death
  • mob.horse.zombie.hit
  • mob.horse.zombie.idle
  • mob.irongolem.death
  • mob.irongolem.hit
  • mob.irongolem.throw
  • mob.irongolem.walk
  • mob.magmacube.big
  • mob.magmacube.jump
  • mob.magmacube.small
  • mob.pig.death
  • mob.pig.say
  • mob.pig.step
  • mob.sheep.say
  • mob.sheep.shear
  • mob.sheep.step
  • mob.silverfish.hit
  • mob.silverfish.kill
  • mob.silverfish.say
  • mob.silverfish.step
  • mob.skeleton.death
  • mob.skeleton.hurt
  • mob.skeleton.say
  • mob.skeleton.step
  • mob.slime.attack
  • mob.slime.big
  • mob.slime.small
  • mob.spider.death
  • mob.spider.say
  • mob.spider.step
  • mob.villager.death
  • mob.villager.haggle
  • mob.villager.hit
  • mob.villager.idle
  • mob.villager.no
  • mob.villager.yes
  • mob.wither.death
  • mob.wither.hurt
  • mob.wither.idle
  • mob.wither.shoot
  • mob.wither.spawn
  • mob.wolf.bark
  • mob.wolf.death
  • mob.wolf.growl
  • mob.wolf.howl
  • mob.wolf.hurt
  • mob.wolf.panting
  • mob.wolf.shake
  • mob.wolf.step
  • mob.wolf.whine
  • mob.zombie.death
  • mob.zombie.hurt
  • mob.zombie.infect
  • mob.zombie.metal
  • mob.zombie.remedy
  • mob.zombie.say
  • mob.zombie.step
  • mob.zombie.unfect
  • mob.zombie.wood
  • mob.zombie.woodbreak
  • mob.zombiepig.zpig
  • mob.zombiepig.zpigangry
  • mob.zombiepig.zpigdeath
  • mob.zombiepig.zpighurt
  • note.bass
  • note.bassattack
  • note.bd
  • note.harp
  • note.hat
  • note.pling
  • note.snare
  • portal.portal
  • portal.travel
  • portal.trigger
  • random.anvil_break
  • random.anvil_land
  • random.anvil_use
  • random.bow
  • random.bowhit
  • random.break
  • random.breath
  • random.burp
  • random.chestclosed
  • random.chestopen
  • random.classic_hurt
  • random.click
  • random.door_close
  • random.door_open
  • random.drink
  • random.eat
  • random.explode
  • random.fizz
  • random.fuse
  • random.glass
  • random.levelup
  • random.orb
  • random.pop
  • random.splash
  • random.successful_hit
  • random.wood_click
  • step.cloth
  • step.grass
  • step.gravel
  • step.ladder
  • step.sand
  • step.snow
  • step.stone
  • step.wood
  • tile.piston.in
  • tile.piston.out

(Prior to v3.0)

Many spells can define spell effects that are played when the spell is cast. The list looks something like this:

effects:
  - pos1 smoke
  - pos2 smoke

An effect must follow this format:

<position> <effectname> [parameters]

Resource Usage

Some of the graphical effects can be quite resource intensive, especially on your internet connection. As an example, the nova effect requires your server to send a block update twice for every block in the effect: once to turn it on, and once to turn it off. If the radius of that effect is 2, that's a 5×5 effect size, meaning 25 blocks and 50 block updates. If 20 players see that effect, it means the server must send 1000 block updates within a few seconds.

See the “Resource Usage” column for the relative resource usage of each effect.

Positions

The position is the location where the effect should be positioned. These are valid positions:

Position Description
caster/actor The position of the caster.
target The position of the target of the spell.
position1/pos1 The “first” position (such as the starting position in a teleport spell).
position2/pos2 The “second” position (such as the ending location in a teleport spell).
line/trail The position of the line between the caster and the target.
startcast The position of the caster when the spell starts to cast, for spells with a cast time.
disabled The position of the caster when the spell is disabled (such as when a buff spell runs out).
delayed The position, usually of a target, for a delayed effect of certain spells.
special A special position, generally documented with any spell that uses it.

As you might guess, not all of the positions are valid for every spell.

Effects

This is a list of all of the effects that can currently be used.

Effect Name Description Parameters Resource Usage
angry The villager angry effect. none low
bigsmoke A big smoke effect. none high
blockbreak The effect when a block breaks, including the sound. The block id of the breaking block. low
bluesparkle [v2.11] The witch effect. none low
cloud A cloud of smoke. The cloud radius. high
ender The ground effect from using an eye of ender. none low
explosion The explosion graphical effect and sound. No damage will be done. none low
fireworks [v2.12, 1.4.6] Fireworks. There are 5 options: flicker (yes/no), trail (yes/no), type (a number from 0-4: 0-small, 1-large, 2-star, 3-creeper, 4-burst), a list of (hex) colors, a list of fade (hex) colors. Example: “target fireworks yes yes 4 FF0000,00FF00,0000FF FFFF00,FF00FF,00FFFF” low
greensparkle [v2.11] The villager green sparkle effect. none low
hearts Causes the “tame” hearts to appear. Note that this works by temporarily spawning a cat, which is often noticeable. none low
itemspray Causes fake items to 'explode' from the position. The item type, number of items, duration (in ticks) and velocity of the items. Example: “target itemspray 331 15 6 1.0”. medium
lightning The lightning graphical effect and sound. No damage will be done. none low
nova An expanding ring effect, like the firenova spell. The block type and data, effect radius, and animation tick interval. Example: “target nova 8 2 2 3” will create a fast and small water nova effect. high
particles [v2.14] Creates a particle effect. The particle name, horizontal spread, vertical spread, speed, number of particles, and y-offset. See below for a list of particle names. Example: “target particles reddust 0.4 0.2 0.3 15 1.5” low
particleline [v2.16] Creates a particle effect in a line. The particle spacing, particle name, horizontal spread, vertical spread, speed, number of particles, and y-offset. See below for a list of particle names. Example: “target particles 0.5 reddust 0.4 0.2 0.3 15 1.5” low
potion The swirly particle effect that appears on a player when affected by a potion. The hex color and duration of the effect. Example: “caster potion 00FF00 30” will put a green potion effect on the caster for 30 server ticks. low
smoke A small wisp of smoke. The direction the smoke floats. See here (scroll down a bit). low
smokeswirl An animated swirling smoke. The duration of the effect, in ticks. medium
smoketrail A trail of smoke between two points. Animation speed, represented as number of ticks between each smoke effect. medium
spawn The smoke and fire effect from when a monster spawns at a monster spawner. none low
sound Plays a sound effect by name to every player nearby. The sound name, volume, and pitch. See below for a list of sound names. The volume is a decimal value, with 1.0 being 100%. A volume higher than 1.0 will increase the range from which the sound can be heard. The pitch is a decimal value between 0.0 and 2.0, with 1.0 being 'normal'. Example: “caster sound random.pop 1.0 1.0” (more volume and pitch info) low
soundpersonal Plays a sound effect by name just to the player at the position. Same as sound. low
splash The splash potion break effect. Splash potion type. low
wolfsmoke [v2.11] The wolf smoke effect when taming fails. none low

Sound Names

  • ambient.cave.cave
  • ambient.weather.rain
  • ambient.weather.thunder
  • damage.fallbig
  • damage.fallsmall
  • damage.hit
  • dig.cloth
  • dig.grass
  • dig.gravel
  • dig.sand
  • dig.snow
  • dig.stone
  • dig.wood
  • fire.fire
  • fire.ignite
  • liquid.lava
  • liquid.lavapop
  • liquid.splash
  • liquid.swim
  • liquid.water
  • minecart.base
  • minecart.inside
  • mob.bat.death
  • mob.bat.hurt
  • mob.bat.idle
  • mob.bat.loop
  • mob.bat.takeoff
  • mob.blaze.breathe
  • mob.blaze.death
  • mob.blaze.hit
  • mob.cat.hiss
  • mob.cat.hitt
  • mob.cat.meow
  • mob.cat.purr
  • mob.cat.purreow
  • mob.chicken.hurt
  • mob.chicken.plop
  • mob.chicken.say
  • mob.chicken.step
  • mob.cow.hurt
  • mob.cow.say
  • mob.cow.step
  • mob.creeper.death
  • mob.creeper.say
  • mob.enderdragon.end
  • mob.enderdragon.growl
  • mob.enderdragon.hit
  • mob.enderdragon.wings
  • mob.endermen.death
  • mob.endermen.hit
  • mob.endermen.idle
  • mob.endermen.portal
  • mob.endermen.scream
  • mob.endermen.stare
  • mob.ghast.affectionate_scream
  • mob.ghast.charge
  • mob.ghast.death
  • mob.ghast.fireball
  • mob.ghast.moan
  • mob.ghast.scream
  • mob.irongolem.death
  • mob.irongolem.hit
  • mob.irongolem.throw
  • mob.irongolem.walk
  • mob.magmacube.big
  • mob.magmacube.jump
  • mob.magmacube.small
  • mob.pig.death
  • mob.pig.say
  • mob.pig.step
  • mob.sheep.say
  • mob.sheep.shear
  • mob.sheep.step
  • mob.silverfish.hit
  • mob.silverfish.kill
  • mob.silverfish.say
  • mob.silverfish.step
  • mob.skeleton.death
  • mob.skeleton.hurt
  • mob.skeleton.say
  • mob.skeleton.step
  • mob.slime.attack
  • mob.slime.big
  • mob.slime.small
  • mob.spider.death
  • mob.spider.say
  • mob.spider.step
  • mob.wither.death
  • mob.wither.hurt
  • mob.wither.idle
  • mob.wither.shoot
  • mob.wither.spawn
  • mob.wolf.bark
  • mob.wolf.death
  • mob.wolf.growl
  • mob.wolf.howl
  • mob.wolf.hurt
  • mob.wolf.panting
  • mob.wolf.shake
  • mob.wolf.step
  • mob.wolf.whine
  • mob.zombie.death
  • mob.zombie.hurt
  • mob.zombie.infect
  • mob.zombie.metal
  • mob.zombie.remedy
  • mob.zombie.say
  • mob.zombie.step
  • mob.zombie.unfect
  • mob.zombie.wood
  • mob.zombie.woodbreak
  • mob.zombiepig.zpig
  • mob.zombiepig.zpigangry
  • mob.zombiepig.zpigdeath
  • mob.zombiepig.zpighurt
  • note.bass
  • note.bassattack
  • note.bd
  • note.harp
  • note.hat
  • note.pling
  • note.snare
  • portal.portal
  • portal.travel
  • portal.trigger
  • random.anvil_break
  • random.anvil_land
  • random.anvil_use
  • random.bow
  • random.bowhit
  • random.break
  • random.breath
  • random.burp
  • random.chestclosed
  • random.chestopen
  • random.classic_hurt
  • random.click
  • random.door_close
  • random.door_open
  • random.drink
  • random.eat
  • random.explode
  • random.fizz
  • random.fuse
  • random.glass
  • random.levelup
  • random.orb
  • random.pop
  • random.splash
  • random.wood_click
  • step.cloth
  • step.grass
  • step.gravel
  • step.ladder
  • step.sand
  • step.snow
  • step.stone
  • step.wood
  • tile.piston.in
  • tile.piston.out

Particle Names

  • angryVillager (particles after attacking villager)
  • bubble (water bubble, only works under water)
  • cloud (puff of smoke)
  • crit (critical hit)
  • depthsuspend (small gray particles)
  • dripLava (drip from blocks beneath lava)
  • dripWater (drip from blocks beneath water)
  • enchantmenttable (symbols from bookcases)
  • explode
  • flame
  • fireworksSpark
  • footstep (small gray squares from sprinting)
  • happyVillager (green sparkles)
  • heart
  • hugeexplosion
  • iconcrack_TYPEID (item icon breaking, fill in the TYPEID)
  • instantSpell (white particles)
  • largeexplode
  • largesmoke (doesn't work?)
  • lava (lava pop particles)
  • magicCrit (blue critical hit)
  • mobSpell (potion effect, random colors)
  • mobSpellAmbient (potion effect but more transparent, random colors)
  • note (note block note, random colors)
  • portal (purple nether portal particles)
  • reddust (smokey dust particles of (ironically) many random colors)
  • slime (green slime jump particles)
  • smoke
  • snowballpoof
  • snowshovel (white particles)
  • spell (white particles)
  • splash
  • suspended (doesn't work?)
  • tilecrack_TYPEID_DATA (block breaking, fill in the TYPEID and DATA)
  • townaura (small gray particles)
  • witchMagic (purple sparks)
spelleffects.txt · Last modified: 2014/04/26 02:00 by nisovin