Whether or not the sprite should be rendered additively.

Alpha threshold for discarding pixels. Pixels with alpha below this value will be discarded. Only used when Opaque is true. Range: 0.0 (transparent) to 1.0 (opaque). Default is 0.5.

Alignment mode for the sprite's billboard behavior.

The color of the sprite. This is multiplied with the texture color.

The animation that is currently being played. Returns null if no sprite is set or the sprite has no animations.

The index of the current frame being displayed. This will change over time if the sprite is animated, and can be set to go to a specific frame even during playback.

Amount of feathering applied to the depth, softening its intersection with geometry.

Whether or not the sprite should be flipped horizontally.

Whether or not the sprite should be flipped vertically.

The strength of the fog effect applied to the sprite. This determines how much the sprite blends with any fog in the scene.

Whether or not the sprite is animated. This is true if the sprite has more than one animation.

Whether or not the sprite should be sorted by depth. If the sprite is opaque, this can be turned off for a performance boost if not needed.

Whether or not the sprite should be lit by the scene's lighting system. Otherwise it will be unlit/fullbright.

This action is invoked when an animation finishes playing or has looped. The string parameter is the name of the animation.

This action is invoked when an animation starts playing. The string parameter is the name of the animation that started.

This action is invoked when advancing to a new frame that has broadcast messages. The string parameter is the message being broadcast.

Whether or not the sprite should be rendered opaque. If true, any semi-transparent pixels will be dithered.

The playback speed of the animation. 0 is paused, and negative values will play the animation in reverse.

Whether or not the sprite should cast shadows.

The width and height of the sprite in world units.

The sprite resource to render. This can be completely static or contain animation(s).

The animation that this sprite should start playing when the scene starts.

The texture of the current frame being displayed. Returns a transparent texture when no valid frame is available.

The texture filtering mode used when rendering the sprite. For pixelated sprites, use Sandbox.UI.ImageRendering.Point.

Play an animation by index (the first animation is index 0).