Package com.kraken.api.query.world

Class WorldEntity

  • All Implemented Interfaces:
    Interactable<net.runelite.api.World>
    public class WorldEntity
extends AbstractEntity<net.runelite.api.World>

    • Constructor Summary

      Constructors 
      Constructor Description
      WorldEntity​(Context ctx, net.runelite.api.World raw, net.runelite.http.api.worlds.World httpPackageWorld)  

    • 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 hop()
      Attempts to perform a world hop for the current WorldEntity.
      boolean interact​(java.lang.String action)
      Interacts with the entity using the given action verb.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • WorldEntity

        public WorldEntity​(Context ctx,
                   net.runelite.api.World raw,
                   net.runelite.http.api.worlds.World httpPackageWorld)

    • Method Detail

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

      • getId

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

      • 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

      • hop

        public boolean hop()
        Attempts to perform a world hop for the current WorldEntity.

        This method interacts with the RuneLite client to hop to the target world associated with this WorldEntity. Depending on the client's state, it may handle login screen transitions or directly use the world hopper interface to complete the action. This operation may require the world hopper plugin to be enabled.

        Returns:
        true if the world hop was successfully performed; false otherwise.