# Show/Hide Cutscene

Grammar — inShow|Show/Hide Cutscene inCutscene.
Flags — Native | Action

Shows or hides a cutscene. When hidden, the cutscene will continue to advance and fire events, but it will not be visible nor will it play any sounds.

# Arguments

int<preset::Cutscene> — Cutscene
bool<preset::ShowHideOption> — Show/Hide

Returns — void

native void CutsceneShow(int inCutscene, bool inShow);

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/swarmstory.sc2campaign — base.sc2data/TriggerLibs/SwarmCampaignLib.galaxy:8182


    if ((lp_lightType == "Inactive")) {
        CutsceneShow(libSwaC_gv_zS_ArmyCustomEggLightScenes[lv_index], false);
    }
    else if ((lp_lightType != libSwaC_gv_zS_ArmyCustomEggLightStates[lv_index])) {

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

    }
    else if ((lp_lightType != libSwaC_gv_zS_ArmyCustomEggLightStates[lv_index])) {
        CutsceneShow(libSwaC_gv_zS_ArmyCustomEggLightScenes[lv_index], true);
        libSwaC_gv_zS_ArmyCustomEggLightStates[lv_index] = lp_lightType;
        CutsceneGoToBookmark(libSwaC_gv_zS_ArmyCustomEggLightScenes[lv_index], libSwaC_gf_ZS_ArmyCustomEggLightBookmark(lp_armyCategory, lp_lightType));

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

    }
    else if (true) {
        CutsceneShow(libSwaC_gv_zS_ArmyCustomEggLightScenes[lv_index], true);
    }
}

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


    if ((lp_play == true)) {
        CutsceneShow(libSwaC_gv_zS_ArmyCustomEggRoomSetLightScene, true);
    }
    else {

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

    }
    else {
        CutsceneShow(libSwaC_gv_zS_ArmyCustomEggRoomSetLightScene, false);
    }
}

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


    if ((lp_play == true)) {
        CutsceneShow(libSwaC_gv_zS_ArmyCustomEggRoomEvoLightScene, true);
    }
    else {

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

    }
    else {
        CutsceneShow(libSwaC_gv_zS_ArmyCustomEggRoomEvoLightScene, false);
    }
}

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

    else {
    }
    CutsceneShow(lib281DEC45_gv_zSS_StorySetLightingCutscene, true);
}

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

    else {
    }
    CutsceneShow(lib281DEC45_gv_zSS_StorySetLightingCutscene, false);
}

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

        lv_indexCutscene = 1;
        for ( ; ( (auto368B6600_ai >= 0 && lv_indexCutscene <= auto368B6600_ae) || (auto368B6600_ai <= 0 && lv_indexCutscene >= auto368B6600_ae) ) ; lv_indexCutscene += auto368B6600_ai ) {
            CutsceneShow(lib281DEC45_gv_zSS_AmbientScenes[lv_indexScene][lv_indexCutscene], lp_showHide);
        }
    }

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

            lv_indexCutscene = 1;
            for ( ; ( (auto4D6F7500_ai >= 0 && lv_indexCutscene <= auto4D6F7500_ae) || (auto4D6F7500_ai <= 0 && lv_indexCutscene >= auto4D6F7500_ae) ) ; lv_indexCutscene += auto4D6F7500_ai ) {
                CutsceneShow(lib281DEC45_gv_zSS_AmbientScenes[lv_indexScene][lv_indexCutscene], true);
            }
        }

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

    }
    if ((lib281DEC45_gv_zSS_AmbientScenesHidden == true)) {
        CutsceneShow(CutsceneLastCreated(), false);
    }
    else {

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

    else {
    }
    CutsceneShow(lib281DEC45_gv_zSS_Characters[lib281DEC45_gf_ZSS_CharacterIndex(lp_character)].lv_lightingCutscene, true);
}

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

    else {
    }
    CutsceneShow(lib281DEC45_gv_zSS_Characters[lib281DEC45_gf_ZSS_CharacterIndex(lp_character)].lv_lightingCutscene, false);
}

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

    }

    CutsceneShow(libVCST_gv_pS_StorySetLightingCutscene, true);
}

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

    }

    CutsceneShow(libVCST_gv_pS_StorySetLightingCutscene, false);
}

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

    if ((lv_backgroundCutscene != null)) {
        if ((libVCST_gv_pS_Backgrounds[libVCST_gf_PS_ConvertRoomtoBackgroundRoomNumber(lp_room)] != c_cutsceneNone)) {
            CutsceneShow(libVCST_gv_pS_Backgrounds[libVCST_gf_PS_ConvertRoomtoBackgroundRoomNumber(lp_room)], true);
        }
        else {

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

        }

        CutsceneShow(libVCST_gv_pS_Backgrounds[lv_roomNumber], false);
    }

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

            lv_indexEvent = 1;
            for ( ; ( (autoC28F0D64_ai >= 0 && lv_indexEvent <= autoC28F0D64_ae) || (autoC28F0D64_ai < 0 && lv_indexEvent >= autoC28F0D64_ae) ) ; lv_indexEvent += autoC28F0D64_ai ) {
                CutsceneShow(libVCST_gv_pS_AmbientEvents[lv_indexRoom][lv_indexScene][lv_indexEvent], lp_showHide);
            }
        }

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

        lv_indexEvent = 1;
        for ( ; ( (auto9AE66909_ai >= 0 && lv_indexEvent <= auto9AE66909_ae) || (auto9AE66909_ai < 0 && lv_indexEvent >= auto9AE66909_ae) ) ; lv_indexEvent += auto9AE66909_ai ) {
            CutsceneShow(libVCST_gv_pS_AmbientEvents[libVCST_gf_PS_AmbientGetRoomNumber(lp_room)][lv_indexScene][lv_indexEvent], lp_showHide);
        }
    }

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

            lv_indexEvent = 1;
            for ( ; ( (auto9AC7A288_ai >= 0 && lv_indexEvent <= auto9AC7A288_ae) || (auto9AC7A288_ai < 0 && lv_indexEvent >= auto9AC7A288_ae) ) ; lv_indexEvent += auto9AC7A288_ai ) {
                CutsceneShow(libVCST_gv_pS_AmbientEvents[libVCST_gf_PS_AmbientGetRoomNumber(libVCST_gv_pS_CurrentRoom)][lv_indexScene][lv_indexEvent], true);
            }
        }

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

    if ((libVCST_gv_pS_AmbientScenesHidden[lp_room] == true)) {
        if ((libVCST_gv_pS_AmbientIsInConvoState == true) && (UserDataGetInt("AmbientScenes", libVCST_gv_pS_AmbientSceneInstance[lp_room][lp_scene], "ActiveInConvo", 1) == 1) && (libVCST_gf_PS_AmbientGetRoomNumber(libVCST_gv_pS_CurrentRoom) == lp_room)) {
            CutsceneShow(CutsceneLastCreated(), true);
        }
        else {

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

        }
        else {
            CutsceneShow(CutsceneLastCreated(), false);
        }
    }

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

    }

    CutsceneShow(libVCST_gv_pS_Clickable[libVCST_gf_PS_ClickableIndex(lp_clickableInstance)].lv_lightingCutscene, false);
}

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignUILib.galaxy:2878

    TriggerExecute(libVCUI_gt_PU_StarmapInit, true, false);
    libVCUI_gf_PU_StarmapInitFromData();
    CutsceneShow(libVCUI_gv_pU_StarmapCutscene, true);
    libVCUI_gf_PU_RouteArtanisAnims(libVCUI_gv_pU_StarmapCutscene);
    DialogSetSubtitlePositionOverrideControl(libVCUI_gv_pU_StarmapSubtitlePanel);

