org.osbot.rs07.api.model

Class InteractableObject

java.lang.Object

org.osbot.core.api.Wrapper<Bot,C>

org.osbot.rs07.api.RS07Wrapper<C>

org.osbot.rs07.api.model.Modeled<org.osbot.rs07.accessor.XInteractableObject>

org.osbot.rs07.api.model.InteractableObject

All Implemented Interfaces:

Entity, Identifiable, Interactable, RS2Object, Vector3D

public class InteractableObject
extends Modeled<org.osbot.rs07.accessor.XInteractableObject>
implements RS2Object

Represents any in-game model including players, NPCs, objects, projectiles, etc.

Field Summary

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

model, prioritized

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

accessor

Constructor Summary

Constructors

Constructor and Description
InteractableObject(org.osbot.rs07.accessor.XInteractableObject instance) Constructor

Method Summary

Modifier and Type	Method and Description
Animable<?>	getAnimable() Gets the Animable instance.
int	getAnimationId() Gets the current animation of this object, -1 if not animating
int	getConfig() Gets the config for this object.
int	getGridX() Gets the grid x coordinate for this entity.
int	getGridY() Gets the grid y coordinate for this entity.
int	getLocalX() Gets the local x coordinate for this entity.
int	getLocalY() Gets the local y coordinate for this entity.
int	getOrientation() Gets the orientation for this object.
int	getSizeX() Gets the size of this entity in the x dimension.
int	getSizeY() Gets the size of this entity in the y dimension.
long	getUUID() Gets the UID for this object.
boolean	isGameObject() Determines whether this primary object is an instance of a game object.
boolean	isGroundObject() Determines whether this primary object is an instance of a ground object.
boolean	isNPC() Determines whether this primary object is an instance of an NPC object.
boolean	isPlayer() Determines whether this primary object is an instance of a Player object.

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.RS2Object

getActions, getDefinition, getId, getModelIds, getName, getType, getUID, getX, getY, getZ, hover

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

exists, getArea, getBot, getClient, getHeight, getModel, getPosition, hasAction, interact, isVisible

Constructor Detail

InteractableObject

public InteractableObject(org.osbot.rs07.accessor.XInteractableObject instance)

Constructor

Parameters:

instance - The XInteractableObject instance

Method Detail

getAnimable

public Animable<?> getAnimable()

Gets the Animable instance.

Specified by:

getAnimable in class Modeled<org.osbot.rs07.accessor.XInteractableObject>

Returns:

The Animable instance.

getUUID

public long getUUID()

Gets the UID for this object.

Specified by:

getUUID in interface RS2Object

Returns:

The UID for this object.

isPlayer

public boolean isPlayer()

Determines whether this primary object is an instance of a Player object.

Returns:

True if this primary object is an instance of a player object.

isNPC

public boolean isNPC()

Determines whether this primary object is an instance of an NPC object.

Returns:

True if this primary object is an instance of an NPC object.

isGameObject

public boolean isGameObject()

Determines whether this primary object is an instance of a game object.

Returns:

True if this primary object is an instance of a game object.

isGroundObject

public boolean isGroundObject()

Determines whether this primary object is an instance of a ground object.

Returns:

True if this primary object is an instance of a ground object.

getConfig

public int getConfig()

Gets the config for this object.

Specified by:

getConfig in interface RS2Object

Returns:

The config for this object.

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

Specified by:

getLocalX in interface RS2Object

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

Specified by:

getLocalY in interface RS2Object

Returns:

The local y coordinate.

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

Specified by:

getGridX in interface RS2Object

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

Specified by:

getGridY in interface RS2Object

Returns:

The grid y coordinate.

getOrientation

public int getOrientation()

Gets the orientation for this object.

Specified by:

getOrientation in interface RS2Object

Returns:

The orientation for this object.

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

Specified by:

getSizeX in interface RS2Object

Returns:

The size of this entity in the x dimension.

getAnimationId

public int getAnimationId()

Gets the current animation of this object, -1 if not animating

Returns:

The current animation of this object, -1 if not animating

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

Specified by:

getSizeY in interface RS2Object

Returns:

The size of this entity in the y dimension.