Package com.viaversion.viafabricplus.api.settings

Class AbstractSetting<T>

java.lang.Object

com.viaversion.viafabricplus.api.settings.AbstractSetting<T>

Type Parameters:

T - The type of the setting.

Direct Known Subclasses:

BooleanSetting, ButtonSetting, ModeSetting, VersionedBooleanSetting

public abstract class AbstractSetting<T>
extends Object

This class is the base for all settings. It contains the name, the default value and the current value. Developer's should always use the implementations of this class, and not this class itself.

Constructor Summary

Constructors

Constructor	Description
AbstractSetting(SettingGroup parent, net.minecraft.network.chat.MutableComponent name, T defaultValue)

Method Summary

Modifier and Type	Method	Description
T	getCurrentValue()
T	getDefaultValue()
net.minecraft.network.chat.MutableComponent	getName()
net.minecraft.network.chat.Component	getTooltip()
String	getTranslationKey()
T	getValue()
void	lockValue()	Locks the setting so any change to the first value loaded will only be applied after restarting the game.
static String	mapTranslationKey(String input)	Cuts the name of a translation from its key / path.
void	onValueChanged()
abstract void	read(com.google.gson.JsonObject object)
void	setTooltip(Supplier<net.minecraft.network.chat.Component> tooltip)
void	setTooltip(net.minecraft.network.chat.Component tooltip)
void	setValue(T value)
abstract void	write(com.google.gson.JsonObject object)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractSetting

public AbstractSetting(SettingGroup parent,
 net.minecraft.network.chat.MutableComponent name,
 T defaultValue)

Method Details

write

public abstract void write(com.google.gson.JsonObject object)

read

public abstract void read(com.google.gson.JsonObject object)

onValueChanged

public void onValueChanged()

getName

public net.minecraft.network.chat.MutableComponent getName()

getTranslationKey

public String getTranslationKey()

Returns:

The translation key of the name.

mapTranslationKey

public static String mapTranslationKey(String input)

Cuts the name of a translation from its key / path.

Parameters:

input - The translation key.

Returns:

The name of the translation. (E. g: "viafabricplus.settings.base" -> "base")

getDefaultValue

public T getDefaultValue()

getValue

public T getValue()

getCurrentValue

public T getCurrentValue()

setValue

public void setValue(T value)

getTooltip

public net.minecraft.network.chat.Component getTooltip()

setTooltip

public void setTooltip(net.minecraft.network.chat.Component tooltip)

setTooltip

public void setTooltip(Supplier<net.minecraft.network.chat.Component> tooltip)

lockValue

public void lockValue()

Locks the setting so any change to the first value loaded will only be applied after restarting the game.