Package me.gamercoder215.starcosmetics.api.player

Class PlayerSetting<T>

java.lang.Object

me.gamercoder215.starcosmetics.api.player.PlayerSetting<T>

Type Parameters:

T - Setting Type

public final class PlayerSetting<T>
extends Object

Represents a setting available to players.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerSetting.HologramFormat	Represents a Hologram Format.
static enum	PlayerSetting.VelocityPower	Enum used to determine the Velocity Power of STRUCTURE_VELOCITY.

Field Summary

Fields

Modifier and Type	Field	Description
static final PlayerSetting<DyeColor>	EMOTE_COLOR	The color of the armor when using emotes.
static final PlayerSetting<PlayerSetting.HologramFormat>	HOLOGRAM_FORMAT	The color/bold format for the Hologram.
static final PlayerSetting<Boolean>	NOTIFICATIONS	Whether the player should receive chat notifications.
static final PlayerSetting<ParticleReducer>	PARTICLE_REDUCTION	How much to reduce particles by.
static final PlayerSetting<PetCosmetics>	PET_COSMETICS	What cosmetics the player's pets should have.
static final PlayerSetting<PetPosition>	PET_POSITION	Where the player's pet should be placed.
static final PlayerSetting<Boolean>	SOUND_NOTIFICATIONS	Whether the player should receive sound notifications.
static final PlayerSetting<PlayerSetting.VelocityPower>	STRUCTURE_VELOCITY	How much the player should be launched when spawning a structure, to "avoid" suffocation.

Method Summary

Modifier and Type	Method	Description
static @Nullable PlayerSetting<?>	byId(@Nullable String id)	Fetches a Setting by its ID.
boolean	equals(Object obj)
T	getDefaultValue()	Fetches the default value of this setting.
@NotNull String	getDescription()	Fetches the setting's description.
@NotNull String	getDisplayName()	Fetches the setting's display name.
@NotNull String	getId()	Fetches the Setting's ID.
@NotNull List<T>	getPossibleValues()	Fetches all of the possible values for this setting.
static <T> T	getSettingValue(@NotNull Player p, @NotNull PlayerSetting<T> setting)	Fetches the setting value off of a Player.
@NotNull Class<T>	getType()	Fetches the Setting Type.
int	hashCode()
static @NotNull PlayerSetting<?>[]	values()	Creates an array of all of the Settings.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

NOTIFICATIONS

public static final PlayerSetting<Boolean> NOTIFICATIONS

Whether the player should receive chat notifications.

SOUND_NOTIFICATIONS

public static final PlayerSetting<Boolean> SOUND_NOTIFICATIONS

Whether the player should receive sound notifications.

STRUCTURE_VELOCITY

public static final PlayerSetting<PlayerSetting.VelocityPower> STRUCTURE_VELOCITY

How much the player should be launched when spawning a structure, to "avoid" suffocation.

PET_POSITION

public static final PlayerSetting<PetPosition> PET_POSITION

Where the player's pet should be placed.

PET_COSMETICS

public static final PlayerSetting<PetCosmetics> PET_COSMETICS

What cosmetics the player's pets should have.

HOLOGRAM_FORMAT

public static final PlayerSetting<PlayerSetting.HologramFormat> HOLOGRAM_FORMAT

The color/bold format for the Hologram.

PARTICLE_REDUCTION

public static final PlayerSetting<ParticleReducer> PARTICLE_REDUCTION

How much to reduce particles by.

EMOTE_COLOR

public static final PlayerSetting<DyeColor> EMOTE_COLOR

The color of the armor when using emotes.

Method Details

getDefaultValue

@NotNull
public T getDefaultValue()

Fetches the default value of this setting.

Returns:

Default Value

getId

@NotNull
public @NotNull String getId()

Fetches the Setting's ID.

Returns:

Setting ID

getType

@NotNull
public @NotNull Class<T> getType()

Fetches the Setting Type.

Returns:

Setting Type

getPossibleValues

@NotNull
public @NotNull List<T> getPossibleValues()

Fetches all of the possible values for this setting.

Returns:

List of Possible Values

getSettingValue

public static <T> T getSettingValue(@NotNull
 @NotNull Player p,
 @NotNull
 @NotNull PlayerSetting<T> setting)
                             throws IllegalArgumentException

Fetches the setting value off of a Player.

Type Parameters:

T - Setting Type

Parameters:

p - Player to fetch from

setting - Setting to fetch

Returns:

Setting Value

Throws:

IllegalArgumentException - if player or setting is null

getDisplayName

@NotNull
public @NotNull String getDisplayName()

Fetches the setting's display name.

Returns:

Setting Display Name

getDescription

@NotNull
public @NotNull String getDescription()

Fetches the setting's description.

Returns:

Setting Description

values

@NotNull
public static @NotNull PlayerSetting<?>[] values()

Creates an array of all of the Settings.

Returns:

Setting Values Array

byId

@Nullable
public static @Nullable PlayerSetting<?> byId(@Nullable
 @Nullable String id)

Fetches a Setting by its ID.

Parameters:

id - Setting ID

Returns:

Setting

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object