Module net.botwithus.rs3

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

Class Player

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LocalPlayer

public sealed class Player
extends PathingEntity<PlayerAction>
permits LocalPlayer

Nested Class Summary

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

Entity.Type

Field Summary

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

type

Constructor Summary

Constructors

Constructor	Description
Player(int id, int animationId, Coordinate coordinate, String name, String overheadText, boolean isMoving, int followingIndex, int followingType, int combatLevel, Headbar[] headbars, Hitmark[] hitmarks, ScenePosition scene, float dir1, float dir2, int stanceId, List<SpotAnimation> spotAnimations, int serverX, int serverY)

Method Summary

Modifier and Type	Method	Description
@Nullable Area	getArea()	Gets the Area that the Entity occupies on the world graph.
Function<Integer,PlayerAction>	getDefaultMapper()	Returns a default Function that throws an UnsupportedOperationException when called.

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

equals, getAnimationId, getAnimationType, getCombatLevel, getCurrentHealth, getDirection1, getDirection2, getFollowing, getFollowingIndex, getFollowingType, getHeadbars, getHitmarks, getLinkedSpotAnims, getMaximumHealth, getName, getOptions, getOverheadText, getServerCoordinate, getStanceId, hashCode, interact, interact, isMoving, setAnimationId, validate

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

getCoordinate, getId, getScene, 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

Constructor Details

Player

public Player(int id,
 int animationId,
 Coordinate coordinate,
 String name,
 String overheadText,
 boolean isMoving,
 int followingIndex,
 int followingType,
 int combatLevel,
 Headbar[] headbars,
 Hitmark[] hitmarks,
 ScenePosition scene,
 float dir1,
 float dir2,
 int stanceId,
 List<SpotAnimation> spotAnimations,
 int serverX,
 int serverY)

Method Details

getDefaultMapper

public Function<Integer,PlayerAction> getDefaultMapper()

Description copied from interface: Interactable

Returns a default Function that throws an UnsupportedOperationException when called.

Returns:

a default Function

getArea

@Nullable
public @Nullable Area getArea()

Description copied from class: Entity

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

Specified by:

getArea in interface Locatable

Overrides:

getArea in class Entity

Returns:

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