mission_task_cutscene¶

Source: base/tealdef/mission/tasks/cutscene/mission_task_cutscene.d.tl

Notes

Task that plays a camera cutscene.

MissionTaskCutscene¶

record global base/tealdef/mission/tasks/cutscene/mission_task_cutscene.d.tl:3

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

Load: local cutscene = ug_require "::/mission/tasks/cutscene/cutscene.tl"

Notes

Task (cutscene) that plays a cutscene file when it starts (api.gui.mission.playCutscene) and completes when the cutscene ends or is skipped. Tool actions are disabled meanwhile; afterwards the game speed is set to gameSpeed.

Example

-- urbangames_campaign_mission_01
if taskKey == "build_path_task_cutscene" then
    return {
        taskScript = cutscene as MissionInterface.TaskScript<any, any>,
        taskParams = { filePath = "urbangames_campaign_mission_01::/mission/keyframes/MISSION_01_CUTSCENE_BUILD_PATH.lua" },
        allowSimultaneousUiTasks = {
            mission_task_util.makeTaskKey("build_path_task", "urbangames_campaign_mission_01::/mission/mission.script")
        },
    }
end