Character

java.lang.Object
- org.osbot.core.api.Wrapper<Bot,C>
- - org.osbot.rs07.api.RS07Wrapper<C>
  - - org.osbot.rs07.api.model.Modeled<A>
    - - org.osbot.rs07.api.model.Animable<C>
      - org.osbot.rs07.api.model.Character<C>

All Implemented Interfaces:

Entity, Identifiable, Interactable, Vector3D

Direct Known Subclasses:

NPC, Player
```
public abstract class Character<C extends org.osbot.rs07.accessor.XCharacter<?>>
extends Animable<C>
implements Entity
```
Represents an in-game player or NPC.

Field Summary
- Fields inherited from class org.osbot.rs07.api.model.Modeled
  model, prioritized
- Fields inherited from class org.osbot.core.api.Wrapper
  accessor

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`getAnimation()` Gets the current animation id of the character.
`int`	`getAnimation2()` Gets the current animation2 id of the character.
`int`	`getAnimationDelay()` Gets the current animation delay of the character.
`int`	`getAnimationSpot()` Deprecated.
`int`	`getAnimationStanding()` Gets the current standing animation of the character.
`int`	`getCombatTime()` Deprecated. replaced by `getHitBarLoopCycle()`
`int`	`getCurrentHealth()` Deprecated. Returns health percent
`int`	`getGridX()` Gets the grid x coordinate for this entity.
`int`	`getGridY()` Gets the grid y coordinate for this entity.
`java.lang.String`	`getHeadMessage()` Gets the chat message above the character.
`int`	`getHealth()` Deprecated. Returns health percent
`int`	`getHealthPercent()` Gets the health in percentage form. (0% - 100%).
`int`	`getHealthPercentCache()` Gets the most recent health percent.
`int`	`getHitBarLoopCycle()` Gets the last client loop cycle counter value a hit was inflicted on this character.
`abstract int`	`getIndex()` Gets the index of this character
`Character<?>`	`getInteracting()` Gets the character that this character is currently facing/interacting.
`int`	`getLocalX()` Gets the local x coordinate for this entity.
`int`	`getLocalY()` Gets the local y coordinate for this entity.
`int`	`getMaximumHealth()` Deprecated. Returns 100 by default.
`abstract int`	`getPrayerIcon()`
`java.util.List<HeadMessage>`	`getRecentMessages()` Gets the recent head messages (up to 30 seconds)
`int`	`getRotation()` Gets the rotation of this character.
`int`	`getRotationForCamera()` Gets the rotation of this character in the same coordinate system as the camera system.
`int`	`getSizeX()` Gets the size of this entity in the x dimension.
`int`	`getSizeY()` Gets the size of this entity in the y dimension.
`int`	`getWalkingQueueSize()` Gets the walking queue size of this character
`int[]`	`getWalkingQueueX()` Gets the walking queue for x coordinates of this character with the movement for the first to come client cycle to process
`int[]`	`getWalkingQueueY()` Gets the walking queue for y coordinates of this character with the movement for the first to come client cycle to process
`int`	`getX()` Gets the x coordinate for this entity.
`int`	`getY()` Gets the y coordinate for this entity.
`int`	`getZ()` Gets the z coordinate for this entity.
`boolean`	`hasMentionedPhrase(java.lang.String phrase, long maxTime)` Checks if any of the character's recent head messages contains a certain phrase/string.
`boolean`	`hasMentionedPhrase(java.lang.String phrase, long minTime, long maxTime)` Checks if any of the character's recent head messages contains a certain phrase/string.
`boolean`	`hover()` Attempts to hover the mouse over the next click needed to interact with this `Interactable`.
`boolean`	`isAnimating()` Whether the character is performing an animation.
`boolean`	`isAttackable()` Whether this character is attackable.
`boolean`	`isHitBarVisible()` Checks if the hit bar of this character is visible
`boolean`	`isInteracting(Character<?> character)` Returns whether this character is facing/interacting with the specified character.
`boolean`	`isMoving()` Checks if this character is moving
`boolean`	`isUnderAttack()` Whether the character is under attack.

