Package net.storm.api.sailing

Interface Ship

public interface Ship
Represents a ship entity in the sailing system.

A ship is a self-contained world view that contains its own set of entities including tiles, NPCs, players, objects, and items. Ships are used in the sailing feature to represent vessels that players can interact with and travel on.

Each ship maintains its own managers for different entity types, allowing for isolated entity management within the ship's world view.

See Also:

  • Method Details

    • getTileManager

      ITiles getTileManager()
      Gets the tile manager for this ship.

      The tile manager provides access to all tiles within this ship's world view. Tiles represent the walkable and interactable surfaces on the ship.

      Returns:
      the ITiles manager for this ship's tiles

    • getNpcManager

      INPCs getNpcManager()
      Gets the NPC manager for this ship.

      The NPC manager provides access to all non-player characters within this ship's world view, such as crew members or other NPCs present on the ship.

      Returns:
      the INPCs manager for this ship's NPCs

    • getPlayerManager

      IPlayers getPlayerManager()
      Gets the player manager for this ship.

      The player manager provides access to all players currently present within this ship's world view.

      Returns:
      the IPlayers manager for this ship's players

    • getTileObjectManager

      ITileObjects getTileObjectManager()
      Gets the tile object manager for this ship.

      The tile object manager provides access to all game objects within this ship's world view, such as ship equipment, doors, ladders, and other interactable objects.

      Returns:
      the ITileObjects manager for this ship's objects

    • getTileItemManager

      ITileItems getTileItemManager()
      Gets the tile item manager for this ship.

      The tile item manager provides access to all ground items within this ship's world view.

      Returns:
      the ITileItems manager for this ship's ground items

    • getWorldEntity

      net.runelite.api.WorldEntity getWorldEntity()
      Gets the world entity associated with this ship.

      The world entity contains the underlying RuneLite API representation of this ship's world view, including position and other world-level properties.

      Returns:
      the WorldEntity for this ship

    • destroy

      void destroy(net.runelite.client.eventbus.EventBus eventBus)
      Destroys this ship and cleans up its resources.

      This method should be called when the ship is no longer needed. It unregisters event listeners and releases resources associated with this ship's world view.

      Parameters:
      eventBus - the EventBus to unregister event listeners from