Class BaseCheckConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.DialogSystem.Blueprints.BlueprintCheck.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseCueBaseConfigurator<T, TBuilder>
BaseCheckConfigurator<T, TBuilder>
CheckConfigurator
Inherited Members
BaseBlueprintConfigurator<T, TBuilder>.AdditionalDiceOnAttack(Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<AdditionalDiceOnAttack.WeaponOptions>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, List<AdditionalDiceOnAttack.DamageEntry>, DamageTypeDescription, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, ConditionsBuilder, Nullable<Boolean>, ContextDiceValue, Blueprint<BlueprintWeaponTypeReference>)
BaseBlueprintConfigurator<T, TBuilder>.AddRuleCalculateDamageWithWeaponTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<PhysicalDamageForm>, Nullable<Boolean>, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, Nullable<Boolean>, Blueprint<BlueprintItemWeaponReference>, Blueprint<BlueprintWeaponTypeReference>)
Namespace: BlueprintCore.Blueprints.Configurators.DialogSystem
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseCheckConfigurator<T, TBuilder> : BaseCueBaseConfigurator<T, TBuilder> where T : BlueprintCheck where TBuilder : BaseCheckConfigurator<T, TBuilder>
Type Parameters
Name Description
T
TBuilder
Remarks

Each supported blueprint type has a corresponding Configurator class to create and modify blueprints of that type, e.g. FeatureConfigurator supports BlueprintFeature. Configurators exist for all blueprint types inheriting from Kingmaker.Blueprints.BlueprintScriptableObject, excluding any that are not used in the base game.

Creating a Blueprint

Use New(string, string) to create a blueprint:

FeatureConfigurator.New(MyBlueprintName, MyBlueprintGuid)

Once New() is called the blueprint is added to the game library and can be referenced.

Using the Configurator

New() returns a configurator with methods to set or modify blueprint fields and add or modify Kingmaker.Blueprints.BlueprintComponent:

FeatureConfigurator.New(MyBlueprintName, MyBlueprintGuid).AddToGroups(FeatureGroup.Feat).AddPrerequisiteAlignment(AlignmentMaskType.LawfulGood).Configure();

Each method call returns the configurator allowing you to chain calls. Nothing is modified on the blueprint until Configure() is called, at which point the changes are applied and validated. Potential problems with the blueprint are logged as warnings.

Modifying an Existing Blueprint

Use For(Blueprint) to modify existing blueprints:

CharacterClassConfigurator.For(WizardClassGuid)

Usage is otherwise identical to creating a new blueprint.

For more information see Using BlueprintCore.

Constructors

| Improve this Doc View Source

BaseCheckConfigurator(Blueprint<BlueprintReference<T>>)

Declaration
protected BaseCheckConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> blueprint

Methods

| Improve this Doc View Source

AddToDCModifiers(DCModifier[])

Adds to the contents of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.DCModifiers

Declaration
public TBuilder AddToDCModifiers(params DCModifier[] dCModifiers)
Parameters
Type Name Description
Kingmaker.DialogSystem.Blueprints.DCModifier[] dCModifiers
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearDCModifiers()

Removes all elements from Kingmaker.DialogSystem.Blueprints.BlueprintCheck.DCModifiers

Declaration
public TBuilder ClearDCModifiers()
Returns
Type Description
TBuilder
| Improve this Doc View Source

CopyFrom(Blueprint<BlueprintReference<BlueprintCheck>>, Predicate<BlueprintComponent>)

Copies fields and components of the specified types from the blueprint.

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintCheck>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.DialogSystem.Blueprints.BlueprintCheck>> blueprint
System.Predicate<Kingmaker.Blueprints.BlueprintComponent> componentMatcher

Any components in blueprint matching the predicate are copied. These are shallow copies that are shared by both blueprints.
Returns
Type Description
TBuilder
Remarks

NOT A DEEP COPY. This means objects copied are shared between blueprints. Changes to copied objects affect both blueprints.

Recommended when you need to create a nearly identical ability but change some parts such as a ContextRankConfig. 

// Copy the Undead Bloodline's Incorporeal Form ability, replacing the duration w/ Character Level rounds
AbilityConfigurator.New(NewIncorporealForm, Guids.NewIncorporealForm)
  .CopyFrom(
    AbilityRefs.BloodlineUndeadIncorporealFormAbility,
    typeof(AbilityEffectRunAction),
    typeof(AbilityResourceLogic),
    typeof(SpellComponent))
  .AddContextRankConfig(ContextRankConfigs.CharacterLevel())
  .Configure();
| Improve this Doc View Source

CopyFrom(Blueprint<BlueprintReference<BlueprintCheck>>, Type[])

Copies fields and components of the specified types from the blueprint.

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintCheck>> blueprint, params Type[] componentTypes)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.DialogSystem.Blueprints.BlueprintCheck>> blueprint
System.Type[] componentTypes

Any components in blueprint of the listed types are copied. These are shallow copies that are shared by both blueprints.
Returns
Type Description
TBuilder
Remarks

