Package net.runelite.api

Interface PlayerComposition

public interface PlayerComposition

Represents the template of a player.

Field Summary

Fields

Modifier and Type	Field	Description
static int	ITEM_OFFSET
static int	KIT_OFFSET

Method Summary

Modifier and Type	Method	Description
int[]	getColors()	Get the body part colors for this player composition.
ColorTextureOverride[]	getColorTextureOverrides()	Get the overrides for this player composition, indexed by kit id.
int	getEquipmentId(KitType type)	Gets the equipment ID of a particular slot.
int[]	getEquipmentIds()	Gets an array of IDs related to equipment slots.
int	getGender()	Get the player gender
int	getKitId(KitType type)	Gets the kit ID of a particular slot.
boolean	isFemale()	Deprecated. use getGender
void	setHash()	Update the cached hash value for player equipment Used to cache the player models based on equipment.
void	setTransformedNpcId(int id)

Field Detail

KIT_OFFSET

static final int KIT_OFFSET

See Also:

Constant Field Values

ITEM_OFFSET

static final int ITEM_OFFSET

See Also:

Constant Field Values

Method Detail

isFemale

@Deprecated
boolean isFemale()

Deprecated.

use getGender

Checks if the player is female.

Returns:

true if the player is female

getGender

int getGender()

Get the player gender

Returns:

0 for male, 1 for female

getColors

int[] getColors()

Get the body part colors for this player composition.

Returns:

an array of the colors, always size 5

getEquipmentIds

int[] getEquipmentIds()

Gets an array of IDs related to equipment slots.

IDs between KIT_OFFSET and ITEM_OFFSET are kits, offset by KIT_OFFSET. IDs greater than or equal to ITEM_OFFSET are items, offset by ITEM_OFFSET.

Returns:

the equipment IDs

getEquipmentId

int getEquipmentId(KitType type)

Gets the equipment ID of a particular slot.

Parameters:

type - equipment slot

Returns:

the equipment ID

getKitId

int getKitId(KitType type)

Gets the kit ID of a particular slot.

Parameters:

type - equipment slot

Returns:

the kit ID

setHash

@VisibleForDevtools
void setHash()

Update the cached hash value for player equipment Used to cache the player models based on equipment.

setTransformedNpcId

@VisibleForDevtools
void setTransformedNpcId(int id)

getColorTextureOverrides

@Nullable
ColorTextureOverride[] getColorTextureOverrides()

Get the overrides for this player composition, indexed by kit id. The overrides replace the target color/textures for the item instead of using the target colors/textures from the item composition. Only works if the kittype is an item.

Returns: