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

A condition that requires a specified flag to have a specific value.
Inheritance: ICondition
Show file Open project: NexusMods/NexusModManager-4.5

Public Methods

Method Description
FlagCondition ( string p_strFlagName, string p_strValue ) : System

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

GetIsFulfilled ( ConditionStateManager p_csmStateManager ) : bool

Gets whether or not the condition is fulfilled.

The condition is fulfilled if the specified flag has the specified value.

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: Flag '<flag>' is not <value>.

Method Details

FlagCondition() public method

A simple constructor that initializes the object with the given values.
public FlagCondition ( string p_strFlagName, string p_strValue ) : System
p_strFlagName string
p_strValue string The value the flag that must have.
return System

GetIsFulfilled() public method

Gets whether or not the condition is fulfilled.
The condition is fulfilled if the specified flag has the specified value.
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: Flag '<flag>' is not <value>.
public GetMessage ( ConditionStateManager p_csmStateManager ) : string
p_csmStateManager ConditionStateManager The manager that tracks the currect install state.
return string