Sprite Layers

Sprite Layers

Characters.SpriteLayers

Sprite Layers allow for sprites to be generated from individual components, or layers. This functionally allows for a user to have individual pieces in different sprites (e.g. head, hair, eyes, body, armor, weapon, etc.) and then stitch them together based on a user-specified drawing order. This similar to how many pixel character generators work.

Sprite Layers generate a new sprite behind the covers of the engine. They only support Characters (party members or the player character) at the moment, as supporting them for Entities is not currently performant.

If a Sprite Layer is not provided to a sprite that would otherwise use it, that layer will be ignored.

Note: Sprite Layers will only ever take the "region" defined by the base layer when compositing a sprite together. Therefore, it is imperative that the layout for sprites remain the same, or there will be errors.

SpriteLayersModal

Properties

System

Name Explanation Type
Name The name of the Sprite Layer. String

Drawing Order

Name Explanation Type
Draw Order The standard order for drawing the sprite. Number
Reverse Draw Order The order when drawing the sprite facing north (or backwards). This applies to when a sprite would face North, Northeast, or Northwest. Number

Sprite

Name Explanation Type
Is Sprite Animation Whether or not the animation is for a sprite. Toggle
Frame Count The number of frames in the animation. Number
Frame Duration The duration of each animation frame in milliseconds. Number
Frame Offset The number of frames offset from the standard pose of the sprite where the animation exists. Number