Package net.runelite.api

Interface Summary

Interface	Description
AABB
Actor	Represents a RuneScape actor/entity.
ActorSpotAnim
AmbientSoundEffect	An ambient sound effect.
Animation	Represents an animation of a renderable
BufferProvider	Represents an engine graphic buffer.
ChatLineBuffer	Represents the buffer containing all messages in the chatbox.
ChatPlayer	Represents a player in the chat.
Client	Represents the RuneScape client.
CollisionData	Represents tile collision data for the scene
ColorTextureOverride	Represents overridden color/texture replacements for an item.
DecorativeObject	Represents a decorative object, such as an object on a wall.
Deque<T>	A doubly linked list
DynamicObject	An animated object
EnumComposition
FloatProjection
FontTypeFace	A bitmap Font in Jagex's format
Friend	Represents a player in the friends list.
FriendContainer	A nameable container of friends
FriendsChatManager
FriendsChatMember	Represents a friends chat member.
GameEngine	Represents the client game engine.
GameObject	Represents a game object.
GrandExchangeOffer	Represents an offer in a grand exchange slot.
GraphicsObject	Represents a graphics object/spotanim.
GroundObject	Represents an object on the ground of a tile.
HashTable<T extends Node>	A data structure that uses a hash function to compute an index into an array of buckets from which node objects can be quickly obtained.
HealthBarConfig
Ignore	An entry on the ignore list.
IndexDataBase	Represents an index in the cache
IndexedSprite	Represents an paletted sprite.
IntegerNode	Represents an integer typically in a HashTable.
IntProjection
ItemComposition	Represents the template of a specific item type.
ItemContainer	Represents an inventory that contains items.
ItemLayer	Represents a pile of items held by a tile.
IterableHashTable<T extends Node>
MainBufferProvider	Represents the clients primary image buffer.
Menu	The client minimenu.
MenuEntry	A menu entry in a right-click menu.
Mesh<T extends Mesh<T>>	A Model or ModelData
MessageNode	Represents a message in the chatbox.
MidiRequest
Model	Represents the model of an object.
ModelData	An unlit model
Nameable	Represents a chat entity that has a name.
NameableContainer<T extends Nameable>
Node	Represents a doubly linked node.
NodeCache	Represents a doubly linked node cache.
NPC	Represents a non-player character in the game.
NPCComposition	Information about a specific NpcID
NpcOverrides	Dynamically applied NPC effects
ObjectComposition	Information about a specific ObjectID
PacketBuffer
ParamHolder	A composition that can hold `param` keys.
PendingLogin	A pending friend login/out.
Player	Represents a player entity in the game.
PlayerComposition	Represents the template of a player.
Preferences	Stores the clients persisting preferences.
Projectile	Represents a projectile entity.
Projection
Rasterizer	Jagex 2D and 3D drawing utilities.
Renderable	Represents an object that can be rendered.
RenderOverview	Deprecated.
Scene	Represents a 3D scene
SceneTileModel	Represents the model of a tile in the current scene.
SceneTilePaint	Represents the paint of a tile in the current scene.
Script
ScriptEvent
SpritePixels	Represents data about the pixels of a sprite image.
StructComposition	A config type dedicated to holding params.
Texture
TextureProvider
Tile	Represents a tile in the game.
TileFunction
TileItem	Represents an item inside an ItemLayer.
TileObject	Represents an object on a Tile
VarbitComposition
WallObject	Represents one or two walls on a tile
WidgetNode	Represents a widget as an iterable node.
World	Holds data of a RuneScape world.
WorldEntity
WorldMapData	Deprecated.
WorldView

Class Summary

Class	Description
AnimationController
AnimationID	Utility class used for mapping animation IDs.
CollisionDataFlag	A utility class containing collision data flags for tiles.
Constants	A utility class containing constant values.
EnumID	Utility class used for mapping enum IDs.
Experience	A utility class used for calculating experience related values.
FontID	IDs of fonts in the cache
GraphicID
HintArrowType	Hint arrow types.
Hitsplat	A hitsplat that has been applied to an Actor.
HitsplatID
IndexedObjectSet<T>
Item
ItemID
JagexColor
KeyCode	Jagex key codes
NpcID
NullItemID
NullNpcID
NullObjectID
ObjectID
ParamID
Perspective	A utility class containing methods to help with conversion between in-game features to canvas areas.
Point	A two-dimensional coordinate on the canvas.
RuneLiteObject
RuneLiteObjectController
ScriptID
SettingID
SkullIcon	An enumeration of PK skulls.
SoundEffectID	Utility class used for mapping sound effect IDs.
SoundEffectVolume	Volume values for each of the stops on the volume interface
SpriteID
StructID
Varbits	Server controlled "content-developer" integers.
VarClientInt	Client side only, content-developer integers VarCInts are stored entirely in memory, or locally on a user's machine in the preferences2.dat file depending on how Jagex configured the variable
VarClientStr	Client side only, content-developer strings VarCInts are stored entirely in memory, or locally on a user's machine in the preferences2.dat file depending on how Jagex configured the variable
VarPlayer	Server controlled "content-developer" integers.

Enum Summary

Enum	Description
ChatMessageType	Enumeration of message types that can be received in the chat.
EquipmentInventorySlot	An enumeration of equipment slots in the inventory ItemContainer.
FriendsChatRank	An enumeration of ranks of friends chat members.
GameState	An enumeration of game states the client is in.
GrandExchangeOfferState	Describes the state of a Grand Exchange offer.
HeadIcon	An enumeration of prayer icons above the head.
IconID	Enum of all official icons that Jagex uses in chat.
InstanceTemplates	An enumeration of possible instance templates and the area they occupy.
InventoryID	An enumeration of possible inventory types.
MenuAction	An enumeration of right-click menu actions.
Prayer	An enumeration of prayers.
Quest
QuestState
Skill	An enumeration of skills that a player can level.
WorldType	An enumeration of possible world types.