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

Class BuilderModeSetting

java.lang.Object

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

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

All Implemented Interfaces:

ISetting<String>, IStringSetting<String>

public class BuilderModeSetting
extends StringSetting

Stores the builder mode setting.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUILDER_MODES_RESEARCH
static final String	NEEDS_RESEARCH_REASON	Reason display constants.

Fields inherited from class com.minecolonies.core.colony.buildings.modules.settings.StringSetting

currentIndex, MAX_BUTTON_WIDTH

Constructor Summary

Constructors

Constructor	Description
BuilderModeSetting()	Create the builder mode setting.
BuilderModeSetting(List<String> value, int curr)	Create the builder mode setting.

Method Summary

Modifier and Type	Method	Description
static @NotNull String	getActualValue(@NotNull IBuilding building)
protected net.minecraft.network.chat.Component	getDisplayText()	Get the text to render on the button, defaults to the stored index value.
@Nullable net.minecraft.network.chat.Component	getInactiveReason()	Get the reason why this setting is inactive.
net.minecraft.network.chat.Component	getToolTipText()	Get the tooltip text to render on the button, defaults to null.
boolean	isActive(ISettingsModule module)	Check if this setting is active (provided ISettingsModule.getOptionalSetting(ISettingKey) is used).
boolean	isActive(ISettingsModuleView module)	Check if this setting is active (provided ISettingsModule.getOptionalSetting(ISettingKey) is used).

Methods inherited from class com.minecolonies.core.colony.buildings.modules.settings.StringSetting

copyValue, getButtonWidth, getCurrentIndex, getDefault, getLayoutItem, getSettings, getValue, isIndexAllowed, render, set, setupHandler, trigger, updateSetting

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

onUpdate, setHoverPane, shouldHideWhenInactive

Field Details

NEEDS_RESEARCH_REASON

public static final String NEEDS_RESEARCH_REASON

Reason display constants.

See Also:

• Constant Field Values

BUILDER_MODES_RESEARCH

public static final String BUILDER_MODES_RESEARCH

See Also:

• Constant Field Values

Constructor Details

BuilderModeSetting

public BuilderModeSetting()

Create the builder mode setting.

BuilderModeSetting

public BuilderModeSetting(List<String> value,
 int curr)

Create the builder mode setting.

Parameters:

value - the list of possible settings.

curr - the current setting.

Method Details

getActualValue

@NotNull
public static @NotNull String getActualValue(@NotNull
 @NotNull IBuilding building)

getDisplayText

protected net.minecraft.network.chat.Component getDisplayText()

Description copied from class: StringSetting

Get the text to render on the button, defaults to the stored index value.

Overrides:

getDisplayText in class StringSetting

Returns:

the component to render on the button.

getToolTipText

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

Description copied from interface: ISetting

Get the tooltip text to render on the button, defaults to null.

Returns:

the tooltip component to render on the button.

isActive

public boolean isActive(ISettingsModule module)

Description copied from interface: ISetting

Check if this setting is active (provided ISettingsModule.getOptionalSetting(ISettingKey) is used).

Returns:

true if the setting is active;

isActive

public boolean isActive(ISettingsModuleView module)

Description copied from interface: ISetting

Check if this setting is active (provided ISettingsModule.getOptionalSetting(ISettingKey) is used).

Returns:

a component containing a message why this setting is not active, return null if the setting is supposed to be active.

getInactiveReason

@Nullable
public @Nullable net.minecraft.network.chat.Component getInactiveReason()

Description copied from interface: ISetting

Get the reason why this setting is inactive.

Returns:

a component stating why this is inactive, or null if no reason.