# UI Frame Is Visible

Grammar — uIFrame|UI Frame is visible for player player
Flags — Native | Function

Returns true if the specified UI frame is visible for the specified player.

# Arguments

• int — Player
• int<preset::UIFrameType> — UIFrame

Returns — bool

native bool UIFrameVisible(int inPlayer, int inFrameType);

# Related

Category: UI / Game UI

• Set Screen Mode — void — UISetMode
• Set Minimum Letterbox Height — void — UISetMinimumLetterboxHeight
• Show/Hide Game UI — void — libNtve_gf_HideGameUI
• Add/Remove UI Frame Type For Global Filter List — void — libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList
• UI Frame Flag — preset — int
• UI Frame Flag Check — bool — libNtve_gf_UIFrameFlagCheck
• For Each UI Frame — macro
• Show/Hide UI Frame — void — UISetFrameVisible
• Set BattleNet Button Offset — void — UISetBattleNetButtonOffset
• Clear BattleNet Button Offset — void — UIClearBattleNetButtonOffset
• UI Frame Is Visible — bool — UIFrameVisible
• Show/Hide World — void — UISetWorldVisible
• Show/Hide Achievement Panel — void — AchievementPanelSetVisible
• Show/Hide Mouse Cursor — void — UISetCursorVisible
• Enable/Disable Mouse Cursor Auto Hide — void — UISetCursorAutoHide
• Enable/Disable Drag Selection — void — UISetDragSelectEnabled
• Set Hot Key Profile — void — UISetHotkeyProfile
• Lock Ally Color Setting — void — UIUnitColorStyleOverride
• Unlock Ally Color Setting — void — UIUnitColorStyleClearOverride
• Lock Flyer Helper Display — void — UIFlyerHelperOverride
• Unlock Flyer Helper Display — void — UIFlyerHelperClearOverride
• Lock Status Bar Display — void — UIStatusBarOverride
• Unlock Status Bar Display — void — UIStatusBarClearOverride
• Set Achievement Toast Style — void — UISetAchievementToastStyle
• Set Minimap Background Color — void — UISetMiniMapBackGroundColor
• Show/Hide Minimap Camera Field of View — void — UISetMiniMapCameraFoVVisible
• Set Minimap Bounds — void — UISetMiniMapBounds
• Enable/Disable Command Type — void — UISetCommandAllowed
• Turn Ability Highlight On/Off — void — UISetButtonHighlighted
• Turn Button Highlight On/Off — void — UISetButtonFaceHighlighted
• Set Command Type Disabled Message — void — UISetCommandDisallowedMessage
• Show/Hide Resource — void — UISetResourceVisible
• Enable/Disable Selection Type — void — UISetSelectionTypeEnabled
• Launch Nydus Link — void — UILaunchNydusLink
• Show/Hide Message Log — void — UIMessageLogPanelSetVisible
• Set Targeting Order — void — UISetTargetingOrder
• Enable/Disable Hotkey — void — UISetHotkeyAllowed
• Target Mode Updated — void — TriggerAddEventTargetModeUpdate
• Resources Requested — void — TriggerAddEventResourceRequest
• Resources Traded — void — TriggerAddEventResourceTrade
• Target Mode Ability Command — abilcmd — EventTargetModeAbilCmd
• Target Mode State — int<preset::TargetModeState> — EventTargetModeState
• Resource Requested Amount — int — EventResourceRequestAmount
• Resource Traded Amount — int — EventResourceTradeAmount
• Resource Traded Recipient — int — EventResourceTradeRecipient

# Examples

campaigns/liberty.sc2campaign — base.sc2maps/maps/campaign/tstory01.sc2map/MapScript.galaxy:13949

    gf_MercDisplay(gt_CantinaMercLeave);
    CinematicFade(true, 0.1, c_fadeStyleNormal, ColorWithAlpha(0.00, 0.00, 0.00, 0.00), 0.0, true);
    while (!((UIFrameVisible(1, c_syncFrameTypeMercenaryPanel) == false))) {
        Wait(0.0625, c_timeGame);
    }

