mission_react_util¶

Source: base/tealdef/mission/mission_react_util.d.tl

Notes

GUI parameters of the mission dialogue / voice-over overlay.

MissionReactUtil¶

record global base/tealdef/mission/mission_react_util.d.tl:3

global record MissionReactUtil

Load: local mission_react_util = ug_require "/mission/mission_react_util.tl"

Notes

GUI of the mission dialogue and instruction overlay.

Fields

Name	Type	Description
`DialogueOverlay`	`RecipeWithApi0<DialogueOverlayApi>`	Recipe of the dialogue / voice-over overlay; its API reports what is playing. used 2× in the base game

MissionReactUtil.DialogueEventParam¶

record base/tealdef/mission/mission_react_util.d.tl:5

record DialogueEventParam

Notes

Parameter of the dialogue and on-finish-dialogue React events.

Used in the base game: 8 times in 4 files

base/content/mission/mission/mission_react_util.tl:385

local eventParam : MissionReactUtil.DialogueEventParam = {}

base/content/mission/mission/mission_framework/mission_framework_react_util.tl:377

local evtParam = eventParam as MissionReactUtil.DialogueEventParam

base/content/mission/mission/mission_framework/mission_framework_react.tl:1321

local eventParam = eventParamAny as MissionReactUtil.DialogueEventParam

base/content/mission/mission/tasks/dialogue/dialogue.tl:54

local evtParam = eventParam as MissionReactUtil.DialogueEventParam

Fields

Name	Type	Description
`id`	`string`	`start-dialogue`, `start-instruction` or `on-finish-dialogue`.
`scriptName`	`string`	Dialogue script to play.
`instructionData`	`MissionDialogueData.InstructionData`	Instruction to play.
`taskUid`	`string`	Task the dialogue or instruction belongs to.
`instructionKey`	`string`	Key of a queued instruction.
`syncWithCutscene`	`boolean`	Plays the dialogue in sync with a running cutscene.

MissionReactUtil.InstructionsOverlayParam¶

record base/tealdef/mission/mission_react_util.d.tl:14

record InstructionsOverlayParam

No description in the game files yet.

Used in the base game: 1 time in 1 file

base/content/mission/mission/mission_react_util.tl:67

local InstructionsOverlay = react.RegisterRecipe("InstructionsOverlay", function(param : MissionReactUtil.InstructionsOverlayParam) : TreeNodeId

Fields

Name	Type	Description
`startTime`	`number`
`instructionData`	`MissionDialogueData.InstructionData`
`taskUid`	`string`
`instructionKey`	`string`

Functions

setEndState() base/tealdef/mission/mission_react_util.d.tl:19

No description in the game files yet.

MissionReactUtil.DialogueOverlayContentParam¶

record base/tealdef/mission/mission_react_util.d.tl:22

record DialogueOverlayContentParam

No description in the game files yet.

Used in the base game: 1 time in 1 file

base/content/mission/mission/mission_react_util.tl:248

local DialogueOverlayContent = react.RegisterRecipe("DialogueOverlayContent", function(param : MissionReactUtil.DialogueOverlayContentParam) : TreeNodeId

Fields

Name	Type	Description
`startTime`	`number`
`scriptName`	`string`
`missionDialogueData`	`MissionDialogueData.DialogueData`
`taskUid`	`string`
`instructionKey`	`string`
`syncWithCutscene`	`boolean`

Functions

setDeactivateState(boolean) base/tealdef/mission/mission_react_util.d.tl:29

No description in the game files yet.

setEndState() base/tealdef/mission/mission_react_util.d.tl:30

No description in the game files yet.

getSkipCurrentLineRef() : boolean base/tealdef/mission/mission_react_util.d.tl:31

No description in the game files yet.

Returns boolean

setSkipCurrentLineRef(boolean) base/tealdef/mission/mission_react_util.d.tl:32

No description in the game files yet.