IGearsMod

public interface IGearsMod

What Gears knows about one loaded mod: the game's Mod, its global and world settings, and the optional icon and banner declared in ModInfo.xml. Handed to IGearsModApi.InitMod and returned by GearsSettingsManager.

Properties

Mod

Mod Mod { get; }

Gets the game's Mod object for this mod.

GlobalSettings

IModGlobalSettings GlobalSettings { get; }

Gets the mod's global settings tree as an IModGlobalSettings. Never null; empty for a mod that declares none.

WorldSettings

IModWorldSettings WorldSettings { get; }

Gets the mod's world settings tree as an IModWorldSettings. Never null; empty for a mod that declares none.

BannerPath

string BannerPath { get; set; }

Gets or sets the banner image path, relative to the mod folder. Seeded from <Banner value> in ModInfo.xml.

IconPath

string IconPath { get; set; }

Gets or sets the icon image path, relative to the mod folder. Seeded from <Icon value> in ModInfo.xml.

Methods

HasGearsApi()

bool HasGearsApi();

Returns true if at least one IGearsModApi implementation was found in the mod's assemblies.

HasGlobalSettings()

bool HasGlobalSettings();

Returns true if the mod has at least one global tab.

HasWorldSettings()

bool HasWorldSettings();

Returns true if the mod has at least one world setting.

HasBanner()

bool HasBanner();

Returns true if BannerPath is set and the file exists.

HasIcon()

bool HasIcon();

Returns true if IconPath is set and the file exists.

SaveSettings()

bool SaveSettings();

Writes the player-level saved settings file now, including this mod's current global values. Returns true if the file exists afterwards.