Package de.marcely.bedwars.api.arena

Enum ArenaWeatherType

java.lang.Object

java.lang.Enum<ArenaWeatherType>

de.marcely.bedwars.api.arena.ArenaWeatherType

All Implemented Interfaces:

Serializable, Comparable<ArenaWeatherType>, java.lang.constant.Constable

public enum ArenaWeatherType
extends Enum<ArenaWeatherType>

A per-arena weather that'll be used during a match.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLEAR	Weather will be fixed to clear
RAINING	Weather will be fixed to precipitation
UNTOUCHED	Weather will be untouched by MBedwars

Method Summary

Modifier and Type	Method	Description
@Nullable WeatherType	asBukkit()	Get the equivalent of Bukkit's API
ItemStack	getIcon()	Get the icon that is being displayed in the properties menu
static ArenaWeatherType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ArenaWeatherType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNTOUCHED

public static final ArenaWeatherType UNTOUCHED

Weather will be untouched by MBedwars

CLEAR

public static final ArenaWeatherType CLEAR

Weather will be fixed to clear

RAINING

public static final ArenaWeatherType RAINING

Weather will be fixed to precipitation

Method Details

values

public static ArenaWeatherType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ArenaWeatherType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

asBukkit

@Nullable
public @Nullable WeatherType asBukkit()

Get the equivalent of Bukkit's API

Returns:

The equivalent of Bukkit's API. null if untouched

getIcon

public ItemStack getIcon()

Get the icon that is being displayed in the properties menu

Returns:

The icon used in GUIs