Settings (core 1.0.2 API)

java.lang.Object
- net.nextinfinity.core.utils.Settings

```
public class Settings
extends java.lang.Object
```
The Settings class contains static values often accessed during runtime. The set methods should usually not be used except during game initialization.

Constructor Summary

Constructors
Constructor Description

Settings()

Constructors
Constructor	Description
`Settings()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static boolean`	`getBlockBreak()`	Gets whether or not to allow block placing and breaking in Arenas.
`static int`	`getCountdownTime()`	Gets how long the countdown time should last for, in seconds.
`static org.bukkit.ChatColor`	`getError()`	Gets the error color used for chat messages and UI elements.
`static org.bukkit.GameMode`	`getExitMode()`	Gets the GameMode to return players to outside of an Arena.
`static boolean`	`getExplosionBlockDamage()`	Gets whether or not to allow explosions to break blocks in Arenas.
`static boolean`	`getFireBlockDamage()`	Gets whether or not to allow blocks to burn in Arenas.
`static org.bukkit.GameMode`	`getGameMode()`	Gets the GameMode to set players to when they are in an Arena.
`static int`	`getGameTime()`	Gets how long a game should last for, in seconds.
`static boolean`	`getHunger()`	Gets whether or not to allow player hunger to reduce in Arenas.
`static boolean`	`getItemManage()`	Gets whether or not to allow a player to manage their inventory in Arenas.
`static boolean`	`getJoinTeleport()`	Gets whether or not to teleport players to the global lobby when they join the server.
`static org.bukkit.Location`	`getLobby()`	Gets the lobby joining players are teleported to.
`static int`	`getMax()`	Gets the maximum amount of players for an arena.
`static int`	`getMin()`	Gets the minimum amount of players for an arena.
`static java.lang.String`	`getName()`	Gets the name of the game.
`static java.lang.String`	`getPermission()`	Gets the permission prefix for the game.
`static java.lang.String`	`getPrefix()`	Gets the prefix used for chat messages.
`static org.bukkit.ChatColor`	`getPrimary()`	Gets the primary color used for chat messages and UI elements.
`static org.bukkit.ChatColor`	`getSecondary()`	Gets the secondary color used for chat messages and UI elements.
`static int`	`getWinningEco()`	Gets the amount to reward players when they win a game, using Vault.
`static void`	`setBlockBreak(boolean blockBreak)`	Sets whether or not to allow block placing and breaking in Arenas.
`static void`	`setCountdownTime(int countdownTime)`	Sets how long the countdown time should last for, in seconds.
`static void`	`setError(org.bukkit.ChatColor error)`	Sets the error color used for chat messages and UI elements.
`static void`	`setExitMode(org.bukkit.GameMode exitMode)`	Sets the GameMode to return players to outside of an Arena.
`static void`	`setExplosionBlockDamage(boolean explosionBlockDamage)`	Sets whether or not to allow explosions to break blocks in Arenas.
`static void`	`setFireBlockDamage(boolean fireBlockDamage)`	Sets whether or not to allow blocks to burn in Arenas.
`static void`	`setGameMode(org.bukkit.GameMode gameMode)`	Sets the GameMode to set players to when they are in an Arena.
`static void`	`setGameTime(int gameTime)`	Sets how long a game should last for, in seconds.
`static void`	`setHunger(boolean hunger)`	Sets whether or not to allow player hunger to reduce in Arenas.
`static void`	`setItemManage(boolean itemManage)`	Sets whether or not to allow a player to manage their inventory in Arenas.
`static void`	`setJoinTeleport(boolean joinTeleport)`	Sets whether or not to teleport players to the global lobby when they join the server.
`static void`	`setLobby(org.bukkit.Location lobby)`	Sets the lobby joining players are teleported to.
`static void`	`setMax(int max)`	Sets the maxmimum amount of players for an arena.
`static void`	`setMin(int min)`	Sets the minimum amount of players for an arena.
`static void`	`setName(java.lang.String name)`	Sets the name of the game.
`static void`	`setPermission(java.lang.String permission)`	Sets the permission prefix for the game.
`static void`	`setPrefix(java.lang.String prefix)`	Sets the prefix used for chat messages.
`static void`	`setPrimary(org.bukkit.ChatColor primary)`	Sets the primary color used for chat messages and UI elements.
`static void`	`setSecondary(org.bukkit.ChatColor secondary)`	Sets the secondary color used for chat messages and UI elements.
`static void`	`setWinningEco(int winningEco)`	Sets the amount to reward players when they win a game, using Vault.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Settings
```
public Settings()
```
- Method Detail
  - getMax
