Package net.runelite.api

Interface PlayerComposition

  • public interface PlayerComposition
    Represents the template of a player.

    • 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

      • 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

        void setHash()
        Update the cached hash value for player equipment. Call this whenever the player's equipment changes or overrides change.

      • getTransformedNpcId

        int getTransformedNpcId()
        Get the ID of the NPC that the player is currently transformed into. Used natively for cutscenes.
        Returns:
        the id of the npc that the player is rendering as
        See Also:
        setTransformedNpcId(int)

      • setTransformedNpcId

        @VisibleForDevtools
void setTransformedNpcId​(int id)
        Set the ID of the NPC that the player should transform into. Used natively for cutscenes.
        Parameters:
        id - the id of the npc that the player should render as
        See Also:
        getTransformedNpcId()

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

      • createColorTextureOverride

        ColorTextureOverride createColorTextureOverride​(KitType kit,
                                                int itemId)
        Create a ColorTextureOverride for a kit slot. The ColorTextureOverride is initialized with the overrides from the provided item.