Package net.storm.api.widgets

Interface IMinigames

public interface IMinigames
Interface for interacting with the minigame teleport system in the game.

This interface provides methods to access the minigame teleport interface, teleport to various minigame locations, and check teleport availability and cooldowns. Minigame teleports have a 20-minute cooldown between uses.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canTeleport()
    Checks if the minigame teleport can currently be used.
    Instant
    getLastMinigameTeleportUsage()
    Gets the timestamp of the last minigame teleport usage.
    boolean
    isOpen()
    Checks if the minigame teleport interface is currently open.
    boolean
    isTabOpen()
    Checks if the minigame tab in the quest/achievement diary interface is open.
    boolean
    open()
    Opens the minigame teleport interface.
    boolean
    teleport(MinigameTeleport destination)
    Teleports the player to the specified minigame destination.

  • Method Details

    • canTeleport

      boolean canTeleport()
      Checks if the minigame teleport can currently be used. The teleport has a 20-minute cooldown between uses.
      Returns:
      true if the teleport is available, false if on cooldown

    • teleport

      boolean teleport(MinigameTeleport destination)
      Teleports the player to the specified minigame destination.
      Parameters:
      destination - the minigame teleport destination
      Returns:
      true if the teleport was initiated successfully, false otherwise

    • open

      boolean open()
      Opens the minigame teleport interface.
      Returns:
      true if the interface was successfully opened, false otherwise

    • isOpen

      boolean isOpen()
      Checks if the minigame teleport interface is currently open.
      Returns:
      true if the interface is open, false otherwise

    • isTabOpen

      boolean isTabOpen()
      Checks if the minigame tab in the quest/achievement diary interface is open.
      Returns:
      true if the minigame tab is open, false otherwise

    • getLastMinigameTeleportUsage

      Instant getLastMinigameTeleportUsage()
      Gets the timestamp of the last minigame teleport usage. This can be used to calculate remaining cooldown time.
      Returns:
      the instant when the teleport was last used, or null if never used