Skip to content

Animation Control

Start or stop an animation on the current scene.

Syntax

Start an animation on the current scene.

animation start %animation_name% (--loop) (--unique) (--block)

Stops the specified animation.

animation stop %animation_name%

Parameters

  • animation_name (string, required) The name of the animation to play.
  • --loop (argument, optional) Loop the animation.
  • --unique (argument, optional) Kill entities when the animation end.
  • --block (argument, optional) Story will wait for the animation to complete before continuing.

INFO

This is a blocking command if block is true. It will pause the story until the animation ends.

Examples

  • animation start wave --unique
  • animation stop wave