guide_generic

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

Notes

Guide task triggered by a custom condition function.

GuideGeneric

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

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

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

Notes

Guide task triggered when a custom function returns true.

Example

-- base game: mission/guide_system/main/guide_system_story.tl
if taskKey == "create_line" then
    return {
        taskScript = guide_generic as MissionInterface.TaskScript<any, any>,
        taskParams = {
            guiWaitFn = function() : boolean
                return api.gui.byId.isVisibleRecursive("menu.management")
            end,
        } as GuideGeneric.Params,
        guideInfo = {
            text = _("To create new lines, ..."),
            name = _("Create a Line"),
            targets = { { idOrTag = "menu.management.newLineButton", position = "Right" } },
        },
    }
end

GuideGeneric.Params

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

record Params

Notes

Trigger conditions.

Used in the base game: 2 times in 2 files

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

local type P = GuideGeneric.Params

base/content/mission/mission/guide_system/main/guide_system_story.tl:61

} as GuideGeneric.Params,

Functions

waitFn(readOnlyApi : MissionInterface.MissionTaskReadOnlyApi) : boolean base/tealdef/mission/guide_system/guides/guide_generic.d.tl:5

Notes

Engine-side condition, checked every update.

Parameter	Type	Description
readOnlyApi	MissionInterface.MissionTaskReadOnlyApi	Read-only mission API.

Returns boolean: true to trigger the guide.

guiWaitFn(readOnlyApi : MissionInterface.DeferredTaskApi) : boolean base/tealdef/mission/guide_system/guides/guide_generic.d.tl:6

Notes

GUI-side condition, checked every GUI update.

Parameter	Type	Description
readOnlyApi	MissionInterface.DeferredTaskApi	Deferred API.

Returns boolean: true to trigger the guide.

GuideGeneric.State

record base/tealdef/mission/guide_system/guides/guide_generic.d.tl:8

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_generic.tl:1

local type S = GuideGeneric.State

Fields

Name	Type	Description
state	any	Free state slot for the guide.