Class ActionsBuilderAVEx

Extension to ActionsBuilder for actions involving audiovisual effects such as dialogs, camera, cutscenes, and sounds.

Inheritance

System.Object

ActionsBuilderAVEx

Namespace: BlueprintCore.Actions.Builder.AVEx

Assembly: BlueprintCore.dll

Syntax

public static class ActionsBuilderAVEx

Remarks

Actions are supported using extension methods. Include the extension namespaces as needed.

When Build is called the Kingmaker.ElementsSystem.ActionList is constructed, validated, and returned. If any errors are detected by Validator they will be logged as a warning.

Do not call Build(Validator) twice on the same builder.

If a method calls for a string to represent any type of blueprint, you can pass the blueprint's Kingmaker.Blueprints.SimpleBlueprint.AssetGuid as a string or as a name you already provided using AddGuidsByName().

AreaEx	Actions involving the game map, dungeons, or locations. See also KingdomEx for location related actions specifically tied to the Kingdom and Crusade system.
AVEx	Actions involving audiovisual effects such as dialogs, camera, cutscenes, and sounds.
BasicEx	Most game mechanics related actions not included in ContextEx.
ContextEx	Most Kingmaker.UnitLogic.Mechanics.Actions.ContextAction types. Some Kingmaker.UnitLogic.Mechanics.Actions.ContextAction types are in more specific extensions such as AVEx or KingdomEx.
KingdomEx	Actions involving the Kingdom and Crusade system.
MiscEx	Actions without a better extension container such as achievements and CustomEvent.
NewEx	Actions defined in BlueprintCore and not available in the base game.
StoryEx	Actions related to the story such as companion stories, quests, name changes, and etudes.
UpgraderEx	All UpgraderOnlyActions.

Apply a buff and make a melee attack:

// Provides ApplyBuff and MeleeAttack extensions
using BlueprintCore.Actions.Builder.ContextEx; 
var actionList =
ActionsBuilder.New()
.ApplyBuff(MyAttackBuff, duration: ContextDuration.Fixed(1))
.MeleeAttack()
.Build();

Methods

| Improve this Doc View Source

AnimationActionToggleFxParticles(ActionsBuilder, UnitEvaluator)

Adds AnimationActionToggleFxParticles(ActionsBuilder, UnitEvaluator)

Declaration

