guide_generic¶

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

Hinweise

Spielführer-Aufgabe, die eine eigene Bedingungsfunktion auslöst.

GuideGeneric¶

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

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

Laden: local guide_generic = ug_require "::/mission/guide_system/guides/guide_generic.tl" as GuideGeneric

Hinweise

Spielführer-Aufgabe, die auslöst, wenn eine eigene Funktion true zurückgibt.

Beispiel

-- Basisspiel: 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

Hinweise

Auslösebedingungen.

Im Basisspiel verwendet: 2-mal in 2 Dateien

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,

Funktionen

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

Hinweise

Engine-seitige Bedingung, die bei jedem Update geprüft wird.

Parameter	Typ	Beschreibung
`readOnlyApi`	`MissionInterface.MissionTaskReadOnlyApi`	Nur lesende Missions-API.

Rückgabe boolean: true, um den Spielführer auszulösen.

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

Hinweise

GUI-seitige Bedingung, die bei jedem GUI-Update geprüft wird.

Parameter	Typ	Beschreibung
`readOnlyApi`	`MissionInterface.DeferredTaskApi`	Verzögerte API.

Rückgabe boolean: true, um den Spielführer auszulösen.

GuideGeneric.State¶

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

record State is IGuideState

Hinweise

Zustand des Spielführers.

Im Basisspiel verwendet: 1-mal in 1 Datei

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

local type S = GuideGeneric.State

Felder

Name	Typ	Beschreibung
`state`	`any`	Freier Zustandsplatz für den Spielführer.