Methods inherited from class org.osbot.rs07.api.model.Animable
getAnimable, getModelHeight

Methods inherited from class org.osbot.rs07.api.model.Modeled
getHeight, getModel, isPrioritized, setPrioritized, updateModel

Methods inherited from class org.osbot.rs07.api.RS07Wrapper
getClient, getMethods

Methods inherited from class org.osbot.core.api.Wrapper
equals, getBot, supplyWrappers, wrap, wrapArray

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.osbot.rs07.api.model.Entity
exists, getArea, getBot, getClient, getDefinition, getHeight, getModel, getPosition, hasAction, interact, isVisible

Methods inherited from interface org.osbot.rs07.api.model.Identifiable
getActions, getId, getModelIds, getName

- Method Detail
  - getIndex
```
public abstract int getIndex()
```
    Gets the index of this character
    
    Returns:
    
    The index of this character
  - getPrayerIcon
```
public abstract int getPrayerIcon()
```
    Returns:
    
    The prayer icon above the character
  - getSizeX
```
public int getSizeX()
```
    Gets the size of this entity in the x dimension. Note that entities can appear rotated in the world.
    
    Specified by:
    
    getSizeX in interface Entity
    
    Returns:
    
    The size of this entity in the x dimension.
  - getSizeY
```
public int getSizeY()
```
    Gets the size of this entity in the y dimension. Note that entities can appear rotated in the world.
    
    Specified by:
    
    getSizeY in interface Entity
    
    Returns:
    
    The size of this entity in the y dimension.
  - getX
```
public int getX()
```
    Gets the x coordinate for this entity.
    
    Specified by:
    
    getX in interface Entity
    
    Specified by:
    
    getX in interface Vector3D
    
    Returns:
    
    The x coordinate for this entity.
  - getY
```
public int getY()
```
    Gets the y coordinate for this entity.
    
    Specified by:
    
    getY in interface Entity
    
    Specified by:
    
    getY in interface Vector3D
    
    Returns:
    
    The y coordinate for this entity.
  - getZ
```
public int getZ()
```
    Gets the z coordinate for this entity.
    
    Specified by:
    
    getZ in interface Entity
    
    Specified by:
    
    getZ in interface Vector3D
    
    Returns:
    
    The z coordinate for this entity.
  - getLocalX
```
public int getLocalX()
```
    Gets the local x coordinate for this entity. This is the x coordinate within the loaded region and ranged between 0 and 103.
    
    Specified by:
    
    getLocalX in interface Entity
    
    Returns:
    
    The local x coordinate.
  - getLocalY
```
public int getLocalY()
```
    Gets the local y coordinate for this entity. This is the y coordinate within the loaded region and ranged between 0 and 103.
    
    Specified by:
    
    getLocalY in interface Entity
    
    Returns:
    
    The local y coordinate.
  - getWalkingQueueX
```
public int[] getWalkingQueueX()
```
    Gets the walking queue for x coordinates of this character with the movement for the first to come client cycle to process
    
    Returns:
    
    The walking queue for x coordinates of this character with the movement for the first to come client cycle to process
  - getWalkingQueueY
```
public int[] getWalkingQueueY()
```
    Gets the walking queue for y coordinates of this character with the movement for the first to come client cycle to process
    
    Returns:
    
    The walking queue for y coordinates of this character with the movement for the first to come client cycle to process
  - getWalkingQueueSize
```
public int getWalkingQueueSize()
```
    Gets the walking queue size of this character
    
    Returns:
    
    The walking queue size of this character
  - isMoving
```
public boolean isMoving()
```
    Checks if this character is moving
    
    Returns:
    
    True if this character is moving
  - getGridX
