Interface ArenaData


public interface ArenaData
Represents a read-only snapshot of arena configuration data.

This interface provides access to the core properties of an arena, including its identification, game association, player limits, and configuration settings. The data is immutable and represents a point-in-time snapshot of the arena's state.

  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the identifier of the game module this arena is configured for.
    int
    Gets the unique identifier of this arena.
    int
    Gets the maximum number of players allowed in this arena.
    int
    Gets the minimum number of players required to start a game in this arena.
    int
    Gets the configured time limit for games in this arena.
    Gets the name of the world where this arena is located.
    boolean
    Checks if this arena is currently enabled and available for use.
  • Method Details

    • getId

      int getId()
      Gets the unique identifier of this arena.
      Returns:
      the arena ID
    • getGameId

      String getGameId()
      Gets the identifier of the game module this arena is configured for.
      Returns:
      the game module ID
    • getWorldName

      String getWorldName()
      Gets the name of the world where this arena is located.
      Returns:
      the world name
    • isEnabled

      boolean isEnabled()
      Checks if this arena is currently enabled and available for use.
      Returns:
      true if the arena is enabled, false otherwise
    • getMinPlayers

      int getMinPlayers()
      Gets the minimum number of players required to start a game in this arena.
      Returns:
      the minimum player count
    • getMaxPlayers

      int getMaxPlayers()
      Gets the maximum number of players allowed in this arena.
      Returns:
      the maximum player count
    • getTime

      int getTime()
      Gets the configured time limit for games in this arena.

      The meaning and units of this value are game-specific. Common interpretations include game duration in seconds or countdown time.

      Returns:
      the time configuration value