Frames

Animation is built from frames. Frames determine when to spawn reward, when to play a model animation, when it should stop the animation and so on.

Each frame ends with ";<number>" which determines the delay in ticks (1 second = 20 ticks).

So for example when you use "finishAnimation;100", it means that it will stop the animation after 100 ticks a.k.a. 5 seconds.

It's required to follow this format!

Types of frames

modelAnimation

• Plays an animation of the crate model

Usage:

frames:
  - modelAnimation:open;0

Arguments:

• animation name

  • a name of the animation from ModelEngine that should be played

finishAnimation

• Stops the animation

No actions after this one are played!

Usage:

frames:
  - finishAnimation;300

This frame type has no arguments

showReward

• spawns a reward item at a defined location

Usage:

frames:
  - showReward:Spawn|-267.5|90|3.5;55

Arguments:

• world

• x

• y

• z

showRumblingReward

• spawns a reward item at a defined location that also starts immediately rumbling

Usage:

frames:
  - showRumblingReward:Spawn|-267.5|90|3.5|60|4;55

Arguments:

• world

• x

• y

• z

• rumbling duration

  • for how long show it rumble the item

• delay between rumbling

  • what delay should be between each rumble

startRumbling

• Starts rumbling a spawned reward

Usage:

frames:
  - startRumbling:4;55

Arguments:

• delay between rumbling

  • what delay should be between each rumble

stopRumbling

• stops the rumbling reward and shows the final reward

Usage:

frames:
  - stopRumbling;105

This frame type has no arguments

hideReward

• despawns the spawned reward item

Usage:

frames
  - hideReward;155

This frame type has no arguments

playSound

• plays a sound...

Usage:

frames:
  - playSound:minecraft:ui.toast.challenge_complete|1|1;115

Arguments:

• Sound identifier

  • If you are using the default sounds, it must contain the "minecraft:" identifier!

  • This is required because of the Resource-Pack sounds

• Volume

• Pitch

sendCommand

• send a console command (Placeholder %player% can be used)

Usage:

frames:
  - sendCommand:broadcast This is a test command!;115

Arguments:

• Command

  • a command that should be sent

spawnParticle

• spawns a particle at a location

Usage:

frames:
  - spawnParticle:Spawn|-165.5|93|-122.5|EXPLOSION_LARGE|0|0|0|0|0|0|1;65

Arguments:

• world

• x

• y

• z

• Particle

• Red

• Green

• Blue

• OffsetX

• OffsetY

• OffsetZ

• Amount