The Editor

Animations

Reminder: Hover your mouse over almost any input, field, selectionbox or button in the Editor to receive tooltips and examples.

Table of contents

    The Animation Creator

    Make a note of the number of frames your animation frame sheet has horizontally and vertically before you start.

    Animations require an animation frame sheet in your 
     '...mods/[YourMod]/gfx/animations' folder. Basically a .png file with every single frame of your animation. There is no size limitation for the sheet itself, but make sure each frame is the same size.

    Create your Animation in the Editor and give it a unique ID, then hit 'Browse' to find your sheet. Then, its time to configure a bunch of things.

    Number of Columns and Rows (x/y)
    This is also explained in an image further down, but basically you need to count the number of frames horizontally and vertically, then put those numbers in the Editor.

    Frame duration (decimal)
    The amount of time that each single frame is displayed. A smaller number makes the animation faster. Test this with the Preview-Button, to find out what looks good. The total length is displayed below.

    Loops infinitely
    Once the animation starts, it never stops by itself. Can then only be stopped through Events. Infinitely looping animations are good for e.g. campfires, light sources, ambient effects etc.

    Number of Loops
    If the checkbox for 'Loops Infinitely' is not checked, you need to specify the total number of loops. 1 Loop is just one single play.

    Light-Emission (Non-UI)
    The animation can emit light to its surroundings. Good for animated light sources or anything that glows. Negative numbers are bright light, while positive numbers are dim light.

    Affected by Brightness
    If checked, the animation will be as bright as its surroundings. This is usually a good idea and looks better.

    Sound
    You can select a Sound here, including your own. This sound plays when the animation plays. It will also play every loop, if the animation does loop.

    How animations work

    Explosion animation with 4 frames horizontally and 4 vertically.

    In the image to the left you see how the Columns and Rows are counted. You need to have both numbers ready when defining your animation. If one of the numbers is incorrect, your animation will look wonky.

    There is no restriction to the layout of the animation frame sheet. You can also put all frames into the same row (e.g. x=16, y=1). Try to have a layout that minimizes the number of empty frames.

    If you are following the Guide, continue with Attributes.