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

Class GuardPatrolModeSetting

java.lang.Object

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

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

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

All Implemented Interfaces:

ISetting<String>, IStringSetting<String>

public class GuardPatrolModeSetting
extends StringSettingWithDesc

Stores the patrol mode setting.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTO	Different setting possibilities.
static final String	MANUAL

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

currentIndex, MAX_BUTTON_WIDTH

Constructor Summary

Constructors

Constructor	Description
GuardPatrolModeSetting()	Create a new patrol mode list setting.
GuardPatrolModeSetting(List<String> settings, int currentIndex)	Create a new patrol mode list setting.

Method Summary

Modifier and Type	Method	Description
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).
boolean	shouldHideWhenInactive()	Configures if this setting is inactive, whether it should show in the settings at all.

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

copyValue, getButtonWidth, getCurrentIndex, getDefault, getDisplayText, 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

getInactiveReason, getToolTipText, onUpdate, setHoverPane

Field Details

AUTO

public static final String AUTO

Different setting possibilities.

See Also:

• Constant Field Values

MANUAL

public static final String MANUAL

See Also:

• Constant Field Values

Constructor Details

GuardPatrolModeSetting

public GuardPatrolModeSetting()

Create a new patrol mode list setting.

GuardPatrolModeSetting

public GuardPatrolModeSetting(List<String> settings,
 int currentIndex)

Create a new patrol mode list setting.

Parameters:

settings - the overall list of settings.

currentIndex - the current selected index.

Method Details

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.

shouldHideWhenInactive

public boolean shouldHideWhenInactive()

Description copied from interface: ISetting

Configures if this setting is inactive, whether it should show in the settings at all. This would default to false in most cases as we want to prevent not showing settings, but certain settings related to addon mods may want to be hidden if another mod is not loaded.

Returns:

true if the inactive setting should be hidden.