Skip to content

Animations with Regions

Ella edited this page Sep 2, 2023 · 2 revisions

Explanation

Region animations are a useful way for you, the map maker to implement unique animations into the game, without messing with code.

Region tools

  • animation_<name>_play

    This is the basis to all animations. This is the region where your animation will be played at, and the basis for all sizing.

  • animation_<name>_f<number>

    f in this case stands for frame. The number of existing regions with a f will be the number of frames your animation has. Do make sure to have number higher than the last frame, so that your animation can be properly iterated through.

  • animation_<name>_settings

    The settings is what holds your whole animation together. Your animation block will be a lectern holding a signed book. The title of your signed book will be the name of your animation. And the text inside of your book's page(s) will be the options.

    • Possible options

      • startTime <option1> <option2> (Integer)

      Start time will hold how many seconds and or minutes will your animation start playing. You can use m:<minutes> and or s:<seconds> to set your needed start time. Not both options are needed.

      By default this is set to 0 seconds from the starting time

      • loop <option1> (Boolean)

      Loop is what defines the repeatability of you your animation. If you don't set loop to be true, your animation will play till its end frame than stop. Else the opposite will be true.

      By default looping is set to false.

      • framerate <option1> (Double)

      Frame rate is what defines the time in between your frames.

      By default the frame rate is set to 1.0 seconds.

Notes

  • Frames

    Note that your frame's region size need to be exactly the same size as the your play region. This means both the X, Y, Z value have to all be the same value as the play's else they will be skipped inside of the animation's possible frames.

    Rotations will not be applied. This means if your animation is South to North and your play region is East to West it currently won't be able to be translated so it will be just skipped.

Clone this wiki locally