Module net.botwithus.rs3

Package net.botwithus.rs3.game.scene.entities

Class Entity

java.lang.Object

net.botwithus.rs3.game.scene.entities.Entity

All Implemented Interfaces:

Identifiable, Validatable, Locatable

Direct Known Subclasses:

GroundItem, HintArrow, PathingEntity, Projectile, SceneObject, SpotAnimation

public abstract sealed class Entity
extends Object
implements Identifiable, Locatable, Validatable
permits Projectile, SpotAnimation, HintArrow, PathingEntity<T>, GroundItem, SceneObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Entity.Type

Field Summary

Fields

Modifier and Type	Field	Description
final Entity.Type	type

Constructor Summary

Constructors

Constructor	Description
Entity(int id, Entity.Type type, Area position, ScenePosition scene)
Entity(int id, Entity.Type type, Coordinate position, ScenePosition scene)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable Area	getArea()	Gets the Area that the Entity occupies on the world graph.
@Nullable Coordinate	getCoordinate()	Gets the singular Coordinate that the Entity occupies on the world graph.
int	getId()	Gets the id of the Entity.
ScenePosition	getScene()	Returns the scene position.
Entity.Type	getType()	Gets the Entity.Type of this entity
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.botwithus.rs3.game.Locatable

distanceTo, isReachable

Methods inherited from interface net.botwithus.rs3.game.annotations.Validatable

validate

Field Details

type

public final Entity.Type type

Constructor Details

Entity

public Entity(int id,
 Entity.Type type,
 Coordinate position,
 ScenePosition scene)

Entity

public Entity(int id,
 Entity.Type type,
 Area position,
 ScenePosition scene)

Method Details

getScene

public ScenePosition getScene()

Returns the scene position.

Returns:

the scene position

getId

public int getId()

Gets the id of the Entity.

Specified by:

getId in interface Identifiable

Returns:

the id of the Entity

getType

public Entity.Type getType()

Gets the Entity.Type of this entity

Returns:

the type of this entity.

getCoordinate

@Nullable
public @Nullable Coordinate getCoordinate()

Gets the singular Coordinate that the Entity occupies on the world graph.

Specified by:

getCoordinate in interface Locatable

Returns:

the entities position as a Coordinate if available, otherwise null.

getArea

@Nullable
public @Nullable Area getArea()

Gets the Area that the Entity occupies on the world graph.

Specified by:

getArea in interface Locatable

Returns:

the entities position as an Area if available, otherwise null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object