Add/Remove UI Frame Type For Global Filter List / Reference / Galaxy API / StarCraft II API Documentation

Grammar — addRemove frameType for the global filter list
Flags — Action

Adds or removes the frame type from a list of which UI frames will NOT be automatically hidden & restored during actions like Cinematic Mode and Show/Hide Game UI.

# Arguments

bool<preset::AddRemoveOption> — Add/Remove
int<preset::UIFrameType> — FrameType

Returns — void

void libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(
	bool lp_addRemove,
	int lp_frameType,
);

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

    }

    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeTextTag);
    libNtve_gf_StoryMode(PlayerGroupAll(), true);
    GameSetTransitionMap("Campaign/TStory01.SC2Map");

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

    }

    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeTextTag);
    libNtve_gf_StoryMode(PlayerGroupAll(), true);
    GameSetTransitionMap("Campaign/TStory01.SC2Map");

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

    // Implementation
    CampaignMode(PlayerGroupAll(), true);
    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeTextTag);
    UISetFrameVisible(PlayerGroupAll(), c_syncFrameTypeTeamResourceButton, false);
    if ((GameCheatsEnabled(c_gameCheatCategoryDevelopment) == true)) {

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

    CampaignMode(PlayerGroupAll(), true);
    UISetFrameVisible(PlayerGroupAll(), c_syncFrameTypeTeamResourceButton, false);
    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeTextTag);
    TriggerDebugSetTypeFile(1, "StoryModeDebug.txt");
    libSwaC_gv_zS_CurrentMap = lp_map;

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

    // Implementation
    CampaignMode(PlayerGroupAll(), true);
    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeTextTag);
    UISetFrameVisible(PlayerGroupAll(), c_syncFrameTypeTeamResourceButton, false);
    UISetFrameVisible(PlayerGroupAll(), c_syncFrameTypeAllianceButton, false);

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

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

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

    TriggerDebugSetTypeFile(1, "StoryModeDebug.txt");
    CampaignMode(PlayerGroupAll(), true);
    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeTextTag);
    libComC_gv_cC_CurrentMap = lp_storyMap;
    libComC_gf_NS_LoadAllTransitionData(lp_storyMap);

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

    CampaignMode(PlayerGroupAll(), true);
    UISetFrameVisible(PlayerGroupAll(), c_syncFrameTypeTeamResourceButton, false);
    libNtve_gf_AddRemoveUIFrameTypeForGlobalFilterList(true, c_syncFrameTypeTextTag);
    libA3DDD02B_gf_PC_AutoHeatMapTestMode();
    TriggerDebugSetTypeFile(1, "StoryModeDebug.txt");

# Add/Remove UI Frame Type For Global Filter List

# Arguments

# Related

# Examples