Skip to main content

Minigame Teleport Actions

MinigameTeleportActions interfaces with the minigame teleport menus and manages shared cooldown states. The API supports two distinct execution routes with specific completion rules.

Query Methods

  • isOpen(): Evaluates if a minigame teleport surface is visible.
  • isTabOpen(): Provides an alias for isOpen().
  • canTeleport(): Checks if the cooldown allows teleportation.
  • getLastMinigameTeleportUsage(): Retrieves the timestamp of the last usage.

Action Methods

  • open(): Opens the Grouping entry surface. Returns an InteractionResult.
  • open(EntryPath.GROUPING): Opens the Chat-channel/Grouping surface. Returns an InteractionResult.
  • open(EntryPath.MAGIC): Opens the Magic Minigame Teleport destination list only when the Magic tab is already visible. Otherwise returns targeted WIDGET_HIDDEN without changing tabs.
  • openDropdown(): Opens the Grouping-specific dropdown. Returns an InteractionResult.
  • selectDestination(MinigameTeleport): Selects a visible destination row. Returns an InteractionResult.
  • teleport(MinigameTeleport): Executes the teleport via the Grouping route. Returns an InteractionResult.
  • teleport(MinigameTeleport, EntryPath.MAGIC): Executes the teleport via the Magic route. Returns an InteractionResult.

Usage Example

if (MinigameTeleportActions.canTeleport()) {
if (!TabActions.isOpen(Tab.MAGIC)) {
TabActions.open(Tab.MAGIC);
return;
}
InteractionResult opened = MinigameTeleportActions.open(MinigameTeleportActions.EntryPath.MAGIC);
// On a later tick, after the destination list is visible:
MinigameTeleportActions.teleport(
MinigameTeleport.CASTLE_WARS,
MinigameTeleportActions.EntryPath.MAGIC);
}

Execution Routes

Grouping Flow:

  1. Open EntryPath.GROUPING.
  2. Open the dropdown widget.
  3. Select the desired destination row.
  4. Once the selection becomes visible, trigger the final Teleport widget.

Magic Flow:

  1. The caller explicitly opens and observes the Magic tab.
  2. On a later tick, open(EntryPath.MAGIC) casts the minigame teleport spell widget.
  3. On a later tick, select a destination row from the generated list.
  4. The row selection inherently executes the teleport.

Status Codes

ConditionReturned Status
Interface not openMINIGAME_NOT_OPEN
Magic entry requested while Magic tab is closedWIDGET_HIDDEN targeting tab/MAGIC
Cooldown activeMINIGAME_ON_COOLDOWN
Widget not foundWIDGET_NOT_FOUND
DispatchedDISPATCHED

MinigameTeleport Enum

The MinigameTeleport enum defines the available destinations.

Constant
PEST_CONTROL
LAST_MAN_STANDING
NIGHTMARE_ZONE
BARBARIAN_ASSAULT
TITHE_FARM
BLAST_FURNACE
CASTLE_WARS
FISHING_TRAWLER
SOUL_WARS
TROUBLE_BREWING
VOLCANIC_MINE
GUARDIANS_OF_THE_RIFT

Implementation Notes:

  • open() defaults to the Grouping route for backward compatibility.
  • Magic-route selections execute immediately and skip requiring a separate teleport button confirmation.
  • The teleport cooldown applies account-wide and shares across both entry surfaces.