C# Class Nexus.Client.ModManagement.Scripting.XmlScript.ConditionStateManager

This class manages the state of the installation.
Show file Open project: NexusMods/NexusModManager-4.5 Class Usage Examples

Public Methods

Method Description
ConditionStateManager ( IMod p_modMod, IGameMode p_gmdGameMode, IPluginManager p_pmgPluginManager, IEnvironmentInfo p_eifEnvironmentInfo ) : System

A simple constructor that initializes the object with the given values.

GetImage ( string p_strPath ) : Image

Gets the specified image from the mod against which the script is running.

RemoveFlags ( Option p_pifPlugin ) : void

Removes the all flags owned by the given option.

SetFlagValue ( string p_strFlagName, string p_strValue, Option p_pifPlugin ) : void

Sets the value of a conditional flag.

Method Details

ConditionStateManager() public method

A simple constructor that initializes the object with the given values.
public ConditionStateManager ( IMod p_modMod, IGameMode p_gmdGameMode, IPluginManager p_pmgPluginManager, IEnvironmentInfo p_eifEnvironmentInfo ) : System
p_modMod IMod The mod being installed.
p_gmdGameMode IGameMode The game mode currently bieng managed.
p_pmgPluginManager IPluginManager The plugin manager.
p_eifEnvironmentInfo IEnvironmentInfo The application's envrionment info.
return System

GetImage() public method

Gets the specified image from the mod against which the script is running.
public GetImage ( string p_strPath ) : Image
p_strPath string The path to the image in the mod to retrieve.
return Image

RemoveFlags() public method

Removes the all flags owned by the given option.
public RemoveFlags ( Option p_pifPlugin ) : void
p_pifPlugin Option The owner of the flags to remove.
return void

SetFlagValue() public method

Sets the value of a conditional flag.
public SetFlagValue ( string p_strFlagName, string p_strValue, Option p_pifPlugin ) : void
p_strFlagName string The name of the falg whose value is to be set.
p_strValue string The value to which to set the flag.
p_pifPlugin Option The plugin that is responsible for setting the flag's value.
return void