Class BaseTacticalCombatRootConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseTacticalCombatRootConfigurator<T, TBuilder>
TacticalCombatRootConfigurator
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.Armies
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseTacticalCombatRootConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintTacticalCombatRoot where TBuilder : BaseTacticalCombatRootConfigurator<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

BaseTacticalCombatRootConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToBannedUnitFacts(Blueprint<BlueprintUnitFactReference>[])

Adds to the contents of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_BannedUnitFacts

Declaration
public TBuilder AddToBannedUnitFacts(params Blueprint<BlueprintUnitFactReference>[] bannedUnitFacts)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitFactReference>[] bannedUnitFacts

Blueprint of type BlueprintUnitFact. 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

AddToUnitTiersByBaseHealth(Int32[])

Adds to the contents of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_UnitTiersByBaseHealth

Declaration
public TBuilder AddToUnitTiersByBaseHealth(params int[] unitTiersByBaseHealth)
Parameters
Type Name Description
System.Int32[] unitTiersByBaseHealth
Returns
Type Description
TBuilder
| Improve this Doc View Source

AddToZoneSettings(BlueprintTacticalCombatRoot.TacticalZoneSettings[])

Adds to the contents of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ZoneSettings

Declaration
public TBuilder AddToZoneSettings(params BlueprintTacticalCombatRoot.TacticalZoneSettings[] zoneSettings)
Parameters
Type Name Description
Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.TacticalZoneSettings[] zoneSettings
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearBannedUnitFacts()

Removes all elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_BannedUnitFacts

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

ClearUnitTiersByBaseHealth()

Removes all elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_UnitTiersByBaseHealth

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

ClearZoneSettings()

Removes all elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ZoneSettings

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

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

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

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintTacticalCombatRoot>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot>> 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<BlueprintTacticalCombatRoot>>, Type[])

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

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintTacticalCombatRoot>> blueprint, params Type[] componentTypes)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot>> 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

