mission_task_send_event¶

Source: base/tealdef/mission/tasks/utility/mission_task_send_event.d.tl

Notes

Task that sends a script event or a GUI React event.

MissionTaskSendEvent¶

record global base/tealdef/mission/tasks/utility/mission_task_send_event.d.tl:3

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

Load: local send_event = ug_require "::/mission/tasks/utility/send_event.tl"

Notes

Task (send_event) that sends one script event (engine side) or fires a React event in the GUI (isGuiEvent), then completes.

record base/tealdef/mission/tasks/utility/mission_task_send_event.d.tl:4

record Params

Notes

Event to send.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tasks/utility/send_event.tl:2

local type P = MissionTaskSendEvent.Params

Fields

Name	Type	Description
`src`	`string`	Event source (script events only).
`id`	`string`	Event id (script events only).
`name`	`string`	Event name; the React event name when `isGuiEvent` is set.
`param`	`any`	Event parameter.
`isGuiEvent`	`boolean`	Fires `api.gui.fireReactEvent(name, param)` instead of a script event.

record base/tealdef/mission/tasks/utility/mission_task_send_event.d.tl:11

record State

Notes

State of the task.

Used in the base game: 1 time in 1 file

base/content/mission/mission/tasks/utility/send_event.tl:1

local type S = MissionTaskSendEvent.State

Fields

Name	Type	Description
`isComplete`	`boolean`	The event was sent.