Class GameConfig

java.lang.Object
com.storytimeproductions.models.stgames.GameConfig
public class GameConfig extends Object
Represents the configuration for a game, including its properties and settings.

  • Constructor Details

    • GameConfig

      public GameConfig(String gameId, org.bukkit.Location joinBlock, int ticketCost, org.bukkit.Location gameArea, org.bukkit.Location exitArea, int playerLimit, String joinSuccessMessage, String joinFailMessage, String winMessage, String loseMessage, Map<String,String> gameProperties)
      Constructs a new GameConfig with the specified parameters.
      Parameters:
      gameId - the unique identifier for the game
      joinBlock - the location of the join block
      ticketCost - the cost to join the game
      gameArea - the location representing the game area
      exitArea - the location representing the exit area
      playerLimit - the maximum number of players allowed
      joinSuccessMessage - the message shown when joining succeeds
      joinFailMessage - the message shown when joining fails
      winMessage - the message shown when a player wins
      loseMessage - the message shown when a player loses
      gameProperties - additional game-specific properties

  • Method Details

    • getGameId

      public String getGameId()
      Gets the unique identifier for the game.
      Returns:
      the game ID

    • getJoinBlock

      public org.bukkit.Location getJoinBlock()
      Gets the location of the join block.
      Returns:
      the join block location

    • getTicketCost

      public int getTicketCost()
      Gets the cost to join the game.
      Returns:
      the ticket cost

    • getGameArea

      public org.bukkit.Location getGameArea()
      Gets the location representing the game area.
      Returns:
      the game area location

    • getExitArea

      public org.bukkit.Location getExitArea()
      Gets the location representing the exit area.
      Returns:
      the exit area location

    • getPlayerLimit

      public int getPlayerLimit()
      Gets the maximum number of players allowed in the game.
      Returns:
      the player limit

    • getJoinSuccessMessage

      public String getJoinSuccessMessage()
      Gets the message shown when joining the game succeeds.
      Returns:
      the join success message

    • getJoinFailMessage

      public String getJoinFailMessage()
      Gets the message shown when joining the game fails.
      Returns:
      the join fail message

    • getWinMessage

      public String getWinMessage()
      Gets the message shown when a player wins the game.
      Returns:
      the win message

    • getLoseMessage

      public String getLoseMessage()
      Gets the message shown when a player loses the game.
      Returns:
      the lose message

    • getGameProperties

      public Map<String,String> getGameProperties()
      Gets additional game-specific properties.
      Returns:
      a map of game properties