# Player In Story Mode

Grammar — Player player is in story mode
Flags — Function

Returns true if the specified player is in story mode. Use the “Story Mode” action to turn story mode on and off for a player.

# Arguments

  • int — Player

Returns — bool

bool libNtve_gf_PlayerInStoryMode(int lp_player);

Category: Story / Modes And Sets

# Examples

campaigns/libertystory.sc2campaign — base.sc2data/TriggerLibs/CampaignLib.galaxy:814


    // Implementation
    if ((libNtve_gf_PlayerInCinematicMode(1) == false) && (libNtve_gf_PlayerInStoryMode(1) == false)) {
        lv_flashOption = true;
        lv_portrait = libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft);

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

    libSwaC_gv_zS_SendTransmissionCampaignTrigger = TriggerGetCurrent();
    if ((lp_keepPortraitVisible != libSwaC_ge_CampaignTransmissionPortraitOptioins_DontShowPortrait) && ((lp_model != null) || ((lp_model == null) && (SoundPortraitModel(lp_sound) != null)) || ((lp_isPlaceHolder == true) && (lp_unit != null)))) {
        if ((libNtve_gf_PlayerInCinematicMode(1) == false) && (libNtve_gf_PlayerInStoryMode(1) == false)) {
            lv_portrait = libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft);
        }

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

        SoundtrackPause(PlayerGroupAll(), c_soundtrackCategoryAmbience, true, true);
        libVCUI_gf_PU_GPVisibilityAutoUpdate(false, c_transitionDurationImmediate);
        lv_wasStoryMode = libNtve_gf_PlayerInStoryMode(1);
        libNtve_gf_StoryMode(PlayerGroupAll(), true);
        libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate);

campaigns/voidstory.sc2campaign — base.sc2data/TriggerLibs/VoidCampaignMissionLib.galaxy:2796

    libVCMI_gv_pM_SendTransmissionCampaignTrigger = TriggerGetCurrent();
    if ((lp_keepPortraitVisible != libVCMI_ge_MissionTransmissionPortraitOptioins_DontShowPortrait) && ((lp_model != null) || ((lp_model == null) && (SoundPortraitModel(lp_sound) != null)) || ((lp_isPlaceHolder == true) && (lp_unit != null)))) {
        if ((libNtve_gf_PlayerInCinematicMode(1) == false) && (libNtve_gf_PlayerInStoryMode(1) == false)) {
            lv_portrait = libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft);
        }

mods/core.sc2mod — base.sc2data/TriggerLibs/NativeLib.galaxy:2097

            lv_pickedPlayer = PlayerGroupNextPlayer(auto451C348A_g, lv_pickedPlayer);
            if (lv_pickedPlayer < 0) { break; }
            if ((libNtve_gf_PlayerInStoryMode(lv_pickedPlayer) == false)) {
                UISetMode(PlayerGroupSingle(lv_pickedPlayer), c_uiModeConsole, lp_duration);
            }

mods/core.sc2mod — base.sc2data/TriggerLibs/NativeLib.galaxy:4477

            lv_pickedPlayer = PlayerGroupNextPlayer(auto24E8EA3B_g, lv_pickedPlayer);
            if (lv_pickedPlayer < 0) { break; }
            if ((libNtve_gf_PlayerInStoryMode(lv_pickedPlayer) == true)) {
                PlayerGroupRemove(lv_validPlayers, lv_pickedPlayer);
            }

mods/core.sc2mod — base.sc2data/TriggerLibs/NativeLib.galaxy:4508

            lv_pickedPlayer = PlayerGroupNextPlayer(auto4DCAC640_g, lv_pickedPlayer);
            if (lv_pickedPlayer < 0) { break; }
            if ((libNtve_gf_PlayerInStoryMode(lv_pickedPlayer) == false)) {
                PlayerGroupRemove(lv_validPlayers, lv_pickedPlayer);
            }

