Show/Hide Game Menu Dialog Item / Reference / Galaxy API / StarCraft II API Documentation

Grammar — show menuItem for players
Flags — Native | Action

Shows or hides the specified menu item in the game menu. Allows customization of the F10 menu.

# Arguments

playergroup — Players
int<preset::GameMenuDialogItem> — Menu Item
bool<preset::ShowHideOption> — Show/Hide

Returns — void

native void UISetGameMenuItemVisible(
	playergroup inPlayers,
	int inMenuItemType,
	bool inVisible,
);

Category: UI / Game Menu

Abort Mission — void — TriggerAddEventAbortMission
Game Menu Item Selected — void — TriggerAddEventGameMenuItemSelected
Game Menu Item Selected — int<preset::GameMenuDialogItem> — EventGameMenuItemSelected
Set Game Menu Dialog Item Text — void — UISetGameMenuItemText
Set Game Menu Dialog Item Shortcut — void — UISetGameMenuItemShortcut
Show/Hide Game Menu Dialog Item — void — UISetGameMenuItemVisible
Show Custom Menu — void — UIShowCustomMenu
Show Standard Menu — void — UIShowStandardMenu
Set Custom Menu Dialog Item Text — void — UISetCustomMenuItemText
Set Custom Menu Dialog Item Shortcut — void — UISetCustomMenuItemShortcut
Show/Hide Custom Menu Dialog Item — void — UISetCustomMenuItemVisible
Hide All Custom Menu Dialog Items — void — UIClearCustomMenuItemList

