com.codingame.gameengine.module.entities

Class SpriteAnimation

java.lang.Object

com.codingame.gameengine.module.entities.Entity<T>

com.codingame.gameengine.module.entities.SpriteAnimation

public class SpriteAnimation
extends Entity<T>

A SpriteAnimation is a graphical entity which displays a sequence of images. You can use this class to animate a sprite based on milliseconds, rather than frame time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextureBasedEntity.BlendMode The list of supported PIXI blend modes and their associated constant.

Method Summary

Modifier and Type	Method and Description
double	getAnchorX() Returns the X anchor of this TextureBasedEntity as a percentage of its width.
double	getAnchorY() Returns the Y anchor of this TextureBasedEntity as a percentage of its width.
TextureBasedEntity.BlendMode	getBlendMode() Returns the BlendMode this TextureBasedEntity is to be drawn with.
int	getDuration() Returns the duration of the animation in milliseconds.
java.lang.String[]	getImages() Returns the names of the images used for this animation.
int	getTint() Returns the tint of this TextureBasedEntity as an RGB integer.
boolean	isLoop() Returns whether the animation should loop.
boolean	isStarted() Returns whether the animation is flagged to have the graphical counterpart start animating if it hasn't yet.
T	setAnchor(double anchor) Sets both the X and Y anchors of this TextureBasedEntity as a percentage of its width and height.
T	setAnchorX(double anchorX) Sets the X anchor of this TextureBasedEntity as a percentage of its width.
T	setAnchorX(double anchorX, Curve curve) Sets the X anchor of this TextureBasedEntity as a percentage of its width.
T	setAnchorY(double anchorY) Sets the Y anchor of this TextureBasedEntity as a percentage of its width.
T	setAnchorY(double anchorY, Curve curve) Sets the Y anchor of this TextureBasedEntity as a percentage of its width.
T	setBlendMode(TextureBasedEntity.BlendMode blendMode) Sets the blend mode for this TextureBasedEntity.
SpriteAnimation	setDuration(int duration) Sets the duration of the animation in milliseconds.
SpriteAnimation	setImages(java.lang.String... images) Sets the sequence of images for this animation.
SpriteAnimation	setLoop(boolean loop) Sets whether the animation loops.
SpriteAnimation	setStarted(boolean started) Begins or restarts the animation, it will always begin at the first image.
T	setTint(int color) Sets the tint of this TextureBasedEntity as an RGB integer.
T	setTint(int color, Curve curve) Sets the tint of this TextureBasedEntity as an RGB integer.
void	start() Calls setStarted(true);
void	stop() Calls setStarted(false);

Methods inherited from class com.codingame.gameengine.module.entities.Entity

getAlpha, getId, getRotation, getScaleX, getScaleY, getX, getY, getZIndex, isVisible, setAlpha, setAlpha, setRotation, setRotation, setScale, setScale, setScaleX, setScaleX, setScaleY, setScaleY, setVisible, setX, setX, setY, setY, setZIndex

Methods inherited from class java.lang.Object

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

Method Detail

isStarted

public boolean isStarted()

Returns whether the animation is flagged to have the graphical counterpart start animating if it hasn't yet.

Default is false.

Returns:

true if the animation has been started.

setStarted

public SpriteAnimation setStarted(boolean started)

Begins or restarts the animation, it will always begin at the first image.

Setting this to false will stop the animation, but it may not be resumed without restarting.

Parameters:

started - true to begin or restart animation, false to stop animation

Returns:

this animation.

start

public void start()

Calls setStarted(true);

stop

public void stop()

Calls setStarted(false);

isLoop

public boolean isLoop()

Returns whether the animation should loop.

Default is false.

Returns:

true if the animation loops.

setLoop

public SpriteAnimation setLoop(boolean loop)

Sets whether the animation loops. If false, the last image of the animation stays visible at the end.

Parameters:

loop - true to make this animation loop.

Returns:

this animation.

getDuration

public int getDuration()

Returns the duration of the animation in milliseconds.

Default is 1000.

Returns:

