Package org.screamingsandals.bedwars.api.config

Interface ConfigurationContainer

@NonExtendable
public interface ConfigurationContainer

Since:

0.3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_WOOL_TO_INVENTORY_ON_JOIN
static final String	ANCHOR_AUTO_FILL
static final String	ANCHOR_DECREASING
static final String	BLOCK_FALLING
static final String	CAKE_TARGET_BLOCK_EATING
static final String	COLORED_LEATHER_BY_TEAM_IN_LOBBY
static final String	COMPASS
static final String	CRAFTING
static final String	DAMAGE_WHEN_PLAYER_IS_NOT_IN_ARENA
static final String	ENABLE_GAME_START_ITEMS
static final String	ENABLE_PLAYER_RESPAWN_ITEMS
static final String	FRIENDLY_FIRE
static final String	GAME_BOSSBAR
static final String	GAME_SCOREBOARD
static final String	HEALTH_INDICATOR
static final String	HOLOGRAMS_ABOVE_BEDS
static final String	HYPIXEL_HOLOGRAMS
static final String	INVISIBLE_LOBBY_ON_GAME_START
static final String	JOIN_RANDOM_TEAM_AFTER_LOBBY
static final String	JOIN_RANDOM_TEAM_ON_JOIN
static final String	KEEP_ARMOR
static final String	KEEP_INVENTORY
static final String	LOBBY_BOSSBAR
static final String	LOBBY_SCOREBOARD
static final String	NEW_GAME_SCOREBOARD
static final String	PLAYER_DROPS
static final String	PREVENT_SPAWNING_MOBS
static final String	PROTECT_SHOP
static final String	REMOVE_UNUSED_TARGET_BLOCKS
static final String	SPAWNER_COUNTDOWN_HOLOGRAM
static final String	SPAWNER_DISABLE_MERGE
static final String	SPAWNER_HOLOGRAMS
static final String	SPECTATOR_JOIN
static final String	STOP_TEAM_SPAWNERS_ON_DIE
static final String	TARGET_BLOCK_EXPLOSIONS

Method Summary

Modifier and Type	Method	Description
<T> Optional<Configuration<T>>	get(String key, Class<T> type)	Gets configuration from the key
<T> T	getOrDefault(String key, Class<T> type, T defaultValue)	Gets the value from configuration or returns back the default value
@Nullable ConfigurationContainer	getParentContainer()
List<String>	getRegisteredKeys()	Gets all keys known by this configuration container
<T> boolean	register(String key, Class<T> typeToBeSaved)	Registers new configuration type.

Field Details

COMPASS

static final String COMPASS

See Also:

• Constant Field Values

JOIN_RANDOM_TEAM_AFTER_LOBBY

static final String JOIN_RANDOM_TEAM_AFTER_LOBBY

See Also:

• Constant Field Values

JOIN_RANDOM_TEAM_ON_JOIN

static final String JOIN_RANDOM_TEAM_ON_JOIN

See Also:

• Constant Field Values

ADD_WOOL_TO_INVENTORY_ON_JOIN

static final String ADD_WOOL_TO_INVENTORY_ON_JOIN

See Also:

• Constant Field Values

PROTECT_SHOP

static final String PROTECT_SHOP

See Also:

• Constant Field Values

PLAYER_DROPS

static final String PLAYER_DROPS

See Also:

• Constant Field Values

FRIENDLY_FIRE

static final String FRIENDLY_FIRE

See Also:

• Constant Field Values

COLORED_LEATHER_BY_TEAM_IN_LOBBY

static final String COLORED_LEATHER_BY_TEAM_IN_LOBBY

See Also:

• Constant Field Values

KEEP_INVENTORY

static final String KEEP_INVENTORY

See Also:

• Constant Field Values

KEEP_ARMOR

static final String KEEP_ARMOR

See Also:

• Constant Field Values

CRAFTING

static final String CRAFTING

See Also:

• Constant Field Values

LOBBY_BOSSBAR

static final String LOBBY_BOSSBAR

See Also:

• Constant Field Values

GAME_BOSSBAR

static final String GAME_BOSSBAR

