guide_event

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

Notes

Guide task triggered by a matching script event.

GuideEvent

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

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

Load: local guide_event = ug_require "::/mission/guide_system/guides/guide_event.tl"

Notes

Guide task triggered by an engine-side script event that matches all given fields.

GuideEvent.Params

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

record Params

Notes

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

Used in the base game: 29 times in 5 files

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

local type P = GuideEvent.Params

base/content/mission/mission/tutorial/guide_system/guide_system_story.tl:17

taskParams : GuideEvent.Params = {

mods/release/urbangames_campaign_mission_03/content/guide_system/guide_system/guide_system_story.tl:8

taskParams : GuideEvent.Params = {

mods/release/urbangames_campaign_mission_02/content/guide_system/guide_system/guide_system_story.tl:8

taskParams : GuideEvent.Params = {

mods/release/urbangames_campaign_mission_01/content/guide_system/guide_system/guide_system_story.tl:8

taskParams : GuideEvent.Params = {

Fields

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

GuideEvent.State

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

record State is IGuideState

Notes

Guide state.

Used in the base game: 1 time in 1 file

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

local type S = GuideEvent.State