Package org.collebol.shared

Class Sprite

java.lang.Object

org.collebol.shared.Sprite

public class Sprite
extends Object

Represents a sprite animation composed of multiple frames. A sprite consists of one or more texture frames that are displayed sequentially to create an animation. Each frame is identified by a texture ID previously registered in the TextureRenderer. The sprite updates its current frame automatically based on the elapsed time and the specified frame duration.

Sprites are designed to be attached to GameObject instances. When a GameObject has a Sprite, the rendering system will use the sprite's current frame instead of a static texture.

Usage:

     Sprite sprite = new Sprite(new Sprite.SpriteBuilder()
         .frames(new int[]{1, 2 etc.}) // The ID's of the textures
         .duration(1f) // 1f for 1 sec. 0.25f for 1/4th of a sec etc.
     );
 

Since:

1.0-dev

Author:

ColleBol - contact@collebol.org

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Sprite.SpriteBuilder

Constructor Summary

Constructors

Constructor	Description
Sprite(Sprite.SpriteBuilder builder)

Method Summary

Modifier and Type	Method	Description
int	getCurrentFrameId()
float	getElapsedTime()
float	getFrameDuration()
List<Integer>	getFrameIds()
void	update(float deltaTime)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Sprite

public Sprite(Sprite.SpriteBuilder builder)

Method Details

update

public void update(float deltaTime)

getElapsedTime

public float getElapsedTime()

getCurrentFrameId

public int getCurrentFrameId()

getFrameDuration

public float getFrameDuration()

getFrameIds

public List<Integer> getFrameIds()