Class BaseGameUIConfigConfigurator<T, TBuilder>

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

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseGameUIConfigConfigurator<T, TBuilder>
GameUIConfigConfigurator
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
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseGameUIConfigConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : GameUIConfig where TBuilder : BaseGameUIConfigConfigurator<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

BaseGameUIConfigConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToSpriteLinks(GameUIConfig.SpriteNameLink[])

Adds to the contents of Kingmaker.Blueprints.GameUIConfig.SpriteLinks

Declaration
public TBuilder AddToSpriteLinks(params GameUIConfig.SpriteNameLink[] spriteLinks)
Parameters
Type Name Description
Kingmaker.Blueprints.GameUIConfig.SpriteNameLink[] spriteLinks
Returns
Type Description
TBuilder
| Improve this Doc View Source

Removes all elements from Kingmaker.Blueprints.GameUIConfig.SpriteLinks

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

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

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

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

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

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

ModifyDLC3BoonWindow(Action<GameUIConfig.PrefabLinkPair>)

Modifies Kingmaker.Blueprints.GameUIConfig.DLC3BoonWindow by invoking the provided action.

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

ModifyDLC3GameOverWindow(Action<GameUIConfig.PrefabLinkPair>)

Modifies Kingmaker.Blueprints.GameUIConfig.DLC3GameOverWindow by invoking the provided action.

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

ModifyDLC3MapWindow(Action<GameUIConfig.PrefabLinkPair>)

Modifies Kingmaker.Blueprints.GameUIConfig.DLC3MapWindow by invoking the provided action.

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

ModifySpriteLinks(Action<GameUIConfig.SpriteNameLink>)

Modifies Kingmaker.Blueprints.GameUIConfig.SpriteLinks by invoking the provided action on each element.

Declaration
public TBuilder ModifySpriteLinks(Action<GameUIConfig.SpriteNameLink> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.GameUIConfig.SpriteNameLink> 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

RemoveFromSpriteLinks(GameUIConfig.SpriteNameLink[])

Removes elements from Kingmaker.Blueprints.GameUIConfig.SpriteLinks

Declaration
public TBuilder RemoveFromSpriteLinks(params GameUIConfig.SpriteNameLink[] spriteLinks)
Parameters
Type Name Description
Kingmaker.Blueprints.GameUIConfig.SpriteNameLink[] spriteLinks
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromSpriteLinks(Func<GameUIConfig.SpriteNameLink, Boolean>)

Removes elements from Kingmaker.Blueprints.GameUIConfig.SpriteLinks that match the provided predicate.

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

SetDLC3BoonWindow(GameUIConfig.PrefabLinkPair)

Sets the value of Kingmaker.Blueprints.GameUIConfig.DLC3BoonWindow

Declaration
public TBuilder SetDLC3BoonWindow(GameUIConfig.PrefabLinkPair dLC3BoonWindow)
Parameters
Type Name Description
Kingmaker.Blueprints.GameUIConfig.PrefabLinkPair dLC3BoonWindow
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDLC3GameOverWindow(GameUIConfig.PrefabLinkPair)

Sets the value of Kingmaker.Blueprints.GameUIConfig.DLC3GameOverWindow

Declaration
public TBuilder SetDLC3GameOverWindow(GameUIConfig.PrefabLinkPair dLC3GameOverWindow)
Parameters
Type Name Description
Kingmaker.Blueprints.GameUIConfig.PrefabLinkPair dLC3GameOverWindow
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDLC3MapWindow(GameUIConfig.PrefabLinkPair)

Sets the value of Kingmaker.Blueprints.GameUIConfig.DLC3MapWindow

Declaration
public TBuilder SetDLC3MapWindow(GameUIConfig.PrefabLinkPair dLC3MapWindow)
Parameters
Type Name Description
Kingmaker.Blueprints.GameUIConfig.PrefabLinkPair dLC3MapWindow
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSpriteLinks(GameUIConfig.SpriteNameLink[])

Sets the value of Kingmaker.Blueprints.GameUIConfig.SpriteLinks

Declaration
public TBuilder SetSpriteLinks(params GameUIConfig.SpriteNameLink[] spriteLinks)
Parameters
Type Name Description
Kingmaker.Blueprints.GameUIConfig.SpriteNameLink[] spriteLinks
Returns
Type Description
TBuilder