Constructor Detail

• SummonedFamiliar

  public SummonedFamiliar​(Summoning.Familiar info)

  Deprecated.

Method Detail

• getInfo

  public Summoning.Familiar getInfo()

  Deprecated.
  Gets the enum information about this familiar

• toString

  public java.lang.String toString()

  Deprecated.

  Overrides:

  toString in class java.lang.Object

• getAnimationFrame

  public int getAnimationFrame()

  Deprecated.
  Description copied from interface: Actor
  Gets the current frame of the actors animation

  Specified by:

  getAnimationFrame in interface Actor

  Returns:

  the current frame, otherwise -1

• getStanceFrame

  public int getStanceFrame()

  Deprecated.
  Description copied from interface: Actor
  Gets the current frame of the actors stance animation

  Specified by:

  getStanceFrame in interface Actor

  Returns:

  the current frame, otherwise -1

• getStanceId

  public int getStanceId()

  Deprecated.
  Description copied from interface: Actor
  Gets the current stance animation id

  Specified by:

  getStanceId in interface Actor

  Returns:

  the current stance animation id, otherwise -1

• isMoving

  public boolean isMoving()

  Deprecated.
  Description copied from interface: Actor
  Gets whether or not the actor is moving across the world graph

  Specified by:

  isMoving in interface Actor

• getHealthGauge

  @Nullable
  public @Nullable CombatGauge getHealthGauge()

  Deprecated.
  Description copied from interface: Actor
  Gets the health gauge which is displayed during combat

  Specified by:

  getHealthGauge in interface Actor

  Returns:

  the health gauge, otherwise null

• getDialogue

  @Nullable
  public @Nullable java.lang.String getDialogue()

  Deprecated.
  Description copied from interface: Actor
  Gets the dialogue above an actors head

  Specified by:

  getDialogue in interface Actor

  Returns:

  The actors current dialogue, otherwise null

• getTarget

  @Nullable
  public @Nullable Actor getTarget()

  Deprecated.
  Description copied from interface: Actor
  Gets the Actor that this Actor is targeting (talking, attacking, trading, pickpocketing, etc)

  Specified by:

  getTarget in interface Actor

  Returns:

  The target, otherwise null

• getOverheadIcons

  @NonNull
  public @NonNull java.util.List<OverheadIcon> getOverheadIcons()

  Deprecated.
  Description copied from interface: Actor
  Gets a list of the overhead icons currently above the npc.

  Specified by:

  getOverheadIcons in interface Actor

• getServerPosition

  public Coordinate getServerPosition()

  Deprecated.
  Description copied from interface: Actor
  Gets the position of the actor according to the server.

  This value is typically ahead of where the client renders.

  Specified by:

  getServerPosition in interface Actor

• getSpotAnimationIds

  @NonNull
  public @NonNull java.util.List<java.lang.Integer> getSpotAnimationIds()

  Deprecated.
  Description copied from interface: Actor
  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.

  Specified by:

  getSpotAnimationIds in interface Actor

• getHitsplats

  @NonNull
  public @NonNull java.util.List<Hitsplat> getHitsplats()

  Deprecated.

  Specified by:

  getHitsplats in interface Actor

• getPath

  @NonNull
  public @NonNull java.util.List<Coordinate> getPath()

  Deprecated.

  Specified by:

  getPath in interface Actor

• getPosition

  @Nullable
  public @Nullable Coordinate getPosition​(Coordinate regionBase)

  Deprecated.
  Description copied from interface: LocatableEntity
  Gets the position using the region base as the coordinate to offset from. For optimization.

  Specified by:

  getPosition in interface LocatableEntity

  Parameters:

  regionBase - The Coordinate base of the loaded region

• getHighPrecisionPosition

  @Nullable
  public Coordinate.HighPrecision getHighPrecisionPosition​(Coordinate regionBase)

  Deprecated.
  Description copied from interface: LocatableEntity
  Gets the high precision position using the region base as the coordinate to offset from. For optimization.

  Specified by:

  getHighPrecisionPosition in interface LocatableEntity

  Parameters:

  regionBase - The Coordinate base of the loaded region

• getArea

  @Nullable
  public Area.Rectangular getArea​(Coordinate regionBase)

  Deprecated.
  Description copied from interface: LocatableEntity
  Gets the area using the region base as the coordinate to offset from. For optimization.

  Specified by:

  getArea in interface LocatableEntity

  Parameters:

  regionBase - The Coordinate base of the loaded region

• getLevel

  public int getLevel()

  Deprecated.
  Description copied from interface: Npc
  Gets the npcs current level

  Specified by:

  getLevel in interface Npc

  Returns:

  the npcs level, otherwise -1

• getDefinition

  @Nullable
  public @Nullable NpcDefinition getDefinition()

  Deprecated.
  Description copied from interface: Npc
  A definition containing a vast collection of data regarding this npcs creation on the world-graph

  Specified by:

  getDefinition in interface Npc

  Returns:

  The definition, otherwise null

