org.osbot.rs07.api.def

Class ObjectDefinition

java.lang.Object

org.osbot.rs07.api.def.ObjectDefinition

All Implemented Interfaces:

EntityDefinition

public class ObjectDefinition
extends java.lang.Object
implements EntityDefinition

Represents the definition of an object in the game.

Constructor Summary

Constructors

Constructor and Description
ObjectDefinition(org.osbot.rs07.accessor.XObjectDefinition def)

Method Summary

Modifier and Type	Method and Description
static void	add(org.osbot.rs07.accessor.XObjectDefinition def) Caches the item definition and wraps it.
static ObjectDefinition	forId(int id) Gets the definition for an object based on it's id.
java.lang.String[]	getActions() Gets the menu actions of this object.
int	getClipping2() Deprecated.
int	getId() Gets the id of this object.
int[]	getModelIds() Gets the model ids of this object.
short[]	getModifiedModelColors() Gets what is called modified model colors of the object definition.
java.lang.String	getName() Gets the name of this object.
short[]	getOriginalModelColors() Gets what is called original model colors of the object definition.
int	getRealId() Gets the real id of this object if it's transformed.
int	getSizeX() Gets the size in the x dimension.
int	getSizeY() Gets the size in the y dimension.
int	getWalkToData() Deprecated.
boolean	isClipping1() Deprecated.
boolean	isClipping3() Deprecated.
static void	setTransformIndex(int id, int realId) Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectDefinition

public ObjectDefinition(org.osbot.rs07.accessor.XObjectDefinition def)

Method Detail

add

public static void add(org.osbot.rs07.accessor.XObjectDefinition def)

Caches the item definition and wraps it.

setTransformIndex

@Deprecated
public static void setTransformIndex(int id,
                                                  int realId)

Deprecated.

Deprecated for internal use only.

Parameters:

id - The base id of the definition

realId - The real id of the definition

forId

public static ObjectDefinition forId(int id)

Gets the definition for an object based on it's id.

Note: This method might return null because the object hasn't been loaded by the client yet!

Parameters:

id - The object id.

Returns:

The object definition.

getId

public int getId()

Gets the id of this object.

Returns:

The object id.

getRealId

public int getRealId()

Gets the real id of this object if it's transformed.

Returns:

The object id.

getName

public java.lang.String getName()

Gets the name of this object.

Returns:

The name of this object.

getSizeX

public int getSizeX()

Gets the size in the x dimension. Note that objects can exist with rotation in the world.

Returns:

The size in the x dimension.

getSizeY

public int getSizeY()

Gets the size in the y dimension. Note that objects can exist with rotation in the world.

Returns:

The size in the y dimension.

getWalkToData

@Deprecated
public int getWalkToData()

Deprecated.

Deprecated for internal use only.

isClipping3

@Deprecated
public boolean isClipping3()

Deprecated.

Deprecated for internal use only.

isClipping1

@Deprecated
public boolean isClipping1()

Deprecated.

Deprecated for internal use only.

getClipping2

@Deprecated
public int getClipping2()

Deprecated.

Deprecated for internal use only.

getModelIds

public int[] getModelIds()

Gets the model ids of this object.

Specified by:

getModelIds in interface EntityDefinition

Returns:

The model ids of this object.

getActions

public java.lang.String[] getActions()

Gets the menu actions of this object.

Specified by:

getActions in interface EntityDefinition

Returns:

The menu actions of this object.

getModifiedModelColors

public short[] getModifiedModelColors()

Gets what is called modified model colors of the object definition.

Specified by:

getModifiedModelColors in interface EntityDefinition

Returns:

The modified model colors array.

getOriginalModelColors

public short[] getOriginalModelColors()

Gets what is called original model colors of the object definition.

Specified by:

getOriginalModelColors in interface EntityDefinition

Returns:

The original model colors array.