public static ActionsBuilder AnimationActionToggleFxParticles(this ActionsBuilder builder, UnitEvaluator unit = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
Kingmaker.ElementsSystem.UnitEvaluator	unit

Returns

Type	Description
ActionsBuilder

Remarks

StartParticleFXOnUnit0c2a75fda3c641f9b36a8274c09ca195

| Improve this Doc View Source

CameraToPosition(ActionsBuilder, PositionEvaluator)

Adds CameraToPosition(ActionsBuilder, PositionEvaluator)

Declaration

public static ActionsBuilder CameraToPosition(this ActionsBuilder builder, PositionEvaluator position = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
Kingmaker.ElementsSystem.PositionEvaluator	position

Returns

Type	Description
ActionsBuilder

Remarks

ComponentName: Actions/CameraToPosition

CommandAction6264845f5654cdd48809fe36f5dc4ffb
Cue_0029e6c1d14727803964eb118d83bc31787e
Wardstone_SoldiersAndDemonsFight76de06039af340ddba4ed13149ecb72a

| Improve this Doc View Source

ChangeBookEventImage(ActionsBuilder, AssetLink<SpriteLink>)

Adds ChangeBookEventImage(ActionsBuilder, AssetLink<SpriteLink>)

Declaration

public static ActionsBuilder ChangeBookEventImage(this ActionsBuilder builder, AssetLink<SpriteLink> image)

Parameters

Type	Name	Description
ActionsBuilder	builder
AssetLink<Kingmaker.ResourceLinks.SpriteLink>	image	You can pass in the animation using a SpriteLink or it's AssetId.

Returns

Type	Description
ActionsBuilder

Remarks

Cue_0224150a2e3902592f640a2e9feb1f8a5e0b
Cue_0421fbf88ab6b8e5d4c439a4357fdd918906
Cue_70969e0a217635439fa12584914a304312

| Improve this Doc View Source

ClearBlood(ActionsBuilder)

Adds ClearBlood(ActionsBuilder)

Declaration

public static ActionsBuilder ClearBlood(this ActionsBuilder builder)

Parameters

Type	Name	Description
ActionsBuilder	builder

Returns

Type	Description
ActionsBuilder

Remarks

CommandAction920fcfc04d9f4179b850b23c2ec9d3c7
DLC4_BeforeTheSiege74f0b09ffe084d0b9da11f97dc49b62d
DLC5_EndingsPreparations_Actionse7b80d49162d4793af3a500bc40c6a00

| Improve this Doc View Source

Play2DSound(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, String)

Adds Play2DSound(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, String)

Declaration

public static ActionsBuilder Play2DSound(this ActionsBuilder builder, bool? setRace = null, bool? setSex = null, string soundName = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
System.Nullable<System.Boolean>	setRace	Tooltip: Sets Ak switch on player's Race
System.Nullable<System.Boolean>	setSex	Tooltip: Sets Ak switch on player's Sex
System.String	soundName	Tooltip: Ak event name from Wwise library

Returns

Type	Description
ActionsBuilder

Remarks

ComponentName: Actions/Play2DSound

AirAdventures_BookEventa07f6d1f93531e048928c5c9de328a92
CommandAction2145fc1e6a76184940a58411f94362de0b
WillSaveGhoulCheckPassed_Actions0a39e8f4368328949aca5616589abe5d

| Improve this Doc View Source

Play3DSound(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, EntityReference)

Adds Play3DSound(ActionsBuilder, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, EntityReference)

Declaration

public static ActionsBuilder Play3DSound(this ActionsBuilder builder, bool? setCurrentSpeaker = null, bool? setRace = null, bool? setSex = null, string soundName = null, EntityReference soundSourceObject = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
System.Nullable<System.Boolean>	setCurrentSpeaker	Tooltip: Sets SoundSourceObject as current dialog speaker
System.Nullable<System.Boolean>	setRace	Tooltip: Sets Ak switch on player's Race
System.Nullable<System.Boolean>	setSex	Tooltip: Sets Ak switch on player's Sex
System.String	soundName	Tooltip: Ak event name from Wwise library
Kingmaker.Blueprints.EntityReference	soundSourceObject

Returns

Type	Description
ActionsBuilder

Remarks

ComponentName: Actions/Play3DSound

Answer_0004979c0288728143d4cadd65e43eb70f77
CommandAction204623253914a54befa165efa8453b857b
ZK_Knowledge9adabce8e4fa4cfd8be491a9ea798fd6

| Improve this Doc View Source

PlayAnimationOneShot(ActionsBuilder, AssetLink<AnimationClipWrapperLink>, Nullable<Single>, Nullable<Single>, UnitEvaluator)

Adds PlayAnimationOneShot(ActionsBuilder, AssetLink<AnimationClipWrapperLink>, Nullable<Single>, Nullable<Single>, UnitEvaluator)

Declaration

public static ActionsBuilder PlayAnimationOneShot(this ActionsBuilder builder, AssetLink<AnimationClipWrapperLink> clipWrapper = null, float? transitionIn = null, float? transitionOut = null, UnitEvaluator unit = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
AssetLink<Kingmaker.ResourceLinks.AnimationClipWrapperLink>	clipWrapper	You can pass in the animation using an AnimationClipWrapperLink or it's AssetId.
System.Nullable<System.Single>	transitionIn
System.Nullable<System.Single>	transitionOut
Kingmaker.ElementsSystem.UnitEvaluator	unit

Returns

Type	Description
ActionsBuilder

Remarks

Answer_0005058d6563b283ae04294ba2c729383663
Cue_00134899ab1a9ed97e441bea4eaa3a628f6d
Vrok_Chainedb04649a8dd8abf741a51728a4ba9c746

| Improve this Doc View Source

PlayCustomMusic(ActionsBuilder, String, String)

Adds PlayCustomMusic(ActionsBuilder, String, String)

Declaration

public static ActionsBuilder PlayCustomMusic(this ActionsBuilder builder, string musicEventStart = null, string musicEventStop = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
System.String	musicEventStart
System.String	musicEventStop

Returns

Type	Description
ActionsBuilder

Remarks

ComponentName: Actions/PlayCustomMusic

Abducted_dialogue43c9a316be2e45678606133610e80063
DLC3_FirstMythic_dialogue441d5ef4fec04cdb8a4dc95b320758c8
ZachariusLostChapel_dialogue484953d7dfcc1244fadfdeab34a363ff

| Improve this Doc View Source

PlayCutscene(ActionsBuilder, Nullable<Boolean>, Blueprint<CutsceneReference>, ParametrizedContextSetter, Nullable<Boolean>)

Adds PlayCutscene(ActionsBuilder, Nullable<Boolean>, Blueprint<CutsceneReference>, ParametrizedContextSetter, Nullable<Boolean>)

Declaration

public static ActionsBuilder PlayCutscene(this ActionsBuilder builder, bool? checkExistence = null, Blueprint<CutsceneReference> cutscene = null, ParametrizedContextSetter parameters = null, bool? putInQueue = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
System.Nullable<System.Boolean>	checkExistence
Blueprint<Kingmaker.Blueprints.CutsceneReference>	cutscene	Blueprint of type Cutscene. You can pass in the blueprint using: A blueprint instance A blueprint reference A blueprint id as a string, Guid, or BlueprintGuid A blueprint name registered with BlueprintTool See Blueprint for more details.
Kingmaker.Designers.EventConditionActionSystem.NamedParameters.ParametrizedContextSetter	parameters
System.Nullable<System.Boolean>	putInQueue

Returns

Type	Description
ActionsBuilder

Remarks

ComponentName: Actions/Play cutscene

(CR 6) Necromancer_SpawnActions966067be66094e699fd7247f4507dd1a
Cue_0053072a27dd3cb3ca045a96009cdd21cdf9
Zone3_Epigraph_SZfde009ee2ae62024baaac478de277b28

| Improve this Doc View Source

PlaySound(ActionsBuilder, String)

Adds Kingmaker.Assets.UnitLogic.Mechanics.Actions.ContextActionPlaySound

Declaration

public static ActionsBuilder PlaySound(this ActionsBuilder builder, string soundName)

Parameters

Type	Name	Description
ActionsBuilder	builder
System.String	soundName	Tooltip: Ak event name from Wwise library

Returns

Type	Description
ActionsBuilder

Remarks

AngelMinorAbilityVisualBuff8c902ab79f74c5c40a8071d314a0bab0
MandragoraSwarmDamageBuff0f4923163104a8748b88e91ec7e14837
TickSwarmDamageBuff97fd811a706e31c43887e163b51660b0

| Improve this Doc View Source

ReloadMechanic(ActionsBuilder, Nullable<Boolean>, String)

Adds ReloadMechanic(ActionsBuilder, Nullable<Boolean>, String)

Declaration

public static ActionsBuilder ReloadMechanic(this ActionsBuilder builder, bool? clearFx = null, string desc = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
System.Nullable<System.Boolean>	clearFx
System.String	desc

Returns

Type	Description
ActionsBuilder

Remarks

Arueshalae_DemonWarningKTC58b51cce24b484e40ae075c5f56ad2e5
KTC_LocustMeetsArenaMasterebc5142e78f7460aa8faa70eacf59e34
WenduagKTC_WenduagRomance_TroublesInTheTavern70260967f8e8efc40934a31a346221b0

| Improve this Doc View Source

RunAnimationClip(ActionsBuilder, AssetLink<AnimationClipWrapperLink>, ExecutionMode, Nullable<Single>, Nullable<Single>)

Adds Kingmaker.UnitLogic.Mechanics.Actions.ContextActionRunAnimationClip

Declaration

public static ActionsBuilder RunAnimationClip(this ActionsBuilder builder, AssetLink<AnimationClipWrapperLink> clipWrapper, ExecutionMode mode = ExecutionMode.Interrupted, float? transitionIn = null, float? transitionOut = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
AssetLink<Kingmaker.ResourceLinks.AnimationClipWrapperLink>	clipWrapper	You can pass in the animation using an AnimationClipWrapperLink or it's AssetId.
Kingmaker.Visual.Animation.Actions.ExecutionMode	mode
System.Nullable<System.Single>	transitionIn
System.Nullable<System.Single>	transitionOut

Returns

Type	Description
ActionsBuilder

Remarks

AngelRevealLight_Buffb3f693c8d4a4c964796fb33f8a24a0ef
NightcrawlerUnburrowedBuff88b7ded46fa24358adafa0fff50eef4c
TigerOfSin_SpawnActionsd8416de51062a1a43af32df8764870a2

| Improve this Doc View Source

SetSoundState(ActionsBuilder, AkStateReference)

Adds SetSoundState(ActionsBuilder, AkStateReference)

Declaration

public static ActionsBuilder SetSoundState(this ActionsBuilder builder, AkStateReference state = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
Kingmaker.Sound.AkStateReference	state

Returns

Type	Description
ActionsBuilder

Remarks

ComponentName: Actions/SetSoundState

AirAdventures_BookEventa07f6d1f93531e048928c5c9de328a92
Cue_00015dfe54e43d9f4fd3b2f575737abf0633
Wenduag_TakeMeHome_dialoguebc265dbf76c34729b7af2cdcce59444f

| Improve this Doc View Source

ShowBark(ActionsBuilder, LocalString, Nullable<Boolean>, Nullable<Boolean>, SharedStringAsset)

Adds Kingmaker.UnitLogic.Mechanics.Actions.ContextActionShowBark

Declaration

public static ActionsBuilder ShowBark(this ActionsBuilder builder, LocalString whatToBark, bool? barkDurationByText = null, bool? showWhileUnconscious = null, SharedStringAsset whatToBarkShared = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
LocalString	whatToBark	You can pass in the string using a LocalizedString or the Key to a LocalizedString.
System.Nullable<System.Boolean>	barkDurationByText	Tooltip: Bark duration depends on text length
System.Nullable<System.Boolean>	showWhileUnconscious
Kingmaker.Localization.SharedStringAsset	whatToBarkShared

Returns

Type	Description
ActionsBuilder

Remarks

AboutIzyagnafa1f67444ec844508ea2eb6549581d5d
GrimoireOfTheBeastbeaa7a8b2f5bfd8459042db7f81867d7
ZachariusNecromancyde12840a4662481f937ff9542a6beb6b

| Improve this Doc View Source

ShowBark(ActionsBuilder, Nullable<Boolean>, MapObjectEvaluator, UnitEvaluator, LocalString, SharedStringAsset)

Adds ShowBark(ActionsBuilder, LocalString, Nullable<Boolean>, Nullable<Boolean>, SharedStringAsset)

Declaration

public static ActionsBuilder ShowBark(this ActionsBuilder builder, bool? barkDurationByText = null, MapObjectEvaluator targetMapObject = null, UnitEvaluator targetUnit = null, LocalString whatToBark = null, SharedStringAsset whatToBarkShared = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
System.Nullable<System.Boolean>	barkDurationByText	Tooltip: Bark duration depends on text length
Kingmaker.ElementsSystem.MapObjectEvaluator	targetMapObject
Kingmaker.ElementsSystem.UnitEvaluator	targetUnit
LocalString	whatToBark	You can pass in the string using a LocalizedString or the Key to a LocalizedString.
Kingmaker.Localization.SharedStringAsset	whatToBarkShared

Returns

Type	Description
ActionsBuilder

Remarks

ComponentName: Actions/ShowBark

!Octavia_Companion_Warrior_Test0f5938a10fd0d3644be33747d6d2b11c
DLC6_GoodiesMerchantBark02_AHa4f34d5944e042eaac390047bc33fed7
ZombiesOnStreetsffcf5bca11694784686d9947ed226a88

| Improve this Doc View Source

SpawnFx(ActionsBuilder, AssetLink<PrefabLink>)

Adds Kingmaker.UnitLogic.Mechanics.Actions.ContextActionSpawnFx

Declaration

public static ActionsBuilder SpawnFx(this ActionsBuilder builder, AssetLink<PrefabLink> prefabLink)

Parameters

Type	Name	Description
ActionsBuilder	builder
AssetLink<Kingmaker.ResourceLinks.PrefabLink>	prefabLink	You can pass in the animation using a PrefabLink or it's AssetId.

Returns

Type	Description
ActionsBuilder

Remarks

Aeon_TrueForm_Cutscene18d9251a3c5682a429e1c3769431f4ee
Hosilla_Buff_JudgmentProtection840bbe624d7dad4439199aa2dc410b1a
ZombieDispelExplosionbcd9277193ef41dfb8d3b292ee33c828

| Improve this Doc View Source

SpawnFx(ActionsBuilder, AssetLink<PrefabLink>, TransformEvaluator)

Adds SpawnFx(ActionsBuilder, AssetLink<PrefabLink>)

Declaration

public static ActionsBuilder SpawnFx(this ActionsBuilder builder, AssetLink<PrefabLink> fxPrefab = null, TransformEvaluator target = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
AssetLink<Kingmaker.ResourceLinks.PrefabLink>	fxPrefab	You can pass in the animation using a PrefabLink or it's AssetId.
Kingmaker.ElementsSystem.TransformEvaluator	target

Returns

Type	Description
ActionsBuilder

Remarks

AdditionalAtmosphericScenese04f6b926f3350d41ab2d07c55d9814d
CommandAction139f5d4e5e10ae414193aa476209845973
ZK_Knowledge9adabce8e4fa4cfd8be491a9ea798fd6

| Improve this Doc View Source

StartChangeVisual(ActionsBuilder)

Adds StartChangeVisual(ActionsBuilder)

Declaration

public static ActionsBuilder StartChangeVisual(this ActionsBuilder builder)

Parameters

Type	Name	Description
ActionsBuilder	builder

Returns

Type	Description
ActionsBuilder

Remarks

Answer_001249c56a16ef034d86810143cd4e5283d1
Cue_0015f58a3ad5bd4f4f05a988b12d9875df1a

| Improve this Doc View Source

StopCustomMusic(ActionsBuilder)

Adds StopCustomMusic(ActionsBuilder)

Declaration

public static ActionsBuilder StopCustomMusic(this ActionsBuilder builder)

Parameters

Type	Name	Description
ActionsBuilder	builder

Returns

Type	Description
ActionsBuilder

Remarks

Abducted_dialogue43c9a316be2e45678606133610e80063
Drezen_Final_Battle_Middle_Dialogue46953090b95e83b44a6741a072b818ab
ZachariusLostChapel_dialogue484953d7dfcc1244fadfdeab34a363ff

| Improve this Doc View Source

StopCutscene(ActionsBuilder, Nullable<Boolean>, Nullable<StopCutscene.UnitCheckType>, Blueprint<CutsceneReference>, UnitEvaluator)

Adds StopCutscene(ActionsBuilder, Nullable<Boolean>, Nullable<StopCutscene.UnitCheckType>, Blueprint<CutsceneReference>, UnitEvaluator)

Declaration

public static ActionsBuilder StopCutscene(this ActionsBuilder builder, bool? allCutscenesFromUnit = null, StopCutscene.UnitCheckType? checkType = null, Blueprint<CutsceneReference> cutscene = null, UnitEvaluator withUnit = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
System.Nullable<System.Boolean>	allCutscenesFromUnit
System.Nullable<Kingmaker.Designers.EventConditionActionSystem.Actions.StopCutscene.UnitCheckType>	checkType	InfoBox: If set to 'Controlled', stops all cutscenes that marked selected unit. If set to 'Params' stops all cutscenes that have selected unit as a parameter. 'Controlled' is the old mode, you probably never need it.
Blueprint<Kingmaker.Blueprints.CutsceneReference>	cutscene	Blueprint of type Cutscene. You can pass in the blueprint using: A blueprint instance A blueprint reference A blueprint id as a string, Guid, or BlueprintGuid A blueprint name registered with BlueprintTool See Blueprint for more details.
Kingmaker.ElementsSystem.UnitEvaluator	withUnit

Returns

Type	Description
ActionsBuilder

Remarks

ComponentName: Actions/Stop cutscene

Abad_state_052edc4f040174899850aaeb0b853b1d8
Cue_0016331665d02ccb36a4ba8ad2568a333947
ZombiesDeadc042c6cb0eaaafc418c94615e4aac891

| Improve this Doc View Source

ToggleObjectFx(ActionsBuilder, MapObjectEvaluator, Nullable<Boolean>)

Adds ToggleObjectFx(ActionsBuilder, MapObjectEvaluator, Nullable<Boolean>)

Declaration

public static ActionsBuilder ToggleObjectFx(this ActionsBuilder builder, MapObjectEvaluator target = null, bool? toggleOn = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
Kingmaker.ElementsSystem.MapObjectEvaluator	target
System.Nullable<System.Boolean>	toggleOn

Returns

Type	Description
ActionsBuilder

Remarks

2ArenaCombatbdd2b9ebe0ec2f240b9ac1d6b4c430ab
CommandAction3cb441fcdf5384ed0911a38344aca9ac8
Ziggurat_CorruptionReducer_Cleanse_CheckPassedActionsa53e004ccda24065b81f49c9ee3b0e49

| Improve this Doc View Source

ToggleObjectMusic(ActionsBuilder, MapObjectEvaluator, Nullable<Boolean>)

Adds ToggleObjectMusic(ActionsBuilder, MapObjectEvaluator, Nullable<Boolean>)

Declaration

public static ActionsBuilder ToggleObjectMusic(this ActionsBuilder builder, MapObjectEvaluator target = null, bool? toggleOn = null)

Parameters

Type	Name	Description
ActionsBuilder	builder
Kingmaker.ElementsSystem.MapObjectEvaluator	target
System.Nullable<System.Boolean>	toggleOn

Returns

Type	Description
ActionsBuilder

Remarks

ArushalaeRedoubt_CustomMusicCave_fromCellar_Disableb5980fc442390ed4783a2cad6b5d428c