Class ConditionsBuilder

Fluent builder for Kingmaker.ElementsSystem.ConditionsChecker

Inheritance
System.Object
ConditionsBuilder
Namespace: BlueprintCore.Conditions.Builder
Assembly: BlueprintCore.dll
Syntax
public class ConditionsBuilder
Remarks

Conditions are supported using extension methods. Include the extension namespaces as needed.

When Build(Validator) is called the Kingmaker.ElementsSystem.ConditionsChecker is constructed, validated, and returned. If any errors are detected by Validator they will be logged as a warning.

Do not call Build(Validator) twice on the same builder.

If a method calls for a string to represent any type of blueprint, you can pass the blueprint's Kingmaker.Blueprints.SimpleBlueprint.AssetGuid as a string or as a name you already provided using AddGuidsByName().

AreaEx Conditions involving the game map, dungeons, or locations. See also KingdomEx for location related conditions specifically tied to the Kingdom and Crusade system.
BasicEx Most game mechanics related conditions not included in ContextEx.
ContextEx Most Kingmaker.UnitLogic.Mechanics.Conditions.ContextCondition types. Some Kingmaker.UnitLogic.Mechanics.Conditions.ContextCondition types are in more specific extensions such as KingdomEx.
KingdomEx Conditions involving the Kingdom and Crusade system.
MiscEx Conditions without a better extension container such as game difficulty.
NewEx Conditions defined in BlueprintCore and not available in the base game.
StoryEx Conditions related to the story such as companion stories, quests, name changes, and etudes.
Make a melee attack if the target is in range: 
// Provides the MeleeAttack extension for ActionsBuilder
using BlueprintCore.Actions.Builder.ContextEx; 
// Provides the TargetInMeleeRange extension for ConditionsBuilder
using BlueprintCore.Conditions.Builder.NewEx;

var actionList =
ActionsBuilder.New()
.Conditional(
ConditionsBuilder.New().TargetInMeleeRange(),
ifTrue: ActionsBuilder.New().MeleeAttack())
.build();

Methods

| Improve this Doc View Source

Add(Condition)

Adds the specified Kingmaker.ElementsSystem.Condition to the checker, with validation.

Declaration
public ConditionsBuilder Add(Condition condition)
Parameters
Type Name Description
Kingmaker.ElementsSystem.Condition condition
Returns
Type Description
ConditionsBuilder
Remarks

It is recommended to only call this from an extension class or when adding a condition type not supported by the builder.

| Improve this Doc View Source

Add<C>(Action<C>)

Adds a Kingmaker.ElementsSystem.Condition of the specified type to the checker.

Declaration
public ConditionsBuilder Add<C>(Action<C> init = null)
    where C : Condition, new()
Parameters
Type Name Description
System.Action<C> init

Optional initialization System.Action run on the condition.
Returns
Type Description
ConditionsBuilder
Type Parameters
Name Description
C
Remarks

It is recommended to only call this when adding a condition type not supported by the builder.

| Improve this Doc View Source

AddAll(ConditionsChecker, Func<Condition, Boolean>)

Adds all conditions from conditionsChecker. This is a shallow copy so changes to those conditions affect the original list as well.

Declaration
public ConditionsBuilder AddAll(ConditionsChecker conditionsChecker, Func<Condition, bool> matcher)
Parameters
Type Name Description
Kingmaker.ElementsSystem.ConditionsChecker conditionsChecker
System.Func<Kingmaker.ElementsSystem.Condition, System.Boolean> matcher

Only conditions matching this function are added
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddAll(ConditionsChecker, Type[])

Adds all conditions from conditionsChecker. This is a shallow copy so changes to those conditions affect the original list as well.

Declaration
public ConditionsBuilder AddAll(ConditionsChecker conditionsChecker, params Type[] typesToExclude)
Parameters
Type Name Description
Kingmaker.ElementsSystem.ConditionsChecker conditionsChecker
System.Type[] typesToExclude

Types of conditions which will not be added
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddFalse()

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.False

Declaration
public ConditionsBuilder AddFalse()
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddGreaterThan(FloatEvaluator, FloatEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.GreaterThan

Declaration
public ConditionsBuilder AddGreaterThan(FloatEvaluator Value, FloatEvaluator MinValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.FloatEvaluator Value
Kingmaker.ElementsSystem.FloatEvaluator MinValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddGreaterThan(IntEvaluator, IntEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.GreaterThan

Declaration
public ConditionsBuilder AddGreaterThan(IntEvaluator Value, IntEvaluator MinValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.IntEvaluator Value
Kingmaker.ElementsSystem.IntEvaluator MinValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddGreaterThanOrEqualTo(FloatEvaluator, FloatEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.LessThan, negated

Declaration
public ConditionsBuilder AddGreaterThanOrEqualTo(FloatEvaluator Value, FloatEvaluator MaxValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.FloatEvaluator Value
Kingmaker.ElementsSystem.FloatEvaluator MaxValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddGreaterThanOrEqualTo(IntEvaluator, IntEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.LessThan, negated

Declaration
public ConditionsBuilder AddGreaterThanOrEqualTo(IntEvaluator Value, IntEvaluator MaxValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.IntEvaluator Value
Kingmaker.ElementsSystem.IntEvaluator MaxValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddIsEqual(IntEvaluator, IntEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.IsEqual

Declaration
public ConditionsBuilder AddIsEqual(IntEvaluator FirstValue, IntEvaluator SecondValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.IntEvaluator FirstValue
Kingmaker.ElementsSystem.IntEvaluator SecondValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddIsNotEqual(IntEvaluator, IntEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.IsEqual, negated

Declaration
public ConditionsBuilder AddIsNotEqual(IntEvaluator FirstValue, IntEvaluator SecondValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.IntEvaluator FirstValue
Kingmaker.ElementsSystem.IntEvaluator SecondValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddLessThan(FloatEvaluator, FloatEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.LessThan

Declaration
public ConditionsBuilder AddLessThan(FloatEvaluator Value, FloatEvaluator MaxValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.FloatEvaluator Value
Kingmaker.ElementsSystem.FloatEvaluator MaxValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddLessThan(IntEvaluator, IntEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.LessThan

Declaration
public ConditionsBuilder AddLessThan(IntEvaluator Value, IntEvaluator MaxValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.IntEvaluator Value
Kingmaker.ElementsSystem.IntEvaluator MaxValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddLessThanOrEqualTo(FloatEvaluator, FloatEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.GreaterThan, negated

Declaration
public ConditionsBuilder AddLessThanOrEqualTo(FloatEvaluator Value, FloatEvaluator MinValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.FloatEvaluator Value
Kingmaker.ElementsSystem.FloatEvaluator MinValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddLessThanOrEqualTo(IntEvaluator, IntEvaluator)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.GreaterThan, negated

Declaration
public ConditionsBuilder AddLessThanOrEqualTo(IntEvaluator Value, IntEvaluator MinValue)
Parameters
Type Name Description
Kingmaker.ElementsSystem.IntEvaluator Value
Kingmaker.ElementsSystem.IntEvaluator MinValue
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddOrAndLogic(ConditionsBuilder, Boolean)

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.OrAndLogic

Declaration
public ConditionsBuilder AddOrAndLogic(ConditionsBuilder conditions, bool negate = false)
Parameters
Type Name Description
ConditionsBuilder conditions
System.Boolean negate
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

AddTrue()

Adds Kingmaker.Designers.EventConditionActionSystem.Conditions.False, negated

Declaration
public ConditionsBuilder AddTrue()
Returns
Type Description
ConditionsBuilder
| Improve this Doc View Source

Build(Validator)

Declaration
public ConditionsChecker Build(Validator parentValidator = null)
Parameters
Type Name Description
Validator parentValidator

If specified, indicates that errors should be reported to this validator. As a result errors will not be logged by this call but can be logged using the provided validator.
Returns
Type Description
Kingmaker.ElementsSystem.ConditionsChecker

A Kingmaker.ElementsSystem.ConditionsChecker containing all specified conditions. Any validation errors are logged as a warning. Do not call twice on the same builder.
| Improve this Doc View Source

New()

Declaration
public static ConditionsBuilder New()
Returns
Type Description
ConditionsBuilder

A new ConditionsBuilder
| Improve this Doc View Source

UseOr()

Causes the checker to return true if at least one conditions check passes. By default all checks must pass.

Declaration
public ConditionsBuilder UseOr()
Returns
Type Description
ConditionsBuilder

Operators

| Improve this Doc View Source

Implicit(ConditionsChecker to ConditionsBuilder)

Declaration
public static implicit operator ConditionsBuilder(ConditionsChecker conditionsChecker)
Parameters
Type Name Description
Kingmaker.ElementsSystem.ConditionsChecker conditionsChecker
Returns
Type Description
ConditionsBuilder

Extension Methods