core/com.lehaine.littlekt.graphics.g2d/AnimatedSprite

AnimatedSprite

class AnimatedSprite(var slice: TextureSlice = Textures.white, var anchorX: Float = 0.0f, var anchorY: Float = 0.0f) : AnimationPlayer<TextureSlice>

Author

Colton Daily

Constructors

AnimatedSprite

fun AnimatedSprite(slice: TextureSlice = Textures.white, anchorX: Float = 0.0f, anchorY: Float = 0.0f)

Functions

play

fun play(animation: Animation<TextureSlice>, times: Int = 1, queue: Boolean = false)

Play the specified animation an X number of times.

fun play(animation: Animation<TextureSlice>, duration: Duration, queue: Boolean = false)

Play the specified animation for a duration.

fun play(frame: TextureSlice, frameTime: Duration = 50.milliseconds, numFrames: Int = 1)

Play a specified frame for a certain amount of frames.

playLooped

fun playLooped(animation: Animation<TextureSlice>)

Play the specified animation as a loop.

playOnce

fun playOnce(animation: Animation<TextureSlice>)

Play the specified animation one time.

registerState

fun registerState(anim: Animation<TextureSlice>, priority: Int, loop: Boolean = true, reason: () -> Boolean = { true })

Priority is represented by the deepest. The deepest has top priority while the shallowest has lowest.

removeAllStates

fun removeAllStates()

removeState

fun removeState(anim: Animation<TextureSlice>)

render

fun render(batch: Batch)

restart

fun restart()

Restarts the current running animation from the beginning. Is the same as invoking stop and then start.

resume

fun resume()

Resumes any currently stopped animation. This only does something when an animation is stopped with stop.

start

fun start()

Starts any currently stopped animation from the beginning. This only does something when an animation is stopped with stop.

stop

fun stop()

Stops any running animations. Resume the current animation with resume.

update

fun update(dt: Duration)

Runs any updates for any requested animation and grabs the next frame if so.

Properties

anchorX

var anchorX: Float = 0.0f

anchorY

var anchorY: Float = 0.0f

currentAnimation

val currentAnimation: Animation<TextureSlice>?

The current playing animations. Set this by using one of the play methods.

currentFrameIdx

var currentFrameIdx: Int

The index of the current frame

currentKeyFrame

val currentKeyFrame: TextureSlice?

onFrameChange

var onFrameChange: (Int) -> Unit?

Invoked when a frame is changed.

overlapPlaying

var overlapPlaying: Boolean

scaleX

var scaleX: Float = 0.0f

scaleY

var scaleY: Float = 0.0f

slice

var slice: TextureSlice

totalFrames

val totalFrames: Int

The total frames the currentAnimation has.

totalFramesPlayed

var totalFramesPlayed: Int

The total amount of frames played across all animations.

var x: Float = 0.0f

var y: Float = 0.0f