Package net.runelite.api

Interface PlayerComposition

  • public interface PlayerComposition
    Represents the template of a player.

    • Method Detail

      • isFemale

        boolean isFemale()
        Checks if the player is female.
        Returns:
        true if the player is 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.

        If the ID for a specific slot is between 256 and 512, subtracting 256 will result in the kit ID. Values above 512 indicate an item and can be converted to the item ID by subtracting 512.

        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.

      • 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: