Skip to content

🔸Sprites

Sprite Items are used to display textured quads in 2D or 3D space. To get started with sprites, you need to have imported images into the Atlases IconAtlases section of the Asset Manager. Once you have your images imported, you can add them as frames to a state of the Sprite Item. Single frame sprites and animated sprites are created and used the same way. If this is an animated sprite with multiple frames, you can preview the animation using Space which will play/pause the animation starting from the currently selected frame in the properties table.

Property Widgets

Sprite Item Properties

  • Generate States
    If your Asset Manager's Atlases Icon Atlas images are organized into Filter Icon filters, you can quickly setup the sprite's various animations with a single button. Otherwise you can manually create states and add frames using and instead.
  • Configure States
    Sprite states allow a sprite instance to show a different image or animation. All settings for the currently selected state are shown below the States Groupbox.
  • Add/Remove Frames
    Add all the selected images within Asset Manager to the currently selected state. The images become frames of animation and are inserted alphabetically, so it's ideal to have the images named with the frame index appended on the end.
  • Animation Settings
    The Anim Frame Rate buttons are labeled in "Frames per second" and will apply to all frames in the current state. You can alternately use the Anim spin box spin box which will directly specify the duration that each frame lasts in the animation. The three checkboxes determine in what order will the frames of animation play for the state. You can use the Play Button button to preview how each checkbox affects the playback.
  • Frame List
    The table here lists all the frames this state uses, and their attributes Offset and Duration. You can double Left Button on an attribute to change it.

Sprite Origin & Frame Offsets

The white origin (or pivot point) in the center render window is the point around which the sprite will position, rotate, and scale its frames in the game. By default, any newly added frames start centered at the origin, but you can change it by adjusting the Offset values for each frame in the frame list.

To more easily set the Offset for the frames, you can use any of the alignment buttons located above the frame list, or Left Button on the preview and drag the frame in the Middle Render Window.

Sprite Offseting Gif

Sprites have a unique checkable 'apply to all' Sprite Apply All button. By default it starts checked, and applys any Offset to all frames in the current state. If you uncheck it, any Offset changes will only apply to the currently selected frame in the list.