# Triggering Cutscene

Grammar — Triggering cutscene
Flags — Native | Function

Returns the triggering cutscene. Use in conjunction with “Cutscene Bookmark Fired”.

Returns — int<preset::Cutscene>

native int EventCutsceneId();

# Related

Category: Cutscene / Cutscenes

• Create Cutscene — int<preset::Cutscene> — CutsceneCreateNoPosition
• Create Cutscene at Position — int<preset::Cutscene> — CutsceneCreateNew
• Go To Next Cutscene Bookmark — void — CutsceneGoToNextBookmark
• Cutscene EndScene Fired — void — TriggerAddEventCutsceneEndSceneFired
• Create Cutscene — int<preset::Cutscene> — CutsceneCreate
• Last Created Cutscene — int<preset::Cutscene> — CutsceneLastCreated
• Play Cutscene — void — CutscenePlay
• Pause Cutscene — void — CutscenePause
• Stop Cutscene — void — CutsceneStop
• Set Cutscene Time — void — CutsceneSetTime
• Go To Cutscene Bookmark — void — CutsceneGoToBookmark
• Show/Hide Cutscene — void — CutsceneShow
• Play Cutscene Range Over Time — void — CutscenePlayCutsceneRangeOverTime
• Cutscene Fade — void — CutsceneFade
• Dialog Item Cutscene — int<preset::Cutscene> — CutsceneGetTriggerControl
• Cutscene Bookmark Fired — void — TriggerAddEventCutsceneBookmarkFired
• Triggering Cutscene — int<preset::Cutscene> — EventCutsceneId
• Triggering Cutscene Bookmark — string — EventCutsceneBookmark
• Wait For Cutscene To End — void — WaitForCutsceneToEnd

# Examples

campaigns/swarm.sc2campaign — base.sc2maps/maps/campaign/swarm/zchar02.sc2map/MapScript.galaxy:2101

        }

        if (!((EventCutsceneId() == gv_scene_GorgonLaunch))) {
            return false;
        }

campaigns/swarm.sc2campaign — base.sc2maps/maps/campaign/swarm/zchar02.sc2map/MapScript.galaxy:4988

    // Conditions
    if (testConds) {
        if (!((EventCutsceneId() == gv_scene_GorgonLaunch))) {
            return false;
        }

campaigns/swarm.sc2campaign — base.sc2maps/maps/campaign/swarm/zstoryspace.sc2map/MapScript.galaxy:758

    libNtve_gf_WaitForTimer(gv_cutsceneLoadingTimer, 0.0, false);
    DialogDestroy(gv_cutsceneLoadingDialog);
    CutscenePlay(EventCutsceneId());
    SoundtrackPlay(PlayerGroupAll(), c_soundtrackCategoryMusic, "ZSpace02MusicCutscene02_MissionBriefing", c_soundtrackCueAny, c_soundtrackIndexAny, false);
    return true;

campaigns/swarm.sc2campaign/base.sc2maps/maps/campaign/swarm/zchar02.sc2map — MapScript.galaxy:2101

        }

        if (!((EventCutsceneId() == gv_scene_GorgonLaunch))) {
            return false;
        }