ModifyBannedUnitFacts(Action<BlueprintUnitFactReference>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_BannedUnitFacts by invoking the provided action on each element.

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

ModifyBuffPrefix(Action<LocalizedString>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_BuffPrefix by invoking the provided action.

Declaration
public TBuilder ModifyBuffPrefix(Action<LocalizedString> action)
Parameters
Type Name Description
System.Action<Kingmaker.Localization.LocalizedString> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyCrusadersFaction(Action<BlueprintFactionReference>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_CrusadersFaction by invoking the provided action.

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

ModifyDefaultBrain(Action<BlueprintTacticalCombatBrain.Reference>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DefaultBrain by invoking the provided action.

Declaration
public TBuilder ModifyDefaultBrain(Action<BlueprintTacticalCombatBrain.Reference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Armies.TacticalCombat.Brain.BlueprintTacticalCombatBrain.Reference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyDefaultLeaderBrain(Action<BlueprintTacticalCombatBrain.Reference>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DefaultLeaderBrain by invoking the provided action.

Declaration
public TBuilder ModifyDefaultLeaderBrain(Action<BlueprintTacticalCombatBrain.Reference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Armies.TacticalCombat.Brain.BlueprintTacticalCombatBrain.Reference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyDemonsFaction(Action<BlueprintFactionReference>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DemonsFaction by invoking the provided action.

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

ModifyDiceRollResultsDistribution(Action<AnimationCurve>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DiceRollResultsDistribution by invoking the provided action.

Declaration
public TBuilder ModifyDiceRollResultsDistribution(Action<AnimationCurve> action)
Parameters
Type Name Description
System.Action<UnityEngine.AnimationCurve> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyLeaderManaResource(Action<BlueprintAbilityResourceReference>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_LeaderManaResource by invoking the provided action.

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

ModifyNegativeMoraleFx(Action<PrefabLink>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_NegativeMoraleFx by invoking the provided action.

Declaration
public TBuilder ModifyNegativeMoraleFx(Action<PrefabLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.ResourceLinks.PrefabLink> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyPositiveMoraleFx(Action<PrefabLink>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_PositiveMoraleFx by invoking the provided action.

Declaration
public TBuilder ModifyPositiveMoraleFx(Action<PrefabLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.ResourceLinks.PrefabLink> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyProbabilitySampler(Action<ProbabilityCurveSampler>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ProbabilitySampler by invoking the provided action.

Declaration
public TBuilder ModifyProbabilitySampler(Action<ProbabilityCurveSampler> action)
Parameters
Type Name Description
System.Action<Owlcat.Runtime.Core.Math.ProbabilityCurveSampler> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyUnitTiersByBaseHealth(Action<Int32>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_UnitTiersByBaseHealth by invoking the provided action on each element.

Declaration
public TBuilder ModifyUnitTiersByBaseHealth(Action<int> action)
Parameters
Type Name Description
System.Action<System.Int32> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyVictorySoundEvent(Action<AkEventReference>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_VictorySoundEvent by invoking the provided action.

Declaration
public TBuilder ModifyVictorySoundEvent(Action<AkEventReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Sound.AkEventReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyWinnerCutscene(Action<CutsceneReference>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_WinnerCutscene by invoking the provided action.

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

ModifyZoneSettings(Action<BlueprintTacticalCombatRoot.TacticalZoneSettings>)

Modifies Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ZoneSettings by invoking the provided action on each element.

Declaration
public TBuilder ModifyZoneSettings(Action<BlueprintTacticalCombatRoot.TacticalZoneSettings> action)
Parameters
Type Name Description
System.Action<Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.TacticalZoneSettings> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

OnConfigureCompleted()

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

RemoveFromBannedUnitFacts(Blueprint<BlueprintUnitFactReference>[])

Removes elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_BannedUnitFacts

Declaration
public TBuilder RemoveFromBannedUnitFacts(params Blueprint<BlueprintUnitFactReference>[] bannedUnitFacts)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitFactReference>[] bannedUnitFacts

Blueprint of type BlueprintUnitFact. 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

RemoveFromBannedUnitFacts(Func<BlueprintUnitFactReference, Boolean>)

Removes elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_BannedUnitFacts that match the provided predicate.

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

RemoveFromUnitTiersByBaseHealth(Func<Int32, Boolean>)

Removes elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_UnitTiersByBaseHealth that match the provided predicate.

Declaration
public TBuilder RemoveFromUnitTiersByBaseHealth(Func<int, bool> predicate)
Parameters
Type Name Description
System.Func<System.Int32, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromUnitTiersByBaseHealth(Int32[])

Removes elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_UnitTiersByBaseHealth

Declaration
public TBuilder RemoveFromUnitTiersByBaseHealth(params int[] unitTiersByBaseHealth)
Parameters
Type Name Description
System.Int32[] unitTiersByBaseHealth
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromZoneSettings(BlueprintTacticalCombatRoot.TacticalZoneSettings[])

Removes elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ZoneSettings

Declaration
public TBuilder RemoveFromZoneSettings(params BlueprintTacticalCombatRoot.TacticalZoneSettings[] zoneSettings)
Parameters
Type Name Description
Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.TacticalZoneSettings[] zoneSettings
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromZoneSettings(Func<BlueprintTacticalCombatRoot.TacticalZoneSettings, Boolean>)

Removes elements from Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ZoneSettings that match the provided predicate.

Declaration
public TBuilder RemoveFromZoneSettings(Func<BlueprintTacticalCombatRoot.TacticalZoneSettings, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.TacticalZoneSettings, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAiCanUseRituals(Boolean)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_AiCanUseRituals

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

SetAiSpellCastWeight(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_AiSpellCastWeight

Declaration
public TBuilder SetAiSpellCastWeight(float aiSpellCastWeight)
Parameters
Type Name Description
System.Single aiSpellCastWeight
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetArmyLossesCoefOnRetreat(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ArmyLossesCoefOnRetreat

Declaration
public TBuilder SetArmyLossesCoefOnRetreat(float armyLossesCoefOnRetreat)
Parameters
Type Name Description
System.Single armyLossesCoefOnRetreat
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAudioScalingFactor(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_AudioScalingFactor

Declaration
public TBuilder SetAudioScalingFactor(float audioScalingFactor)
Parameters
Type Name Description
System.Single audioScalingFactor
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAutoVictoryCoefficient(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_AutoVictoryCoefficient

Declaration
public TBuilder SetAutoVictoryCoefficient(float autoVictoryCoefficient)
Parameters
Type Name Description
System.Single autoVictoryCoefficient

InfoBox: Get auto win result if `Enemy Army Exp / Player Army Exp &lt;= AutoVictoryCoefficient`

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetBannedUnitFacts(Blueprint<BlueprintUnitFactReference>[])

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_BannedUnitFacts

Declaration
public TBuilder SetBannedUnitFacts(params Blueprint<BlueprintUnitFactReference>[] bannedUnitFacts)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintUnitFactReference>[] bannedUnitFacts

Blueprint of type BlueprintUnitFact. 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

SetBuffPrefix(LocalString)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_BuffPrefix

Declaration
public TBuilder SetBuffPrefix(LocalString buffPrefix)
Parameters
Type Name Description
LocalString buffPrefix

You can pass in the string using a LocalizedString or the Key to a LocalizedString.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetCrusadersFaction(Blueprint<BlueprintFactionReference>)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_CrusadersFaction

Declaration
public TBuilder SetCrusadersFaction(Blueprint<BlueprintFactionReference> crusadersFaction)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintFactionReference> crusadersFaction

Blueprint of type BlueprintFaction. 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

SetDefaultBrain(Blueprint<BlueprintTacticalCombatBrain.Reference>)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DefaultBrain

Declaration
public TBuilder SetDefaultBrain(Blueprint<BlueprintTacticalCombatBrain.Reference> defaultBrain)
Parameters
Type Name Description
Blueprint<Kingmaker.Armies.TacticalCombat.Brain.BlueprintTacticalCombatBrain.Reference> defaultBrain

Blueprint of type BlueprintTacticalCombatBrain. 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

SetDefaultLeaderBrain(Blueprint<BlueprintTacticalCombatBrain.Reference>)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DefaultLeaderBrain

Declaration
public TBuilder SetDefaultLeaderBrain(Blueprint<BlueprintTacticalCombatBrain.Reference> defaultLeaderBrain)
Parameters
Type Name Description
Blueprint<Kingmaker.Armies.TacticalCombat.Brain.BlueprintTacticalCombatBrain.Reference> defaultLeaderBrain

Blueprint of type BlueprintTacticalCombatBrain. 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

SetDefaultZone(TacticalCombatAreaZone)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DefaultZone

Declaration
public TBuilder SetDefaultZone(TacticalCombatAreaZone defaultZone)
Parameters
Type Name Description
Kingmaker.Armies.TacticalCombat.Blueprints.TacticalCombatAreaZone defaultZone
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDelayAfterMoraleEffect(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DelayAfterMoraleEffect

Declaration
public TBuilder SetDelayAfterMoraleEffect(float delayAfterMoraleEffect)
Parameters
Type Name Description
System.Single delayAfterMoraleEffect
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDelayBeforeBattleEnd(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DelayBeforeBattleEnd

Declaration
public TBuilder SetDelayBeforeBattleEnd(float delayBeforeBattleEnd)
Parameters
Type Name Description
System.Single delayBeforeBattleEnd

InfoBox: Time in seconds from last kill before result shown

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDelayBetweenTurns(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DelayBetweenTurns

Declaration
public TBuilder SetDelayBetweenTurns(float delayBetweenTurns)
Parameters
Type Name Description
System.Single delayBetweenTurns
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDemonsFaction(Blueprint<BlueprintFactionReference>)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DemonsFaction

Declaration
public TBuilder SetDemonsFaction(Blueprint<BlueprintFactionReference> demonsFaction)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintFactionReference> demonsFaction

Blueprint of type BlueprintFaction. 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

SetDiceRollResultsDistribution(AnimationCurve)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DiceRollResultsDistribution

Declaration
public TBuilder SetDiceRollResultsDistribution(AnimationCurve diceRollResultsDistribution)
Parameters
Type Name Description
UnityEngine.AnimationCurve diceRollResultsDistribution
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDismembermentDamageCoefficient(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_DismembermentDamageCoefficient

Declaration
public TBuilder SetDismembermentDamageCoefficient(float dismembermentDamageCoefficient)
Parameters
Type Name Description
System.Single dismembermentDamageCoefficient

Tooltip: Damage to original stack full health ratio should exceed this value to trigger dismemberment

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetEnemyLossesCoefficientA(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_EnemyLossesCoefficientA

Declaration
public TBuilder SetEnemyLossesCoefficientA(float enemyLossesCoefficientA)
Parameters
Type Name Description
System.Single enemyLossesCoefficientA

InfoBox: EnemyLosses = A - B * x, where x = Enemy Army Exp / Player Army Exp

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetEnemyLossesCoefficientB(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_EnemyLossesCoefficientB

Declaration
public TBuilder SetEnemyLossesCoefficientB(float enemyLossesCoefficientB)
Parameters
Type Name Description
System.Single enemyLossesCoefficientB
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetHighLossesPercent(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_HighLossesPercent

Declaration
public TBuilder SetHighLossesPercent(float highLossesPercent)
Parameters
Type Name Description
System.Single highLossesPercent

InfoBox: Used to color armies on global map. Player losses &gt; m_HighLossesPercent -&gt; red. Between high and low -&gt; yellow

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLeaderManaResource(Blueprint<BlueprintAbilityResourceReference>)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_LeaderManaResource

Declaration
public TBuilder SetLeaderManaResource(Blueprint<BlueprintAbilityResourceReference> leaderManaResource)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintAbilityResourceReference> leaderManaResource

Blueprint of type BlueprintAbilityResource. 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

SetLowLossesPercent(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_LowLossesPercent

Declaration
public TBuilder SetLowLossesPercent(float lowLossesPercent)
Parameters
Type Name Description
System.Single lowLossesPercent

InfoBox: Used to color armies on global map. Player losses &lt; LowLossesPercent -&gt; green

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMaxSquadsCount(Int32)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_MaxSquadsCount

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

SetMaxTierLossesPercent(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_MaxTierLossesPercent

Declaration
public TBuilder SetMaxTierLossesPercent(float maxTierLossesPercent)
Parameters
Type Name Description
System.Single maxTierLossesPercent

InfoBox: Calculate losses starting from low grade to higher, killing at most MaxGradeLossesPercent of units. If after first iteration there should be more losses, go from low grade reducing count without any cap

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMaxTurnDuration(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_MaxTurnDuration

Declaration
public TBuilder SetMaxTurnDuration(float maxTurnDuration)
Parameters
Type Name Description
System.Single maxTurnDuration

InfoBox: Time in seconds before assert

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMoveAccelerated(Int32)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_MoveAccelerated

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

SetMoveSpeed(Int32)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_MoveSpeed

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

SetNegativeMoraleFx(AssetLink<PrefabLink>)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_NegativeMoraleFx

Declaration
public TBuilder SetNegativeMoraleFx(AssetLink<PrefabLink> negativeMoraleFx)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.PrefabLink> negativeMoraleFx

You can pass in the animation using a PrefabLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetPlayerLossesCoefficientA(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_PlayerLossesCoefficientA

Declaration
public TBuilder SetPlayerLossesCoefficientA(float playerLossesCoefficientA)
Parameters
Type Name Description
System.Single playerLossesCoefficientA

InfoBox: PlayerLosses = A * x^2 + B * x + C, where x = Enemy Army Exp / Player Army Exp

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetPlayerLossesCoefficientB(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_PlayerLossesCoefficientB

Declaration
public TBuilder SetPlayerLossesCoefficientB(float playerLossesCoefficientB)
Parameters
Type Name Description
System.Single playerLossesCoefficientB
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetPlayerLossesCoefficientC(Single)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_PlayerLossesCoefficientC

Declaration
public TBuilder SetPlayerLossesCoefficientC(float playerLossesCoefficientC)
Parameters
Type Name Description
System.Single playerLossesCoefficientC
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetPositiveMoraleFx(AssetLink<PrefabLink>)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_PositiveMoraleFx

Declaration
public TBuilder SetPositiveMoraleFx(AssetLink<PrefabLink> positiveMoraleFx)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.PrefabLink> positiveMoraleFx

You can pass in the animation using a PrefabLink or it's AssetId.
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetProbabilitySampler(ProbabilityCurveSampler)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ProbabilitySampler

Declaration
public TBuilder SetProbabilitySampler(ProbabilityCurveSampler probabilitySampler)
Parameters
Type Name Description
Owlcat.Runtime.Core.Math.ProbabilityCurveSampler probabilitySampler
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetProjectilesSpeedAccelerated(Int32)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ProjectilesSpeedAccelerated

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

SetUnitTiersByBaseHealth(Int32[])

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_UnitTiersByBaseHealth

Declaration
public TBuilder SetUnitTiersByBaseHealth(params int[] unitTiersByBaseHealth)
Parameters
Type Name Description
System.Int32[] unitTiersByBaseHealth
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetVictorySoundEvent(AkEventReference)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_VictorySoundEvent

Declaration
public TBuilder SetVictorySoundEvent(AkEventReference victorySoundEvent)
Parameters
Type Name Description
Kingmaker.Sound.AkEventReference victorySoundEvent
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetWinnerCutscene(Blueprint<CutsceneReference>)

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_WinnerCutscene

Declaration
public TBuilder SetWinnerCutscene(Blueprint<CutsceneReference> winnerCutscene)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.CutsceneReference> winnerCutscene

Blueprint of type Cutscene. 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

SetZoneSettings(BlueprintTacticalCombatRoot.TacticalZoneSettings[])

Sets the value of Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.m_ZoneSettings

Declaration
public TBuilder SetZoneSettings(params BlueprintTacticalCombatRoot.TacticalZoneSettings[] zoneSettings)
Parameters
Type Name Description
Kingmaker.Armies.TacticalCombat.Blueprints.BlueprintTacticalCombatRoot.TacticalZoneSettings[] zoneSettings
Returns
Type Description
TBuilder