Class BaseCueConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.DialogSystem.Blueprints.BlueprintCue.
Inheritance
Inherited Members
Namespace: BlueprintCore.Blueprints.Configurators.DialogSystem
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseCueConfigurator<T, TBuilder> : BaseCueBaseConfigurator<T, TBuilder> where T : BlueprintCue where TBuilder : BaseCueConfigurator<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 SourceBaseCueConfigurator(Blueprint<BlueprintReference<T>>)
Declaration
protected BaseCueConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> | blueprint |
Methods
| Improve this Doc View SourceAddToAnswers(Blueprint<BlueprintAnswerBaseReference>[])
Adds to the contents of Kingmaker.DialogSystem.Blueprints.BlueprintCue.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:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
ClearAnswers()
Removes all elements from Kingmaker.DialogSystem.Blueprints.BlueprintCue.Answers
Declaration
public TBuilder ClearAnswers()
Returns
| Type | Description |
|---|---|
| TBuilder |
CopyFrom(Blueprint<BlueprintReference<BlueprintCue>>, Predicate<BlueprintComponent>)
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintCue>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.DialogSystem.Blueprints.BlueprintCue>> | 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<BlueprintCue>>, Type[])
Copies fields and components of the specified types from the blueprint.
Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<BlueprintCue>> blueprint, params Type[] componentTypes)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.DialogSystem.Blueprints.BlueprintCue>> | 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();
ModifyAlignmentShift(Action<AlignmentShift>)
Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCue.AlignmentShift by invoking the provided action.
Declaration
public TBuilder ModifyAlignmentShift(Action<AlignmentShift> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.UnitLogic.Alignments.AlignmentShift> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyAnswers(Action<BlueprintAnswerBaseReference>)
Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCue.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 |
ModifyContinueValue(Action<CueSelection>)
Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCue.Continue by invoking the provided action.
Declaration
public TBuilder ModifyContinueValue(Action<CueSelection> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.DialogSystem.CueSelection> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyListener(Action<BlueprintUnitReference>)
Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCue.m_Listener by invoking the provided action.
Declaration
public TBuilder ModifyListener(Action<BlueprintUnitReference> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Blueprints.BlueprintUnitReference> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyOnShow(Action<ActionList>)
Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCue.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 |
ModifyOnStop(Action<ActionList>)
Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCue.OnStop by invoking the provided action.
Declaration
public TBuilder ModifyOnStop(Action<ActionList> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.ElementsSystem.ActionList> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifySpeaker(Action<DialogSpeaker>)
Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCue.Speaker by invoking the provided action.
Declaration
public TBuilder ModifySpeaker(Action<DialogSpeaker> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.DialogSystem.DialogSpeaker> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
ModifyText(Action<LocalizedString>)
Modifies Kingmaker.DialogSystem.Blueprints.BlueprintCue.Text by invoking the provided action.
Declaration
public TBuilder ModifyText(Action<LocalizedString> action)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<Kingmaker.Localization.LocalizedString> | action |
Returns
| Type | Description |
|---|---|
| TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromAnswers(Blueprint<BlueprintAnswerBaseReference>[])
Removes elements from Kingmaker.DialogSystem.Blueprints.BlueprintCue.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:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
RemoveFromAnswers(Func<BlueprintAnswerBaseReference, Boolean>)
Removes elements from Kingmaker.DialogSystem.Blueprints.BlueprintCue.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 |
SetAlignmentShift(AlignmentShift)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.AlignmentShift
Declaration
public TBuilder SetAlignmentShift(AlignmentShift alignmentShift)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.UnitLogic.Alignments.AlignmentShift | alignmentShift |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetAnimation(DialogAnimation)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.Animation
Declaration
public TBuilder SetAnimation(DialogAnimation animation)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.DialogSystem.Blueprints.DialogAnimation | animation |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetAnswers(Blueprint<BlueprintAnswerBaseReference>[])
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.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:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
SetContinueValue(CueSelection)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.Continue
Declaration
public TBuilder SetContinueValue(CueSelection continueValue)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.DialogSystem.CueSelection | continueValue | Create using CueSelections |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetExperience(DialogExperience)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.Experience
Declaration
public TBuilder SetExperience(DialogExperience experience)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.DialogSystem.DialogExperience | experience |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetListener(Blueprint<BlueprintUnitReference>)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.m_Listener
Declaration
public TBuilder SetListener(Blueprint<BlueprintUnitReference> listener)
Parameters
| Type | Name | Description |
|---|---|---|
| Blueprint<Kingmaker.Blueprints.BlueprintUnitReference> | listener | Tooltip: Listener portrait (main character by default) Blueprint of type BlueprintUnit. You can pass in the blueprint using:
|
Returns
| Type | Description |
|---|---|
| TBuilder |
SetOnShow(ActionsBuilder)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.OnShow
Declaration
public TBuilder SetOnShow(ActionsBuilder onShow)
Parameters
| Type | Name | Description |
|---|---|---|
| ActionsBuilder | onShow |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetOnStop(ActionsBuilder)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.OnStop
Declaration
public TBuilder SetOnStop(ActionsBuilder onStop)
Parameters
| Type | Name | Description |
|---|---|---|
| ActionsBuilder | onStop |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetSpeaker(DialogSpeaker)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.Speaker
Declaration
public TBuilder SetSpeaker(DialogSpeaker speaker)
Parameters
| Type | Name | Description |
|---|---|---|
| Kingmaker.DialogSystem.DialogSpeaker | speaker | Create using DialogSpeakers |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetText(LocalString)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.Text
Declaration
public TBuilder SetText(LocalString text)
Parameters
| Type | Name | Description |
|---|---|---|
| LocalString | text | You can pass in the string using a LocalizedString or the Key to a LocalizedString. |
Returns
| Type | Description |
|---|---|
| TBuilder |
SetTurnSpeaker(Boolean)
Sets the value of Kingmaker.DialogSystem.Blueprints.BlueprintCue.TurnSpeaker
Declaration
public TBuilder SetTurnSpeaker(bool turnSpeaker = true)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | turnSpeaker |
Returns
| Type | Description |
|---|---|
| TBuilder |