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

Class GuardTaskSetting

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.GuardTaskSetting

All Implemented Interfaces:

ISetting<String>, IStringSetting<String>

public class GuardTaskSetting
extends StringSettingWithDesc

Stores a guard task setting.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FOLLOW
static final String	GUARD
static final String	PATROL	Different setting possibilities.
static final String	PATROL_MINE

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

currentIndex, MAX_BUTTON_WIDTH

Constructor Summary

Constructors

Constructor	Description
GuardTaskSetting()	Create a new guard task list setting.
GuardTaskSetting(String... list)	Create a new guard task list setting.
GuardTaskSetting(List<String> settings, int currentIndex)	Create a new string list setting.

Method Summary

Modifier and Type	Method	Description
protected int	getButtonWidth(ISettingsModuleView settingsModuleView)	Get the width to render the button at.
net.minecraft.resources.ResourceLocation	getLayoutItem()	Get the resource location of the view you want to use for this setting.
void	onUpdate(IBuilding building, net.minecraft.server.level.ServerPlayer sender)	Called when updated.
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.

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

copyValue, getCurrentIndex, getDefault, getDisplayText, getSettings, getValue, isIndexAllowed, set, 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, isActive, isActive, setHoverPane, shouldHideWhenInactive

Field Details

PATROL

public static final String PATROL

Different setting possibilities.

See Also:

• Constant Field Values

GUARD

public static final String GUARD

See Also:

• Constant Field Values

FOLLOW

public static final String FOLLOW

See Also:

• Constant Field Values

PATROL_MINE

public static final String PATROL_MINE

See Also:

• Constant Field Values

Constructor Details

GuardTaskSetting

public GuardTaskSetting()

Create a new guard task list setting.

GuardTaskSetting

public GuardTaskSetting(String... list)

Create a new guard task list setting.

GuardTaskSetting

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

Create a new string list setting.

Parameters:

settings - the overall list of settings.

currentIndex - the current selected index.

Method Details

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<String>

Overrides:

getLayoutItem in class StringSetting

Returns:

the resource location indicating which view to use.

onUpdate

public void onUpdate(IBuilding building,
 net.minecraft.server.level.ServerPlayer sender)

Description copied from interface: ISetting

Called when updated.

Parameters:

building - the building its updated for.

sender - the player triggering the update.

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<String>

Overrides:

setupHandler in class StringSetting

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<String>

Overrides:

render in class StringSetting

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.

getButtonWidth

protected int getButtonWidth(ISettingsModuleView settingsModuleView)

Description copied from class: StringSetting

Get the width to render the button at. This can be at most 145, to leave adequate spacing.

Overrides:

getButtonWidth in class StringSetting

Parameters:

settingsModuleView - the module view that holds the setting.

Returns:

the width.