campaigns/liberty.sc2campaign/base.sc2maps/maps/campaign/tstory01.sc2map — MapScript.galaxy:13949

    gf_MercDisplay(gt_CantinaMercLeave);
    CinematicFade(true, 0.1, c_fadeStyleNormal, ColorWithAlpha(0.00, 0.00, 0.00, 0.00), 0.0, true);
    while (!((UIFrameVisible(1, c_syncFrameTypeMercenaryPanel) == false))) {
        Wait(0.0625, c_timeGame);
    }

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

        libCamp_gv_tS_StoryUIVisibilityCounter += 1;
        if ((UIFrameVisible(1, c_syncFrameTypeMenuBar) == true)) {
            libCamp_gv_tS_StoryUIVisibility_Menu[libCamp_gv_tS_StoryUIVisibilityCounter] = true;
        }

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

            libCamp_gv_tS_StoryUIVisibility_Menu[libCamp_gv_tS_StoryUIVisibilityCounter] = false;
        }
        if ((UIFrameVisible(1, c_syncFrameTypeCashPanel) == true)) {
            libCamp_gv_tS_StoryUIVisibility_Cash[libCamp_gv_tS_StoryUIVisibilityCounter] = true;
        }

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

            libCamp_gv_tS_StoryUIVisibility_RoomChange[libCamp_gv_tS_StoryUIVisibilityCounter] = false;
        }
        if ((UIFrameVisible(1, c_syncFrameTypeTipAlertPanel) == true)) {
            libCamp_gv_tS_StoryUIVisibility_Tip[libCamp_gv_tS_StoryUIVisibilityCounter] = true;
        }

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

    // Conditions
    if (testConds) {
        if (!((UIFrameVisible(1, c_syncFrameTypeBattleReportPanel) == true))) {
            return false;
        }

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

        }

        if (!((UIFrameVisible(1, c_syncFrameTypeBattleReportPanel) == true))) {
            return false;
        }

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

    // Conditions
    if (testConds) {
        if (!((UIFrameVisible(1, c_syncFrameTypeBattleReportPanel) == true))) {
            return false;
        }

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

    }

    if ((UIFrameVisible(1, c_syncFrameTypeResearchPanel) == false)) {
        libNtve_gf_HideGameUI(false, PlayerGroupAll());
        UISetWorldVisible(PlayerGroupAll(), false);

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

    }

    if ((UIFrameVisible(1, c_syncFrameTypeMercenaryPanel) == false)) {
        libNtve_gf_HideGameUI(false, PlayerGroupAll());
        UISetWorldVisible(PlayerGroupAll(), false);

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

    libCamp_gf_SetStoryCredits((libCamp_gf_StoryCredits() + lv_amount));
    PlayerModifyPropertyInt(1, c_playerPropCredits, c_playerPropOperSetTo, libCamp_gf_StoryCredits());
    if ((UIFrameVisible(1, c_syncFrameTypePurchasePanel) == true)) {
        libCamp_gf_TS_UpdateTechVisuals();
    }

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

    if ((libNtve_gf_PlayerInCinematicMode(1) == false)) {
        if ((UIFrameVisible(1, c_syncFrameTypeConsolePanel) == true)) {
            libVCMI_gv_pM_ScreenMode = c_uiModeConsole;
        }

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

            if (((GameMapIsBlizzard() == true) || (lv_indexFrame != c_syncFrameTypeBattleUI)) && (libNtve_gv__GameUIFrameFiltered[(lv_indexFrame)] == false)) {
                if ((lp_storeRestore == true)) {
                    if ((UIFrameVisible(lv_player, lv_indexFrame) == true)) {
                        libNtve_gv__GameUIVisible[lv_player][lv_indexFrame][(lp_index)] = true;
                    }

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

            if (((GameMapIsBlizzard() == true) || (lv_indexFrame != c_syncFrameTypeBattleUI)) && (libNtve_gv__GameUIFrameFiltered[(lv_indexFrame)] == false)) {
                if ((lp_storeRestore == true)) {
                    if ((UIFrameVisible(lv_player, lv_indexFrame) == true)) {
                        libNtve_gv__GameUIVisible[lv_player][lv_indexFrame][(lp_index)] = true;
                    }

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

    if ((libNtve_gf_PlayerInCinematicMode(1) == false)) {
        if ((UIFrameVisible(1, c_syncFrameTypeConsolePanel) == true)) {
            libNCMI_gv_nM_ScreenMode = c_uiModeConsole;
        }

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

    }

    while (!((libNCMI_gf_NM_CreditsCutsceneCreditsFinished() == true) && (UIFrameVisible(1, c_syncFrameTypeCreditsPanel) == true))) {
        Wait(0.1, c_timeGame);
    }

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

    }

    while (!((libNCST_gf_NS_CreditsFinished() == true) && (UIFrameVisible(1, c_syncFrameTypeCreditsPanel) == true))) {
        Wait(0.1, c_timeGame);
    }