```
public int getGridX()
```
    Gets the grid x coordinate for this entity. This is a more accurate grid than the conventional coordinate grid, where each tile is divided in 32 x 32 tiles.
    
    Specified by:
    
    getGridX in interface Entity
    
    Returns:
    
    The grid x coordinate.
  - getGridY
```
public int getGridY()
```
    Gets the grid y coordinate for this entity. This is a more accurate grid than the conventional coordinate grid, where each tile is divided in 32 x 32 tiles.
    
    Specified by:
    
    getGridY in interface Entity
    
    Returns:
    
    The grid y coordinate.
  - getRotation
```
public int getRotation()
```
    Gets the rotation of this character. This works in a clockwise system starting with SOUTH. SOUTH = 0 or 2048, WEST = 512, NORTH = 1024, EAST = 1536
    
    Returns:
    
    The rotation of this character.
  - getRotationForCamera
```
public int getRotationForCamera()
```
    Gets the rotation of this character in the same coordinate system as the camera system. This works in a counter-clockwise system starting with NORTH. NORTH = 0 or 360, WEST = 90, SOUTH = 180, EAST = 270
    
    Returns:
    
    The rotation of this character.
  - getHeadMessage
```
public java.lang.String getHeadMessage()
```
    Gets the chat message above the character.
    
    Returns:
    
    Null or empty if there is no chat, otherwise the chat message.
  - getAnimation
```
public int getAnimation()
```
    Gets the current animation id of the character.
    
    Returns:
    
    The current animation id of the character.
  - getAnimation2
```
public int getAnimation2()
```
    Gets the current animation2 id of the character.
    
    Returns:
    
    The current animation2 id of the character.
  - getAnimationDelay
```
public int getAnimationDelay()
```
    Gets the current animation delay of the character.
    
    Returns:
    
    The current animation delay of the character.
  - getAnimationSpot
```
@Deprecated
public int getAnimationSpot()
```
    Deprecated.
    
    Deprecated, use Character#getSpotAnimation()
    
    Returns:
    
    -1
  - getAnimationStanding
```
public int getAnimationStanding()
```
    Gets the current standing animation of the character.
    
    Returns:
    
    The current standing animation of the character.
  - isAnimating
```
public boolean isAnimating()
```
    Whether the character is performing an animation. If it's in a sequence of animations, but stopped temporarily, it will still return true.
    
    Returns:
    
    True if performing an animation.
  - isUnderAttack
```
public boolean isUnderAttack()
```
    Whether the character is under attack.
    
    Returns:
    
    False if the hitbar is not visible. True if the hitbar is visible and this character is interacting with another character.
  - isAttackable
```
public boolean isAttackable()
```
    Whether this character is attackable. Checks for the health to be higher than zero.
    
    Returns:
    
    True is the character is attackable. In single zone areas this means no other character is attacking this character, or when you are already attacking this character. In multi-zone the character is attackable regardless of other characters attacking it.
  - isHitBarVisible
```
public boolean isHitBarVisible()
```
    Checks if the hit bar of this character is visible
    
    Returns:
    
    true if the hit bar of this character is visible
  - getCombatTime
```
@Deprecated
public int getCombatTime()
```
    Deprecated. replaced by getHitBarLoopCycle()
    
    Gets the last client loop cycle counter value a hit was inflicted on this character.
    
    Returns:
    
    The last client loop cycle counter value a hit was inflicted on this character.
  - getHitBarLoopCycle
```
public int getHitBarLoopCycle()
```
    Gets the last client loop cycle counter value a hit was inflicted on this character.
    
    Returns:
    
    The last client loop cycle counter value a hit was inflicted on this character.
  - getInteracting
```
public Character<?> getInteracting()
```
    Gets the character that this character is currently facing/interacting.
    
    Returns:
    
    The character.
  - isInteracting
```
public boolean isInteracting(Character<?> character)
```
    Returns whether this character is facing/interacting with the specified character.
    
    Parameters:
    
    character - The specified character.
    
    Returns:
    
    True if interacting.
  - getCurrentHealth
