Class BaseCutsceneConfigurator<T, TBuilder>

Implements common fields and components for blueprints inheriting from Kingmaker.AreaLogic.Cutscenes.Cutscene.

Inheritance
System.Object
Configurator
RootConfigurator<T, TBuilder>
BaseBlueprintConfigurator<T, TBuilder>
BaseGateConfigurator<T, TBuilder>
BaseCutsceneConfigurator<T, TBuilder>
CutsceneConfigurator
Inherited Members
BaseBlueprintConfigurator<T, TBuilder>.AdditionalDiceOnAttack(Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<AdditionalDiceOnAttack.WeaponOptions>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, List<AdditionalDiceOnAttack.DamageEntry>, DamageTypeDescription, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, ConditionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, ConditionsBuilder, Nullable<Boolean>, ContextDiceValue, Blueprint<BlueprintWeaponTypeReference>)
BaseBlueprintConfigurator<T, TBuilder>.AddRuleCalculateDamageWithWeaponTrigger(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponCategory>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<PhysicalDamageForm>, Nullable<Boolean>, Nullable<Feet>, Nullable<Boolean>, Nullable<WeaponFighterGroup>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<WeaponRangeType>, Nullable<Boolean>, Nullable<Boolean>, Blueprint<BlueprintItemWeaponReference>, Blueprint<BlueprintWeaponTypeReference>)
Namespace: BlueprintCore.Blueprints.Configurators.AreaLogic.Cutscenes
Assembly: BlueprintCore.dll
Syntax
public abstract class BaseCutsceneConfigurator<T, TBuilder> : BaseGateConfigurator<T, TBuilder> where T : Cutscene where TBuilder : BaseCutsceneConfigurator<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 Source

BaseCutsceneConfigurator(Blueprint<BlueprintReference<T>>)

Declaration
protected BaseCutsceneConfigurator(Blueprint<BlueprintReference<T>> blueprint)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<T>> blueprint

Methods

| Improve this Doc View Source

AddStopCutsceneWhenExitingArea(Action<BlueprintComponent, BlueprintComponent>, ComponentMerge)

Adds Kingmaker.AreaLogic.Cutscenes.StopCutsceneWhenExitingArea

Declaration
public TBuilder AddStopCutsceneWhenExitingArea(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

  • RestCutscenee45b17a590873794ebf427e00f5462fa
| Improve this Doc View Source

AddToAnchors(EntityReference[])

Adds to the contents of Kingmaker.AreaLogic.Cutscenes.Cutscene.Anchors

Declaration
public TBuilder AddToAnchors(params EntityReference[] anchors)
Parameters
Type Name Description
Kingmaker.Blueprints.EntityReference[] anchors
Returns
Type Description
TBuilder
| Improve this Doc View Source

ClearAnchors()

Removes all elements from Kingmaker.AreaLogic.Cutscenes.Cutscene.Anchors

Declaration
public TBuilder ClearAnchors()
Returns
Type Description
TBuilder
| Improve this Doc View Source

CopyFrom(Blueprint<BlueprintReference<Cutscene>>, Predicate<BlueprintComponent>)

Copies fields and components of the specified types from the blueprint.

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<Cutscene>> blueprint, Predicate<BlueprintComponent> componentMatcher)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.AreaLogic.Cutscenes.Cutscene>> blueprint
System.Predicate<Kingmaker.Blueprints.BlueprintComponent> componentMatcher

Any components in blueprint matching the predicate are copied. These are shallow copies that are shared by both blueprints.
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();
| Improve this Doc View Source

CopyFrom(Blueprint<BlueprintReference<Cutscene>>, Type[])

Copies fields and components of the specified types from the blueprint.

Declaration
public TBuilder CopyFrom(Blueprint<BlueprintReference<Cutscene>> blueprint, params Type[] componentTypes)
Parameters
Type Name Description
Blueprint<Kingmaker.Blueprints.BlueprintReference<Kingmaker.AreaLogic.Cutscenes.Cutscene>> blueprint
System.Type[] componentTypes

Any components in blueprint of the listed types are copied. These are shallow copies that are shared by both blueprints.
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();
| Improve this Doc View Source

ModifyAnchors(Action<EntityReference>)

Modifies Kingmaker.AreaLogic.Cutscenes.Cutscene.Anchors by invoking the provided action on each element.

Declaration
public TBuilder ModifyAnchors(Action<EntityReference> action)
Parameters
Type Name Description
System.Action<Kingmaker.Blueprints.EntityReference> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyDefaultParameters(Action<ParametrizedContextSetter>)

Modifies Kingmaker.AreaLogic.Cutscenes.Cutscene.DefaultParameters by invoking the provided action.

Declaration
public TBuilder ModifyDefaultParameters(Action<ParametrizedContextSetter> action)
Parameters
Type Name Description
System.Action<Kingmaker.Designers.EventConditionActionSystem.NamedParameters.ParametrizedContextSetter> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

ModifyOnStopped(Action<ActionList>)

Modifies Kingmaker.AreaLogic.Cutscenes.Cutscene.OnStopped by invoking the provided action.

