User Manual

Sprite

The Sprite Component renders and animates Sprite Assets into the scene.

There are two types of sprite Simple and Animated.

Simple Sprites

Simple Sprite Components display a single frame from an atlas

Simple Sprite

Simple Sprite Component Properties

Description
TypeSimple or Animated
SpriteThe Sprite Asset to display
FrameThe frame index of the Sprite to display.
ColorA color to apply as a tint to the sprite.
OpacityThe transparency of the sprite.
Flip XFlip the rendered sprite horizontally.
Flip YFlip the rendered sprite vertically.
LayersThe Layers in which to render the sprite.
Draw OrderThe order in which this sprite is rendered. Lower numbers are rendered first.

Animated Sprites

Animated Sprite Components have multiple Sprite Animation Clips attached which can play back a different Sprite Asset.

Animated Sprite

Animated Sprite Component Properties

PropertyDescription
TypeSimple or Animated
FrameThe frame index of the Sprite to display.
ColorA color to apply as a tint to the sprite.
OpacityThe transparency of the sprite.
Flip XFlip the rendered sprite horizontally.
Flip YFlip the rendered sprite vertically.
SpeedMultiplier applied to the speed at which sprite animation clips on this sprite component are animated.
LayersThe Layers in which to render the sprite.
Draw OrderThe order in which this sprite is rendered. Lower numbers are rendered first.
Auto PlayThe name of a sprite animation clip to play when the sprite is enabled.

Sprite Animation Clip Properties

PropertyDescription
NameThe name of the Sprite Animation Clip. Used to reference an individual clip.
LoopIf true the animation clip will loop back to the start when it reaches the end.
FPSThe speed at which the clip is played in Frames Per Second.
SpriteThe Sprite Asset which is used to play this clip.

Scripting Interface

You can control the properties of a Sprite component using a script component. The scripting interface for the Sprite component is here.