Package net.storm.api.game

Interface IHouse

public interface IHouse
Provides access to player-owned house (POH) information and interactions.

This interface allows querying house location, checking if inside the house, and entering the house using various methods (portals, teleport tabs, capes, or spells).

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canEnter()
    Checks if the player has the means to enter their house.
    void
    enter()
    Attempts to enter the player-owned house.
    HouseLocation
    getLocation()
    Gets the location where the player's house is built.
    net.runelite.api.coords.WorldPoint
    getOutsideLocation()
    Gets the world coordinates of the house portal entrance.
    boolean
    isInside()
    Checks if the player is currently inside their player-owned house.

  • Method Details

    • getLocation

      HouseLocation getLocation()
      Gets the location where the player's house is built.
      Returns:
      the house location, or null if not logged in or house not set

    • getOutsideLocation

      net.runelite.api.coords.WorldPoint getOutsideLocation()
      Gets the world coordinates of the house portal entrance.

      This is the location outside the house where the portal is located, based on the current house location setting.

      Returns:
      the coordinates of the house portal, or null if house location is not set

    • isInside

      boolean isInside()
      Checks if the player is currently inside their player-owned house.

      This is determined by checking if the player is in an instanced region and a house portal with "Lock" action is nearby.

      Returns:
      true if inside the house, false otherwise

    • canEnter

      boolean canEnter()
      Checks if the player has the means to enter their house.

      This returns true if any of the following conditions are met:

      • Player has a teleport to house tablet in inventory
      • Player has a construction cape (equipped or in inventory)
      • Player has a max cape (equipped or in inventory)
      • Player can cast the Teleport to House spell
      • Player is near a house portal

      Returns:
      true if the player can enter their house, false otherwise

    • enter

      void enter()
      Attempts to enter the player-owned house.

      This method will use the first available method to enter the house in this order:

      1. Nearby house portal (if available)
      2. Max cape "Home" option
      3. Construction cape "Tele to POH" option
      4. Teleport to House spell
      5. Teleport to house tablet