# Enable/Disable Hotkey

Grammar — disable|Enable/Disable hotkey for playerGroup
Flags — Native | Action | Restricted

Enables or disables a specific hotkey command.

# Arguments

• playergroup — PlayerGroup
• int<preset::UIHotkey> — Hotkey
• bool<preset::Enable_Disable_Option> — Disable

Returns — void

native void UISetHotkeyAllowed(
	playergroup players,
	int hotkey,
	bool allow,
);

# 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

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

        }

        UISetHotkeyAllowed(lv_validPlayers, c_hotkeyCameraFollow, false);
        libNtve_gf__CineModeTurnOnOffForPlayerGroup(lv_validPlayers, true);
        libNtve_gf__CineModeHideUI(lv_validPlayers);

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

        }
        UIFlyerHelperClearOverride(lv_validPlayers);
        UISetHotkeyAllowed(lv_validPlayers, c_hotkeyCameraFollow, true);
        TriggerSendEvent("CinematicModeOff");
    }

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

        }

        UISetHotkeyAllowed(lv_validPlayers, c_hotkeyCameraFollow, false);
        libNtve_gf__CineModeTurnOnOffForPlayerGroup(lv_validPlayers, true);
        libNtve_gf__CineModeHideUI(lv_validPlayers);

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

        }
        UIFlyerHelperClearOverride(lv_validPlayers);
        UISetHotkeyAllowed(lv_validPlayers, c_hotkeyCameraFollow, true);
        TriggerSendEvent("CinematicModeOff");
    }

mods/heroesdata.stormmod — base.stormdata/TriggerLibs/StartingExperienceLib.galaxy:701

        UISetFrameVisible(lv_validPlayers, c_syncFrameTypeTextTag, true);
        if ((libCore_gv_sYSGameMode == libCore_ge_GameModes_Tutorial1Deprecated)) {
            UISetHotkeyAllowed(PlayerGroupAll(), c_hotkeyCameraFollow, false);
        }

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

    }

    UISetHotkeyAllowed(lv_validPlayers, c_hotkeyCameraFollow, false);
    libNtve_gf__CineModeTurnOnOffForPlayerGroup(lv_validPlayers, true);
    libNtve_gf__CineModeHideUI(lv_validPlayers);

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOUI.galaxy:1770

    // Implementation
    libCOUI_gf_CU_CustomMutatorUpdateData();
    UISetHotkeyAllowed(PlayerGroupAll(), c_hotkeyMenuAchievements, true);
    SoundChannelMute(PlayerGroupAll(), c_soundCategoryAmbient, false);
    SoundChannelMute(PlayerGroupAll(), c_soundCategoryDoodad, false);

mods/starcoop/starcoop.sc2mod — base.sc2data/LibCOUI.galaxy:2015

    libCOUI_gf_CU_CustomMutatorInitFromData();
    UISetFrameVisible(PlayerGroupAll(), c_syncFrameTypeMenuBar, true);
    UISetHotkeyAllowed(PlayerGroupAll(), c_hotkeyMenuAchievements, false);
    DialogControlSetVisible(libCOUI_gv_cU_CustomMutatorChatDisplayStandard, PlayerGroupAll(), false);
    DialogSetVisible(libCOUI_gv_cU_CustomMutatorDialog, PlayerGroupAll(), true);