Module net.botwithus.rs3

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

Class Npc

java.lang.Object

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

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

net.botwithus.rs3.game.scene.entities.characters.npc.Npc

All Implemented Interfaces:

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

public final class Npc
extends PathingEntity<NPCAction>
implements Interactable<NPCAction>

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
Npc(int id, int typeId, Coordinate coordinate, String name, String overheadText, int health, int maxHealth, boolean isMoving, int followingIndex, int followingType, int combatLevel, int animationId, 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.
@Nullable NpcType	getConfigType()
Function<Integer,NPCAction>	getDefaultMapper()	Returns a default Function that throws an UnsupportedOperationException when called.
@NotNull List<String>	getOptions()	Gets the options available for this Interactable

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, 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, interact, interact

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

distanceTo, isReachable

Constructor Details

Npc

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

Method Details

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.

getOptions

@NotNull
public @NotNull List<String> getOptions()

Description copied from interface: Interactable

Gets the options available for this Interactable

Specified by:

getOptions in interface Interactable<NPCAction>

Overrides:

getOptions in class PathingEntity<NPCAction>

Returns:

a list of strings containing the options

getConfigType

@Nullable
public @Nullable NpcType getConfigType()

getDefaultMapper

public Function<Integer,NPCAction> getDefaultMapper()

Description copied from interface: Interactable

Returns a default Function that throws an UnsupportedOperationException when called.

Specified by:

getDefaultMapper in interface Interactable<NPCAction>

Returns:

a default Function