```
public static int getMax()
```
    Gets the maximum amount of players for an arena.
    
    Returns:
    
    the maximum amount of players
  - setMax
```
public static void setMax(int max)
```
    Sets the maxmimum amount of players for an arena.
    
    Parameters:
    
    max - the new maximum amount
  - getMin
```
public static int getMin()
```
    Gets the minimum amount of players for an arena.
    
    Returns:
    
    the minimum amount of players
  - setMin
```
public static void setMin(int min)
```
    Sets the minimum amount of players for an arena.
    
    Parameters:
    
    min - the new minimum amount
  - getName
```
public static java.lang.String getName()
```
    Gets the name of the game.
    
    Returns:
    
    the name of the game
  - setName
```
public static void setName(java.lang.String name)
```
    Sets the name of the game.
    
    Parameters:
    
    name - the new name of the game
  - getPrefix
```
public static java.lang.String getPrefix()
```
    Gets the prefix used for chat messages.
    
    Returns:
    
    the game's chat prefix
  - setPrefix
```
public static void setPrefix(java.lang.String prefix)
```
    Sets the prefix used for chat messages.
    
    Parameters:
    
    prefix - the game's new chat prefix
  - getPrimary
```
public static org.bukkit.ChatColor getPrimary()
```
    Gets the primary color used for chat messages and UI elements.
    
    Returns:
    
    the primary ChatColor
  - setPrimary
```
public static void setPrimary(org.bukkit.ChatColor primary)
```
    Sets the primary color used for chat messages and UI elements.
    
    Parameters:
    
    primary - the new primary ChatColor
  - getSecondary
```
public static org.bukkit.ChatColor getSecondary()
```
    Gets the secondary color used for chat messages and UI elements.
    
    Returns:
    
    the secondary ChatColor
  - setSecondary
```
public static void setSecondary(org.bukkit.ChatColor secondary)
```
    Sets the secondary color used for chat messages and UI elements.
    
    Parameters:
    
    secondary - the new secondary ChatColor
  - getError
```
public static org.bukkit.ChatColor getError()
```
    Gets the error color used for chat messages and UI elements.
    
    Returns:
    
    the error ChatColor
  - setError
```
public static void setError(org.bukkit.ChatColor error)
```
    Sets the error color used for chat messages and UI elements.
    
    Parameters:
    
    error - the new error ChatColor
  - getLobby
```
public static org.bukkit.Location getLobby()
```
    Gets the lobby joining players are teleported to.
    
    Returns:
    
    the global lobby location
  - setLobby
```
public static void setLobby(org.bukkit.Location lobby)
```
    Sets the lobby joining players are teleported to.
    
    Parameters:
    
    lobby - the new global lobby location
  - getBlockBreak
```
public static boolean getBlockBreak()
```
    Gets whether or not to allow block placing and breaking in Arenas.
    
    Returns:
    
    whether or not to allow block breakage
  - setBlockBreak
```
public static void setBlockBreak(boolean blockBreak)
```
    Sets whether or not to allow block placing and breaking in Arenas.
    
    Parameters:
    
    blockBreak - whether or not to allow block breakage
  - getItemManage
```
public static boolean getItemManage()
```
    Gets whether or not to allow a player to manage their inventory in Arenas.
    
    Returns:
    
    whether or not to allow inventory management
  - setItemManage
```
public static void setItemManage(boolean itemManage)
```
    Sets whether or not to allow a player to manage their inventory in Arenas.
    
    Parameters:
    
    itemManage - whether or not to allow inventory management
  - getHunger
```
public static boolean getHunger()
```
    Gets whether or not to allow player hunger to reduce in Arenas.
    
    Returns:
    
    whether or not to allow hunger
  - setHunger
```
public static void setHunger(boolean hunger)
```
    Sets whether or not to allow player hunger to reduce in Arenas.
    
    Parameters:
    
    hunger - whether or not to allow hunger
  - getFireBlockDamage
