com.codingame.gameengine.module.entities

Class Entity<T extends Entity<?>>

java.lang.Object

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

Type Parameters:

T - a subclass inheriting Entity, used in order to return this as a T instead of an Entity.

Direct Known Subclasses:

Circle, Group, Line, Rectangle, Sprite, SpriteAnimation, Text

public abstract class Entity<T extends Entity<?>>
extends java.lang.Object

A graphical entity, displayed on screen in the game's replay.

The graphical counterpart's coordinates are converted from world units to pixel coordinates.

Method Summary

Modifier and Type	Method and Description
double	getAlpha() Returns the alpha of this Entity as a percentage.
int	getId() Returns a unique identifier for this Entity.
double	getRotation() Returns the rotation of this Entity in radians.
double	getScaleX() Returns the horizontal scale of this Entity as a percentage.
double	getScaleY() Returns the vertical scale of this Entity as a percentage.
int	getX() Returns the X coordinate of this Entity in world units.
int	getY() Returns the Y coordinate of this Entity in world units.
int	getZIndex() Returns the z-index of this Entity used to compute the display order for overlapping entities.
boolean	isVisible() Returns whether this Entity is flagged to be drawn on screen.
T	setAlpha(double alpha) Sets the alpha of this Entity as a percentage.
T	setAlpha(double alpha, Curve curve) Sets the alpha of this Entity as a percentage.
T	setRotation(double rotation) Sets the rotation of this Entity in radians.
T	setRotation(double rotation, Curve curve) Sets the rotation of this Entity in radians.
T	setScale(double scale) Sets both the horizontal and vertical scale of this Entity to the same percentage.
T	setScale(double scale, Curve curve) Sets both the horizontal and vertical scale of this Entity to the same percentage.
T	setScaleX(double scaleX) Sets the horizontal scale of this Entity as a percentage.
T	setScaleX(double scaleX, Curve curve) Sets the horizontal scale of this Entity as a percentage.
T	setScaleY(double scaleY) Sets the vertical scale of this Entity as a percentage.
T	setScaleY(double scaleY, Curve curve) Sets the vertical scale of this Entity as a percentage.
T	setVisible(boolean visible) Flags this Entity to be drawn on screen or not.
T	setX(int x) Sets the X coordinate of this Entity in world units.
T	setX(int x, Curve curve) Sets the X coordinate of this Entity in world units.
T	setY(int y) Sets the Y coordinate of this Entity in world units.
T	setY(int y, Curve curve) Sets the Y coordinate of this Entity in world units.
T	setZIndex(int zIndex) Sets the z-index of this Entity used to compute the display order for overlapping entities.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public int getId()

Returns a unique identifier for this Entity.

Returns:

A unique identifier.

setX

public T setX(int x)

Sets the X coordinate of this Entity in world units.

Parameters:

x - the X coordinate for this Entity.

Returns:

this Entity.

setX

public T setX(int x,
              Curve curve)

Sets the X coordinate of this Entity in world units.

Parameters:

x - the X coordinate for this Entity.

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

Returns:

this Entity.

setY

public T setY(int y)

Sets the Y coordinate of this Entity in world units.

Parameters:

y - the Y coordinate for this Entity.

Returns:

this Entity.

setY

public T setY(int y,
              Curve curve)

Sets the Y coordinate of this Entity in world units.

Parameters:

y - the Y coordinate for this Entity.

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

Returns:

this Entity.

setZIndex

public T setZIndex(int zIndex)

Sets the z-index of this Entity used to compute the display order for overlapping entities.

An Entity with a higher z-index is displayed over one with a smaller z-index.

In case of equal values, the most recently created Entity will be on top.

Parameters:

zIndex - the z-index for this Entity.

Returns:

this Entity.

setScaleX

public T setScaleX(double scaleX)

Sets the horizontal scale of this Entity as a percentage.

Parameters:

scaleX - the horizontal scale for this Entity.

Returns:

this Entity.

setScaleX

public T setScaleX(double scaleX,
                   Curve curve)

Sets the horizontal scale of this Entity as a percentage.

Parameters:

scaleX - the horizontal scale for this Entity.

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

Returns:

this Entity.

setScaleY

public T setScaleY(double scaleY)

Sets the vertical scale of this Entity as a percentage.

Parameters:

scaleY - the vertical scale for this Entity.

Returns:

this Entity.

setScaleY

public T setScaleY(double scaleY,
                   Curve curve)

Sets the vertical scale of this Entity as a percentage.

Parameters:

scaleY - the vertical scale for this Entity.

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

Returns:

this Entity.

setAlpha

public T setAlpha(double alpha)

Sets the alpha of this Entity as a percentage.

1 is opaque and 0 is invisible.

Parameters:

alpha - the alpha for this Entity.

Returns:

this Entity.

Throws:

java.lang.IllegalArgumentException - if alpha < 0 or alpha > 1

setAlpha

public T setAlpha(double alpha,
                  Curve curve)

Sets the alpha of this Entity as a percentage.

1 is opaque and 0 is invisible.

Parameters:

alpha - the alpha for this Entity.

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

Returns:

this Entity.

Throws:

java.lang.IllegalArgumentException - if alpha < 0 or alpha > 1

setScale

public T setScale(double scale)

Sets both the horizontal and vertical scale of this Entity to the same percentage.

Parameters:

scale - the scale for this Entity.

Returns:

this Entity.

setScale

public T setScale(double scale,
                  Curve curve)

Sets both the horizontal and vertical scale of this Entity to the same percentage.

Parameters:

scale - the scale for this Entity.

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

Returns:

this Entity.

setRotation

public T setRotation(double rotation)

Sets the rotation of this Entity in radians.

Parameters:

rotation - the rotation for this Entity.

Returns:

this Entity.

setRotation

public T setRotation(double rotation,
                     Curve curve)

Sets the rotation of this Entity in radians.

Parameters:

rotation - the rotation for this Entity.

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

Returns:

this Entity.

setVisible

public T setVisible(boolean visible)

Flags this Entity to be drawn on screen or not.

Default is true.

Parameters:

visible - the value for this Entity's visible flag.

Returns:

this Entity.

getX

public int getX()

Returns the X coordinate of this Entity in world units.

Returns:

the X coordinate of this Entity.

getY

public int getY()

Returns the Y coordinate of this Entity in world units.

Returns:

the Y coordinate of this Entity.

getZIndex

public int getZIndex()

Returns the z-index of this Entity used to compute the display order for overlapping entities.

Returns:

the z-index of this Entity.

getScaleX

public double getScaleX()

Returns the horizontal scale of this Entity as a percentage.

Default is 1.

Returns:

the horizontal scale of this Entity.

getScaleY

public double getScaleY()

Returns the vertical scale of this Entity as a percentage.

Default is 1.

Returns:

the vertical scale of this Entity.

getAlpha

public double getAlpha()

Returns the alpha of this Entity as a percentage.

Default is 1.

Returns:

the alpha of this Entity.

getRotation

public double getRotation()

Returns the rotation of this Entity in radians.

Returns:

the rotation coordinate of this Entity.

isVisible

public boolean isVisible()

Returns whether this Entity is flagged to be drawn on screen.

Returns:

the value of the visible flag of this Entity.