# Turn Button Highlight On/Off

Grammar — Turn button highlight highlighted|On/Off for players
Flags — Native | Action

The selected button is flashed in the user’s command card UI. If the button is contained in a sub-page, like one of the standard “build” commands, the button for the sub-page itself will also be highlighted.

# Arguments

• playergroup — Players
• string [ gamelink::Button ] — Button
• bool [ preset::OnOffOption ] — Highlighted

Returns — void

native void UISetButtonFaceHighlighted(
	playergroup inPlayers,
	string face,
	bool inHighlight,
);

# Related

Category: UI / Game UI

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

# Examples

# campaigns/swarm.sc2campaign

— MapScript.galaxy

// L1559
UISetButtonFaceHighlighted(PlayerGroupAll(), "Aberration", true)

// L3184
UISetButtonFaceHighlighted(PlayerGroupAll(), "Aberration", false)

// L2604
UISetButtonFaceHighlighted(PlayerGroupAll(), "Mutalisk", true)

// L3044
UISetButtonFaceHighlighted(PlayerGroupAll(), "Mutalisk", false)

// L1155
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", true)

// L1156
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", true)

// L1376
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

// L1377
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", false)

// L1545
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", true)

// L1546
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", true)

// L1588
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

// L1589
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", false)

// L3243
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", true)

// L1155
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", true)

// L1156
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", true)

// L1376
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

// L1377
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", false)

// L1545
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", true)

// L1546
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", true)

// L1588
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

// L1589
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", false)

// L3243
UISetButtonFaceHighlighted(PlayerGroupAll(), "MorphToSwarmling", true)

// L1559
UISetButtonFaceHighlighted(PlayerGroupAll(), "Aberration", true)

// L3184
UISetButtonFaceHighlighted(PlayerGroupAll(), "Aberration", false)

// L2604
UISetButtonFaceHighlighted(PlayerGroupAll(), "Mutalisk", true)

// L3044
UISetButtonFaceHighlighted(PlayerGroupAll(), "Mutalisk", false)

# campaigns/swarmstory.sc2campaign

— SwarmCampaignLib.galaxy

// L17710
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", true)

// L17717
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

# campaigns/void.sc2campaign

— MapScript.galaxy

// L1894
UISetButtonFaceHighlighted(PlayerGroupAll(), "SCV", false)

// L1920
UISetButtonFaceHighlighted(PlayerGroupAll(), "SupplyDepot", false)

// L1966
UISetButtonFaceHighlighted(PlayerGroupAll(), "Barracks", false)

// L1980
UISetButtonFaceHighlighted(PlayerGroupAll(), "Marine", false)

// L2065
UISetButtonFaceHighlighted(PlayerGroupAll(), "Drone", false)

// L2066
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

// L2086
UISetButtonFaceHighlighted(PlayerGroupAll(), "SpawningPool", false)

// L2108
UISetButtonFaceHighlighted(PlayerGroupAll(), "Zergling", false)

// L2109
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

// L2126
UISetButtonFaceHighlighted(PlayerGroupAll(), "Extractor", false)

// L1575
UISetButtonFaceHighlighted(PlayerGroupAll(), "Blink", true)

// L1607
UISetButtonFaceHighlighted(PlayerGroupAll(), "Blink", false)

// L2424
UISetButtonFaceHighlighted(PlayerGroupAll(), "Pylon", false)

// L2450
UISetButtonFaceHighlighted(PlayerGroupAll(), "Pylon", true)

// L2873
UISetButtonFaceHighlighted(PlayerGroupAll(), "Assimilator", true)

// L3108
UISetButtonFaceHighlighted(PlayerGroupAll(), "Assimilator", false)

// L3136
UISetButtonFaceHighlighted(PlayerGroupAll(), "Assimilator", true)

// L3194
UISetButtonFaceHighlighted(PlayerGroupAll(), "Assimilator", false)

// L1442
UISetButtonFaceHighlighted(PlayerGroupAll(), "AlarakKnockback", false)

// L1445
UISetButtonFaceHighlighted(PlayerGroupAll(), "VorazunBlink", false)

// L1492
UISetButtonFaceHighlighted(PlayerGroupAll(), "AlarakKnockback", true)

// L1727
UISetButtonFaceHighlighted(PlayerGroupAll(), "AlarakKnockback", false)

// L1792
UISetButtonFaceHighlighted(PlayerGroupAll(), "AlarakKnockback", false)

// L1859
UISetButtonFaceHighlighted(PlayerGroupAll(), "VorazunBlink", true)

// L1903
UISetButtonFaceHighlighted(PlayerGroupAll(), "VorazunBlink", false)

