com.osroyale.game.world.entity.Entity Class Reference

Inheritance diagram for com.osroyale.game.world.entity.Entity:

Collaboration diagram for com.osroyale.game.world.entity.Entity:

Public Member Functions
Position	getPosition ()
int	width ()
int	length ()
int	getX ()
int	getY ()
int	getHeight ()
boolean	isValid ()
abstract void	register ()
abstract void	unregister ()
abstract void	addToRegion (Region region)
abstract void	removeFromRegion (Region region)
abstract String	getName ()
abstract EntityType	getType ()
final boolean	isStaticObject ()
final boolean	isCustomObject ()

Protected Member Functions
Entity	destroy ()

Additional Inherited Members
Static Public Member Functions inherited from com.osroyale.game.world.Interactable
static Interactable	create (Position position)
static Interactable	create (Position position, int width, int length)

Detailed Description

Represents a character in the game world, i.e. a Player or an NPC.

Author

Michael | Chex

Definition at line 50 of file Entity.java.

Member Function Documentation

addToRegion()

abstract void com.osroyale.game.world.entity.Entity.addToRegion ( Region region )

abstract

Adds this entity to the specified region.

Parameters

region

The region.

Reimplemented in com.osroyale.content.combat.cannon.Cannon, com.osroyale.game.world.entity.mob.npc.Npc, com.osroyale.game.world.entity.mob.player.Player, com.osroyale.game.world.items.ground.GroundItem, and com.osroyale.game.world.object.CustomGameObject.

destroy()

Entity com.osroyale.game.world.entity.Entity.destroy ( )

inlineprotected

Destroys this entity.

Returns

This entity.

Definition at line 180 of file Entity.java.

getHeight()

int com.osroyale.game.world.entity.Entity.getHeight ( )

inline

Returns

the z coordinate of the getPosition()

Implements com.osroyale.game.world.Interactable.

Definition at line 119 of file Entity.java.

getName()

abstract String com.osroyale.game.world.entity.Entity.getName ( )

abstract

Gets the name of this entity.

Returns

The entity's name.

Reimplemented in com.osroyale.content.combat.cannon.Cannon, com.osroyale.game.world.entity.mob.npc.Npc, com.osroyale.game.world.entity.mob.player.Player, com.osroyale.game.world.items.ground.GroundItem, and com.osroyale.game.world.object.CustomGameObject.

getPosition()

Position com.osroyale.game.world.entity.Entity.getPosition ( )

inline

Returns

the current location

Implements com.osroyale.game.world.Interactable.

Reimplemented in com.osroyale.content.combat.cannon.Cannon.

Definition at line 77 of file Entity.java.

getType()

abstract EntityType com.osroyale.game.world.entity.Entity.getType ( )

abstract

Gets the EntityType.

Returns

The EntityType.

Reimplemented in com.osroyale.content.combat.cannon.Cannon, com.osroyale.game.world.entity.mob.npc.Npc, com.osroyale.game.world.entity.mob.player.Player, com.osroyale.game.world.items.ground.GroundItem, and com.osroyale.game.world.object.CustomGameObject.

getX()

int com.osroyale.game.world.entity.Entity.getX ( )

inline

Returns

the x coordinate of the getPosition()

Implements com.osroyale.game.world.Interactable.

Definition at line 111 of file Entity.java.

getY()

int com.osroyale.game.world.entity.Entity.getY ( )

inline

Returns

the y coordinate of the getPosition()

Implements com.osroyale.game.world.Interactable.

Definition at line 115 of file Entity.java.

isCustomObject()

final boolean com.osroyale.game.world.entity.Entity.isCustomObject ( )

inline

Check if an entity is an object

Definition at line 251 of file Entity.java.

isStaticObject()

final boolean com.osroyale.game.world.entity.Entity.isStaticObject ( )

inline

Check if an entity is an object

Definition at line 246 of file Entity.java.

isValid()

boolean com.osroyale.game.world.entity.Entity.isValid ( )

inline

Validates this npc based on its current region and registered state.

Returns

True if this npc is a valid log in the game world.

Reimplemented in com.osroyale.game.world.entity.mob.player.Player.

Definition at line 191 of file Entity.java.

length()

int com.osroyale.game.world.entity.Entity.length ( )

inline

Returns

the length

Implements com.osroyale.game.world.Interactable.

Definition at line 95 of file Entity.java.

register()

abstract void com.osroyale.game.world.entity.Entity.register ( )

abstract

Registers an entity to the World.

Reimplemented in com.osroyale.content.bot.PlayerBot, com.osroyale.content.combat.cannon.Cannon, com.osroyale.game.world.entity.mob.npc.Npc, com.osroyale.game.world.entity.mob.player.Player, com.osroyale.game.world.items.ground.GroundItem, and com.osroyale.game.world.object.CustomGameObject.

removeFromRegion()

abstract void com.osroyale.game.world.entity.Entity.removeFromRegion ( Region region )

abstract

Removes this entity from the specified region.

Parameters

region

The region.

Reimplemented in com.osroyale.content.combat.cannon.Cannon, com.osroyale.game.world.entity.mob.npc.Npc, com.osroyale.game.world.entity.mob.player.Player, com.osroyale.game.world.items.ground.GroundItem, and com.osroyale.game.world.object.CustomGameObject.

unregister()

abstract void com.osroyale.game.world.entity.Entity.unregister ( )

abstract

Unregisters an entity from the World.

Reimplemented in com.osroyale.content.bot.PlayerBot, com.osroyale.content.combat.cannon.Cannon, com.osroyale.game.world.entity.mob.npc.Npc, com.osroyale.game.world.entity.mob.player.Player, com.osroyale.game.world.items.ground.GroundItem, and com.osroyale.game.world.object.CustomGameObject.

width()

int com.osroyale.game.world.entity.Entity.width ( )

inline

Returns

the width

Implements com.osroyale.game.world.Interactable.

Definition at line 90 of file Entity.java.

---

The documentation for this class was generated from the following file:

• osroyale/game/world/entity/Entity.java