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

Interface ISettingsModule

All Superinterfaces:

IBuildingModule, ICommonSettingsModule, IHasDirty

All Known Implementing Classes:

SettingsModule

public interface ISettingsModule
extends IBuildingModule, ICommonSettingsModule

Settings module interface.

Method Summary

Modifier and Type	Method	Description
<T extends ISetting<?>> @NotNull Optional<T>	getOptionalSetting(ISettingKey<T> key)	Get a specific setting.
<S, T extends ISetting<S>> S	getSettingValueOrDefault(ISettingKey<T> key, S def)	Get setting value or default.
ISettingsModule	with(ISettingKey<?> key, ISetting<?> setting)	Register a new setting.

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.IBuildingModule

getBuilding, getProducer, serializeToView, serializeToView, setBuilding, setProducer

Methods inherited from interface com.minecolonies.api.colony.buildings.modules.ICommonSettingsModule

getSetting, trigger, updateSetting

Methods inherited from interface com.minecolonies.api.util.IHasDirty

checkDirty, clearDirty, markDirty

Method Details

with

ISettingsModule with(ISettingKey<?> key,
 ISetting<?> setting)

Register a new setting.

Parameters:

key - the key of the setting.

setting - the setting.

Returns:

the instance of the module.

getOptionalSetting

@NotNull
<T extends ISetting<?>> @NotNull Optional<T> getOptionalSetting(ISettingKey<T> key)

Get a specific setting.

Type Parameters:

T - the type of setting.

Parameters:

key - the key of the setting.

Returns:

the setting, if it exists and is active.

getSettingValueOrDefault

<S,
T extends ISetting<S>> S getSettingValueOrDefault(ISettingKey<T> key,
 S def)

Get setting value or default.

Type Parameters:

T - the type of setting.

S - the setting value type.

Parameters:

key - the key of the setting.

def - the default.

Returns:

the setting value or the default.