Package com.minecolonies.api.colony.buildings.modules.settings

Interface IStringSetting<S>

All Superinterfaces:

ISetting<S>

All Known Implementing Classes:

BeekeeperCollectionSetting, BuilderModeSetting, CrafterRecipeSetting, GuardFollowModeSetting, GuardPatrolModeSetting, GuardTaskSetting, StringSetting, StringSettingWithDesc

public interface IStringSetting<S>
extends ISetting<S>

String Setting.

Method Summary

Modifier and Type	Method	Description
int	getCurrentIndex()	Get the current index of the setting.
S	getDefault()	Get the default value.
List<String>	getSettings()	Get the list of all settings.
S	getValue()	Get the setting value.
void	set(S value)	Set the setting to a specific index.

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.settings.ISetting

copyValue, getInactiveReason, getLayoutItem, getToolTipText, isActive, isActive, onUpdate, render, setHoverPane, setupHandler, shouldHideWhenInactive, trigger, updateSetting

Method Details

getValue

S getValue()

Get the setting value.

Specified by:

getValue in interface ISetting<S>

Returns:

the current value.

getDefault

S getDefault()

Get the default value.

Returns:

the default value.

getCurrentIndex

int getCurrentIndex()

Get the current index of the setting.

Returns:

the index.

getSettings

List<String> getSettings()

Get the list of all settings.

Returns:

a copy of the list.

set

void set(S value)

Set the setting to a specific index.

Parameters:

value - the value to set.