Class BaseSettlementBuildListConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.Kingdom.AI.SettlementBuildList.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseSettlementBuildListConfigurator<T, TBuilder>
SettlementBuildListConfigurator
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.AI
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseSettlementBuildListConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : SettlementBuildList where TBuilder : BaseSettlementBuildListConfigurator<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

BaseSettlementBuildListConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToList(SettlementBuildList.Entry[])

Adds to the contents of Kingmaker.Kingdom.AI.SettlementBuildList.List

Declaration
public TBuilder AddToList(params SettlementBuildList.Entry[] list)
Parameters
Type Name Description
Kingmaker.Kingdom.AI.SettlementBuildList.Entry[] list
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearList()

Removes all elements from Kingmaker.Kingdom.AI.SettlementBuildList.List

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

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

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

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

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

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

ModifyBuildArea(Action<BlueprintAreaEnterPointReference>)

Modifies Kingmaker.Kingdom.AI.SettlementBuildList.m_BuildArea by invoking the provided action.

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

ModifyList(Action<SettlementBuildList.Entry>)

Modifies Kingmaker.Kingdom.AI.SettlementBuildList.List by invoking the provided action on each element.

Declaration
public TBuilder ModifyList(Action<SettlementBuildList.Entry> action)
Parameters
Type Name Description
System.Action<Kingmaker.Kingdom.AI.SettlementBuildList.Entry> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifySlotSetupPrefab(Action<SettlementsBuildSlots>)

Modifies Kingmaker.Kingdom.AI.SettlementBuildList.SlotSetupPrefab by invoking the provided action.

Declaration
public TBuilder ModifySlotSetupPrefab(Action<SettlementsBuildSlots> action)
Parameters
Type Name Description
System.Action<Kingmaker.UI.Settlement.SettlementsBuildSlots> 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

RemoveFromList(SettlementBuildList.Entry[])

Removes elements from Kingmaker.Kingdom.AI.SettlementBuildList.List

Declaration
public TBuilder RemoveFromList(params SettlementBuildList.Entry[] list)
Parameters
Type Name Description
Kingmaker.Kingdom.AI.SettlementBuildList.Entry[] list
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromList(Func<SettlementBuildList.Entry, Boolean>)

Removes elements from Kingmaker.Kingdom.AI.SettlementBuildList.List that match the provided predicate.

Declaration
public TBuilder RemoveFromList(Func<SettlementBuildList.Entry, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Kingdom.AI.SettlementBuildList.Entry, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetBuildArea(Blueprint<BlueprintAreaEnterPointReference>)

Sets the value of Kingmaker.Kingdom.AI.SettlementBuildList.m_BuildArea

Declaration
public TBuilder SetBuildArea(Blueprint<BlueprintAreaEnterPointReference> buildArea)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintAreaEnterPointReference> buildArea

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

SetList(SettlementBuildList.Entry[])

Sets the value of Kingmaker.Kingdom.AI.SettlementBuildList.List

Declaration
public TBuilder SetList(params SettlementBuildList.Entry[] list)
Parameters
Type Name Description
Kingmaker.Kingdom.AI.SettlementBuildList.Entry[] list
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSlotSetupPrefab(SettlementsBuildSlots)

Sets the value of Kingmaker.Kingdom.AI.SettlementBuildList.SlotSetupPrefab

Declaration
public TBuilder SetSlotSetupPrefab(SettlementsBuildSlots slotSetupPrefab)
Parameters
Type Name Description
Kingmaker.UI.Settlement.SettlementsBuildSlots slotSetupPrefab
Returns
Type Description
TBuilder