```
@Deprecated
public int getCurrentHealth()
```
    Deprecated. Returns health percent
    
    Returns:
    
    The current health of the character.
  - getMaximumHealth
```
@Deprecated
public int getMaximumHealth()
```
    Deprecated. Returns 100 by default.
    
    Returns:
    
    The maximum health of the character.
  - getHealth
```
@Deprecated
public int getHealth()
```
    Deprecated. Returns health percent
    
    Returns:
    
    The current health of the character.
  - getHealthPercent
```
public int getHealthPercent()
```
    Gets the health in percentage form. (0% - 100%). Please note: this is only updated in combat, which means if you got out of combat and then your hp changed, this won't reflect this. For this you should use the actual skills to check. This will return 100% if it cannot access the information. Use getHealthPercentCache() if you want older info.
    
    Returns:
    
    The percentage of health.
  - getHealthPercentCache
```
public int getHealthPercentCache()
```
    Gets the most recent health percent. This may return outdated information.
    
    Returns:
    
    The most recent health percent. This may return outdated information.
  - hover
```
public boolean hover()
```
    Attempts to hover the mouse over the next click needed to interact with this Interactable. This method will never click the mouse, so it can be used to speed up scripts while they are idling.
    
    Specified by:
    
    hover in interface Interactable
  - getRecentMessages
```
public java.util.List<HeadMessage> getRecentMessages()
```
    Gets the recent head messages (up to 30 seconds)
    
    Returns:
    
    The recent head messages (up to 30 seconds)
  - hasMentionedPhrase
```
public boolean hasMentionedPhrase(java.lang.String phrase,
                                  long maxTime)
```
    Checks if any of the character's recent head messages contains a certain phrase/string.
    
    Parameters:
    
    phrase - The phrase to check for.
    
    maxTime - The amount of time to look for in the past (up to 30 seconds) in milliseconds.
    
    Returns:
    
    If the phrase has been mentioned.
  - hasMentionedPhrase
```
public boolean hasMentionedPhrase(java.lang.String phrase,
                                  long minTime,
                                  long maxTime)
```
    Checks if any of the character's recent head messages contains a certain phrase/string. Looks for any messages between minTime milliseconds and maxTime milliseconds in the past.
    
    Parameters:
    
    phrase - The phrase to check for.
    
    minTime - The amount of time to in the past to skip (up to 30 seconds) in milliseconds.
    
    maxTime - The amount of time to look for in the past (up to 30 seconds) in milliseconds.
    
    Returns:
    
    If the phrase has been mentioned.

Class Character<C extends org.osbot.rs07.accessor.XCharacter<?>>

Field Summary

Fields inherited from class org.osbot.rs07.api.model.Modeled

Fields inherited from class org.osbot.core.api.Wrapper

Method Summary

Methods inherited from class org.osbot.rs07.api.model.Animable

Methods inherited from class org.osbot.rs07.api.model.Modeled

Methods inherited from class org.osbot.rs07.api.RS07Wrapper

Methods inherited from class org.osbot.core.api.Wrapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.osbot.rs07.api.model.Entity

Methods inherited from interface org.osbot.rs07.api.model.Identifiable

Method Detail

getIndex

getPrayerIcon

getSizeX

getSizeY

getX

getY

getZ

getLocalX

getLocalY

getWalkingQueueX

getWalkingQueueY

getWalkingQueueSize

isMoving

getGridX

getGridY

getRotation

getRotationForCamera

getHeadMessage

getAnimation

getAnimation2

getAnimationDelay

getAnimationSpot

getAnimationStanding

isAnimating

isUnderAttack

isAttackable

isHitBarVisible

getCombatTime

getHitBarLoopCycle

getInteracting

isInteracting

getCurrentHealth

getMaximumHealth

getHealth

getHealthPercent

getHealthPercentCache

hover

getRecentMessages

hasMentionedPhrase

hasMentionedPhrase