Class BaseCueConfigurator<T, TBuilder>
Implements common fields and components for blueprints inheriting from Kingmaker.
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. FeatureBlueprintFeature
. Configurators exist for all
blueprint types inheriting from Kingmaker.
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.
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. |
blueprint |
Methods
| Improve this Doc View SourceAddToAnswers(Blueprint<BlueprintAnswerBaseReference>[])
Adds to the contents of Kingmaker.
Declaration
public TBuilder AddToAnswers(params Blueprint<BlueprintAnswerBaseReference>[] answers)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker. |
answers | Blueprint of type BlueprintAnswerBase. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
ClearAnswers()
Removes all elements from Kingmaker.
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. |
blueprint | |
System. |
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. |
blueprint | |
System. |
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.
Declaration
public TBuilder ModifyAlignmentShift(Action<AlignmentShift> action)
Parameters
Type | Name | Description |
---|---|---|
System. |
action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyAnswers(Action<BlueprintAnswerBaseReference>)
Modifies Kingmaker.
Declaration
public TBuilder ModifyAnswers(Action<BlueprintAnswerBaseReference> action)
Parameters
Type | Name | Description |
---|---|---|
System. |
action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyContinueValue(Action<CueSelection>)
Modifies Kingmaker.
Declaration
public TBuilder ModifyContinueValue(Action<CueSelection> action)
Parameters
Type | Name | Description |
---|---|---|
System. |
action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyListener(Action<BlueprintUnitReference>)
Modifies Kingmaker.
Declaration
public TBuilder ModifyListener(Action<BlueprintUnitReference> action)
Parameters
Type | Name | Description |
---|---|---|
System. |
action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyOnShow(Action<ActionList>)
Modifies Kingmaker.
Declaration
public TBuilder ModifyOnShow(Action<ActionList> action)
Parameters
Type | Name | Description |
---|---|---|
System. |
action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyOnStop(Action<ActionList>)
Modifies Kingmaker.
Declaration
public TBuilder ModifyOnStop(Action<ActionList> action)
Parameters
Type | Name | Description |
---|---|---|
System. |
action |
Returns
Type | Description |
---|---|
TBuilder |
ModifySpeaker(Action<DialogSpeaker>)
Modifies Kingmaker.
Declaration
public TBuilder ModifySpeaker(Action<DialogSpeaker> action)
Parameters
Type | Name | Description |
---|---|---|
System. |
action |
Returns
Type | Description |
---|---|
TBuilder |
ModifyText(Action<LocalizedString>)
Modifies Kingmaker.
Declaration
public TBuilder ModifyText(Action<LocalizedString> action)
Parameters
Type | Name | Description |
---|---|---|
System. |
action |
Returns
Type | Description |
---|---|
TBuilder |
OnConfigureCompleted()
Declaration
protected override void OnConfigureCompleted()
Overrides
RemoveFromAnswers(Blueprint<BlueprintAnswerBaseReference>[])
Removes elements from Kingmaker.
Declaration
public TBuilder RemoveFromAnswers(params Blueprint<BlueprintAnswerBaseReference>[] answers)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker. |
answers | Blueprint of type BlueprintAnswerBase. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
RemoveFromAnswers(Func<BlueprintAnswerBaseReference, Boolean>)
Removes elements from Kingmaker.
Declaration
public TBuilder RemoveFromAnswers(Func<BlueprintAnswerBaseReference, bool> predicate)
Parameters
Type | Name | Description |
---|---|---|
System. |
predicate |
Returns
Type | Description |
---|---|
TBuilder |
SetAlignmentShift(AlignmentShift)
Sets the value of Kingmaker.
Declaration
public TBuilder SetAlignmentShift(AlignmentShift alignmentShift)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker. |
alignmentShift |
Returns
Type | Description |
---|---|
TBuilder |
SetAnimation(DialogAnimation)
Sets the value of Kingmaker.
Declaration
public TBuilder SetAnimation(DialogAnimation animation)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker. |
animation |
Returns
Type | Description |
---|---|
TBuilder |
SetAnswers(Blueprint<BlueprintAnswerBaseReference>[])
Sets the value of Kingmaker.
Declaration
public TBuilder SetAnswers(params Blueprint<BlueprintAnswerBaseReference>[] answers)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker. |
answers | Blueprint of type BlueprintAnswerBase. You can pass in the blueprint using:
|
Returns
Type | Description |
---|---|
TBuilder |
SetContinueValue(CueSelection)
Sets the value of Kingmaker.
Declaration
public TBuilder SetContinueValue(CueSelection continueValue)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker. |
continueValue | Create using Cue |
Returns
Type | Description |
---|---|
TBuilder |
SetExperience(DialogExperience)
Sets the value of Kingmaker.
Declaration
public TBuilder SetExperience(DialogExperience experience)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker. |
experience |
Returns
Type | Description |
---|---|
TBuilder |
SetListener(Blueprint<BlueprintUnitReference>)
Sets the value of Kingmaker.
Declaration
public TBuilder SetListener(Blueprint<BlueprintUnitReference> listener)
Parameters
Type | Name | Description |
---|---|---|
Blueprint<Kingmaker. |
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.
Declaration
public TBuilder SetOnShow(ActionsBuilder onShow)
Parameters
Type | Name | Description |
---|---|---|
Actions |
onShow |
Returns
Type | Description |
---|---|
TBuilder |
SetOnStop(ActionsBuilder)
Sets the value of Kingmaker.
Declaration
public TBuilder SetOnStop(ActionsBuilder onStop)
Parameters
Type | Name | Description |
---|---|---|
Actions |
onStop |
Returns
Type | Description |
---|---|
TBuilder |
SetSpeaker(DialogSpeaker)
Sets the value of Kingmaker.
Declaration
public TBuilder SetSpeaker(DialogSpeaker speaker)
Parameters
Type | Name | Description |
---|---|---|
Kingmaker. |
speaker | Create using Dialog |
Returns
Type | Description |
---|---|
TBuilder |
SetText(LocalString)
Sets the value of Kingmaker.
Declaration
public TBuilder SetText(LocalString text)
Parameters
Type | Name | Description |
---|---|---|
Local |
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.
Declaration
public TBuilder SetTurnSpeaker(bool turnSpeaker = true)
Parameters
Type | Name | Description |
---|---|---|
System. |
turnSpeaker |
Returns
Type | Description |
---|---|
TBuilder |