campaigns/swarm.sc2campaign/base.sc2maps/maps/campaign/swarm/zchar02.sc2map — MapScript.galaxy:4988

    // Conditions
    if (testConds) {
        if (!((EventCutsceneId() == gv_scene_GorgonLaunch))) {
            return false;
        }

campaigns/swarm.sc2campaign/base.sc2maps/maps/campaign/swarm/zstoryspace.sc2map — MapScript.galaxy:758

    libNtve_gf_WaitForTimer(gv_cutsceneLoadingTimer, 0.0, false);
    DialogDestroy(gv_cutsceneLoadingDialog);
    CutscenePlay(EventCutsceneId());
    SoundtrackPlay(PlayerGroupAll(), c_soundtrackCategoryMusic, "ZSpace02MusicCutscene02_MissionBriefing", c_soundtrackCueAny, c_soundtrackIndexAny, false);
    return true;

campaigns/swarmstoryutil.sc2mod — base.sc2data/Lib281DEC45.galaxy:8573

            lv_indexCutscene = 1;
            for ( ; ( (auto80BAA897_ai >= 0 && lv_indexCutscene <= auto80BAA897_ae) || (auto80BAA897_ai <= 0 && lv_indexCutscene >= auto80BAA897_ae) ) ; lv_indexCutscene += auto80BAA897_ai ) {
                if ((EventCutsceneId() == lib281DEC45_gv_zSS_AmbientScenes[lv_indexScene][lv_indexCutscene])) {
                    lib281DEC45_gf_ZSS_AmbientSceneOver(lv_indexScene, lv_indexCutscene);
                    return true;

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignStoryLib.galaxy:5512

    // Conditions
    if (testConds) {
        if (!((libVCST_gv_pS_ActiveBackground == EventCutsceneId()))) {
            return false;
        }

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignStoryLib.galaxy:5654

            lv_indexEvent = 1;
            for ( ; ( (autoE684077D_ai >= 0 && lv_indexEvent <= autoE684077D_ae) || (autoE684077D_ai < 0 && lv_indexEvent >= autoE684077D_ae) ) ; lv_indexEvent += autoE684077D_ai ) {
                if ((EventCutsceneId() == libVCST_gv_pS_AmbientEvents[lv_indexRoom][lv_indexScene][lv_indexEvent])) {
                    libVCST_gv_pS_AmbientEvents[lv_indexRoom][lv_indexScene][lv_indexEvent] = c_cutsceneNone;
                    libVCST_gf_PS_AmbientEventFinished(lv_indexRoom, lv_indexScene);

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/MapMechanicsLib.galaxy:5717

    lv_itPlayer = 1;
    for ( ; ( (autoCD1759B6_ai >= 0 && lv_itPlayer <= autoCD1759B6_ae) || (autoCD1759B6_ai < 0 && lv_itPlayer >= autoCD1759B6_ae) ) ; lv_itPlayer += autoCD1759B6_ai ) {
        if ((EventCutsceneId() == libMapM_gv_mMIntroCutscene[lv_itPlayer])) {
            libStEx_gf_CinematicFade(true, 1.5, Color(0.00, 0.00, 0.00), lv_itPlayer);
            return true;

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/MapMechanicsLib.galaxy:5753

    lv_itPlayer = 1;
    for ( ; ( (auto41494892_ai >= 0 && lv_itPlayer <= auto41494892_ae) || (auto41494892_ai < 0 && lv_itPlayer >= auto41494892_ae) ) ; lv_itPlayer += auto41494892_ai ) {
        if ((EventCutsceneId() == libMapM_gv_mMIntroCutscene[lv_itPlayer])) {
            libStEx_gf_CinematicFade(false, 0.0, Color(0.00, 0.00, 0.00), lv_itPlayer);
            return true;

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCST.galaxy:4822

            lv_indexEvent = 1;
            for ( ; ( (autoE684077D_ai >= 0 && lv_indexEvent <= autoE684077D_ae) || (autoE684077D_ai <= 0 && lv_indexEvent >= autoE684077D_ae) ) ; lv_indexEvent += autoE684077D_ai ) {
                if ((EventCutsceneId() == libNCST_gv_NS_AmbientEvents[lv_indexRoom][lv_indexScene][lv_indexEvent])) {
                    libNCST_gv_NS_AmbientEvents[lv_indexRoom][lv_indexScene][lv_indexEvent] = c_cutsceneNone;
                    libNCST_gf_NS_AmbientEventFinished(lv_indexRoom, lv_indexScene);

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOUI.galaxy:8525

        lv_indexPlayer = PlayerGroupNextPlayer(auto7FEFBF0E_g, lv_indexPlayer);
        if (lv_indexPlayer < 0) { break; }
        if ((libCOUI_gv_cU_GPCutscene[lv_indexPlayer] != c_invalidDialogControlId) && (EventCutsceneId() == CutsceneGetTriggerControl(libCOUI_gv_cU_GPCutscene[lv_indexPlayer]))) {
            lv_updatePlayers = PlayerGroupSingle(lv_indexPlayer);
            lv_buttonIndex = 1;

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOUI.galaxy:8587

        lv_indexPlayer = PlayerGroupNextPlayer(auto0CA96A82_g, lv_indexPlayer);
        if (lv_indexPlayer < 0) { break; }
        if ((libCOUI_gv_cU_GPCutscene[lv_indexPlayer] != c_invalidDialogControlId) && (EventCutsceneId() == CutsceneGetTriggerControl(libCOUI_gv_cU_GPCutscene[lv_indexPlayer]))) {
            lv_updatePlayers = PlayerGroupSingle(lv_indexPlayer);
            lv_buttonIndex = 1;