guide_ui_event

Source: base/tealdef/mission/guide_system/guides/guide_ui_event.d.tl

Notes

Guide task triggered by a matching GUI event.

GuideUiEvent

record global base/tealdef/mission/guide_system/guides/guide_ui_event.d.tl:3

global record GuideUiEvent is MissionInterface.TaskScript<GuideUiEvent.State, GuideUiEvent.Params>

Notes

Guide task triggered by a GUI event that matches all given fields.

GuideUiEvent.Params

record base/tealdef/mission/guide_system/guides/guide_ui_event.d.tl:4

record Params

Notes

GUI event to wait for; nil fields match anything, param is compared deeply.

Used in the base game: 1 time in 1 file

base/content/mission/mission/guide_system/guides/guide_ui_event.tl:4

local type P = GuideUiEvent.Params

Fields

Name	Type	Description
src	string	Event source.
id	string	Event id.
name	string	Event name.
param	any	Event parameter.

GuideUiEvent.State

record base/tealdef/mission/guide_system/guides/guide_ui_event.d.tl:10

record State is IGuideState

Notes

Guide state.

Used in the base game: 3 times in 2 files

base/content/mission/mission/guide_system/guides/guide_generic.tl:6

Trigger = function(ctx : TaskContext<GuideUiEvent.State, P>)

base/content/mission/mission/guide_system/guides/guide_ui_event.tl:3

local type S = GuideUiEvent.State