Package net.storm.api.widgets

Enum Class MinigameTeleport

java.lang.Object
java.lang.Enum<MinigameTeleport>
net.storm.api.widgets.MinigameTeleport
All Implemented Interfaces:
Serializable, Comparable<MinigameTeleport>, Constable
public enum MinigameTeleport extends Enum<MinigameTeleport>
Enumeration of all minigame teleport destinations available in the game.

Each minigame teleport represents a destination accessible via the minigame teleport system. The enum includes the teleport's index in the interface, display name, destination coordinates, and any required dialog options.

Minigame teleports have a 20-minute cooldown between uses and may have various requirements such as quest completion, skill levels, or other unlocks before they can be used.

See Also:

  • Enum Constant Details

  • Method Details

    • values

      public static MinigameTeleport[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static MinigameTeleport valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getCurrent

      public static MinigameTeleport getCurrent()
      Gets the currently selected minigame teleport destination.
      Returns:
      the currently selected teleport, or NONE if none is selected

    • byName

      public static MinigameTeleport byName(String name)
      Gets a minigame teleport by its display name.
      Parameters:
      name - the name to search for
      Returns:
      the matching teleport, or NONE if not found

    • canUse

      public boolean canUse()
      Checks if the player can use this minigame teleport based on requirements.

      Requirements may include quest completion, skill levels, or other unlocks depending on the specific minigame.

      Returns:
      true if the player meets all requirements, false otherwise

    • hasDestination

      public boolean hasDestination()
      Checks if this teleport has a fixed destination location.

      Some teleports like Player Owned Houses or Shield of Arrav don't have fixed destinations and will return false.

      Returns:
      true if this teleport has a fixed destination, false otherwise