Class BaseEncyclopediaPageConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.Encyclopedia
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseEncyclopediaPageConfigurator<T, TBuilder> : BaseEncyclopediaNodeConfigurator<T, TBuilder> where T : BlueprintEncyclopediaPage where TBuilder : BaseEncyclopediaPageConfigurator<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 SourceBaseEncyclopediaPageConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseEncyclopediaPageConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddToBlocks(BlueprintEncyclopediaBlock[])
Adds to the contents of Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.Blocks
Declaration
public TBuilder AddToBlocks(params BlueprintEncyclopediaBlock[] blocks)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock[] | blocks |
Returns
Type | Description |
---|---|
TBuilder |
AddToConsoleBlocks(BlueprintEncyclopediaBlock[])
Adds to the contents of Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.ConsoleBlocks
Declaration
public TBuilder AddToConsoleBlocks(params BlueprintEncyclopediaBlock[] consoleBlocks)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock[] | consoleBlocks |
Returns
Type | Description |
---|---|
TBuilder |
ClearBlocks()
Removes all elements from Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.Blocks
Declaration
public TBuilder ClearBlocks()
Returns
Type | Description |
---|---|
TBuilder |
ClearConsoleBlocks()
Removes all elements from Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.ConsoleBlocks
Declaration
public TBuilder ClearConsoleBlocks()
Returns
Type | Description |
---|---|
TBuilder |
CopyFrom(Blueprint<BlueprintReference<BlueprintEncyclopediaPage>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintEncyclopediaPage>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage>> | blueprint | |
System.Predicate<Kingmaker.Blueprints.BlueprintComponent> | componentMatcher | Any components in |
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();
CopyFrom(Blueprint<BlueprintReference<BlueprintEncyclopediaPage>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintEncyclopediaPage>> blueprint, params Type[] componentTypes)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage>> | blueprint | |
System.Type[] | componentTypes | Any components in |
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();
ModifyBlocks(Action<BlueprintEncyclopediaBlock>)
Modifies Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.Blocks by invoking the provided action on each element.
Declaration
public TBuilder ModifyBlocks(Action<BlueprintEncyclopediaBlock> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyConsoleBlocks(Action<BlueprintEncyclopediaBlock>)
Modifies Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.ConsoleBlocks by invoking the provided action on each element.
Declaration
public TBuilder ModifyConsoleBlocks(Action<BlueprintEncyclopediaBlock> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyParentAsset(Action<BlueprintEncyclopediaNodeReference>)
Modifies Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.m_ParentAsset by invoking the provided action.
Declaration
public TBuilder ModifyParentAsset(Action<BlueprintEncyclopediaNodeReference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.BlueprintEncyclopediaNodeReference> | action |
Returns
Type | Description |
---|---|
TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromBlocks(BlueprintEncyclopediaBlock[])
Removes elements from Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.Blocks
Declaration
public TBuilder RemoveFromBlocks(params BlueprintEncyclopediaBlock[] blocks)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock[] | blocks |
Returns
Type | Description |
---|---|
TBuilder |
RemoveFromBlocks(Func<BlueprintEncyclopediaBlock, Boolean>)
Removes elements from Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.Blocks that match the provided predicate.
Declaration
public TBuilder RemoveFromBlocks(Func<BlueprintEncyclopediaBlock, bool> predicate)
Parameters
Type | Name | Description |
---|---|---|
System.Func<Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock, System.Boolean> | predicate |
Returns
Type | Description |
---|---|
TBuilder |
RemoveFromConsoleBlocks(BlueprintEncyclopediaBlock[])
Removes elements from Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.ConsoleBlocks
Declaration
public TBuilder RemoveFromConsoleBlocks(params BlueprintEncyclopediaBlock[] consoleBlocks)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock[] | consoleBlocks |
Returns
Type | Description |
---|---|
TBuilder |
RemoveFromConsoleBlocks(Func<BlueprintEncyclopediaBlock, Boolean>)
Removes elements from Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.ConsoleBlocks that match the provided predicate.
Declaration
public TBuilder RemoveFromConsoleBlocks(Func<BlueprintEncyclopediaBlock, bool> predicate)
Parameters
Type | Name | Description |
---|---|---|
System.Func<Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock, System.Boolean> | predicate |
Returns
Type | Description |
---|---|
TBuilder |
SetBlocks(BlueprintEncyclopediaBlock[])
Sets the value of Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.Blocks
Declaration
public TBuilder SetBlocks(params BlueprintEncyclopediaBlock[] blocks)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock[] | blocks |
Returns
Type | Description |
---|---|
TBuilder |
SetConsoleBlocks(BlueprintEncyclopediaBlock[])
Sets the value of Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.ConsoleBlocks
Declaration
public TBuilder SetConsoleBlocks(params BlueprintEncyclopediaBlock[] consoleBlocks)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Blueprints.Encyclopedia.Blocks.BlueprintEncyclopediaBlock[] | consoleBlocks |
Returns
Type | Description |
---|---|
TBuilder |
SetParentAsset(Blueprint<BlueprintEncyclopediaNodeReference>)
Sets the value of Kingmaker.Blueprints.Encyclopedia.BlueprintEncyclopediaPage.m_ParentAsset
Declaration
public TBuilder SetParentAsset(Blueprint<BlueprintEncyclopediaNodeReference> parentAsset)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintEncyclopediaNodeReference> | parentAsset | Blueprint of type BlueprintEncyclopediaNode. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |