Package net.runelite.api

Interface WorldEntity

All Superinterfaces:

CameraFocusableEntity

public interface WorldEntity
extends CameraFocusableEntity

Field Summary

Fields

Modifier and Type	Field	Description
static int	OWNER_TYPE_NOT_PLAYER
static int	OWNER_TYPE_OTHER_PLAYER
static int	OWNER_TYPE_SELF_PLAYER

Method Summary

Modifier and Type	Method	Description
WorldEntityConfig	getConfig()
LocalPoint	getLocalLocation()	Get the location of this world entity in the top level world.
int	getOrientation()	Get the orientation of this world entity in the top level world.
int	getOwnerType()
LocalPoint	getTargetLocation()	Get the destination that the WorldEntity is moving toward.
int	getTargetOrientation()	Get the target orientation of this world entity in the top level world.
WorldView	getWorldView()
boolean	isHiddenForOverlap()	Return true if this worldentity is overlapped
LocalPoint	transformToMainWorld(LocalPoint point)	Transform a point within the world entity to the overworld

Methods inherited from interface net.runelite.api.CameraFocusableEntity

getCameraFocus

Field Detail

OWNER_TYPE_NOT_PLAYER

static final int OWNER_TYPE_NOT_PLAYER

See Also:

Constant Field Values

OWNER_TYPE_OTHER_PLAYER

static final int OWNER_TYPE_OTHER_PLAYER

See Also:

Constant Field Values

OWNER_TYPE_SELF_PLAYER

static final int OWNER_TYPE_SELF_PLAYER

See Also:

Constant Field Values

Method Detail

getWorldView

WorldView getWorldView()

Specified by:

getWorldView in interface CameraFocusableEntity

getLocalLocation

LocalPoint getLocalLocation()

Get the location of this world entity in the top level world.

Returns:

getOrientation

int getOrientation()

Get the orientation of this world entity in the top level world.

Returns:

getTargetLocation

LocalPoint getTargetLocation()

Get the destination that the WorldEntity is moving toward. After receiving a destination from the server, the client will interpolate movement along this route until the next game tick (with some added buffer for lag compensation).

Returns:

The target LocalPoint in the top-level WorldView.

getTargetOrientation

int getTargetOrientation()

Get the target orientation of this world entity in the top level world.

Returns:

See Also:

getTargetLocation()

transformToMainWorld

LocalPoint transformToMainWorld(LocalPoint point)

Transform a point within the world entity to the overworld

Parameters:

point -

Returns:

isHiddenForOverlap

boolean isHiddenForOverlap()

Return true if this worldentity is overlapped

Returns:

getConfig

WorldEntityConfig getConfig()

getOwnerType

int getOwnerType()