Package org.dreambot.api.wrappers.items

Class GroundItem

java.lang.Object

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

org.dreambot.api.wrappers.interactive.Entity

org.dreambot.api.wrappers.items.GroundItem

All Implemented Interfaces:

Identifiable, Locatable, Verified

public class GroundItem
extends Entity

Constructor Summary

Constructors

Constructor	Description
GroundItem(org.dreambot.internal.injector.interfaces.RSItemLayer itemLayer, java.lang.Object itemReference)	Note: This shouldn't be used by API users, it's an internal constructor.

Method Summary

Modifier and Type	Method	Description
boolean	exists()	Determines where or not this object exists in game.
java.lang.String[]	getActions()
int	getAmount()
java.awt.Rectangle	getBoundingBox()	Gets the bounding box for the entity's model
int	getGridX()	Gets grid (local) X coordinate of the given object.
int	getGridY()	Gets grid (local) Y coordinate of the given object.
int	getHeight()
int	getId()	Gets ID number of the given object.
Item	getItem()
int	getLocalX()
int	getLocalY()
java.lang.String	getName()	Gets the name of the entity
int	getPlane()
int	getRenderableHeight()
Tile	getTile()	Gets tile of the object.
int	getX()	Gets X coordinate of the given object.
int	getY()	Gets Y coordinate of the given object.
int	getZ()	Gets Z coordinate of the given object.
boolean	hasAction(java.lang.String... actions)	Checks whether given actions are in the list of menu actions for an entity
boolean	isOnScreen()	Checks whether the entity is visible on the game screen
void	setTile(Tile t)
void	setZ(int z)
java.lang.String	toString()

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

canReach, distance, distance, distance, equals, getCenterPoint, getClickablePoint, getLeftClickAction, getModel, getReference, getSurroundingArea, getTileReference, hashCode, interact, interact, interact, interact, interact, interactForceLeft, interactForceRight, 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.Identifiable

getID

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

canReach, getRegionId, tileDistance

Constructor Detail

GroundItem

public GroundItem(org.dreambot.internal.injector.interfaces.RSItemLayer itemLayer,
                  java.lang.Object itemReference)

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

Method Detail

getTile

public Tile getTile()

Description copied from interface: Locatable

Gets tile of the object.

Specified by:

getTile in interface Locatable

Overrides:

getTile in class Entity

Returns:

the object tile.

setTile

public void setTile(Tile t)

getHeight

public int getHeight()

getId

public int getId()

Description copied from interface: Identifiable

Gets ID number of the given object.

Returns:

the ID number as integer.

getAmount

public int getAmount()

getPlane

public int getPlane()

getLocalX

public int getLocalX()

getLocalY

public int getLocalY()

getX

public int getX()

Description copied from interface: Locatable

Gets X coordinate of the given object.

Returns:

the X coordinate of the object.

getY

public int getY()

Description copied from interface: Locatable

Gets Y coordinate of the given object.

Returns:

the Y coordinate of the object.

getGridX

public int getGridX()

Description copied from interface: Locatable

Gets grid (local) X coordinate of the given object.

Returns:

the grid X coordinate of the object.

getGridY

public int getGridY()

Description copied from interface: Locatable

Gets grid (local) Y coordinate of the given object.

Returns:

the grid Y coordinate of the object.

getZ

public int getZ()

Description copied from interface: Locatable

Gets Z coordinate of the given object.

Returns:

the Z coordinate of the object.

setZ

public void setZ(int z)

isOnScreen

public boolean isOnScreen()

Description copied from class: Entity

Checks whether the entity is visible on the game screen

Overrides:

isOnScreen in class Entity

Returns:

true if the entity is visible

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

getRenderableHeight

public int getRenderableHeight()

Specified by:

getRenderableHeight in class Entity

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

hasAction

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

Description copied from class: Entity

Checks whether given actions are in the list of menu actions for an entity

Specified by:

hasAction in class Entity

Parameters:

actions - actions to check

Returns:

true if all actions are in the list of menu actions

getActions

public java.lang.String[] getActions()

Specified by:

getActions in class Entity

getItem

public Item getItem()

exists

public boolean exists()

Description copied from interface: Verified

Determines where or not this object exists in game.

Specified by:

exists in interface Verified

Overrides:

exists in class Entity

Returns:

true, if the object exist, otherwise false.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object