bubolo
 All Classes Namespaces Functions Variables Enumerator
Public Member Functions | List of all members
bubolo.world.entity.Entity Class Referenceabstract
Inheritance diagram for bubolo.world.entity.Entity:
bubolo.graphics.Drawable bubolo.world.entity.Actor bubolo.world.entity.StationaryEntity bubolo.world.entity.concrete.Tank bubolo.world.entity.Modifier bubolo.world.entity.StationaryElement bubolo.world.entity.Terrain bubolo.world.entity.concrete.Road bubolo.world.entity.concrete.Tree bubolo.world.entity.concrete.Grass

Public Member Functions

 Entity ()
 
 Entity (UUID newID)
 
Entity setParams (float x, float y, int w, int h, float rot)
 
UUID getId ()
 
void setId (UUID id)
 
int getHeight ()
 
int getWidth ()
 
void update ()
 
float getRotation ()
 
float getX ()
 
float getY ()
 
Entity setRotation (float newRotation)
 
Entity setX (float x)
 
Entity setY (float y)
 
Entity setWidth (int size)
 
Entity setHeight (int size)
 

Detailed Description

Base class for game objects. Anything that is part of the game logic should inherit from this class.

Author
BU CS673 - Clone Productions

Definition at line 14 of file Entity.java.

Constructor & Destructor Documentation

bubolo.world.entity.Entity.Entity ( )

Construct a new Entity with a random UUID.

Definition at line 28 of file Entity.java.

bubolo.world.entity.Entity.Entity ( UUID  newID)

Construct a new Entity with the specified UUID.

Parameters
newIDis the existing UUID to be assigned to the new Entity.

Definition at line 39 of file Entity.java.

Member Function Documentation

int bubolo.world.entity.Entity.getHeight ( )

Get the height of this Entity.

Returns
the height of this Entity in world coordinates.

Implements bubolo.graphics.Drawable.

Definition at line 88 of file Entity.java.

UUID bubolo.world.entity.Entity.getId ( )

The Entity's unique id.

Returns
the Entity's unique id.

Definition at line 73 of file Entity.java.

float bubolo.world.entity.Entity.getRotation ( )

Get the current rotation of this Entity.

Returns
the rotation of this Entity in radians.

Implements bubolo.graphics.Drawable.

Definition at line 110 of file Entity.java.

int bubolo.world.entity.Entity.getWidth ( )

Get the width of this Entity.

Returns
the height of this Entity in world coordinates.

Implements bubolo.graphics.Drawable.

Definition at line 94 of file Entity.java.

float bubolo.world.entity.Entity.getX ( )

Get the x position of this Entity.

Returns
the entity's x position in world coordinates.

Implements bubolo.graphics.Drawable.

Definition at line 116 of file Entity.java.

float bubolo.world.entity.Entity.getY ( )

Get the y position of this Entity.

Returns
the entity's y position in world coordinates.

Implements bubolo.graphics.Drawable.

Definition at line 122 of file Entity.java.

Entity bubolo.world.entity.Entity.setHeight ( int  size)

Set this Entity's height.

Parameters
sizeis the desired Entity height in world coordinates.
Returns
this Entity.

Definition at line 187 of file Entity.java.

Referenced by bubolo.world.entity.Entity.setParams().

void bubolo.world.entity.Entity.setId ( UUID  id)

Sets the Entity's unique id.

Parameters
idthe Entity's unique id.

Definition at line 82 of file Entity.java.

Entity bubolo.world.entity.Entity.setParams ( float  x,
float  y,
int  w,
int  h,
float  rot 
)

Set the basic parameters for an Entity. Intended to be used after construction.

Parameters
xis the initial x position in world coordinates.
yis the initial y position in world coordinates.
wis the initial width in world coordinates.
his the initial height in world coordinates.
rotis the initial rotation in radians.
Returns
a reference to this Entity.

Definition at line 59 of file Entity.java.

References bubolo.world.entity.Entity.setHeight(), bubolo.world.entity.Entity.setRotation(), bubolo.world.entity.Entity.setWidth(), bubolo.world.entity.Entity.setX(), and bubolo.world.entity.Entity.setY().

Entity bubolo.world.entity.Entity.setRotation ( float  newRotation)

Set the rotation of this Entity.

Parameters
newRotationis the desired rotation state of this Entity in radians.
Returns
this Entity, after the rotation action has been completed.

Definition at line 134 of file Entity.java.

Referenced by bubolo.world.entity.Entity.setParams().

Entity bubolo.world.entity.Entity.setWidth ( int  size)

Set this Entity's width.

Parameters
sizeis the desired Entity width in world coordinates.
Returns
this Entity.

Definition at line 174 of file Entity.java.

Referenced by bubolo.world.entity.Entity.setParams().

Entity bubolo.world.entity.Entity.setX ( float  x)

Sets this Entity's x position.

Parameters
xis the desired x position in world coordinates.
Returns
this Entity.

Definition at line 148 of file Entity.java.

Referenced by bubolo.world.entity.Entity.setParams().

Entity bubolo.world.entity.Entity.setY ( float  y)

Set this Entity's y position.

Parameters
yis the desired y position in world coordinates.
Returns
this Entity.

Definition at line 161 of file Entity.java.

Referenced by bubolo.world.entity.Entity.setParams().

void bubolo.world.entity.Entity.update ( )

Updates the state of this Entity. Called multiple times per second to maintain current Entity state.

Definition at line 104 of file Entity.java.