Package com.osrsbots.orb.api.interactables.types

Class RSObject

java.lang.Object

com.osrsbots.orb.api.interactables.types.RSObject

All Implemented Interfaces:

java.io.Serializable

public class RSObject
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RSObject.RSItemAdapter
static class	RSObject.Type

Field Summary

Fields

Modifier and Type	Field	Description
long	hash
net.runelite.api.Tile	tile
RSObject.Type	type

Constructor Summary

Constructors

Constructor	Description
RSObject(@NotNull RSObject.Type type, long hash, int orientation, int orientationA, int orientationB, @NotNull net.runelite.api.ObjectComposition composition)
RSObject(net.runelite.api.DecorativeObject o, net.runelite.api.Tile t)
RSObject(net.runelite.api.GameObject o, net.runelite.api.Tile t)
RSObject(net.runelite.api.GroundObject o, net.runelite.api.Tile t)
RSObject(net.runelite.api.WallObject o, net.runelite.api.Tile t)

Method Summary

Modifier and Type	Method	Description
boolean	clickBounds()
int	distanceToPlayer()
boolean	doAction(java.lang.String option)
boolean	doAction(net.runelite.api.MenuAction type, java.lang.String option)
@Nullable java.lang.String[]	getActions()
@Nullable java.awt.Shape	getClickbox()
int	getId()
int	getMapIconId()
int	getMapSceneId()
java.lang.String	getName()
int	getSizeX()
int	getSizeY()
int	getVarbitId()
int	getVarPlayerId()
net.runelite.api.coords.WorldPoint	getWorldLocation()
void	highlight()
boolean	hover()
boolean	interact(@Nullable net.runelite.api.MenuAction type, java.lang.String option)
boolean	interact(java.lang.String option)
boolean	isInScene()
boolean	isInteractable()
boolean	isReachable()
java.lang.String	toString()
boolean	useItem(RSItem rsi)
boolean	useWith(RSItem rsi)

Methods inherited from class java.lang.Object

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

Field Detail

type

@Nonnull
@SerializedName("type")
public final RSObject.Type type

hash

@SerializedName("hash")
public final long hash

tile

@Nonnull
@SerializedName("tile")
public net.runelite.api.Tile tile

Constructor Detail

RSObject

public RSObject(@Nonnull
                net.runelite.api.GameObject o,
                @Nonnull
                net.runelite.api.Tile t)

RSObject

public RSObject(@Nonnull
                net.runelite.api.WallObject o,
                @Nonnull
                net.runelite.api.Tile t)

RSObject

public RSObject(@Nonnull
                net.runelite.api.GroundObject o,
                @Nonnull
                net.runelite.api.Tile t)

RSObject

public RSObject(@Nonnull
                net.runelite.api.DecorativeObject o,
                @Nonnull
                net.runelite.api.Tile t)

RSObject

public RSObject(@NotNull
                @NotNull RSObject.Type type,
                long hash,
                int orientation,
                int orientationA,
                int orientationB,
                @NotNull
                @NotNull net.runelite.api.ObjectComposition composition)

Method Detail

doAction

public boolean doAction(@Nonnull
                        java.lang.String option)

doAction

public boolean doAction(@Nonnull
                        net.runelite.api.MenuAction type,
                        @Nonnull
                        java.lang.String option)

interact

public boolean interact(@Nonnull
                        java.lang.String option)

interact

public boolean interact(@Nullable
                        @Nullable net.runelite.api.MenuAction type,
                        @Nonnull
                        java.lang.String option)

useItem

public boolean useItem(@Nonnull
                       RSItem rsi)

highlight

public void highlight()

clickBounds

public boolean clickBounds()

getClickbox

@Nullable
public @Nullable java.awt.Shape getClickbox()

hover

public boolean hover()

isReachable

public boolean isReachable()

useWith

public boolean useWith(@Nonnull
                       RSItem rsi)

distanceToPlayer

public int distanceToPlayer()

isInteractable

public boolean isInteractable()

getWorldLocation

@Nonnull
public net.runelite.api.coords.WorldPoint getWorldLocation()

isInScene

public boolean isInScene()

getName

@Nonnull
public java.lang.String getName()

getActions

@Nullable
public @Nullable java.lang.String[] getActions()

getId

public int getId()

getMapSceneId

public int getMapSceneId()

getMapIconId

public int getMapIconId()

getVarbitId

public int getVarbitId()

getVarPlayerId

public int getVarPlayerId()

getSizeX

public int getSizeX()

getSizeY

public int getSizeY()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object