• getAnimationId

  public int getAnimationId()

  Deprecated.
  Description copied from interface: Animable
  Gets the entities current animation id

  Specified by:

  getAnimationId in interface Animable

  Returns:

  the current animation id, or if unavailable -1

• getId

  public int getId()

  Deprecated.

  Specified by:

  getId in interface Identifiable

• isVisible

  public boolean isVisible()

  Deprecated.
  Description copied from interface: Interactable
  Whether the entity is visible

  Specified by:

  isVisible in interface Interactable

  Returns:

  true if visible, and false if not visible

• getVisibility

  public double getVisibility()

  Deprecated.
  Description copied from interface: Interactable
  Returns a rough estimate of how visible this entity is as a percent (0 to 100)

  Specified by:

  getVisibility in interface Interactable

• hasDynamicBounds

  public boolean hasDynamicBounds()

  Deprecated.

  Specified by:

  hasDynamicBounds in interface Interactable

• getInteractionPoint

  @Nullable
  public @Nullable InteractablePoint getInteractionPoint​(java.awt.Point origin)

  Deprecated.
  Description copied from interface: Interactable
  Gets a point within the entity that can be interacted with. Takes into account the direction of movement from the origin point.

  Specified by:

  getInteractionPoint in interface Interactable

• contains

  public boolean contains​(java.awt.Point point)

  Deprecated.
  Description copied from interface: Interactable
  Checks if the projected bounds of this entity contains the Point provided.

  Specified by:

  contains in interface Interactable

  Returns:

• click

  public boolean click()

  Deprecated.
  Description copied from interface: Interactable
  Clicks this entity in an interactable point

  Specified by:

  click in interface Interactable

  Returns:

  true if successfully clicked

• interact

  public boolean interact​(@Nullable
                          @Nullable java.util.regex.Pattern action,
                          @Nullable
                          @Nullable java.util.regex.Pattern target)

  Deprecated.
  Description copied from interface: Interactable
  Attempts to match action and target using Matcher.find() and then interacts with the appropriate menu item

  Specified by:

  interact in interface Interactable

  Parameters:

  action - The pattern to match the action with, if null it's ignored

  target - The pattern to match the target with, if null it's ignored

• getModel

  @Nullable
  public @Nullable Model getModel()

  Deprecated.
  Description copied from interface: Modeled
  Gets the polygon-based model of the entity

  Specified by:

  getModel in interface Modeled

  Returns:

  the entities model, otherwise the backup if set, if neither are available null

• setBackupModel

  public void setBackupModel​(int[] frontBottomLeft,
                             int[] backTopRight)

  Deprecated.
  Description copied from interface: Modeled
  Sets a backup model to be used when the model isn't available.

  Specified by:

  setBackupModel in interface Modeled

• setBackupModel

  public void setBackupModel​(com.runemate.game.api.hybrid.util.collections.Pair<int[],​int[]> values)

  Deprecated.
  Description copied from interface: Modeled
  Sets a pair of points to be used to create a backup model when the in-game model isn't available

  Specified by:

  setBackupModel in interface Modeled

• setBackupModel

  public void setBackupModel​(Model backup)

  Deprecated.

  Specified by:

  setBackupModel in interface Modeled

• setForcedModel

  public void setForcedModel​(int[] frontBottomLeft,
                             int[] backTopRight)

  Deprecated.
  Description copied from interface: Modeled
  Sets a model to be used regardless of whether the in-game model is available.

  Specified by:

  setForcedModel in interface Modeled

• setForcedModel

  public void setForcedModel​(com.runemate.game.api.hybrid.util.collections.Pair<int[],​int[]> values)

  Deprecated.
  Description copied from interface: Modeled
  Sets a pair of points to be used to create a model regardless of whether the in-game model is available

  Specified by:

  setForcedModel in interface Modeled

• setForcedModel

  public void setForcedModel​(Model forced)

  Deprecated.

  Specified by:

  setForcedModel in interface Modeled

• getName

  @Nullable
  public @Nullable java.lang.String getName()

  Deprecated.

  Specified by:

  getName in interface Onymous

• render

  public void render​(javafx.scene.canvas.GraphicsContext gc)

  Deprecated.
  Description copied from interface: Renderable
  Renders this entity onto the given GraphicsContext

  Specified by:

  render in interface Renderable

• getHighPrecisionOrientation

  public int getHighPrecisionOrientation()

  Deprecated.
  Description copied from interface: Rotatable
  For internal usage only. Subject to removal without notice.

  Specified by:

  getHighPrecisionOrientation in interface Rotatable

• getOrientationAsAngle

  public int getOrientationAsAngle()

  Deprecated.
  Description copied from interface: Rotatable
  Gets the current orientation as an angle.

  Specified by:

  getOrientationAsAngle in interface Rotatable

• isValid

  public boolean isValid()

  Deprecated.
  Description copied from interface: Validatable
  Verifies whether this entity is valid and still exists, typically on the world-graph

  Specified by:

  isValid in interface Validatable

  Returns:

  true if it's still available, otherwise false