Package org.dreambot.api.wrappers.interactive

Class Player

java.lang.Object

org.dreambot.api.wrappers.interactive.interact.Interactable

org.dreambot.api.wrappers.interactive.Entity

org.dreambot.api.wrappers.interactive.Character

org.dreambot.api.wrappers.interactive.Player

All Implemented Interfaces:

Identifiable, Locatable, Verified

public class Player
extends Character

Constructor Summary

Constructors

Constructor	Description
Player(java.lang.Object reference)	Note: This shouldn't be used by API users, it's an internal constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String[]	getActions()	Gets the actions available for a player.
java.awt.Rectangle	getBoundingBox()	Gets the bounding box for the entity's model
PlayerComposite	getComposite()
java.util.List<Item>	getEquipment()	Gets a list of Items that the player is wearing based on PlayerComposite.getAppearance() and adjusting the value to translate from appearance to item.
int	getID()	Gets ID number of the given object.
int	getIndex()	Gets the index of this Character.
int	getLevel()	Gets the Character's combat level.
java.lang.String	getName()	Gets the name of the entity
NameComposite	getNameComposite()
int	getOverheadIcon()
int	getSkullIcon()
int	getTeam()
boolean	hasAction(java.lang.String... actions)	Determines if player contains at least one of the following actions.
java.lang.String	hashed()
java.lang.String	hashed(java.lang.String prepend, java.lang.String append)
boolean	isHidden()
boolean	isSkulled()
void	setIndex(int index)
java.lang.String	toString()

Methods inherited from class org.dreambot.api.wrappers.interactive.Character

canAttack, exists, getAnimation, getAnimationDelay, getCharacterInteractingWithMe, getCharactersInteractingWithMe, getCombatTime, getFacingDirection, getGridX, getGridY, getHeadFrame, getHealthPercent, getHitSplatCycles, getHitSplatIds, getHitSplats, getHitSplatSpecials, getHitSplatTypes, getInteractingCharacter, getInteractingIndex, getLocalX, getLocalY, getOrientation, getOverhead, getQueueSize, getQueueX, getQueueY, getRenderableHeight, getServerTile, getSmoothOrientation, getSpotAnimation, getStandAnimation, getTailFrame, getUID, getWalkAnimation, getWalkingQueueSpeed, getX, getY, getZ, isAnimating, isHealthBarVisible, isInCombat, isInteractedWith, isInteracting, isMoving, isStandingStill

Methods inherited from class org.dreambot.api.wrappers.interactive.Entity

canReach, distance, distance, distance, equals, getCenterPoint, getClickablePoint, getLeftClickAction, getModel, getReference, getSurroundingArea, getTile, getTileReference, hashCode, interact, interact, interact, interact, interact, interactForceLeft, interactForceRight, isOnScreen, walkingDistance

Methods inherited from class org.dreambot.api.wrappers.interactive.interact.Interactable

hover, rightClick

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dreambot.api.wrappers.interactive.Locatable

canReach, tileDistance

Constructor Detail

Player

public Player(java.lang.Object reference)

Note: This shouldn't be used by API users, it's an internal constructor.

Method Detail

getOverheadIcon

public int getOverheadIcon()

getTeam

public int getTeam()

getComposite

public PlayerComposite getComposite()

getLevel

public int getLevel()

Description copied from class: Character

Gets the Character's combat level.

Specified by:

getLevel in class Character

Returns:

the combat level of this Character.

getSkullIcon

public int getSkullIcon()

isSkulled

public boolean isSkulled()

isHidden

public boolean isHidden()

getNameComposite

public NameComposite getNameComposite()

getName

public java.lang.String getName()

Description copied from class: Entity

Gets the name of the entity

Specified by:

getName in interface Identifiable

Specified by:

getName in class Entity

Returns:

name of entity

getIndex

public int getIndex()

Description copied from class: Character

Gets the index of this Character.

Specified by:

getIndex in class Character

Returns:

this index location.

setIndex

public void setIndex(int index)

getBoundingBox

public java.awt.Rectangle getBoundingBox()

Description copied from class: Entity

Gets the bounding box for the entity's model

Overrides:

getBoundingBox in class Entity

Returns:

bounding box of model

getID

public int getID()

Description copied from interface: Identifiable

Gets ID number of the given object.

Returns:

the ID number as integer.

hasAction

public boolean hasAction(java.lang.String... actions)

Determines if player contains at least one of the following actions.

Specified by:

hasAction in class Entity

Parameters:

actions - actions to check

Returns:

boolean which is true if player has at least one of the possible actions, otherwise it is false.

getActions

public java.lang.String[] getActions()

Gets the actions available for a player. This array DOES contain null values. Values returned here will update during wildy

Specified by:

getActions in class Entity

Returns:

Current available actions for a player

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEquipment

public java.util.List<Item> getEquipment()

Gets a list of Items that the player is wearing based on PlayerComposite.getAppearance() and adjusting the value to translate from appearance to item.

Returns:

List of items player is wearing, empty if items not found, note specific slot information is not filled in.

hashed

public java.lang.String hashed()

hashed

public java.lang.String hashed(java.lang.String prepend,
                               java.lang.String append)