IGlobalModSettingsTab

InterfaceNamespace GearsAPI.Settings.GlobalAssembly GearsAPI.dllSource

public interface IGlobalModSettingsTab

A tab in the mod's settings page. A tab is not a setting: it has a tooltip rather than a caption and description, and no preview or restart scope.

Properties

string Name { get; }

Gets the tab's identity within the mod.

string DisplayKey { get; }

Gets the localization key for the tab label. Falls back to Name.

string TooltipKey { get; set; }

Gets or sets the localization key for the hover text.

IGlobalModSettingsCategory GetCategory(string categoryName);

Returns the IGlobalModSettingsCategory named categoryName, or null.

IGlobalModSettingsCategory CreateCategory(string categoryName, string displayName);

Creates a category with the given name and display key. Throws ArgumentException on a duplicate name.

IGlobalModSettingsCategory GetOrCreateCategory(string categoryName, string displayName);

Returns the existing category, or creates it.

bool AddCategory(IGlobalModSettingsCategory category);

Adds an existing category object. Returns false if the name is taken.

bool RemoveCategory(string categoryName);

Removes the category with that name. Returns whether one was removed.

bool RemoveCategory(IGlobalModSettingsCategory category);

Removes that category. Returns whether it was removed.

List<IGlobalModSettingsCategory> GetAllCategories();

Returns every category as a List<IGlobalModSettingsCategory>.

List<IGlobalModSetting> GetAllModSettings();

Returns every setting in every category of this tab, categories included, as a List<IGlobalModSetting>.

bool HasToolTip();

Returns true if TooltipKey is set.

string GetToolTipText();

Returns the localized tooltip.

string GetDisplayName();

Returns the localized tab label.