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

A condition that requires a specified plugin to be in a specified PluginState.
Inheritance: ICondition
Show file Open project: NexusMods/NexusModManager-4.5

Public Methods

Method Description
GetIsFulfilled ( ConditionStateManager p_csmStateManager ) : bool

Gets whether or not the condition is fulfilled.

The condition is fulfilled if the specified File is in the specified State.

GetMessage ( ConditionStateManager p_csmStateManager ) : string

Gets a message describing whether or not the condition is fulfilled.

If the condition is fulfilled the message is "Passed." If the condition is not fulfilled the message uses the pattern: File '<file>' is not <state>.

PluginCondition ( string p_strPluginPath, PluginState p_pnsState ) : System

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

Method Details

GetIsFulfilled() public method

Gets whether or not the condition is fulfilled.
The condition is fulfilled if the specified File is in the specified State.
public GetIsFulfilled ( ConditionStateManager p_csmStateManager ) : bool
p_csmStateManager ConditionStateManager The manager that tracks the currect install state.
return bool

GetMessage() public method

Gets a message describing whether or not the condition is fulfilled.
If the condition is fulfilled the message is "Passed." If the condition is not fulfilled the message uses the pattern: File '<file>' is not <state>.
public GetMessage ( ConditionStateManager p_csmStateManager ) : string
p_csmStateManager ConditionStateManager The manager that tracks the currect install state.
return string

PluginCondition() public method

A simple constructor that initializes the object with the given values.
public PluginCondition ( string p_strPluginPath, PluginState p_pnsState ) : System
p_strPluginPath string The plugin that must be is the specified state.
p_pnsState PluginState The state in which the specified plugin must be.
return System