// L4393
UISetButtonFaceHighlighted(PlayerGroupAll(), "Reclamation", false)

// L4437
UISetButtonFaceHighlighted(PlayerGroupAll(), "Reclamation", true)

// L4620
UISetButtonFaceHighlighted(PlayerGroupAll(), "Reclamation", false)

// L992
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisAstralWind", true)

// L996
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisAstralWind", false)

// L2322
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisLightningDash", true)

// L2377
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisLightningDash", false)

// L2419
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisLightningDash", false)

// L1894
UISetButtonFaceHighlighted(PlayerGroupAll(), "SCV", false)

// L1920
UISetButtonFaceHighlighted(PlayerGroupAll(), "SupplyDepot", false)

// L1966
UISetButtonFaceHighlighted(PlayerGroupAll(), "Barracks", false)

// L1980
UISetButtonFaceHighlighted(PlayerGroupAll(), "Marine", false)

// L2065
UISetButtonFaceHighlighted(PlayerGroupAll(), "Drone", false)

// L2066
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

// L2086
UISetButtonFaceHighlighted(PlayerGroupAll(), "SpawningPool", false)

// L2108
UISetButtonFaceHighlighted(PlayerGroupAll(), "Zergling", false)

// L2109
UISetButtonFaceHighlighted(PlayerGroupAll(), "Larva", false)

// L2126
UISetButtonFaceHighlighted(PlayerGroupAll(), "Extractor", false)

// L1575
UISetButtonFaceHighlighted(PlayerGroupAll(), "Blink", true)

// L1607
UISetButtonFaceHighlighted(PlayerGroupAll(), "Blink", false)

// L2424
UISetButtonFaceHighlighted(PlayerGroupAll(), "Pylon", false)

// L2450
UISetButtonFaceHighlighted(PlayerGroupAll(), "Pylon", true)

// L2873
UISetButtonFaceHighlighted(PlayerGroupAll(), "Assimilator", true)

// L3108
UISetButtonFaceHighlighted(PlayerGroupAll(), "Assimilator", false)

// L3136
UISetButtonFaceHighlighted(PlayerGroupAll(), "Assimilator", true)

// L3194
UISetButtonFaceHighlighted(PlayerGroupAll(), "Assimilator", false)

// L1442
UISetButtonFaceHighlighted(PlayerGroupAll(), "AlarakKnockback", false)

// L1445
UISetButtonFaceHighlighted(PlayerGroupAll(), "VorazunBlink", false)

// L1492
UISetButtonFaceHighlighted(PlayerGroupAll(), "AlarakKnockback", true)

// L1727
UISetButtonFaceHighlighted(PlayerGroupAll(), "AlarakKnockback", false)

// L1792
UISetButtonFaceHighlighted(PlayerGroupAll(), "AlarakKnockback", false)

// L1859
UISetButtonFaceHighlighted(PlayerGroupAll(), "VorazunBlink", true)

// L1903
UISetButtonFaceHighlighted(PlayerGroupAll(), "VorazunBlink", false)

// L4393
UISetButtonFaceHighlighted(PlayerGroupAll(), "Reclamation", false)

// L4437
UISetButtonFaceHighlighted(PlayerGroupAll(), "Reclamation", true)

// L4620
UISetButtonFaceHighlighted(PlayerGroupAll(), "Reclamation", false)

// L992
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisAstralWind", true)

// L996
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisAstralWind", false)

// L2322
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisLightningDash", true)

// L2377
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisLightningDash", false)

// L2419
UISetButtonFaceHighlighted(PlayerGroupAll(), "ArtanisLightningDash", false)

# mods/heroesmapmods/battlegroundmapmods/warheadjunction.stormmod

— LibMSC2.galaxy

// L410
UISetButtonFaceHighlighted(PlayerGroupSingle(lp_player), "MapMechanicNuke", true)

// L418
UISetButtonFaceHighlighted(libCore_gv_playerGroupFromPlayer[lv_itPlayer], "MapMechanicNuke", false)

// L450
UISetButtonFaceHighlighted(libCore_gv_playerGroupFromPlayer[lp_player], "MapMechanicNuke", false)

# mods/novastoryassets.sc2mod

— MapScript.galaxy

// L4530
UISetButtonFaceHighlighted(PlayerGroupAll(), "NovaWeaponPsiBlade", true)

// L4767
UISetButtonFaceHighlighted(PlayerGroupAll(), "NovaWeaponPsiBlade", false)

// L3077
UISetButtonFaceHighlighted(PlayerGroupAll(), "NovaDomination", false)