FB2Action_TalkContext

Overview

• TalkContext action. Override the OnPlay/OnFinish/OnPaused/OnCanceled/OnTick timing hooks in Lua.

Metadata

Field	Value
Kind	action
Environment	B2 - Simulation
Category	actions
Extends	FB2Action_PlayAnim
Require	require('Actions.B2Action_TalkContext')

Properties (8)

Name	Type	Description
CurrentMontageTimeOut	number	Elapsed time accumulator counting toward OverridedMontageTimeOut
HiddenGrabObject	boolean	Whether the grabbed object should be hidden while talking (from the coop talk action context)
LookAtTargetCharacter	FB1EntityId	Target character entity id this character should look at while talking, if set (from the coop talk action context)
OverridedMontageTimeOut	number	Forced montage duration (seconds) to wait when bOverridedMontagePlayTime is set
TalkFinishScriptIds	string[]	Script ids run once when the talk action finishes (from the coop talk action context)
TalkStartScriptIds	string[]	Script ids run once when the talk action starts (from the coop talk action context)
bNotPlayingAnim	boolean	Whether this talk is voice-only, with animation driven externally by the speaker's notify, skipping this action's own PlayAnim setup
bOverridedMontagePlayTime	boolean	Whether montage play time is overridden by a fixed forced duration instead of the natural animation length

Functions (5)

Function	Parameters	Returns	Description
OnCanceled	-	-	Callback invoked on Canceled.
OnFinish	-	-	Callback invoked on Finish.
OnPaused	-	-	Callback invoked on Paused.
OnPlay	-	-	Callback invoked on Play.
OnTick	DeltaTime: number, CurrentTime: FDateTime, GameDeltaMinutes: number	-	Callback invoked on Tick.

Override points (5)

Implement these in Lua as FB2Action_TalkContext.Override_Name = function(...) end.

Function	Parameters	Returns	Description
Override_OnCanceled	-	-	Timing hook called when the action is canceled.
Override_OnFinish	-	-	Timing hook called when the action finishes.
Override_OnPaused	-	-	Timing hook called when the action is paused.
Override_OnPlay	-	-	Timing hook called when the action starts (play). Override in Lua to replace the start behavior.
Override_OnTick	DeltaTime: number, CurrentTime: FDateTime, GameDeltaMinutes: number	-	Timing hook called every tick while the action runs. (performance-sensitive)