mods/heroesmapmods/battlegroundmapmods/battlefieldofeternity.stormmod — base.stormdata/LibMLBD.galaxy:142

        CutsceneCreateNew("Cutscenes\\Storm_HvH_CS_EventStart.StormCutscene", libMLBD_gv_mMBOEBossSpawnLocationCenter, 0.0, PlayerGroupAll(), true);
        lv_currentCutscene = CutsceneLastCreated();
        CutsceneShow(lv_currentCutscene, true);
        CutscenePlay(lv_currentCutscene);
    }

mods/heroesmapmods/battlegroundmapmods/battlefieldofeternity.stormmod — base.stormdata/LibMLBD.galaxy:148

        CutsceneCreateNew("Cutscenes\\Storm_HvH_CS_EventMid.StormCutscene", libMLBD_gv_mMBOEBossSpawnLocationCenter, 0.0, PlayerGroupAll(), true);
        lv_currentCutscene = CutsceneLastCreated();
        CutsceneShow(lv_currentCutscene, true);
        CutscenePlay(lv_currentCutscene);
    }

mods/heroesmapmods/battlegroundmapmods/battlefieldofeternity.stormmod — base.stormdata/LibMLBD.galaxy:154

        CutsceneCreateNew("Cutscenes\\Storm_HvH_CS_EventEndHeaven.StormCutscene", lp_point, 45.0, PlayerGroupAll(), true);
        lv_currentCutscene = CutsceneLastCreated();
        CutsceneShow(lv_currentCutscene, true);
        CutscenePlay(lv_currentCutscene);
    }

mods/heroesmapmods/battlegroundmapmods/battlefieldofeternity.stormmod — base.stormdata/LibMLBD.galaxy:160

        CutsceneCreateNew("Cutscenes\\Storm_HvH_CS_EventEndHell.StormCutscene", lp_point, 315.0, PlayerGroupAll(), true);
        lv_currentCutscene = CutsceneLastCreated();
        CutsceneShow(lv_currentCutscene, true);
        CutscenePlay(lv_currentCutscene);
    }

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

    }

    CutsceneShow(libNCST_gv_nS_StorySetLightingCutscene, true);
}

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

    }

    CutsceneShow(libNCST_gv_nS_StorySetLightingCutscene, false);
}

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

    if ((lv_backgroundCutscene != null)) {
        if ((libNCST_gv_NS_Backgrounds[libNCST_gf_NS_ConvertRoomtoBackgroundRoomNumber(lp_room)] != c_cutsceneNone)) {
            CutsceneShow(libNCST_gv_NS_Backgrounds[libNCST_gf_NS_ConvertRoomtoBackgroundRoomNumber(lp_room)], true);
        }
        else {

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

        }

        CutsceneShow(libNCST_gv_NS_Backgrounds[lv_roomNumber], false);
    }

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

            lv_indexEvent = 1;
            for ( ; ( (autoC28F0D64_ai >= 0 && lv_indexEvent <= autoC28F0D64_ae) || (autoC28F0D64_ai <= 0 && lv_indexEvent >= autoC28F0D64_ae) ) ; lv_indexEvent += autoC28F0D64_ai ) {
                CutsceneShow(libNCST_gv_NS_AmbientEvents[lv_indexRoom][lv_indexScene][lv_indexEvent], lp_showHide);
            }
        }

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

        lv_indexEvent = 1;
        for ( ; ( (auto9AE66909_ai >= 0 && lv_indexEvent <= auto9AE66909_ae) || (auto9AE66909_ai <= 0 && lv_indexEvent >= auto9AE66909_ae) ) ; lv_indexEvent += auto9AE66909_ai ) {
            CutsceneShow(libNCST_gv_NS_AmbientEvents[libNCST_gf_NS_AmbientGetRoomNumber(lp_room)][lv_indexScene][lv_indexEvent], lp_showHide);
        }
    }

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

            lv_indexEvent = 1;
            for ( ; ( (auto9AC7A288_ai >= 0 && lv_indexEvent <= auto9AC7A288_ae) || (auto9AC7A288_ai <= 0 && lv_indexEvent >= auto9AC7A288_ae) ) ; lv_indexEvent += auto9AC7A288_ai ) {
                CutsceneShow(libNCST_gv_NS_AmbientEvents[libNCST_gf_NS_AmbientGetRoomNumber(libNCST_gv_nS_CurrentRoom)][lv_indexScene][lv_indexEvent], true);
            }
        }

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

    if ((libNCST_gv_nS_AmbientScenesHidden[lp_room] == true)) {
        if ((libNCST_gv_NS_AmbientIsInConvoState == true) && (UserDataGetInt("AmbientScenes", libNCST_gv_nS_AmbientSceneInstance[lp_room][lp_scene], "ActiveInConvo", 1) == 1) && (libNCST_gf_NS_AmbientGetRoomNumber(libNCST_gv_nS_CurrentRoom) == lp_room)) {
            CutsceneShow(CutsceneLastCreated(), true);
        }
        else {

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

        }
        else {
            CutsceneShow(CutsceneLastCreated(), false);
        }
    }

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

    }

    CutsceneShow(libNCST_gv_nS_Clickable[libNCST_gf_NS_ClickableIndex(lp_clickableInstance)].lv_lightingCutscene, false);
}

# Show/Hide Cutscene

# Arguments

# Related

# Examples