Class BaseRegionConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Kingdom.Blueprints.BlueprintRegion.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseRegionConfigurator<T, TBuilder>
RegionConfigurator
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.Kingdom
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseRegionConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintRegion where TBuilder : BaseRegionConfigurator<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

BaseRegionConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToAdjacent(Blueprint<BlueprintRegionReference>[])

Adds to the contents of Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_Adjacent

Declaration
public TBuilder AddToAdjacent(params Blueprint<BlueprintRegionReference>[] adjacent)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintRegionReference>[] adjacent

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

AddToArtisans(Blueprint<BlueprintKingdomArtisanReference>[])

Adds to the contents of Kingmaker.Kingdom.Blueprints.BlueprintRegion.Artisans

Declaration
public TBuilder AddToArtisans(params Blueprint<BlueprintKingdomArtisanReference>[] artisans)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintKingdomArtisanReference>[] artisans

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

AddToUpgradeEvents(BlueprintRegion.UpgradeVariant[])

Adds to the contents of Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeEvents

Declaration
public TBuilder AddToUpgradeEvents(params BlueprintRegion.UpgradeVariant[] upgradeEvents)
Parameters
Type Name Description
Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeVariant[] upgradeEvents
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearAdjacent()

Removes all elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_Adjacent

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

ClearArtisans()

Removes all elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.Artisans

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

ClearUpgradeEvents()

Removes all elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeEvents

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

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

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

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

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

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

ModifyAdjacent(Action<BlueprintRegionReference>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_Adjacent by invoking the provided action on each element.

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

ModifyArtisans(Action<BlueprintKingdomArtisanReference>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintRegion.Artisans by invoking the provided action on each element.

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

ModifyClaimedDescription(Action<LocalizedString>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintRegion.ClaimedDescription by invoking the provided action.

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

ModifyClaimEvent(Action<BlueprintKingdomClaimReference>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_ClaimEvent by invoking the provided action.

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

ModifyGlobalMap(Action<BlueprintGlobalMapReference>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_GlobalMap by invoking the provided action.

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

ModifyLocalizedName(Action<LocalizedString>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintRegion.LocalizedName by invoking the provided action.

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

ModifyStatsWhenClaimed(Action<KingdomStats.Changes>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintRegion.StatsWhenClaimed by invoking the provided action.

Declaration
public TBuilder ModifyStatsWhenClaimed(Action<KingdomStats.Changes> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.KingdomStats.Changes> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyUpgradeEvents(Action<BlueprintRegion.UpgradeVariant>)

Modifies Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeEvents by invoking the provided action on each element.

Declaration
public TBuilder ModifyUpgradeEvents(Action<BlueprintRegion.UpgradeVariant> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeVariant> 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

RemoveFromAdjacent(Blueprint<BlueprintRegionReference>[])

Removes elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_Adjacent

Declaration
public TBuilder RemoveFromAdjacent(params Blueprint<BlueprintRegionReference>[] adjacent)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintRegionReference>[] adjacent

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

RemoveFromAdjacent(Func<BlueprintRegionReference, Boolean>)

Removes elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_Adjacent that match the provided predicate.

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

RemoveFromArtisans(Blueprint<BlueprintKingdomArtisanReference>[])

Removes elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.Artisans

Declaration
public TBuilder RemoveFromArtisans(params Blueprint<BlueprintKingdomArtisanReference>[] artisans)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintKingdomArtisanReference>[] artisans

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

RemoveFromArtisans(Func<BlueprintKingdomArtisanReference, Boolean>)

Removes elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.Artisans that match the provided predicate.

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

RemoveFromUpgradeEvents(BlueprintRegion.UpgradeVariant[])

Removes elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeEvents

Declaration
public TBuilder RemoveFromUpgradeEvents(params BlueprintRegion.UpgradeVariant[] upgradeEvents)
Parameters
Type Name Description
Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeVariant[] upgradeEvents
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromUpgradeEvents(Func<BlueprintRegion.UpgradeVariant, Boolean>)

Removes elements from Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeEvents that match the provided predicate.

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

SetAdjacent(Blueprint<BlueprintRegionReference>[])

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_Adjacent

Declaration
public TBuilder SetAdjacent(params Blueprint<BlueprintRegionReference>[] adjacent)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintRegionReference>[] adjacent

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

SetArtisans(Blueprint<BlueprintKingdomArtisanReference>[])

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.Artisans

Declaration
public TBuilder SetArtisans(params Blueprint<BlueprintKingdomArtisanReference>[] artisans)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintKingdomArtisanReference>[] artisans

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

SetClaimedDescription(LocalString)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.ClaimedDescription

Declaration
public TBuilder SetClaimedDescription(LocalString claimedDescription)
Parameters
Type Name Description
LocalString claimedDescription

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

SetClaimEvent(Blueprint<BlueprintKingdomClaimReference>)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_ClaimEvent

Declaration
public TBuilder SetClaimEvent(Blueprint<BlueprintKingdomClaimReference> claimEvent)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintKingdomClaimReference> claimEvent

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

SetCorruptionGrowth(Int32)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.CorruptionGrowth

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

SetCR(Int32)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.CR

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

SetGlobalMap(Blueprint<BlueprintGlobalMapReference>)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_GlobalMap

Declaration
public TBuilder SetGlobalMap(Blueprint<BlueprintGlobalMapReference> globalMap)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintGlobalMapReference> globalMap

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

SetHardEncountersDisabled(Boolean)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.HardEncountersDisabled

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

SetId(RegionId)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.m_Id

Declaration
public TBuilder SetId(RegionId id)
Parameters
Type Name Description
Kingmaker.Kingdom.Blueprints.RegionId id
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetLocalizedName(LocalString)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.LocalizedName

Declaration
public TBuilder SetLocalizedName(LocalString localizedName)
Parameters
Type Name Description
LocalString localizedName

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

SetOverrideCorruption(Boolean)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.OverrideCorruption

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

SetStatsWhenClaimed(KingdomStats.Changes)

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.StatsWhenClaimed

Declaration
public TBuilder SetStatsWhenClaimed(KingdomStats.Changes statsWhenClaimed)
Parameters
Type Name Description
Kingmaker.Kingdom.KingdomStats.Changes statsWhenClaimed
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetUpgradeEvents(BlueprintRegion.UpgradeVariant[])

Sets the value of Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeEvents

Declaration
public TBuilder SetUpgradeEvents(params BlueprintRegion.UpgradeVariant[] upgradeEvents)
Parameters
Type Name Description
Kingmaker.Kingdom.Blueprints.BlueprintRegion.UpgradeVariant[] upgradeEvents
Returns
Type Description
TBuilder