IGlobalModSetting

public interface IGlobalModSetting : IModSetting

A setting that belongs to the player rather than to a world: it knows its tab and category, can warn about a reload or restart, and raises OnSettingApplied when applied.

Implements: IModSetting
Derived: IGlobalModSettingsCategory · IControlBindingSetting · IGlobalValueSetting<T>

Properties

RestartScope

SettingRestartScope RestartScope { get; set; }

What changing this setting costs the player. Global settings only: a world setting belongs to a save and is applied along with it, so it has nothing to restart.

Category

IGlobalModSettingsCategory Category { get; }

Gets the IGlobalModSettingsCategory this setting belongs to.

Tab

IGlobalModSettingsTab Tab { get; }

Gets the IGlobalModSettingsTab this setting belongs to.

Events

OnSettingApplied

event OnSettingAppliedEvent OnSettingApplied;

Occurs when ApplyCurrentChange() runs, whether or not the value differs. Type OnSettingAppliedEvent.