# Pause Cutscene

Grammar — Pause inCutscene
Flags — Native | Action

Tells the specified Cutscene to pause playback.

# Arguments

int<preset::Cutscene> — Cutscene

Returns — void

native void CutscenePause(int inCutscene);

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

    CutsceneCreateNew("Cutscenes\\ZChar02CruiserLaunch.SC2Cutscene", libNtve_gf_PointFromXYZ(168.29, 65.25, 10.02), 0.0, PlayerGroupAll(), false);
    gv_scene_GorgonLaunch = CutsceneLastCreated();
    CutscenePause(gv_scene_GorgonLaunch);
    return true;
}

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


    TriggerEnable(TriggerGetCurrent(), false);
    CutscenePause(gv_scene_GorgonLaunch);
    CutsceneSetTime(gv_scene_GorgonLaunch, 0);
    UnitCreate(1, "GehennaCruiser", 0, gv_pLAYER_04_GORGON, PointFromId(222), -133.9159);

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


    gv_gorgonBeingSpawned = true;
    CutscenePause(gv_scene_GorgonLaunch);
    CutsceneSetTime(gv_scene_GorgonLaunch, 0);
    UnitCreate(1, "GehennaCruiser", 0, gv_pLAYER_04_GORGON, PointFromId(222), -133.9159);

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

    UnitSetPosition(gv_kerrigan, PointFromId(16), false);
    libSwaC_gf_EnableDisableZerglingRespawn(true);
    CutscenePause(gv_scene_GorgonLaunch);
    CutsceneSetTime(gv_scene_GorgonLaunch, 0);
    GameTimeOfDayPause(false);

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


    TriggerEnable(TriggerGetCurrent(), false);
    CutscenePause(gv_scene_GorgonLaunch);
    CutsceneSetTime(gv_scene_GorgonLaunch, 0);
    UnitCreate(1, "GehennaCruiser", 0, gv_pLAYER_04_GORGON, PointFromId(222), -133.9159);

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

    CutsceneCreateNew("Cutscenes\\ZChar02CruiserLaunch.SC2Cutscene", libNtve_gf_PointFromXYZ(168.29, 65.25, 10.02), 0.0, PlayerGroupAll(), false);
    gv_scene_GorgonLaunch = CutsceneLastCreated();
    CutscenePause(gv_scene_GorgonLaunch);
    return true;
}

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


    TriggerEnable(TriggerGetCurrent(), false);
    CutscenePause(gv_scene_GorgonLaunch);
    CutsceneSetTime(gv_scene_GorgonLaunch, 0);
    UnitCreate(1, "GehennaCruiser", 0, gv_pLAYER_04_GORGON, PointFromId(222), -133.9159);

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


    gv_gorgonBeingSpawned = true;
    CutscenePause(gv_scene_GorgonLaunch);
    CutsceneSetTime(gv_scene_GorgonLaunch, 0);
    UnitCreate(1, "GehennaCruiser", 0, gv_pLAYER_04_GORGON, PointFromId(222), -133.9159);

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

    UnitSetPosition(gv_kerrigan, PointFromId(16), false);
    libSwaC_gf_EnableDisableZerglingRespawn(true);
    CutscenePause(gv_scene_GorgonLaunch);
    CutsceneSetTime(gv_scene_GorgonLaunch, 0);
    GameTimeOfDayPause(false);

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


    TriggerEnable(TriggerGetCurrent(), false);
    CutscenePause(gv_scene_GorgonLaunch);
    CutsceneSetTime(gv_scene_GorgonLaunch, 0);
    UnitCreate(1, "GehennaCruiser", 0, gv_pLAYER_04_GORGON, PointFromId(222), -133.9159);

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:8201

        libSwaC_gv_zS_ArmyCustomEggRoomSetLightScene = CutsceneLastCreated();
        CutsceneGoToBookmark(libSwaC_gv_zS_ArmyCustomEggRoomSetLightScene, "World Light Start");
        CutscenePause(libSwaC_gv_zS_ArmyCustomEggRoomSetLightScene);
    }

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:8219

        libSwaC_gv_zS_ArmyCustomEggRoomEvoLightScene = CutsceneLastCreated();
        CutsceneGoToBookmark(libSwaC_gv_zS_ArmyCustomEggRoomEvoLightScene, "EggRoom - EvolutionMaster Start");
        CutscenePause(libSwaC_gv_zS_ArmyCustomEggRoomEvoLightScene);
    }

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:9279


    CutsceneGoToBookmark(libSwaC_gv_zS_ArmyCustomEvolutionUnitLightScene[lv_sceneIndex], (libSwaC_gf_ZS_ArmyCategoryBookmarkToken(libSwaC_gv_zS_ArmyCustomEvolutionCategory, true) + lp_side + lp_state + "Start"));
    CutscenePause(libSwaC_gv_zS_ArmyCustomEvolutionUnitLightScene[lv_sceneIndex]);
}