Declaration
public TBuilder ModifyOnStopped(Action<ActionList> action)
Parameters
Type Name Description
System.Action<Kingmaker.ElementsSystem.ActionList> action
Returns
Type Description
TBuilder
| Improve this Doc View Source

OnConfigureCompleted()

Declaration
protected override void OnConfigureCompleted()
Overrides
BlueprintCore.Blueprints.Configurators.AreaLogic.Cutscenes.BaseGateConfigurator<T, TBuilder>.OnConfigureCompleted()
| Improve this Doc View Source

RemoveFromAnchors(EntityReference[])

Removes elements from Kingmaker.AreaLogic.Cutscenes.Cutscene.Anchors

Declaration
public TBuilder RemoveFromAnchors(params EntityReference[] anchors)
Parameters
Type Name Description
Kingmaker.Blueprints.EntityReference[] anchors
Returns
Type Description
TBuilder
| Improve this Doc View Source

RemoveFromAnchors(Func<EntityReference, Boolean>)

Removes elements from Kingmaker.AreaLogic.Cutscenes.Cutscene.Anchors that match the provided predicate.

Declaration
public TBuilder RemoveFromAnchors(Func<EntityReference, bool> predicate)
Parameters
Type Name Description
System.Func<Kingmaker.Blueprints.EntityReference, System.Boolean> predicate
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAllowCopies(Boolean)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.AllowCopies

Declaration
public TBuilder SetAllowCopies(bool allowCopies = true)
Parameters
Type Name Description
System.Boolean allowCopies

Tooltip: If set, exact copies of this cutscene (with the same parameters) can play at the same time. You probably do not need to set this.

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAnchors(EntityReference[])

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.Anchors

Declaration
public TBuilder SetAnchors(params EntityReference[] anchors)
Parameters
Type Name Description
Kingmaker.Blueprints.EntityReference[] anchors
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetAwakeRange(Single)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.AwakeRange

Declaration
public TBuilder SetAwakeRange(float awakeRange)
Parameters
Type Name Description
System.Single awakeRange
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetDefaultParameters(ParametrizedContextSetter)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.DefaultParameters

Declaration
public TBuilder SetDefaultParameters(ParametrizedContextSetter defaultParameters)
Parameters
Type Name Description
Kingmaker.Designers.EventConditionActionSystem.NamedParameters.ParametrizedContextSetter defaultParameters
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetForbidDialogs(Boolean)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.ForbidDialogs

Declaration
public TBuilder SetForbidDialogs(bool forbidDialogs = true)
Parameters
Type Name Description
System.Boolean forbidDialogs

Tooltip: If set, units moved by this cutscene cannot start a dialog

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetForbidRandomIdles(Boolean)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.ForbidRandomIdles

Declaration
public TBuilder SetForbidRandomIdles(bool forbidRandomIdles = true)
Parameters
Type Name Description
System.Boolean forbidRandomIdles

Tooltip: If set, units moved by this cutscene never play idle variants

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetIsBackground(Boolean)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.IsBackground

Declaration
public TBuilder SetIsBackground(bool isBackground = true)
Parameters
Type Name Description
System.Boolean isBackground

Tooltip: If set, the cutscene auto-pauses when there&apos;s a dialog, rest, or exclusive cutscene playing

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetMarkedUnitHandling(Cutscene.MarkedUnitHandlingType)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.MarkedUnitHandling

Declaration
public TBuilder SetMarkedUnitHandling(Cutscene.MarkedUnitHandlingType markedUnitHandling)
Parameters
Type Name Description
Kingmaker.AreaLogic.Cutscenes.Cutscene.MarkedUnitHandlingType markedUnitHandling

Tooltip: How to react when a unit marked by this cutscene is in combat or marked by a higher priority cutscene

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetNonSkippable(Boolean)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.NonSkippable

Declaration
public TBuilder SetNonSkippable(bool nonSkippable = true)
Parameters
Type Name Description
System.Boolean nonSkippable

Tooltip: If not set, сan&apos;t be skipped

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetNonSkippingFrames(Boolean)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.NonSkippingFrames

Declaration
public TBuilder SetNonSkippingFrames(bool nonSkippingFrames = true)
Parameters
Type Name Description
System.Boolean nonSkippingFrames

Tooltip: If not set, cutscene can skip frames for the mean of optimization

Returns
Type Description
TBuilder
| Improve this Doc View Source

SetOnStopped(ActionsBuilder)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.OnStopped

Declaration
public TBuilder SetOnStopped(ActionsBuilder onStopped)
Parameters
Type Name Description
ActionsBuilder onStopped
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetPriority(CutscenePriority)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.Priority

Declaration
public TBuilder SetPriority(CutscenePriority priority)
Parameters
Type Name Description
Kingmaker.AreaLogic.Cutscenes.CutscenePriority priority
Returns
Type Description
TBuilder
| Improve this Doc View Source

SetSleepless(Boolean)

Sets the value of Kingmaker.AreaLogic.Cutscenes.Cutscene.Sleepless

Declaration
public TBuilder SetSleepless(bool sleepless = true)
Parameters
Type Name Description
System.Boolean sleepless

Tooltip: If not set, cutscene is paused when all anchors are in fog of war or away enough from party

Returns
Type Description
TBuilder