Skip to content

guide_state

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

Notes

State interface shared by all guide task scripts.

IGuideState

interface global base/tealdef/mission/guide_system/guides/guide_state.d.tl:3

global interface IGuideState

Notes

State shared by all guide task scripts. A guide is shown once triggeredTime is set and completes when the GUI sends the guide-system / guide-complete event for it.

Fields

Name Type Description
triggeredTime number GUI time (seconds) at which the guide was triggered; nil while waiting.
complete boolean The guide was dismissed.