Class PlayerEntity

    • Constructor Summary

      Constructors 
      Constructor Description
      PlayerEntity​(Context ctx, net.runelite.api.Player raw)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getId()
      The item ID for the wrapped game entity
      java.lang.String getName()
      The game entities name.
      boolean interact​(java.lang.String action)
      Interacts with the entity using the given action verb.
      boolean isSkulled()
      Returns true if the player has a Skull icon above their head and false otherwise.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • PlayerEntity

        public PlayerEntity​(Context ctx,
                            net.runelite.api.Player raw)
    • Method Detail

      • getId

        public int getId()
        Description copied from interface: Interactable
        The item ID for the wrapped game entity
        Returns:
        int Item id
      • getName

        public java.lang.String getName()
        Description copied from interface: Interactable
        The game entities name.
        Returns:
        The name of the game entity i.e. NPC name for NPC's, item name for ContainerItem's, and GameObject name for various game objects.
      • interact

        public boolean interact​(java.lang.String action)
        Description copied from interface: Interactable
        Interacts with the entity using the given action verb.
        Parameters:
        action - The menu action to trigger (e.g., "Attack", "Talk-to", "Take")
        Returns:
        true if the interaction packet was successfully queued/sent
      • isSkulled

        public boolean isSkulled()
        Returns true if the player has a Skull icon above their head and false otherwise.
        Returns:
        boolean True if the player is skulled