See Also:

• Constant Field Values

GAME_SCOREBOARD

static final String GAME_SCOREBOARD

See Also:

• Constant Field Values

LOBBY_SCOREBOARD

static final String LOBBY_SCOREBOARD

See Also:

• Constant Field Values

PREVENT_SPAWNING_MOBS

static final String PREVENT_SPAWNING_MOBS

See Also:

• Constant Field Values

SPAWNER_HOLOGRAMS

static final String SPAWNER_HOLOGRAMS

See Also:

• Constant Field Values

SPAWNER_DISABLE_MERGE

static final String SPAWNER_DISABLE_MERGE

See Also:

• Constant Field Values

ENABLE_GAME_START_ITEMS

static final String ENABLE_GAME_START_ITEMS

See Also:

• Constant Field Values

ENABLE_PLAYER_RESPAWN_ITEMS

static final String ENABLE_PLAYER_RESPAWN_ITEMS

See Also:

• Constant Field Values

SPAWNER_COUNTDOWN_HOLOGRAM

static final String SPAWNER_COUNTDOWN_HOLOGRAM

See Also:

• Constant Field Values

DAMAGE_WHEN_PLAYER_IS_NOT_IN_ARENA

static final String DAMAGE_WHEN_PLAYER_IS_NOT_IN_ARENA

See Also:

• Constant Field Values

REMOVE_UNUSED_TARGET_BLOCKS

static final String REMOVE_UNUSED_TARGET_BLOCKS

See Also:

• Constant Field Values

BLOCK_FALLING

static final String BLOCK_FALLING

See Also:

• Constant Field Values

HOLOGRAMS_ABOVE_BEDS

static final String HOLOGRAMS_ABOVE_BEDS

See Also:

• Constant Field Values

SPECTATOR_JOIN

static final String SPECTATOR_JOIN

See Also:

• Constant Field Values

STOP_TEAM_SPAWNERS_ON_DIE

static final String STOP_TEAM_SPAWNERS_ON_DIE

See Also:

• Constant Field Values

ANCHOR_AUTO_FILL

static final String ANCHOR_AUTO_FILL

See Also:

• Constant Field Values

ANCHOR_DECREASING

static final String ANCHOR_DECREASING

See Also:

• Constant Field Values

CAKE_TARGET_BLOCK_EATING

static final String CAKE_TARGET_BLOCK_EATING

See Also:

• Constant Field Values

TARGET_BLOCK_EXPLOSIONS

static final String TARGET_BLOCK_EXPLOSIONS

See Also:

• Constant Field Values

INVISIBLE_LOBBY_ON_GAME_START

static final String INVISIBLE_LOBBY_ON_GAME_START

See Also:

• Constant Field Values

HEALTH_INDICATOR

static final String HEALTH_INDICATOR

See Also:

• Constant Field Values

HYPIXEL_HOLOGRAMS

static final String HYPIXEL_HOLOGRAMS

See Also:

• Constant Field Values

NEW_GAME_SCOREBOARD

static final String NEW_GAME_SCOREBOARD

See Also:

• Constant Field Values

Method Details

get

<T> Optional<Configuration<T>> get(String key,
 Class<T> type)

Gets configuration from the key

Parameters:

key - Key of the configuration

type - Type of the configuration

Returns:

configuration or empty optional

register

<T> boolean register(String key,
 Class<T> typeToBeSaved)

Registers new configuration type. This allows addons to save information directly to game.

Parameters:

key - Key of new configuration, it's invalid to use dots or colons

typeToBeSaved - type which will be used for saving

Returns:

true on success

getRegisteredKeys

List<String> getRegisteredKeys()

Gets all keys known by this configuration container

Returns:

list of all registered keys

getOrDefault

<T> T getOrDefault(String key,
 Class<T> type,
 T defaultValue)

Gets the value from configuration or returns back the default value

Parameters:

key - Key of the configuration

type - Type of the configuration

defaultValue - Default value if the configuration won't be found

Returns:

object from configuration if registered; otherwise defaultValue

getParentContainer

@Nullable
@Nullable ConfigurationContainer getParentContainer()