Sprite

Specifies one picture that can be used in the game.

When there is more than one sprite or Animation frame with the same source file and dimensions/position in the game, they all share the same memory.

Type

struct

Properties

layers

• Type: Array<Sprite>
• Optional: true

If this property is present, all Sprite definitions have to be placed as entries in the array, and they will all be loaded from there. layers may not be an empty table. Each definition in the array may also have the layers property.

If this property is present, all other properties, including those inherited from SpriteParameters, are ignored.

filename

• Type: FileName
• Optional: true

Only loaded, and mandatory if layers is not defined.

The path to the sprite file to use.

dice

• Type: SpriteSizeType
• Optional: true

Only loaded if layers is not defined.

Number of slices this is sliced into when using the "optimized atlas packing" option. If you are a modder, you can just ignore this property. Example: If this is 4, the sprite will be sliced into a 4x4 grid.

dice_x

• Type: SpriteSizeType
• Optional: true

Only loaded if layers is not defined.

Same as dice above, but this specifies only how many slices there are on the x axis.

dice_y

• Type: SpriteSizeType
• Optional: true

Only loaded if layers is not defined.

Same as dice above, but this specifies only how many slices there are on the y axis.