Class BaseBarkBanterConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.BarkBanters.BlueprintBarkBanter.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.BarkBanters
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseBarkBanterConfigurator<T, TBuilder> : BaseBlueprintConfigurator<T, TBuilder> where T : BlueprintBarkBanter where TBuilder : BaseBarkBanterConfigurator<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 SourceBaseBarkBanterConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseBarkBanterConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddToFirstPhrase(LocalString[])
Adds to the contents of Kingmaker.BarkBanters.BlueprintBarkBanter.FirstPhrase
Declaration
public TBuilder AddToFirstPhrase(params LocalString[] firstPhrase)
Parameters
| Type | Name | Description |
|---|---|---|
| LocalString[] | firstPhrase | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
| Type | Description |
|---|---|
| TBuilder |
AddToResponses(BlueprintBarkBanter.BanterResponseEntry[])
Adds to the contents of Kingmaker.BarkBanters.BlueprintBarkBanter.Responses
Declaration
public TBuilder AddToResponses(params BlueprintBarkBanter.BanterResponseEntry[] responses)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.BarkBanters.BlueprintBarkBanter.BanterResponseEntry[] | responses |
Returns
| Type | Description |
|---|---|
| TBuilder |
ClearFirstPhrase()
Removes all elements from Kingmaker.BarkBanters.BlueprintBarkBanter.FirstPhrase
Declaration
public TBuilder ClearFirstPhrase()
Returns
| Type | Description |
|---|---|
| TBuilder |
ClearResponses()
Removes all elements from Kingmaker.BarkBanters.BlueprintBarkBanter.Responses
Declaration
public TBuilder ClearResponses()
Returns
| Type | Description |
|---|---|
| TBuilder |
CopyFrom(Blueprint<BlueprintReference<BlueprintBarkBanter>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintBarkBanter>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.BarkBanters.BlueprintBarkBanter>> | 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<BlueprintBarkBanter>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintBarkBanter>> blueprint, params Type[] componentTypes)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.BarkBanters.BlueprintBarkBanter>> | 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();
ModifyConditions(Action<BanterConditions>)
Modifies Kingmaker.BarkBanters.BlueprintBarkBanter.Conditions by invoking the provided action.
Declaration
public TBuilder ModifyConditions(Action<BanterConditions> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.BarkBanters.BanterConditions> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyFirstPhrase(Action<LocalizedString>)
Modifies Kingmaker.BarkBanters.BlueprintBarkBanter.FirstPhrase by invoking the provided action on each element.
Declaration
public TBuilder ModifyFirstPhrase(Action<LocalizedString> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyResponses(Action<BlueprintBarkBanter.BanterResponseEntry>)
Modifies Kingmaker.BarkBanters.BlueprintBarkBanter.Responses by invoking the provided action on each element.
Declaration
public TBuilder ModifyResponses(Action<BlueprintBarkBanter.BanterResponseEntry> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.BarkBanters.BlueprintBarkBanter.BanterResponseEntry> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyUnit(Action<BlueprintUnitReference>)
Modifies Kingmaker.BarkBanters.BlueprintBarkBanter.m_Unit by invoking the provided action.
Declaration
public TBuilder ModifyUnit(Action<BlueprintUnitReference> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Blueprints.BlueprintUnitReference> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromFirstPhrase(LocalString[])
Removes elements from Kingmaker.BarkBanters.BlueprintBarkBanter.FirstPhrase
Declaration
public TBuilder RemoveFromFirstPhrase(params LocalString[] firstPhrase)
Parameters
| Type | Name | Description |
|---|---|---|
| LocalString[] | firstPhrase | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromFirstPhrase(Func<LocalizedString, Boolean>)
Removes elements from Kingmaker.BarkBanters.BlueprintBarkBanter.FirstPhrase that match the provided predicate.
Declaration
public TBuilder RemoveFromFirstPhrase(Func<LocalizedString, bool> predicate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Kingmaker.Localization.LocalizedString, System.Boolean> | predicate |
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromResponses(BlueprintBarkBanter.BanterResponseEntry[])
Removes elements from Kingmaker.BarkBanters.BlueprintBarkBanter.Responses
Declaration
public TBuilder RemoveFromResponses(params BlueprintBarkBanter.BanterResponseEntry[] responses)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.BarkBanters.BlueprintBarkBanter.BanterResponseEntry[] | responses |
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromResponses(Func<BlueprintBarkBanter.BanterResponseEntry, Boolean>)
Removes elements from Kingmaker.BarkBanters.BlueprintBarkBanter.Responses that match the provided predicate.
Declaration
public TBuilder RemoveFromResponses(Func<BlueprintBarkBanter.BanterResponseEntry, bool> predicate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Func<Kingmaker.BarkBanters.BlueprintBarkBanter.BanterResponseEntry, System.Boolean> | predicate |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetConditions(BanterConditions)
Sets the value of Kingmaker.BarkBanters.BlueprintBarkBanter.Conditions
Declaration
public TBuilder SetConditions(BanterConditions conditions)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.BarkBanters.BanterConditions | conditions |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetFirstPhrase(LocalString[])
Sets the value of Kingmaker.BarkBanters.BlueprintBarkBanter.FirstPhrase
Declaration
public TBuilder SetFirstPhrase(params LocalString[] firstPhrase)
Parameters
| Type | Name | Description |
|---|---|---|
| LocalString[] | firstPhrase | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetResponses(BlueprintBarkBanter.BanterResponseEntry[])
Sets the value of Kingmaker.BarkBanters.BlueprintBarkBanter.Responses
Declaration
public TBuilder SetResponses(params BlueprintBarkBanter.BanterResponseEntry[] responses)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.BarkBanters.BlueprintBarkBanter.BanterResponseEntry[] | responses |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetSpeakerType(SpeakerType)
Sets the value of Kingmaker.BarkBanters.BlueprintBarkBanter.m_SpeakerType
Declaration
public TBuilder SetSpeakerType(SpeakerType speakerType)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.BarkBanters.SpeakerType | speakerType |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetUnit(Blueprint<BlueprintUnitReference>)
Sets the value of Kingmaker.BarkBanters.BlueprintBarkBanter.m_Unit
Declaration
public TBuilder SetUnit(Blueprint<BlueprintUnitReference> unit)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintUnitReference> | unit | Blueprint of type BlueprintUnit. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
SetWeight(Single)
Sets the value of Kingmaker.BarkBanters.BlueprintBarkBanter.m_Weight
Declaration
public TBuilder SetWeight(float weight)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | weight |
Returns
| Type | Description |
|---|---|
| TBuilder |