FB2Action_PopupMessage

Overview

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

Metadata

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

Properties (3)

Name	Type	Description
PopupCategory	string	Popup category tag, resolved from Action.S2
PopupId	string	Popup table id to display, resolved from Action.S1
bSendPacket	boolean	Whether the open-popup request has already been sent, gates close-payload cleanup and immediate tick finish

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_PopupMessage.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)