the duration of the animation in milliseconds.

setDuration

public SpriteAnimation setDuration(int duration)

Sets the duration of the animation in milliseconds.

Parameters:

duration - the duration of the animation in milliseconds.

Returns:

this animation.

Throws:

java.lang.IllegalArgumentException - if duration is negative.

setImages

public SpriteAnimation setImages(java.lang.String... images)

Sets the sequence of images for this animation.

Parameters:

images - the names of the images to use for this animation.

Returns:

this animation.

Throws:

java.lang.IllegalArgumentException - if images is empty.

getImages

public java.lang.String[] getImages()

Returns the names of the images used for this animation.

Returns:

the names of the images used for this animation.

getBlendMode

public TextureBasedEntity.BlendMode getBlendMode()

Returns the BlendMode this TextureBasedEntity is to be drawn with.

Returns:

the BlendMode this TextureBasedEntity is to be drawn with.

See Also:

PIXI BLEND_MODES

setBlendMode

public T setBlendMode(TextureBasedEntity.BlendMode blendMode)

Sets the blend mode for this TextureBasedEntity.

The possible values are found in BlendMode.

Parameters:

blendMode -

Returns:

this TextureBasedEntity.

See Also:

PIXI BLEND_MODES

setAnchor

public T setAnchor(double anchor)

Sets both the X and Y anchors of this TextureBasedEntity as a percentage of its width and height.

The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.

Parameters:

anchor - the percentage for both anchors of this TextureBasedEntity.

Returns:

this TextureBasedEntity.

getAnchorX

public double getAnchorX()

Returns the X anchor of this TextureBasedEntity as a percentage of its width.

Default is 0.

Returns:

the X anchor of this TextureBasedEntity as a percentage of its width.

setAnchorX

public T setAnchorX(double anchorX)

Sets the X anchor of this TextureBasedEntity as a percentage of its width.

The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.

Parameters:

anchorX - the X anchor for this TextureBasedEntity.

Returns:

this TextureBasedEntity.

setAnchorX

public T setAnchorX(double anchorX,
                    Curve curve)

Sets the X anchor of this TextureBasedEntity as a percentage of its width.

The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.

Parameters:

anchorX - the X anchor for this TextureBasedEntity.

curve - the transition to animate between values of this property.

Returns:

this TextureBasedEntity.

getAnchorY

public double getAnchorY()

Returns the Y anchor of this TextureBasedEntity as a percentage of its width.

Default is 0.

Returns:

the Y anchor of this TextureBasedEntity as a percentage of its width.

setAnchorY

public T setAnchorY(double anchorY)

Sets the Y anchor of this TextureBasedEntity as a percentage of its width.

The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.

Parameters:

anchorY - the Y anchor for this TextureBasedEntity.

Returns:

this TextureBasedEntity.

setAnchorY

public T setAnchorY(double anchorY,
                    Curve curve)

Sets the Y anchor of this TextureBasedEntity as a percentage of its width.

The point calculated by the anchors times the size of this TextureBasedEntity will be the origin for any rotation or scale.

Parameters:

anchorY - the Y anchor for this TextureBasedEntity.

curve - the transition to animate between values of this property.

Returns:

this TextureBasedEntity.

setTint

public T setTint(int color)

Sets the tint of this TextureBasedEntity as an RGB integer.

Parameters:

color - the tint of this TextureBasedEntity.

Returns:

this TextureBasedEntity.

Throws:

java.lang.IllegalArgumentException - if color is not a valid RGB integer.

setTint

public T setTint(int color,
                 Curve curve)

Sets the tint of this TextureBasedEntity as an RGB integer.

Parameters:

color - the tint of this TextureBasedEntity.

curve - the transition to animate between values of this property.

Returns:

this TextureBasedEntity.

Throws:

java.lang.IllegalArgumentException - if color is not a valid RGB integer.

getTint

public int getTint()

Returns the tint of this TextureBasedEntity as an RGB integer.

Default is 0xFFFFFF (white)

Returns:

the tint of this TextureBasedEntity.