# Examples

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

        UISetFrameVisible(PlayerGroupAll(), c_syncFrameTypeCashPanel, false);
    }
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartDifficultyPulldown, true);
    if (((libCamp_gf_MapTypeCheck(libCamp_gv_tS_CurrentMap, libCamp_ge_MapType_Mission) == true) || (libCamp_gv_tS_CurrentMap == libCamp_ge_MapID_MapTArcade))) {
        libCamp_gf_TS_PrepareForMissionLoadingScreen(libCamp_gv_tS_CurrentMap, true);

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

            lv_indexPlayer = PlayerGroupNextPlayer(auto05DE0937_g, lv_indexPlayer);
            if (lv_indexPlayer < 0) { break; }
            UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, true);
            UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, true);
        }

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

            if (lv_indexPlayer < 0) { break; }
            UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, true);
            UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, true);
        }
    }

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

            lv_indexPlayer = PlayerGroupNextPlayer(autoED5BF6AF_g, lv_indexPlayer);
            if (lv_indexPlayer < 0) { break; }
            UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
            UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, false);
        }

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

            if (lv_indexPlayer < 0) { break; }
            UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
            UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, false);
        }
    }

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

    libSwaC_gf_ZS_InitFeaturedZergStructureTypes();
    if ((libSwaC_gf_StoryMapTypeCheck(libSwaC_gf_CurrentMap(), c_mapKindUpgrade) == false)) {
        UISetGameMenuItemVisible(PlayerGroupSingle(1), c_gameMenuDialogRestartDifficultyPulldown, true);
    }

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

    }
    if ((libSwaC_gv_zS_InStoryMode == false)) {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, true);
    }
    else {

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

    }
    else {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    }
    if ((libSwaC_gv_zS_InStoryMode == false) && ((libSwaC_gv_zSX_IsSimulation == true) || ((libSwaC_gf_CurrentMap() != "ZLab1") && (libSwaC_gf_CurrentMap() != "ZLab2") && (libSwaC_gf_CurrentMap() != "ZLab3")))) {

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

    }
    if ((libSwaC_gv_zS_InStoryMode == false) && ((libSwaC_gv_zSX_IsSimulation == true) || ((libSwaC_gf_CurrentMap() != "ZLab1") && (libSwaC_gf_CurrentMap() != "ZLab2") && (libSwaC_gf_CurrentMap() != "ZLab3")))) {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, true);
        if ((libSwaC_gv_zSX_IsSimulation == true)) {
            UISetGameMenuItemText(PlayerGroupAll(), c_gameMenuDialogAbortButton, StringExternal("Param/Value/lib_SwaC_3FE3B4E6"));

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

    }
    else {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, false);
    }
    libSwaC_gf_ZS_PrepareLoadingScreen(lp_map, true);

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

    }
    if ((libVoiC_gv_pC_InStoryMode == false)) {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, true);
    }
    else {

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

    }
    else {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    }
    if ((libVoiC_gv_pC_InStoryMode == false) && ((libVoiC_gv_pCX_IsSimulation == true) || ((libVoiC_gf_CurrentMap() != "PAiur01") && (libVoiC_gf_CurrentMap() != "PAiur02") && (libVoiC_gf_CurrentMap() != "PAiur03") && (libVoiC_gv_pC_InEpilogue == false)))) {

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

    }
    if ((libVoiC_gv_pC_InStoryMode == false) && ((libVoiC_gv_pCX_IsSimulation == true) || ((libVoiC_gf_CurrentMap() != "PAiur01") && (libVoiC_gf_CurrentMap() != "PAiur02") && (libVoiC_gf_CurrentMap() != "PAiur03") && (libVoiC_gv_pC_InEpilogue == false)))) {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, true);
        if ((libVoiC_gv_pCX_IsSimulation == true)) {
            UISetGameMenuItemText(PlayerGroupAll(), c_gameMenuDialogAbortButton, StringExternal("Param/Value/lib_VoiC_462A52E0"));

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

    }
    else {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, false);
    }
    if ((lp_map == "SC2Epilogue02")) {

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

    libVCMI_gf_DifficultySetting(PlayerDifficulty(1));
    if ((libVoiC_gf_PC_CampaignMapTypeCheck(libVoiC_gf_CurrentMap(), c_mapKindMission) == true)) {
        UISetGameMenuItemVisible(PlayerGroupSingle(1), c_gameMenuDialogRestartDifficultyPulldown, true);
    }

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/UILib.galaxy:8762

    UISetSelectionTypeEnabled(PlayerGroupAll(), c_localSelectionTypeWorldPanelHero, true);
    PingSetPlayerPingsShown(libCore_gv_activeHumanPlayers, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogSaveButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogLoadButton, false);

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/UILib.galaxy:8763

    PingSetPlayerPingsShown(libCore_gv_activeHumanPlayers, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogSaveButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogLoadButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogReturnToGameplayButton, true);

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/UILib.galaxy:8764

    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogSaveButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogLoadButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogReturnToGameplayButton, true);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogMessageLogButton, false);

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/UILib.galaxy:8765

    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogSaveButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogLoadButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogReturnToGameplayButton, true);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogMessageLogButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAchievementsButton, false);

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/UILib.galaxy:8766

    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogLoadButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogReturnToGameplayButton, true);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogMessageLogButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAchievementsButton, false);
    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeCommandPanel);

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/UILib.galaxy:8767

    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogReturnToGameplayButton, true);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogMessageLogButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAchievementsButton, false);
    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeCommandPanel);
    UIClearCustomMenuItemList(PlayerGroupAll());

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

    // Implementation
    if ((libComC_gf_CampaignMapTypeCheck(libComC_gf_CurrentMap(), c_mapKindMission) == true)) {
        UISetGameMenuItemVisible(PlayerGroupSingle(1), c_gameMenuDialogRestartDifficultyPulldown, true);
    }

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNovC.galaxy:2264

    if ((lv_inStoryMode == false)) {
        libComC_gf_CC_LocationActivate(libComC_gf_CC_MissionLocation(lp_map));
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, true);
    }
    else {

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNovC.galaxy:2267

    }
    else {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    }
    if ((lv_inStoryMode == false) && ((libComC_gf_CC_TransitionInSimulation() == true) || (lp_map != "Nova01"))) {

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNovC.galaxy:2270

    }
    if ((lv_inStoryMode == false) && ((libComC_gf_CC_TransitionInSimulation() == true) || (lp_map != "Nova01"))) {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, true);
        if ((libComC_gf_CC_TransitionInSimulation() == true)) {
            UISetGameMenuItemText(PlayerGroupAll(), c_gameMenuDialogAbortButton, StringExternal("Param/Value/lib_NovC_AA8623D0"));

mods/missionpacks/novacampaign.sc2mod — base.sc2data/LibNovC.galaxy:2279

    }
    else {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, false);
    }
    UISetAchievementToastStyle(PlayerGroupAll(), c_achievementToastStyleTerran);

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:4379

        PlayerSetState(lv_indexPlayer, c_playerStateContinueEnabled, false);
    }
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, false);
    autoB8689056_g = libCOOC_gf_CommanderPlayers();

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOOC.galaxy:4380

    }
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, false);
    autoB8689056_g = libCOOC_gf_CommanderPlayers();
    lv_indexPlayer = -1;

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

    }
    if ((libA3DDD02B_gf_StoryMapTypeCheck(libA3DDD02B_gf_CurrentMap(), c_mapKindUpgrade) == false)) {
        UISetGameMenuItemVisible(PlayerGroupSingle(1), c_gameMenuDialogRestartDifficultyPulldown, true);
    }

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

    }
    if ((libA3DDD02B_gv_pP_InStoryMode == false)) {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, true);
    }
    else {

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

    }
    else {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogRestartButton, false);
    }
    if ((libA3DDD02B_gv_pP_InStoryMode == false) && (libA3DDD02B_gv_pPX_IsSimulation == true)) {

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

    }
    if ((libA3DDD02B_gv_pP_InStoryMode == false) && (libA3DDD02B_gv_pPX_IsSimulation == true)) {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, true);
        if ((libA3DDD02B_gv_pPX_IsSimulation == true)) {
            UISetGameMenuItemText(PlayerGroupAll(), c_gameMenuDialogAbortButton, StringExternal("Param/Value/lib_A3DDD02B_3FE3B4E6"));

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

    }
    else {
        UISetGameMenuItemVisible(PlayerGroupAll(), c_gameMenuDialogAbortButton, false);
    }
    libA3DDD02B_gf_PP_PrepareLoadingScreen(lp_map, true);

# Show/Hide Game Menu Dialog Item

# Arguments

# Related

# Examples