Class BaseBookPageConfigurator<T, TBuilder>

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

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseCueBaseConfigurator<T, TBuilder>
BaseBookPageConfigurator<T, TBuilder>
BookPageConfigurator
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.DialogSystem
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseBookPageConfigurator<T, TBuilder> : BaseCueBaseConfigurator<T, TBuilder> where T : BlueprintBookPage where TBuilder : BaseBookPageConfigurator<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

BaseBookPageConfigurator(Blueprint<BlueprintReference<T>>)

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

Methods

| Improve this Doc View Source

AddToAnswers(Blueprint<BlueprintAnswerBaseReference>[])

Adds to the contents of Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Answers

Declaration
public TBuilder AddToAnswers(params Blueprint<BlueprintAnswerBaseReference>[] answers)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintAnswerBaseReference>[] answers

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

AddToCues(Blueprint<BlueprintCueBaseReference>[])

Adds to the contents of Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Cues

Declaration
public TBuilder AddToCues(params Blueprint<BlueprintCueBaseReference>[] cues)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintCueBaseReference>[] cues

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

ClearAnswers()

Removes all elements from Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Answers

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

ClearCues()

Removes all elements from Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Cues

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

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

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

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

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

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

ModifyAnswers(Action<BlueprintAnswerBaseReference>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Answers by invoking the provided action on each element.

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

ModifyCues(Action<BlueprintCueBaseReference>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Cues by invoking the provided action on each element.

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

ModifyForeImageLink(Action<SpriteLink>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.ForeImageLink by invoking the provided action.

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

ModifyImageLink(Action<SpriteLink>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.ImageLink by invoking the provided action.

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

ModifyOnShow(Action<ActionList>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.OnShow by invoking the provided action.

Declaration
public TBuilder ModifyOnShow(Action<ActionList> action)
Parameters
Type Name Description
System.Action<Kingmaker.ElementsSystem.ActionList> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyTitle(Action<LocalizedString>)

Modifies Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.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
| Improve this Doc View Source

OnConfigureCompleted()

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

RemoveFromAnswers(Blueprint<BlueprintAnswerBaseReference>[])

Removes elements from Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Answers

Declaration
public TBuilder RemoveFromAnswers(params Blueprint<BlueprintAnswerBaseReference>[] answers)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintAnswerBaseReference>[] answers

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

RemoveFromAnswers(Func<BlueprintAnswerBaseReference, Boolean>)

Removes elements from Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Answers that match the provided predicate.

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

RemoveFromCues(Blueprint<BlueprintCueBaseReference>[])

Removes elements from Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Cues

Declaration
public TBuilder RemoveFromCues(params Blueprint<BlueprintCueBaseReference>[] cues)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintCueBaseReference>[] cues

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

RemoveFromCues(Func<BlueprintCueBaseReference, Boolean>)

Removes elements from Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Cues that match the provided predicate.

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

SetAnswers(Blueprint<BlueprintAnswerBaseReference>[])

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Answers

Declaration
public TBuilder SetAnswers(params Blueprint<BlueprintAnswerBaseReference>[] answers)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintAnswerBaseReference>[] answers

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

SetCues(Blueprint<BlueprintCueBaseReference>[])

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.Cues

Declaration
public TBuilder SetCues(params Blueprint<BlueprintCueBaseReference>[] cues)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintCueBaseReference>[] cues

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

SetForeImageLink(AssetLink<SpriteLink>)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.ForeImageLink

Declaration
public TBuilder SetForeImageLink(AssetLink<SpriteLink> foreImageLink)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink> foreImageLink

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

SetImageLink(AssetLink<SpriteLink>)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.ImageLink

Declaration
public TBuilder SetImageLink(AssetLink<SpriteLink> imageLink)
Parameters
Type Name Description
AssetLink<Kingmaker.ResourceLinks.SpriteLink> imageLink

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

SetOnShow(ActionsBuilder)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.OnShow

Declaration
public TBuilder SetOnShow(ActionsBuilder onShow)
Parameters
Type Name Description
ActionsBuilder onShow
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetTitle(LocalString)

Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintBookPage.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