Interface Actor
-
- All Superinterfaces:
Animable
,Interactable
,Locatable
,LocatableEntity
,Modeled
,Onymous
,Renderable
,Rotatable
,Validatable
- All Known Implementing Classes:
OSRSNpc
,OSRSPlayer
,SummonedFamiliar
public interface Actor extends LocatableEntity, Rotatable, Modeled, Animable, Onymous
An in-game character (i.e. Npc, Player). By default all Actors have a backup model of BoundingModel.HUMANOID
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getAnimationFrame()
Gets the current frame of the actors animationjava.lang.String
getDialogue()
Gets the dialogue above an actors headCombatGauge
getHealthGauge()
Gets the health gauge which is displayed during combat@NonNull java.util.List<Hitsplat>
getHitsplats()
@NonNull java.util.List<OverheadIcon>
getOverheadIcons()
Gets a list of the overhead icons currently above the npc.@NonNull java.util.List<Coordinate>
getPath()
Coordinate
getServerPosition()
Gets the position of the actor according to the server.@NonNull java.util.List<java.lang.Integer>
getSpotAnimationIds()
Gets a list of the spot animation ids of the entity.int
getStanceFrame()
Gets the current frame of the actors stance animationint
getStanceId()
Gets the current stance animation idActor
getTarget()
Gets the Actor that this Actor is targeting (talking, attacking, trading, pickpocketing, etc)boolean
isMoving()
Gets whether or not the actor is moving across the world graph-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Animable
getAnimationId
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Interactable
click, contains, getInteractionPoint, getInteractionPoint, getVisibility, hasDynamicBounds, hover, interact, interact, interact, interact, interact, interact, isHovered, isVisible
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Locatable
distanceTo, distanceTo, getLocalPosition
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.LocatableEntity
getArea, getArea, getHighPrecisionPosition, getHighPrecisionPosition, getPosition, getPosition
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Modeled
getModel, setBackupModel, setBackupModel, setBackupModel, setForcedModel, setForcedModel, setForcedModel
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Renderable
render, render
-
Methods inherited from interface com.runemate.game.api.hybrid.entities.details.Rotatable
getHighPrecisionOrientation, getOrientationAsAngle, isFacing
-
Methods inherited from interface com.runemate.game.api.hybrid.util.Validatable
isValid
-
-
-
-
Method Detail
-
getAnimationFrame
int getAnimationFrame()
Gets the current frame of the actors animation- Returns:
- the current frame, otherwise -1
-
getStanceFrame
int getStanceFrame()
Gets the current frame of the actors stance animation- Returns:
- the current frame, otherwise -1
-
getStanceId
int getStanceId()
Gets the current stance animation id- Returns:
- the current stance animation id, otherwise -1
-
isMoving
boolean isMoving()
Gets whether or not the actor is moving across the world graph
-
getHealthGauge
@Nullable CombatGauge getHealthGauge()
Gets the health gauge which is displayed during combat- Returns:
- the health gauge, otherwise null
-
getDialogue
@Nullable java.lang.String getDialogue()
Gets the dialogue above an actors head- Returns:
- The actors current dialogue, otherwise null
-
getTarget
@Nullable Actor getTarget()
Gets the Actor that this Actor is targeting (talking, attacking, trading, pickpocketing, etc)- Returns:
- The target, otherwise null
-
getOverheadIcons
@NonNull @NonNull java.util.List<OverheadIcon> getOverheadIcons()
Gets a list of the overhead icons currently above the npc.
-
getServerPosition
Coordinate getServerPosition()
Gets the position of the actor according to the server.This value is typically ahead of where the client renders.
-
getSpotAnimationIds
@NonNull @NonNull java.util.List<java.lang.Integer> getSpotAnimationIds()
Gets a list of the spot animation ids of the entity. A spot animation is a model that is animated simultaneously with the actor's model.
-
getHitsplats
@NonNull @NonNull java.util.List<Hitsplat> getHitsplats()
-
getPath
@NonNull @NonNull java.util.List<Coordinate> getPath()
-
-