Module net.botwithus.rs3

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

Class LocalPlayer

java.lang.Object

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

net.botwithus.rs3.game.scene.entities.characters.PathingEntity<PlayerAction>

net.botwithus.rs3.game.scene.entities.characters.player.Player

net.botwithus.rs3.game.scene.entities.characters.player.LocalPlayer

All Implemented Interfaces:

Identifiable, Interactable<PlayerAction>, Onymous, Validatable, Locatable

public final class LocalPlayer
extends Player

Nested Class Summary

Nested classes/interfaces inherited from class net.botwithus.rs3.game.scene.entities.Entity

Entity.Type

Field Summary

Fields

Modifier and Type	Field	Description
static LocalPlayer	LOCAL_PLAYER

Fields inherited from class net.botwithus.rs3.game.scene.entities.Entity

type

Method Summary

Modifier and Type	Method	Description
int	getAdrenaline()
int	getAnimationId()	Gets the animation id associated with this pathing entity.
int	getCombatLevel()	Returns the combat level of the PathingEntity.
@NotNull Coordinate	getCoordinate()	Gets the singular Coordinate that the Entity occupies on the world graph.
int	getCurrentHealth()	Gets the current health of the entity.
float	getDirection1()	Gets the direction in which the player is facing
float	getDirection2()	Gets the second direction in which the player is facing
@Nullable PathingEntity<?>	getFollowing()
@NotNull List<Headbar>	getHeadbars()	Returns a non-null of Headbar objects.
@NotNull List<Hitmark>	getHitmarks()	Returns a non-null of Hitmark objects
int	getId()	Gets the id of the Entity.
List<SpotAnimation>	getLinkedSpotAnims()	gets the spot animations related to this entity
int	getMaximumHealth()	Returns the maximum health of the entity.
@NotNull String	getName()	Returns the name of the PathingEntity.
@NotNull String	getOverheadText()	Returns the overhead text of the PathingEntity.
int	getPrayerPoints()
@NotNull ScenePosition	getScene()	Returns the scene position.
Coordinate	getServerCoordinate()	Gets the server coordinate of the entity
int	getStanceId()	Gets the players walking/running stance animation
int	getSummoningPoints()
PathingEntity<?>	getTarget()
boolean	hasTarget()
boolean	inCombat()
boolean	isMoving()	Returns whether the PathingEntity is currently moving or not.

Methods inherited from class net.botwithus.rs3.game.scene.entities.characters.player.Player

getArea, getDefaultMapper

Methods inherited from class net.botwithus.rs3.game.scene.entities.characters.PathingEntity

equals, getAnimationType, getFollowingIndex, getFollowingType, getOptions, hashCode, interact, interact, setAnimationId, validate

Methods inherited from class net.botwithus.rs3.game.scene.entities.Entity

getType

Methods inherited from class java.lang.Object

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

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

interact, interact, interact

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

distanceTo, isReachable

Field Details

LOCAL_PLAYER

public static LocalPlayer LOCAL_PLAYER

Method Details

getId

public int getId()

Description copied from class: Entity

Gets the id of the Entity.

Specified by:

getId in interface Identifiable

Overrides:

getId in class Entity

Returns:

the id of the Entity

getCombatLevel

public int getCombatLevel()

Description copied from class: PathingEntity

Returns the combat level of the PathingEntity.

Overrides:

getCombatLevel in class PathingEntity<PlayerAction>

Returns:

The combat level of the PathingEntity.

getFollowing

@Nullable
public @Nullable PathingEntity<?> getFollowing()

Overrides:

getFollowing in class PathingEntity<PlayerAction>

getName

@NotNull
public @NotNull String getName()

Description copied from class: PathingEntity

Returns the name of the PathingEntity.

Specified by:

getName in interface Onymous

Overrides:

getName in class PathingEntity<PlayerAction>

Returns:

The name of the PathingEntity.

getOverheadText

@NotNull
public @NotNull String getOverheadText()

Description copied from class: PathingEntity

Returns the overhead text of the PathingEntity.

Overrides:

getOverheadText in class PathingEntity<PlayerAction>

Returns:

The overhead text of the PathingEntity.

isMoving

public boolean isMoving()

Description copied from class: PathingEntity

Returns whether the PathingEntity is currently moving or not.

Overrides:

isMoving in class PathingEntity<PlayerAction>

Returns:

true if the PathingEntity is currently moving, false otherwise

getCoordinate

@NotNull
public @NotNull Coordinate getCoordinate()

Description copied from class: Entity

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

Specified by:

getCoordinate in interface Locatable

Overrides:

getCoordinate in class Entity

Returns:

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

getScene

@NotNull
public @NotNull ScenePosition getScene()

Description copied from class: Entity

Returns the scene position.

Overrides:

getScene in class Entity

Returns:

the scene position

getHeadbars

@NotNull
public @NotNull List<Headbar> getHeadbars()

Description copied from class: PathingEntity

Returns a non-null of Headbar objects.

Overrides:

getHeadbars in class PathingEntity<PlayerAction>

Returns:

a non-null of Headbar objects.

getHitmarks

@NotNull
public @NotNull List<Hitmark> getHitmarks()

Description copied from class: PathingEntity

Returns a non-null of Hitmark objects

Overrides:

getHitmarks in class PathingEntity<PlayerAction>

Returns:

a non-null list of Hitmark objects

getAnimationId

public int getAnimationId()

Description copied from class: PathingEntity

Gets the animation id associated with this pathing entity.

Overrides:

getAnimationId in class PathingEntity<PlayerAction>

Returns:

The animation id associated with this pathing entity.

hasTarget

public boolean hasTarget()

getTarget

public PathingEntity<?> getTarget()

getDirection1

public float getDirection1()

Description copied from class: PathingEntity

Gets the direction in which the player is facing

Overrides:

getDirection1 in class PathingEntity<PlayerAction>

Returns:

the direction represented as a float

getDirection2

public float getDirection2()

Description copied from class: PathingEntity

Gets the second direction in which the player is facing

Overrides:

getDirection2 in class PathingEntity<PlayerAction>

Returns:

the second direction represented as a float

getStanceId

public int getStanceId()

Description copied from class: PathingEntity

Gets the players walking/running stance animation

Overrides:

getStanceId in class PathingEntity<PlayerAction>

Returns:

the animation id

getCurrentHealth

public int getCurrentHealth()

Description copied from class: PathingEntity

Gets the current health of the entity.

Overrides:

getCurrentHealth in class PathingEntity<PlayerAction>

Returns:

The current health of the entity.

getMaximumHealth

public int getMaximumHealth()

Description copied from class: PathingEntity

Returns the maximum health of the entity.

Overrides:

getMaximumHealth in class PathingEntity<PlayerAction>

Returns:

The maximum health of the entity.

getLinkedSpotAnims

public List<SpotAnimation> getLinkedSpotAnims()

Description copied from class: PathingEntity

gets the spot animations related to this entity

Overrides:

getLinkedSpotAnims in class PathingEntity<PlayerAction>

Returns:

The spot animations

getServerCoordinate

public Coordinate getServerCoordinate()

Description copied from class: PathingEntity

Gets the server coordinate of the entity

Overrides:

getServerCoordinate in class PathingEntity<PlayerAction>

Returns:

The server coordinate

getAdrenaline

public int getAdrenaline()

getSummoningPoints

public int getSummoningPoints()

getPrayerPoints

public int getPrayerPoints()

inCombat

public boolean inCombat()