campaigns/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:23609


    if ((libSwaC_gv_zS_DebugScenePaused[libSwaC_gv_zS_DebugActiveCutscene] == false)) {
        CutscenePause(libSwaC_gv_zS_DebugCutscenes[libSwaC_gv_zS_DebugActiveCutscene]);
        libSwaC_gv_zS_DebugScenePaused[libSwaC_gv_zS_DebugActiveCutscene] = true;
    }

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

        lib281DEC45_gv_zSS_StorySetLightingCutscene = CutsceneLastCreated();
        CutsceneGoToBookmark(lib281DEC45_gv_zSS_StorySetLightingCutscene, "World Light Start");
        CutscenePause(lib281DEC45_gv_zSS_StorySetLightingCutscene);
    }
    else {

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

        CutsceneCreateNew(lib281DEC45_gf_ZSS_SetLightingCutsceneFile(), lib281DEC45_gv_zSS_ConversationCutscenePosition, 0.0, PlayerGroupAll(), false);
        lib281DEC45_gv_zSS_StorySetLightingCutscene = CutsceneLastCreated();
        CutscenePause(lib281DEC45_gv_zSS_StorySetLightingCutscene);
    }
    else {

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

    }
    CutsceneSetTime(lib281DEC45_gv_zSS_ConversationScene, 0);
    CutscenePause(lib281DEC45_gv_zSS_ConversationScene);
}

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

        lib281DEC45_gv_zSS_Characters[lib281DEC45_gf_ZSS_CharacterIndex(lp_character)].lv_lightingCutscene = CutsceneLastCreated();
        CutsceneGoToBookmark(lib281DEC45_gv_zSS_Characters[lib281DEC45_gf_ZSS_CharacterIndex(lp_character)].lv_lightingCutscene, (lv_setString + " - " + lp_token + " Start"));
        CutscenePause(lib281DEC45_gv_zSS_Characters[lib281DEC45_gf_ZSS_CharacterIndex(lp_character)].lv_lightingCutscene);
    }
    else {

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignLib.galaxy:10104


    if ((libVoiC_gv_pC_DebugScenePaused[libVoiC_gv_pC_DebugActiveCutscene] == false)) {
        CutscenePause(libVoiC_gv_pC_DebugCutscenes[libVoiC_gv_pC_DebugActiveCutscene]);
        libVoiC_gv_pC_DebugScenePaused[libVoiC_gv_pC_DebugActiveCutscene] = true;
    }

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

        libVCST_gv_pS_StorySetLightingCutscene = CutsceneLastCreated();
        CutsceneGoToBookmark(libVCST_gv_pS_StorySetLightingCutscene, "World Light Start");
        CutscenePause(libVCST_gv_pS_StorySetLightingCutscene);
    }

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

        CutsceneCreateNew(libVCST_gf_PS_SetLightingCutsceneFile(), libVCST_gv_pS_ConversationCutscenePosition, 0.0, PlayerGroupAll(), false);
        libVCST_gv_pS_StorySetLightingCutscene = CutsceneLastCreated();
        CutscenePause(libVCST_gv_pS_StorySetLightingCutscene);
    }

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

    libVCST_gv_pS_ConversationScene = CutsceneLastCreated();
    CutsceneSetTime(libVCST_gv_pS_ConversationScene, 0);
    CutscenePause(libVCST_gv_pS_ConversationScene);
}

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

        libNCST_gv_nS_StorySetLightingCutscene = CutsceneLastCreated();
        CutsceneGoToBookmark(libNCST_gv_nS_StorySetLightingCutscene, "World Light Start");
        CutscenePause(libNCST_gv_nS_StorySetLightingCutscene);
    }

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

        CutsceneCreateNew(libNCST_gf_NS_SetLightingCutsceneFile(), libNCST_gv_nS_ConversationCutscenePosition, 0.0, PlayerGroupAll(), false);
        libNCST_gv_nS_StorySetLightingCutscene = CutsceneLastCreated();
        CutscenePause(libNCST_gv_nS_StorySetLightingCutscene);
    }

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

    libNCST_gv_nS_ConversationScene = CutsceneLastCreated();
    CutsceneSetTime(libNCST_gv_nS_ConversationScene, 0);
    CutscenePause(libNCST_gv_nS_ConversationScene);
}

# Pause Cutscene

# Arguments

# Related

# Examples