Package com.minecolonies.core.colony.buildings.moduleviews

Class SettingsModuleView

java.lang.Object

com.minecolonies.api.colony.buildings.modules.AbstractBuildingModuleView

com.minecolonies.core.colony.buildings.moduleviews.SettingsModuleView

All Implemented Interfaces:

IBuildingModuleView, ICommonSettingsModule, ISettingsModuleView

Direct Known Subclasses:

TownHallSettingsModuleView

public class SettingsModuleView
extends AbstractBuildingModuleView
implements ISettingsModuleView

Module containing all settings (client side).

Field Summary

Fields inherited from class com.minecolonies.api.colony.buildings.modules.AbstractBuildingModuleView

buildingView, colonyView

Constructor Summary

Constructors

Constructor	Description
SettingsModuleView()

Method Summary

Modifier and Type	Method	Description
void	deserialize(@NotNull net.minecraft.network.RegistryFriendlyByteBuf buf)	Deserialize the data on the client side.
net.minecraft.network.chat.Component	getDesc()	Get the lang string for the title.
net.minecraft.resources.ResourceLocation	getIconResourceLocation()	Get the resource location of the icon for the module view.
<T extends ISetting<?>> T	getSetting(ISettingKey<T> key)	Get a specific setting.
List<ISettingKey<? extends ISetting<?>>>	getSettingsToShow()	Get the full settings map.
com.ldtteam.blockui.views.BOWindow	getWindow()	Get the matching window for the module.
void	trigger(ISettingKey<?> key)	Trigger a setting of a specific key.
void	updateSetting(ISettingKey<?> settingKey, ISetting<?> value, net.minecraft.server.level.ServerPlayer sender)	Update a given settings value.

Methods inherited from class com.minecolonies.api.colony.buildings.modules.AbstractBuildingModuleView

canBeHiredAs, getBuildingView, getColony, getProducer, setBuildingView, setColonyView, setProducer

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

getBuildingView, getColony, getIcon, getProducer, isPageVisible, setBuildingView, setColonyView, setProducer

Constructor Details

SettingsModuleView

public SettingsModuleView()

Method Details

deserialize

public void deserialize(@NotNull
 @NotNull net.minecraft.network.RegistryFriendlyByteBuf buf)

Description copied from interface: IBuildingModuleView

Deserialize the data on the client side.

Specified by:

deserialize in interface IBuildingModuleView

Parameters:

buf - the buffer to read it from.

getSettingsToShow

public List<ISettingKey<? extends ISetting<?>>> getSettingsToShow()

Get the full settings map.

Returns:

the list of string key and ISetting value.

getSetting

@Nullable
public <T extends ISetting<?>> T getSetting(ISettingKey<T> key)

Description copied from interface: ICommonSettingsModule

Get a specific setting.

Specified by:

getSetting in interface ICommonSettingsModule

Type Parameters:

T - the type of setting.

Parameters:

key - the key of the setting.

Returns:

the setting.

getWindow

public com.ldtteam.blockui.views.BOWindow getWindow()

Description copied from interface: IBuildingModuleView

Get the matching window for the module.

Specified by:

getWindow in interface IBuildingModuleView

Returns:

the window.

getIconResourceLocation

public net.minecraft.resources.ResourceLocation getIconResourceLocation()

Description copied from interface: IBuildingModuleView

Get the resource location of the icon for the module view.

Specified by:

getIconResourceLocation in interface IBuildingModuleView

Returns:

the resource location.

getDesc

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

Description copied from interface: IBuildingModuleView

Get the lang string for the title.

Specified by:

getDesc in interface IBuildingModuleView

Returns:

the lang string.

trigger

public void trigger(ISettingKey<?> key)

Description copied from interface: ICommonSettingsModule

Trigger a setting of a specific key.

Specified by:

trigger in interface ICommonSettingsModule

Parameters:

key - the settings key.

updateSetting

public void updateSetting(ISettingKey<?> settingKey,
 ISetting<?> value,
 net.minecraft.server.level.ServerPlayer sender)

Description copied from interface: ICommonSettingsModule

Update a given settings value.

Specified by:

updateSetting in interface ICommonSettingsModule

Parameters:

settingKey - the given key.

value - the value.

sender - the player that updated the setting.