NOT A DEEP COPY. This means objects copied are shared between blueprints. Changes to copied objects affect both blueprints.

Recommended when you need to create a nearly identical ability but change some parts such as a ContextRankConfig. 

// Copy the Undead Bloodline's Incorporeal Form ability, replacing the duration w/ Character Level rounds
AbilityConfigurator.New(NewIncorporealForm, Guids.NewIncorporealForm)
  .CopyFrom(
    AbilityRefs.BloodlineUndeadIncorporealFormAbility,
    typeof(AbilityEffectRunAction),
    typeof(AbilityResourceLogic),
    typeof(SpellComponent))
  .AddContextRankConfig(ContextRankConfigs.CharacterLevel())
  .Configure();
| Improve this Doc View Source

ModifyDCModifiers(Action<DCModifier>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCheck.DCModifiers by invoking the provided action on each element.

Declaration
public TBuilder ModifyDCModifiers(Action<DCModifier> action)
Parameters
Type Name Description
System.Action<Kingmaker.DialogSystem.Blueprints.DCModifier> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyFail(Action<BlueprintCueBaseReference>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCheck.m_Fail by invoking the provided action.

Declaration
public TBuilder ModifyFail(Action<BlueprintCueBaseReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.BlueprintCueBaseReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifySuccess(Action<BlueprintCueBaseReference>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCheck.m_Success by invoking the provided action.

Declaration
public TBuilder ModifySuccess(Action<BlueprintCueBaseReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.BlueprintCueBaseReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyUnitEvaluator(Action<UnitEvaluator>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCheck.m_UnitEvaluator by invoking the provided action.

Declaration
public TBuilder ModifyUnitEvaluator(Action<UnitEvaluator> action)
Parameters
Type Name Description
System.Action<Kingmaker.ElementsSystem.UnitEvaluator> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

OnConfigureCompleted()

Declaration
protected override void OnConfigureCompleted()
Overrides
BlueprintCore.Blueprints.Configurators.DialogSystem.BaseCueBaseConfigurator<T, TBuilder>.OnConfigureCompleted()
| Improve this Doc View Source

RemoveFromDCModifiers(DCModifier[])

Removes elements from Kingmaker.DialogSystem.Blueprints.BlueprintCheck.DCModifiers

Declaration
public TBuilder RemoveFromDCModifiers(params DCModifier[] dCModifiers)
Parameters
Type Name Description
Kingmaker.DialogSystem.Blueprints.DCModifier[] dCModifiers
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromDCModifiers(Func<DCModifier, Boolean>)

Removes elements from Kingmaker.DialogSystem.Blueprints.BlueprintCheck.DCModifiers that match the provided predicate.

Declaration
public TBuilder RemoveFromDCModifiers(Func<DCModifier, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.DialogSystem.Blueprints.DCModifier, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetBanPartyCheckInCamp(Boolean)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.BanPartyCheckInCamp

Declaration
public TBuilder SetBanPartyCheckInCamp(bool banPartyCheckInCamp = true)
Parameters
Type Name Description
System.Boolean banPartyCheckInCamp
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDC(Int32)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.DC

Declaration
public TBuilder SetDC(int dC)
Parameters
Type Name Description
System.Int32 dC
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDCModifiers(DCModifier[])

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.DCModifiers

Declaration
public TBuilder SetDCModifiers(params DCModifier[] dCModifiers)
Parameters
Type Name Description
Kingmaker.DialogSystem.Blueprints.DCModifier[] dCModifiers
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetExperience(DialogExperience)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.Experience

Declaration
public TBuilder SetExperience(DialogExperience experience)
Parameters
Type Name Description
Kingmaker.DialogSystem.DialogExperience experience
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetFail(Blueprint<BlueprintCueBaseReference>)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.m_Fail

Declaration
public TBuilder SetFail(Blueprint<BlueprintCueBaseReference> fail)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintCueBaseReference> fail

Blueprint of type BlueprintCueBase. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetHidden(Boolean)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.Hidden

Declaration
public TBuilder SetHidden(bool hidden = true)
Parameters
Type Name Description
System.Boolean hidden
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSuccess(Blueprint<BlueprintCueBaseReference>)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.m_Success

Declaration
public TBuilder SetSuccess(Blueprint<BlueprintCueBaseReference> success)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintCueBaseReference> success

Blueprint of type BlueprintCueBase. You can pass in the blueprint using:

  • A blueprint instance
  • A blueprint reference
  • A blueprint id as a string, Guid, or BlueprintGuid
  • A blueprint name registered with BlueprintTool
See Blueprint for more details.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetType(StatType)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.Type

Declaration
public TBuilder SetType(StatType type)
Parameters
Type Name Description
Kingmaker.EntitySystem.Stats.StatType type
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetUnitEvaluator(UnitEvaluator)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCheck.m_UnitEvaluator

Declaration
public TBuilder SetUnitEvaluator(UnitEvaluator unitEvaluator)
Parameters
Type Name Description
Kingmaker.ElementsSystem.UnitEvaluator unitEvaluator
Returns
Type Description
TBuilder