Package com.minecolonies.api.colony.buildings.modules

Interface ICommonSettingsModule

All Known Subinterfaces:
ISettingsModule, ISettingsModuleView
All Known Implementing Classes:
SettingsModule, SettingsModuleView, TownHallSettingsModuleView
public interface ICommonSettingsModule
Common (sideless) Settings module interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends ISetting<?>>
    T
    getSetting(ISettingKey<T> key)
    Get a specific setting.
    default 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.

  • Method Details

    • getSetting

      @Nullable <T extends ISetting<?>> T getSetting(ISettingKey<T> key)
      Get a specific setting.
      Type Parameters:
      T - the type of setting.
      Parameters:
      key - the key of the setting.
      Returns:
      the setting.

    • trigger

      default void trigger(ISettingKey<?> key)
      Trigger a setting of a specific key.
      Parameters:
      key - the settings key.

    • updateSetting

      void updateSetting(ISettingKey<?> settingKey, ISetting<?> value, net.minecraft.server.level.ServerPlayer sender)
      Update a given settings value.
      Parameters:
      settingKey - the given key.
      value - the value.
      sender - the player that updated the setting.