mods/core.sc2mod — base.sc2data/TriggerLibs/NativeLib.galaxy:5018

            lv_player = PlayerGroupNextPlayer(autoE7F18298_g, lv_player);
            if (lv_player < 0) { break; }
            if ((libNtve_gf_PlayerInCinematicMode(lv_player) == false) && (libNtve_gf_PlayerInStoryMode(lv_player) == false)) {
                UISetMode(PlayerGroupSingle(lv_player), c_uiModeConsole, c_transitionDurationImmediate);
            }

mods/core.sc2mod — base.sc2data/TriggerLibs/NativeLib.galaxy:5031

            lv_player = PlayerGroupNextPlayer(auto659B6716_g, lv_player);
            if (lv_player < 0) { break; }
            if ((libNtve_gf_PlayerInCinematicMode(lv_player) == false) && (libNtve_gf_PlayerInStoryMode(lv_player) == false)) {
                UISetMode(PlayerGroupSingle(lv_player), c_uiModeFullscreen, c_transitionDurationImmediate);
            }

mods/core.stormmod — base.stormdata/TriggerLibs/NativeLib.galaxy:1787

            	lv_pickedPlayer = PlayerGroupNextPlayer(auto451C348A_g, lv_pickedPlayer);
            	if (lv_pickedPlayer<0) { break; }
            	if ((libNtve_gf_PlayerInStoryMode(lv_pickedPlayer) == false)) {
                UISetMode(PlayerGroupSingle(lv_pickedPlayer), c_uiModeConsole, lp_duration);
            }

mods/core.stormmod — base.stormdata/TriggerLibs/NativeLib.galaxy:3735

            	lv_pickedPlayer = PlayerGroupNextPlayer(auto24E8EA3B_g, lv_pickedPlayer);
            	if (lv_pickedPlayer<0) { break; }
            	if ((libNtve_gf_PlayerInStoryMode(lv_pickedPlayer) == true)) {
                PlayerGroupRemove(lv_validPlayers, lv_pickedPlayer);
            }

mods/core.stormmod — base.stormdata/TriggerLibs/NativeLib.galaxy:3766

            	lv_pickedPlayer = PlayerGroupNextPlayer(auto4DCAC640_g, lv_pickedPlayer);
            	if (lv_pickedPlayer<0) { break; }
            	if ((libNtve_gf_PlayerInStoryMode(lv_pickedPlayer) == false)) {
                PlayerGroupRemove(lv_validPlayers, lv_pickedPlayer);
            }

mods/core.stormmod — base.stormdata/TriggerLibs/NativeLib.galaxy:4263

            	lv_player = PlayerGroupNextPlayer(autoE7F18298_g, lv_player);
            	if (lv_player<0) { break; }
            	if ((libNtve_gf_PlayerInCinematicMode(lv_player) == false) && (libNtve_gf_PlayerInStoryMode(lv_player) == false)) {
                UISetMode(PlayerGroupSingle(lv_player), c_uiModeConsole, c_transitionDurationImmediate);
            }

