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

Class BoolSetting

java.lang.Object

com.minecolonies.core.colony.buildings.modules.settings.BoolSetting

All Implemented Interfaces:

ISetting<Boolean>

public class BoolSetting
extends Object
implements ISetting<Boolean>

Stores a boolean setting.

Constructor Summary

Constructors

Constructor	Description
BoolSetting(boolean init)	Create a new boolean setting.
BoolSetting(boolean value, boolean def)	Create a new boolean setting.

Method Summary

Modifier and Type	Method	Description
void	copyValue(ISetting<?> setting)	Copy value from another instance.
boolean	getDefault()	Get the default value.
net.minecraft.resources.ResourceLocation	getLayoutItem()	Get the resource location of the view you want to use for this setting.
Boolean	getValue()	Get the setting value.
void	render(ISettingKey<?> key, com.ldtteam.blockui.Pane pane, ICommonSettingsModule settingsModuleView, IBuildingView building, com.ldtteam.blockui.views.BOWindow window)	Update the handling (e.g update settings text).
void	setupHandler(ISettingKey<?> key, com.ldtteam.blockui.Pane pane, ICommonSettingsModule settingsModuleView, IBuildingView building, com.ldtteam.blockui.views.BOWindow window)	Add the handling of the specific setting to the box in the UI.
void	trigger()	Trigger a setting.

Methods inherited from class java.lang.Object

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

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

getInactiveReason, getToolTipText, isActive, isActive, onUpdate, setHoverPane, shouldHideWhenInactive, updateSetting

Constructor Details

BoolSetting

public BoolSetting(boolean init)

Create a new boolean setting.

Parameters:

init - the initial value.

BoolSetting

public BoolSetting(boolean value,
 boolean def)

Create a new boolean setting.

Parameters:

value - the value.

def - the default value.

Method Details

getValue

public Boolean getValue()

Get the setting value.

Specified by:

getValue in interface ISetting<Boolean>

Returns:

the set value.

getDefault

public boolean getDefault()

Get the default value.

Returns:

the default value.

getLayoutItem

public net.minecraft.resources.ResourceLocation getLayoutItem()

Description copied from interface: ISetting

Get the resource location of the view you want to use for this setting.

Specified by:

getLayoutItem in interface ISetting<Boolean>

Returns:

the resource location indicating which view to use.

setupHandler

public void setupHandler(ISettingKey<?> key,
 com.ldtteam.blockui.Pane pane,
 ICommonSettingsModule settingsModuleView,
 IBuildingView building,
 com.ldtteam.blockui.views.BOWindow window)

Description copied from interface: ISetting

Add the handling of the specific setting to the box in the UI.

Specified by:

setupHandler in interface ISetting<Boolean>

Parameters:

key - the key of the setting.

pane - the pane of it.

settingsModuleView - the module view that holds the setting.

building - the building.

window - the calling window.

render

public void render(ISettingKey<?> key,
 com.ldtteam.blockui.Pane pane,
 ICommonSettingsModule settingsModuleView,
 IBuildingView building,
 com.ldtteam.blockui.views.BOWindow window)

Description copied from interface: ISetting

Update the handling (e.g update settings text).

Specified by:

render in interface ISetting<Boolean>

Parameters:

key - the key of the setting.

pane - the pane of it.

settingsModuleView - the module view that holds the setting.

building - the building.

window - the calling window.

trigger

public void trigger()

Description copied from interface: ISetting

Trigger a setting.

Specified by:

trigger in interface ISetting<Boolean>

copyValue

public void copyValue(ISetting<?> setting)

Description copied from interface: ISetting

Copy value from another instance.

Specified by:

copyValue in interface ISetting<Boolean>

Parameters:

setting - the setting to copy from