com.codingame.gameengine.module.entities

Class Sprite

java.lang.Object

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

com.codingame.gameengine.module.entities.Sprite

public class Sprite
extends Entity<T>

A Sprite is a graphical entity which displays an image. That image must be loaded into the viewer's texture cache, which you can configure by adding files to the assets folder of your game's project.

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.
java.lang.String	getImage() Returns the name of the image used for this Sprite.
int	getTint() Returns the tint of this TextureBasedEntity as an RGB integer.
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.
Sprite	setImage(java.lang.String image) Sets the image for this Sprite.
Sprite	setImage(java.lang.String image, Curve curve) Sets the image for this Sprite.
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.

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

setImage

public Sprite setImage(java.lang.String image)

Sets the image for this Sprite.

You must either:

• use the filename of an image relative to the assets folder of the Java project.
• use the a player's nickname token.

Parameters:

image - the name of the image to use for this Sprite.

Returns:

this Sprite.

setImage

public Sprite setImage(java.lang.String image,
                       Curve curve)

Sets the image for this Sprite.

You must either:

• use the filename of an image relative to the assets folder of the Java project.
• use the a player's nickname token.

Parameters:

image - the name of the image to use for this Sprite.

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

Returns:

this Sprite.

getImage

public java.lang.String getImage()

Returns the name of the image used for this Sprite.

Can be a player's nickname token.

Returns:

the name of the image used for this Sprite

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.