```
public static boolean getFireBlockDamage()
```
    Gets whether or not to allow blocks to burn in Arenas.
    
    Returns:
    
    whether or not to allow blocks to burn
  - setFireBlockDamage
```
public static void setFireBlockDamage(boolean fireBlockDamage)
```
    Sets whether or not to allow blocks to burn in Arenas.
    
    Parameters:
    
    fireBlockDamage - whether or not to allow blocks to burn
  - getExplosionBlockDamage
```
public static boolean getExplosionBlockDamage()
```
    Gets whether or not to allow explosions to break blocks in Arenas.
    
    Returns:
    
    whether or not to allow explosion block damage
  - setExplosionBlockDamage
```
public static void setExplosionBlockDamage(boolean explosionBlockDamage)
```
    Sets whether or not to allow explosions to break blocks in Arenas.
    
    Parameters:
    
    explosionBlockDamage - whether or not to allow explosion block damage
  - getGameMode
```
public static org.bukkit.GameMode getGameMode()
```
    Gets the GameMode to set players to when they are in an Arena.
    
    Returns:
    
    the GameMode for Arenas
  - setGameMode
```
public static void setGameMode(org.bukkit.GameMode gameMode)
```
    Sets the GameMode to set players to when they are in an Arena.
    
    Parameters:
    
    gameMode - the new GameMode for Arenas
  - getExitMode
```
public static org.bukkit.GameMode getExitMode()
```
    Gets the GameMode to return players to outside of an Arena.
    
    Returns:
    
    the GameMode outside of Arenas
  - setExitMode
```
public static void setExitMode(org.bukkit.GameMode exitMode)
```
    Sets the GameMode to return players to outside of an Arena.
    
    Parameters:
    
    exitMode - the new GameMode outside of Arenas
  - getGameTime
```
public static int getGameTime()
```
    Gets how long a game should last for, in seconds.
    
    Returns:
    
    the length of a game in seconds
  - setGameTime
```
public static void setGameTime(int gameTime)
```
    Sets how long a game should last for, in seconds.
    
    Parameters:
    
    gameTime - the new length of a game in seconds
  - getCountdownTime
```
public static int getCountdownTime()
```
    Gets how long the countdown time should last for, in seconds.
    
    Returns:
    
    the countdown time in seconds
  - setCountdownTime
```
public static void setCountdownTime(int countdownTime)
```
    Sets how long the countdown time should last for, in seconds.
    
    Parameters:
    
    countdownTime - the new countdown time in seconds
  - getJoinTeleport
```
public static boolean getJoinTeleport()
```
    Gets whether or not to teleport players to the global lobby when they join the server.
    
    Returns:
    
    whether or not to teleport players on join
  - setJoinTeleport
```
public static void setJoinTeleport(boolean joinTeleport)
```
    Sets whether or not to teleport players to the global lobby when they join the server.
    
    Parameters:
    
    joinTeleport - whether or not to teleport players on join
  - getWinningEco
```
public static int getWinningEco()
```
    Gets the amount to reward players when they win a game, using Vault.
    
    Returns:
    
    the amount to give winners
  - setWinningEco
```
public static void setWinningEco(int winningEco)
```
    Sets the amount to reward players when they win a game, using Vault.
    
    Parameters:
    
    winningEco - the new amount to give winners
  - getPermission
```
public static java.lang.String getPermission()
```
    Gets the permission prefix for the game.
    
    Returns:
    
    the permission prefix
  - setPermission
```
public static void setPermission(java.lang.String permission)
```
    Sets the permission prefix for the game.
    
    Parameters:
    
    permission - the new permission prefix

Class Settings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

getMax

setMax

getMin

setMin

getName

setName

getPrefix

setPrefix

getPrimary

setPrimary

getSecondary

setSecondary

getError

setError

getLobby

setLobby

getBlockBreak

setBlockBreak

getItemManage

setItemManage

getHunger

setHunger

getFireBlockDamage

setFireBlockDamage

getExplosionBlockDamage

setExplosionBlockDamage

getGameMode

setGameMode

getExitMode

setExitMode

getGameTime

setGameTime

getCountdownTime

setCountdownTime

getJoinTeleport

setJoinTeleport

getWinningEco

setWinningEco

getPermission

setPermission