Class BasePortraitConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.Blueprints.BlueprintPortrait.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators
Assembly: BlueprintCore.dll
Syntax
public abstract class BasePortraitConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintPortrait where TBuilder : BasePortraitConfigurator<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 SourceBasePortraitConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BasePortraitConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddPortraitDollSettings(Nullable<Gender>, Action<BlueprintComponent, BlueprintComponent>, ComponentMerge, Blueprint<BlueprintRaceReference>)
Adds Kingmaker.Blueprints.PortraitDollSettings
Declaration
public TBuilder AddPortraitDollSettings(Gender? gender = null, Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail, Blueprint<BlueprintRaceReference> race = null)
Parameters
Type | Name | Description |
---|---|---|
System.Nullable<Kingmaker.Blueprints.Gender> | gender | |
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
Blueprint<Kingmaker.Blueprints.BlueprintRaceReference> | race | Blueprint of type BlueprintRace. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- AasimarMaleBloodrager7ba4a4bdb55b46779ebca045d7955e82
- PlayerAasimarFemaleMage_Portrait4bb9e147a44d9be43ab4b16fa7d48383
- VillasGunderson_Portrait579ffcd508ac4074597892b12b17ee47
AddPortraitPremiumSetting(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)
Adds Kingmaker.Blueprints.PortraitPremiumSetting
Declaration
public TBuilder AddPortraitPremiumSetting(Action<BlueprintComponent, BlueprintComponent> merge = null, ComponentMerge mergeBehavior = ComponentMerge.Fail)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.BlueprintComponent, Kingmaker.Blueprints.BlueprintComponent> | merge | If mergeBehavior is ComponentMerge.Merge and the component already exists, this expression is called to merge the components. |
ComponentMerge | mergeBehavior | Handling if the component already exists since the component is unique. Defaults to ComponentMerge.Fail. |
Returns
Type | Description |
---|---|
TBuilder |
Remarks
- SepalLorentus_Portrait41db134e53a1908469a2efc6d55cc8f8
CopyFrom(Blueprint<BlueprintReference<BlueprintPortrait>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintPortrait>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.BlueprintPortrait>> | 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<BlueprintPortrait>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintPortrait>> blueprint, params Type[] componentTypes)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.Blueprints.BlueprintPortrait>> | 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();
ModifyBackupPortrait(Action<BlueprintPortraitReference>)
Modifies Kingmaker.Blueprints.BlueprintPortrait.m_BackupPortrait by invoking the provided action.
Declaration
public TBuilder ModifyBackupPortrait(Action<BlueprintPortraitReference> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.BlueprintPortraitReference> | action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyData(Action<PortraitData>)
Modifies Kingmaker.Blueprints.BlueprintPortrait.Data by invoking the provided action.
Declaration
public TBuilder ModifyData(Action<PortraitData> action)
Parameters
Type | Name | Description |
---|---|---|
System.Action<Kingmaker.Blueprints.PortraitData> | action |
Returns
Type | Description |
---|---|
TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
SetBackupPortrait(Blueprint<BlueprintPortraitReference>)
Sets the value of Kingmaker.Blueprints.BlueprintPortrait.m_BackupPortrait
Declaration
public TBuilder SetBackupPortrait(Blueprint<BlueprintPortraitReference> backupPortrait)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker.Blueprints.BlueprintPortraitReference> | backupPortrait | Blueprint of type BlueprintPortrait. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
SetData(PortraitData)
Sets the value of Kingmaker.Blueprints.BlueprintPortrait.Data
Declaration
public TBuilder SetData(PortraitData data)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker.Blueprints.PortraitData | data |
Returns
Type | Description |
---|---|
TBuilder |