mods/core.stormmod — base.stormdata/TriggerLibs/NativeLib.galaxy:4276

            	lv_player = PlayerGroupNextPlayer(auto659B6716_g, lv_player);
            	if (lv_player<0) { break; }
            	if ((libNtve_gf_PlayerInCinematicMode(lv_player) == false) && (libNtve_gf_PlayerInStoryMode(lv_player) == false)) {
                UISetMode(PlayerGroupSingle(lv_player), c_uiModeFullscreen, c_transitionDurationImmediate);
            }

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/HeroesLib.galaxy:3572

    libCore_gv_zS_SendTransmissionCampaignTrigger = TriggerGetCurrent();
    if ((lp_keepPortraitVisible != libCore_ge_TransmissionPortraitOptioins_DontShowPortrait) && ((lp_model != null) || ((lp_model == null) && (SoundPortraitModel(lp_sound) != null)) || ((lp_isPlaceHolder == true) && (lp_unit != null)))) {
        if ((libNtve_gf_PlayerInCinematicMode(1) == false) && (libNtve_gf_PlayerInStoryMode(1) == false)) {
            lv_portrait = PortraitGetGame();
        }

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/HeroesLib.galaxy:3772

    libCore_gv_zS_SendTransmissionCampaignTrigger = TriggerGetCurrent();
    if ((lp_keepPortraitVisible != libCore_ge_TransmissionPortraitOptioins_DontShowPortrait) && ((lp_model != null) || ((lp_model == null) && (SoundPortraitModel(lp_sound) != null)) || ((lp_isPlaceHolder == true) && (lp_unit != null)))) {
        if ((libNtve_gf_PlayerInCinematicMode(1) == false) && (libNtve_gf_PlayerInStoryMode(1) == false)) {
            lv_portrait = PortraitGetGame();
        }

mods/missionpacks/campaigncommon.sc2mod — base.sc2data/LibComC.galaxy:1741

        SoundtrackPause(PlayerGroupAll(), c_soundtrackCategoryMusic, true, true);
        SoundtrackPause(PlayerGroupAll(), c_soundtrackCategoryAmbience, true, true);
        lv_wasStoryMode = libNtve_gf_PlayerInStoryMode(1);
        lv_wasCinematicMode = libNtve_gf_PlayerInCinematicMode(1);
        libNtve_gf_StoryMode(PlayerGroupAll(), true);

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCMI.galaxy:3010

    libNCMI_gv_NM_SendTransmissionCampaignTrigger = TriggerGetCurrent();
    if ((lp_keepPortraitVisible != libNCMI_ge_MissionTransmissionPortraitOptioins_DontShowPortrait) && ((lp_model != null) || ((lp_model == null) && (SoundPortraitModel(lp_sound) != null)) || ((lp_isPlaceHolder == true) && (lp_unit != null)))) {
        if ((libNtve_gf_PlayerInCinematicMode(1) == false) && (libNtve_gf_PlayerInStoryMode(1) == false)) {
            lv_portrait = libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft);
        }

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNCUI.galaxy:2768

    DialogSetVisible(libNCUI_gv_nU_EquipmentDialog, PlayerGroupAll(), true);
    DialogControlSetVisible(libNCUI_gv_nU_EquipmentPanel, PlayerGroupAll(), true);
    if ((libNtve_gf_PlayerInStoryMode(1) == true)) {
        TimerStart(libNCUI_gv_nU_EquipmentReigelResponseTimer, libNCUI_gv_nUC_EquipmentReigelResponseDelay, false, c_timeReal);
        TriggerEnable(libNCUI_gt_NU_EquipmentReigelResponse, true);

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOMI.galaxy:10725

    libCOMI_gv_cM_SendTransmissionCampaignTrigger = TriggerGetCurrent();
    if ((lp_keepPortraitVisible != libCOMI_ge_MissionTransmissionPortraitOptioins_DontShowPortrait) && ((lp_model != null) || ((lp_model == null) && (SoundPortraitModel(lp_sound) != null)) || ((lp_isPlaceHolder == true) && (lp_unit != null)))) {
        if ((libNtve_gf_PlayerInCinematicMode(1) == false) && (libNtve_gf_PlayerInStoryMode(1) == false)) {
            lv_portrait = libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft);
        }

mods/voidprologue.sc2mod — base.sc2data/LibA3DDD02B.galaxy:554

    libA3DDD02B_gv_pP_SendTransmissionCampaignTrigger = TriggerGetCurrent();
    if ((lp_keepPortraitVisible != libA3DDD02B_ge_CampaignTransmissionPortraitOptioins_DontShowPortrait) && ((lp_model != null) || ((lp_model == null) && (SoundPortraitModel(lp_sound) != null)) || ((lp_isPlaceHolder == true) && (lp_unit != null)))) {
        if ((libNtve_gf_PlayerInCinematicMode(1) == false) && (libNtve_gf_PlayerInStoryMode(1) == false)) {
            lv_portrait = libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft);
        }