Class BaseCampaignConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Root.BlueprintCampaign.

Inheritance

System.Object

Configurator

RootConfigurator<T, TBuilder>

BaseBlueprintConfigurator<T, TBuilder>

BaseCampaignConfigurator<T, TBuilder>

CampaignConfigurator

Inherited Members

BaseBlueprintConfigurator<T, TBuilder>.CopyFrom(Blueprint<BlueprintReference<BlueprintScriptableObject>>, Type[])

BaseBlueprintConfigurator<T, TBuilder>.CopyFrom(Blueprint<BlueprintReference<BlueprintScriptableObject>>, Predicate<BlueprintComponent>)

BaseBlueprintConfigurator<T, TBuilder>.AddDlcCondition(Blueprint<BlueprintDlcRewardReference>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddBuffOnCorruptionClear(Blueprint<BlueprintBuffReference>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Int32>)

BaseBlueprintConfigurator<T, TBuilder>.AddIgnoreArmorGroupComponent(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddPrerequisiteConditionForWeaponCategory(Condition, List<WeaponCategory>)

BaseBlueprintConfigurator<T, TBuilder>.AddDamageDecline(Nullable<DamageDeclineType>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddPlayerLeaveCombatTrigger(ActionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddTimerContextActions(ActionsBuilder, Nullable<Single>, Nullable<TimeSpan>, Nullable<Boolean>)

BaseBlueprintConfigurator<T, TBuilder>.AddCustomImmuneMessageComponent(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, GameLogMessage)

BaseBlueprintConfigurator<T, TBuilder>.AddInitiatorAttackRollTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponCategory>)

BaseBlueprintConfigurator<T, TBuilder>.AddInitiatorAttackWithWeaponTrigger(ActionsBuilder, 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>)

BaseBlueprintConfigurator<T, TBuilder>.AddTargetAttackRollTrigger(ActionsBuilder, ActionsBuilder, Nullable<Boolean>, WeaponCategory[], Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)

BaseBlueprintConfigurator<T, TBuilder>.AddTargetBeforeAttackRollTrigger(ActionsBuilder, ActionsBuilder, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<Boolean>, Nullable<SpellDescriptorWrapper>)

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>.AdditionalDiceOnDamage(List<Blueprint<BlueprintAbilityReference>>, Nullable<AbilityType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<CompareOperation.Type>, List<AdditionalDiceOnDamage.DamageEntry>, Nullable<AdditionalDiceOnDamage.DamageEntriesUse>, DamageTypeDescription, ContextDiceValue, Nullable<DamageEnergyType>, Nullable<Boolean>, ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<SpellDescriptorWrapper>, ConditionsBuilder, Nullable<Boolean>, ContextValue, Nullable<Boolean>, Blueprint<BlueprintWeaponTypeReference>)

BaseBlueprintConfigurator<T, TBuilder>.AdditionalStatBonusOnAttackDamage(Nullable<Single>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ConditionEnum>, Nullable<ConditionEnum>, Nullable<GripType>)

BaseBlueprintConfigurator<T, TBuilder>.AddAllAttacksEnhancement(Nullable<Int32>, Nullable<ModifierDescriptor>)

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>)

BaseBlueprintConfigurator<T, TBuilder>.AddMarkUsableWhileCan(ConditionsBuilder, Nullable<Boolean>)

BaseBlueprintConfigurator<T, TBuilder>.AddArmyBattleResultsTrigger(Nullable<RegionId>, Blueprint<BlueprintArmyLeaderReference>, List<Blueprint<BlueprintArmyPresetReference>>, Nullable<ArmyType>, Nullable<Boolean>, ActionsBuilder, ActionsBuilder, Nullable<Boolean>)

BaseBlueprintConfigurator<T, TBuilder>.AddKingdomRegionClaimedTrigger(ActionsBuilder, List<Blueprint<BlueprintRegionReference>>)

BaseBlueprintConfigurator<T, TBuilder>.AddSettlementSiegeTrigger(ActionsBuilder, ActionsBuilder, ActionsBuilder, Blueprint<BlueprintGlobalMapPointReference>, Nullable<Boolean>)

BaseBlueprintConfigurator<T, TBuilder>.AddArmyUnitRecruitedTrigger(ActionsBuilder, Nullable<ArmyProperties>, List<Blueprint<BlueprintUnitReference>>, Nullable<Boolean>, Nullable<Boolean>, Nullable<MercenariesIncludeOption>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Int32>)

BaseBlueprintConfigurator<T, TBuilder>.AddLeaderRecruitedTrigger(ActionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddSummonUnitsAfterArmyBattle(SummonUnitsAfterArmyBattle.SummonGroup[], Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddGarrisonDefeatedTrigger(ActionsBuilder, Blueprint<BlueprintGlobalMapPoint.Reference>)

BaseBlueprintConfigurator<T, TBuilder>.AddPlayerVisitGlobalMapLocationTrigger(ActionsBuilder, Blueprint<BlueprintGlobalMapPoint.Reference>)

BaseBlueprintConfigurator<T, TBuilder>.AddOnIsleStateEnterTrigger(ActionsBuilder, IsleEvaluator, String)

BaseBlueprintConfigurator<T, TBuilder>.AddOnIsleStateExitTrigger(ActionsBuilder, IsleEvaluator, String)

BaseBlueprintConfigurator<T, TBuilder>.AddActivateTrigger(ActionsBuilder, Nullable<Boolean>, ConditionsBuilder, Nullable<Boolean>)

BaseBlueprintConfigurator<T, TBuilder>.AddAreaDidLoadTrigger(ActionsBuilder, ConditionsBuilder)

BaseBlueprintConfigurator<T, TBuilder>.AddDeactivateTrigger(ActionsBuilder, ConditionsBuilder)

BaseBlueprintConfigurator<T, TBuilder>.AddDeviceInteractionTrigger(ActionsBuilder, ActionsBuilder)

BaseBlueprintConfigurator<T, TBuilder>.AddEvaluatedUnitCombatTrigger(ActionsBuilder, Nullable<Boolean>, UnitEvaluator)

BaseBlueprintConfigurator<T, TBuilder>.AddEvaluatedUnitDeathTrigger(ActionsBuilder, Nullable<Boolean>, UnitEvaluator)

BaseBlueprintConfigurator<T, TBuilder>.AddEvaluatedUnitHealthTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, UnitEvaluator)

BaseBlueprintConfigurator<T, TBuilder>.AddExperienceTrigger(ActionsBuilder, ConditionsBuilder, Nullable<Int32>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddGenericInteractionTrigger(ActionsBuilder, EntityReference, ActionsBuilder, Nullable<Boolean>)

BaseBlueprintConfigurator<T, TBuilder>.AddItemInContainerTrigger(Blueprint<BlueprintItemReference>, MapObjectEvaluator, ActionsBuilder, ActionsBuilder)

BaseBlueprintConfigurator<T, TBuilder>.AddLevelUpTrigger(ActionsBuilder, ConditionsBuilder, UnitEvaluator, Nullable<LevelUpTrigger.UnitEntryType>)

BaseBlueprintConfigurator<T, TBuilder>.AddPartyInventoryTrigger(Blueprint<BlueprintItemReference>, ActionsBuilder, ActionsBuilder)

BaseBlueprintConfigurator<T, TBuilder>.AddPerceptionTrigger(MapObjectEvaluator, ActionsBuilder, UnitEvaluator)

BaseBlueprintConfigurator<T, TBuilder>.AddRestTrigger(ActionsBuilder, ConditionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<RestResult>)

BaseBlueprintConfigurator<T, TBuilder>.AddScriptZoneTrigger(ActionsBuilder, ConditionsBuilder, ActionsBuilder, ConditionsBuilder, EntityReference, String)

BaseBlueprintConfigurator<T, TBuilder>.AddSpawnUnitTrigger(ActionsBuilder, Blueprint<BlueprintUnitReference>)

BaseBlueprintConfigurator<T, TBuilder>.AddSpellCastTrigger(ActionsBuilder, EntityReference, List<Blueprint<BlueprintAbilityReference>>)

BaseBlueprintConfigurator<T, TBuilder>.AddSummonPoolTrigger(ActionsBuilder, Nullable<SummonPoolTrigger.ChangeTypes>, ConditionsBuilder, Nullable<Int32>, Blueprint<BlueprintSummonPoolReference>)

BaseBlueprintConfigurator<T, TBuilder>.AddTimeOfDayChangedTrigger(ActionsBuilder, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddUIEventTrigger(ActionsBuilder, ConditionsBuilder, Nullable<UIEventType>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

BaseBlueprintConfigurator<T, TBuilder>.AddUnitHealthTrigger(ActionsBuilder, Nullable<Int32>, Blueprint<BlueprintUnitReference>)

BaseBlueprintConfigurator<T, TBuilder>.AddTrapTrigger(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, ActionsBuilder, ActionsBuilder, MapObjectEvaluator)

BaseBlueprintConfigurator<T, TBuilder>.AddVendorDealTrigger(ActionsBuilder, Nullable<VendorDealTrigger.DealType>, Blueprint<BlueprintItemReference>, UnitEvaluator)

RootConfigurator<T, TBuilder>.Logger

RootConfigurator<T, TBuilder>.Self

RootConfigurator<T, TBuilder>.Blueprint

RootConfigurator<T, TBuilder>.Configured

RootConfigurator<T, TBuilder>.ConfigureDelayedBlueprints()

RootConfigurator<T, TBuilder>.Configure(Boolean)

RootConfigurator<T, TBuilder>.AddComponent(BlueprintComponent)

RootConfigurator<T, TBuilder>.AddComponent<C>(Action<C>)

RootConfigurator<T, TBuilder>.AddUniqueComponent(BlueprintComponent, ComponentMerge, Action<BlueprintComponent, BlueprintComponent>)

RootConfigurator<T, TBuilder>.EditComponent<C>(Action<C>)

RootConfigurator<T, TBuilder>.EditComponents<C>(Action<C>, Func<C, Boolean>)

RootConfigurator<T, TBuilder>.RemoveComponents(Func<BlueprintComponent, Boolean>)

RootConfigurator<T, TBuilder>.OnConfigure(Action<T>[])

RootConfigurator<T, TBuilder>.CopyFrom(Blueprint<BlueprintReference<BlueprintScriptableObject>>, Type[])

RootConfigurator<T, TBuilder>.CopyFrom(Blueprint<BlueprintReference<BlueprintScriptableObject>>, Predicate<BlueprintComponent>)

RootConfigurator<T, TBuilder>.OnConfigureInternal(Action<T>[])

RootConfigurator<T, TBuilder>.OnConfigureCompleted()

RootConfigurator<T, TBuilder>.Validate(Object)

Namespace: BlueprintCore.Blueprints.Configurators.Root

Assembly: BlueprintCore.dll

Syntax

public abstract class BaseCampaignConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintCampaign where TBuilder : BaseCampaignConfigurator<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

BaseCampaignConfigurator(Blueprint<BlueprintReference<T>>)

Declaration

protected BaseCampaignConfigurator(Blueprint<BlueprintReference<T>> blueprint)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>>	blueprint

Methods

AddBlueprintCampaignCustomCompanion(Blueprint<BlueprintUnitReference>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.Blueprints.BlueprintCampaignCustomCompanion

Declaration

public TBuilder AddBlueprintCampaignCustomCompanion(Blueprint<BlueprintUnitReference> customCompanion = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>	customCompanion	Blueprint of type BlueprintUnit. 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.
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent>	merge	If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components.
ComponentMerge	mergeBehavior	Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail.

Returns

Type	Description
TBuilder

Remarks

• Dlc2Campaigne6fdda2539274c1e89d236be69f5a984
• Dlc3Campaigne1bde745d6ad47c0bc9fb8e479b29153
• Dlc5Campaignd7f857701f7f44e0a02d571dea798f28

AddBlueprintCampaignExperience(Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Blueprint<BlueprintStatProgressionReference>)

Adds Kingmaker.Blueprints.BlueprintCampaignExperience

Declaration

public TBuilder AddBlueprintCampaignExperience(bool? allowChecks = null, bool? allowMobs = null, bool? allowQuests = null, bool? allowTraps = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, bool? overrideTrapsProgression = null, Blueprint<BlueprintStatProgressionReference> trapsDCToCRTable = null)

Parameters

Type	Name	Description
System.Nullable<System.Boolean>	allowChecks
System.Nullable<System.Boolean>	allowMobs
System.Nullable<System.Boolean>	allowQuests
System.Nullable<System.Boolean>	allowTraps
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent>	merge	If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components.
ComponentMerge	mergeBehavior	Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail.
System.Nullable<System.Boolean>	overrideTrapsProgression	InfoBox: By default, BlueprintRoot -&gt; Progression -&gt; DCToCRTable will be used
Blueprint<Kingmaker.Blueprints.BlueprintStatProgressionReference>	trapsDCToCRTable	Blueprint of type BlueprintStatProgression. 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

Remarks

• Dlc3Campaigne1bde745d6ad47c0bc9fb8e479b29153

AddBlueprintCampaignOverrideFogOfWarVisionRadius(Nullable<Single>, Nullable<Single>)

Adds Kingmaker.Blueprints.BlueprintCampaignOverrideFogOfWarVisionRadius

Declaration

public TBuilder AddBlueprintCampaignOverrideFogOfWarVisionRadius(float? addition = null, float? multiplier = null)

Parameters

Type	Name	Description
System.Nullable<System.Single>	addition
System.Nullable<System.Single>	multiplier

Returns

Type	Description
TBuilder

Remarks

• Dlc3Campaigne1bde745d6ad47c0bc9fb8e479b29153

AddBlueprintCampaignOverrideSettingBool(UISettingsEntityBool, Nullable<Boolean>)

Adds Kingmaker.Blueprints.BlueprintCampaignOverrideSettingBool

Declaration

public TBuilder AddBlueprintCampaignOverrideSettingBool(UISettingsEntityBool boolValue = null, bool? value = null)

Parameters

Type	Name	Description
Kingmaker.UI.SettingsUI.UISettingsEntityBool	boolValue
System.Nullable<System.Boolean>	value

Returns

Type	Description
TBuilder

Remarks

• Dlc2Campaigne6fdda2539274c1e89d236be69f5a984
• Dlc3Campaigne1bde745d6ad47c0bc9fb8e479b29153

AddBlueprintCampaignRestBehaviour(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Nullable<Boolean>, Nullable<GameDifficultyOption>)

Adds Kingmaker.Blueprints.BlueprintCampaignRestBehaviour

Declaration

public TBuilder AddBlueprintCampaignRestBehaviour(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, bool? removeDeathDoor = null, GameDifficultyOption? removeDeathDoorDifficultyMax = null)

Parameters

Type	Name	Description
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent>	merge	If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components.
ComponentMerge	mergeBehavior	Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail.
System.Nullable<System.Boolean>	removeDeathDoor
System.Nullable<Kingmaker.Settings.GameDifficultyOption>	removeDeathDoorDifficultyMax

Returns

Type	Description
TBuilder

Remarks

• Dlc2Campaigne6fdda2539274c1e89d236be69f5a984

AddToImportSettings(SaveImportSettings[])

Adds to the contents of Kingmaker.Blueprints.Root.BlueprintCampaign.ImportSettings

Declaration

public TBuilder AddToImportSettings(params SaveImportSettings[] importSettings)

Parameters

Type	Name	Description
Kingmaker.DLC.SaveImportSettings[]	importSettings

Returns

Type	Description
TBuilder

AddToPregens(Blueprint<BlueprintUnitReference>[])

Adds to the contents of Kingmaker.Blueprints.Root.BlueprintCampaign.m_Pregens

Declaration

public TBuilder AddToPregens(params Blueprint<BlueprintUnitReference>[] pregens)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[]	pregens	Blueprint of type BlueprintUnit. 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

ClearImportSettings()

Removes all elements from Kingmaker.Blueprints.Root.BlueprintCampaign.ImportSettings

Declaration

public TBuilder ClearImportSettings()

Returns

Type	Description
TBuilder

ClearPregens()

Removes all elements from Kingmaker.Blueprints.Root.BlueprintCampaign.m_Pregens

Declaration

public TBuilder ClearPregens()

Returns

Type	Description
TBuilder

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

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

Declaration

public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintCampaign>> blueprint, Predicate<BlueprintComponent> componentMatcher)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.Root.BlueprintCampaign>>	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();

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

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

Declaration

public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintCampaign>> blueprint, params Type[] componentTypes)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.Root.BlueprintCampaign>>	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();

ModifyDescription(Action<LocalizedString>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.Description by invoking the provided action.

Declaration

public TBuilder ModifyDescription(Action<LocalizedString> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.Localization.LocalizedString>	action

Returns

Type	Description
TBuilder

ModifyDlcReward(Action<BlueprintDlcRewardCampaign>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.m_DlcReward by invoking the provided action.

Declaration

public TBuilder ModifyDlcReward(Action<BlueprintDlcRewardCampaign> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.DLC.BlueprintDlcRewardCampaign>	action

Returns

Type	Description
TBuilder

ModifyImportSettings(Action<SaveImportSettings>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.ImportSettings by invoking the provided action on each element.

Declaration

public TBuilder ModifyImportSettings(Action<SaveImportSettings> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.DLC.SaveImportSettings>	action

Returns

Type	Description
TBuilder

ModifyIsAvailable(Action<Nullable<Boolean>>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.m_IsAvailable by invoking the provided action.

Declaration

public TBuilder ModifyIsAvailable(Action<bool?> action)

Parameters

Type	Name	Description
System.Action<System.Nullable<System.Boolean>>	action

Returns

Type	Description
TBuilder

ModifyKeyArtLink(Action<SpriteLink>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.KeyArtLink by invoking the provided action.

Declaration

public TBuilder ModifyKeyArtLink(Action<SpriteLink> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.ResourceLinks.SpriteLink>	action

Returns

Type	Description
TBuilder

ModifyPregens(Action<BlueprintUnitReference>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.m_Pregens by invoking the provided action on each element.

Declaration

public TBuilder ModifyPregens(Action<BlueprintUnitReference> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.Blueprints.BlueprintUnitReference>	action

Returns

Type	Description
TBuilder

ModifyStartGamePreset(Action<BlueprintAreaPresetReference>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.m_StartGamePreset by invoking the provided action.

Declaration

public TBuilder ModifyStartGamePreset(Action<BlueprintAreaPresetReference> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.Blueprints.BlueprintAreaPresetReference>	action

Returns

Type	Description
TBuilder

ModifyTitle(Action<LocalizedString>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.Title by invoking the provided action.

Declaration

public TBuilder ModifyTitle(Action<LocalizedString> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.Localization.LocalizedString>	action

Returns

Type	Description
TBuilder

ModifyWinMainMenuText(Action<LocalizedString>)

Modifies Kingmaker.Blueprints.Root.BlueprintCampaign.WinMainMenuText by invoking the provided action.

Declaration

public TBuilder ModifyWinMainMenuText(Action<LocalizedString> action)

Parameters

Type	Name	Description
System.Action<Kingmaker.Localization.LocalizedString>	action

Returns

Type	Description
TBuilder

OnConfigureCompleted()

Declaration

protected override void OnConfigureCompleted()

Overrides

BlueprintCore.Blueprints.CustomConfigurators.RootConfigurator<T, TBuilder>.OnConfigureCompleted()

RemoveFromImportSettings(SaveImportSettings[])

Removes elements from Kingmaker.Blueprints.Root.BlueprintCampaign.ImportSettings

Declaration

public TBuilder RemoveFromImportSettings(params SaveImportSettings[] importSettings)

Parameters

Type	Name	Description
Kingmaker.DLC.SaveImportSettings[]	importSettings

Returns

Type	Description
TBuilder

RemoveFromImportSettings(Func<SaveImportSettings, Boolean>)

Removes elements from Kingmaker.Blueprints.Root.BlueprintCampaign.ImportSettings that match the provided predicate.

Declaration

public TBuilder RemoveFromImportSettings(Func<SaveImportSettings, bool> predicate)

Parameters

Type	Name	Description
System.Func<Kingmaker.DLC.SaveImportSettings, System.Boolean>	predicate

Returns

Type	Description
TBuilder

RemoveFromPregens(Blueprint<BlueprintUnitReference>[])

Removes elements from Kingmaker.Blueprints.Root.BlueprintCampaign.m_Pregens

Declaration

public TBuilder RemoveFromPregens(params Blueprint<BlueprintUnitReference>[] pregens)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[]	pregens	Blueprint of type BlueprintUnit. 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

RemoveFromPregens(Func<BlueprintUnitReference, Boolean>)

Removes elements from Kingmaker.Blueprints.Root.BlueprintCampaign.m_Pregens that match the provided predicate.

Declaration

public TBuilder RemoveFromPregens(Func<BlueprintUnitReference, bool> predicate)

Parameters

Type	Name	Description
System.Func<Kingmaker.Blueprints.BlueprintUnitReference, System.Boolean>	predicate

Returns

Type	Description
TBuilder

SetAllowMythicChange(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.AllowMythicChange

Declaration

public TBuilder SetAllowMythicChange(bool allowMythicChange = true)

Parameters

Type	Name	Description
System.Boolean	allowMythicChange

Returns

Type	Description
TBuilder

SetAudioChunk(AudioFilePackagesSettings.AudioChunk)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.AudioChunk

Declaration

public TBuilder SetAudioChunk(AudioFilePackagesSettings.AudioChunk audioChunk)

Parameters

Type	Name	Description
Kingmaker.Sound.AudioFilePackagesSettings.AudioChunk	audioChunk

Returns

Type	Description
TBuilder

SetComingSoon(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.ComingSoon

Declaration

public TBuilder SetComingSoon(bool comingSoon = true)

Parameters

Type	Name	Description
System.Boolean	comingSoon

Returns

Type	Description
TBuilder

SetDescription(LocalString)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.Description

Declaration

public TBuilder SetDescription(LocalString description)

Parameters

Type	Name	Description
LocalString	description	You can pass in the string using a LocalizedString or the Key to a LocalizedString.

Returns

Type	Description
TBuilder

SetDlcReward(BlueprintDlcRewardCampaign)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.m_DlcReward

Declaration

public TBuilder SetDlcReward(BlueprintDlcRewardCampaign dlcReward)

Parameters

Type	Name	Description
Kingmaker.DLC.BlueprintDlcRewardCampaign	dlcReward

Returns

Type	Description
TBuilder

SetHideInRelease(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.HideInRelease

Declaration

public TBuilder SetHideInRelease(bool hideInRelease = true)

Parameters

Type	Name	Description
System.Boolean	hideInRelease

Returns

Type	Description
TBuilder

SetHideInUI(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.HideInUI

Declaration

public TBuilder SetHideInUI(bool hideInUI = true)

Parameters

Type	Name	Description
System.Boolean	hideInUI

Returns

Type	Description
TBuilder

SetImportSettings(SaveImportSettings[])

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.ImportSettings

Declaration

public TBuilder SetImportSettings(params SaveImportSettings[] importSettings)

Parameters

Type	Name	Description
Kingmaker.DLC.SaveImportSettings[]	importSettings

Returns

Type	Description
TBuilder

SetIsAvailable(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.m_IsAvailable

Declaration

public TBuilder SetIsAvailable(bool isAvailable)

Parameters

Type	Name	Description
System.Boolean	isAvailable

Returns

Type	Description
TBuilder

SetIsDungeon(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.IsDungeon

Declaration

public TBuilder SetIsDungeon(bool isDungeon = true)

Parameters

Type	Name	Description
System.Boolean	isDungeon

Returns

Type	Description
TBuilder

SetIsLongImportActivate(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.IsLongImportActivate

Declaration

public TBuilder SetIsLongImportActivate(bool isLongImportActivate = true)

Parameters

Type	Name	Description
System.Boolean	isLongImportActivate

Returns

Type	Description
TBuilder

SetIsMainGameContent(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.IsMainGameContent

Declaration

public TBuilder SetIsMainGameContent(bool isMainGameContent = true)

Parameters

Type	Name	Description
System.Boolean	isMainGameContent

Returns

Type	Description
TBuilder

SetKeyArtLink(AssetLink<SpriteLink>)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.KeyArtLink

Declaration

public TBuilder SetKeyArtLink(AssetLink<SpriteLink> keyArtLink)

Parameters

Type	Name	Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink>	keyArtLink	You can pass in the animation using a SpriteLink or it's AssetId.

Returns

Type	Description
TBuilder

SetMythicLevelsIsUniqueForEachCharacter(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.MythicLevelsIsUniqueForEachCharacter

Declaration

public TBuilder SetMythicLevelsIsUniqueForEachCharacter(bool mythicLevelsIsUniqueForEachCharacter = true)

Parameters

Type	Name	Description
System.Boolean	mythicLevelsIsUniqueForEachCharacter

Returns

Type	Description
TBuilder

SetPregens(Blueprint<BlueprintUnitReference>[])

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.m_Pregens

Declaration

public TBuilder SetPregens(params Blueprint<BlueprintUnitReference>[] pregens)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitReference>[]	pregens	Blueprint of type BlueprintUnit. 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

SetStartGamePreset(Blueprint<BlueprintAreaPresetReference>)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.m_StartGamePreset

Declaration

public TBuilder SetStartGamePreset(Blueprint<BlueprintAreaPresetReference> startGamePreset)

Parameters

Type	Name	Description
Blueprint<Kingmaker.Blueprints.BlueprintAreaPresetReference>	startGamePreset	Blueprint of type BlueprintAreaPreset. 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

SetTitle(LocalString)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.Title

Declaration

public TBuilder SetTitle(LocalString title)

Parameters

Type	Name	Description
LocalString	title	You can pass in the string using a LocalizedString or the Key to a LocalizedString.

Returns

Type	Description
TBuilder

SetToBeContinued(Boolean)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.ToBeContinued

Declaration

public TBuilder SetToBeContinued(bool toBeContinued = true)

Parameters

Type	Name	Description
System.Boolean	toBeContinued

Returns

Type	Description
TBuilder

SetWinMainMenuText(LocalString)

Sets the value of Kingmaker.Blueprints.Root.BlueprintCampaign.WinMainMenuText

Declaration

public TBuilder SetWinMainMenuText(LocalString winMainMenuText)

Parameters

Type	Name	Description
LocalString	winMainMenuText	You can pass in the string using a LocalizedString or the Key to a LocalizedString.

Returns

Type	Description
TBuilder