# Unit Is Highlighted

Grammar — unit is state by Player player
Flags — Native | Event

This event fires when a unit is highlighted or unhighlighted by a player. Use “Triggering Unit” to refer to the unit being highlighted/unhighlighted. Use “Triggering Player” to get the player.

# Arguments

• unitref [ unit ] — Unit
• int — Player
• bool [ preset::HighlightState ] — Highlighted/Unhighlighted

Returns — void

native void TriggerAddEventUnitHighlight(
	trigger t,
	unitref u,
	int player,
	bool state,
);

# Event parameters

• Triggering Game User — EventGameUser
• Triggering Player — EventPlayer
• Triggering Unit — EventUnit

# Related

Category: [Selection / Clicks and Highlights](/galaxy/reference#selection-clicks and-highlights)

• [F] — void — Unit Is Clicked — ( TriggerAddEventUnitClick )
• [F] — void — Unit Is Highlighted — ( TriggerAddEventUnitHighlight )

# Examples

# campaigns/liberty.sc2campaign

— MapScript.galaxy

// L21940
TriggerAddEventUnitHighlight(gt_HotspotHighlighted, null, c_playerAny, true)

// L21959
TriggerAddEventUnitHighlight(gt_HotspotUnhighlighted, null, c_playerAny, false)

// L22661
TriggerAddEventUnitHighlight(gt_BridgeMissionArchivesHighlighted, null, c_playerAny, true)

// L22688
TriggerAddEventUnitHighlight(gt_BridgeMissionArchivesUnhighlighted, null, c_playerAny, false)

// L23150
TriggerAddEventUnitHighlight(gt_CantinaTrophiesHighlighted, null, c_playerAny, true)

// L23180
TriggerAddEventUnitHighlight(gt_CantinaTrophiesUnhighlighted, null, c_playerAny, false)

// L23753
TriggerAddEventUnitHighlight(gt_LabArtifactHighlighted, null, c_playerAny, true)

// L23783
TriggerAddEventUnitHighlight(gt_LabArtifactUnhighlighted, null, c_playerAny, false)

// L24627
TriggerAddEventUnitHighlight(gt_MarSaraBriefcaseHighlighted, null, c_playerAny, true)

// L24654
TriggerAddEventUnitHighlight(gt_MarSaraBriefcaseHologramHighlighted, null, c_playerAny, true)

// L21940
TriggerAddEventUnitHighlight(gt_HotspotHighlighted, null, c_playerAny, true)

// L21959
TriggerAddEventUnitHighlight(gt_HotspotUnhighlighted, null, c_playerAny, false)

// L22661
TriggerAddEventUnitHighlight(gt_BridgeMissionArchivesHighlighted, null, c_playerAny, true)

// L22688
TriggerAddEventUnitHighlight(gt_BridgeMissionArchivesUnhighlighted, null, c_playerAny, false)

// L23150
TriggerAddEventUnitHighlight(gt_CantinaTrophiesHighlighted, null, c_playerAny, true)

// L23180
TriggerAddEventUnitHighlight(gt_CantinaTrophiesUnhighlighted, null, c_playerAny, false)

// L23753
TriggerAddEventUnitHighlight(gt_LabArtifactHighlighted, null, c_playerAny, true)

// L23783
TriggerAddEventUnitHighlight(gt_LabArtifactUnhighlighted, null, c_playerAny, false)

// L24627
TriggerAddEventUnitHighlight(gt_MarSaraBriefcaseHighlighted, null, c_playerAny, true)

// L24654
TriggerAddEventUnitHighlight(gt_MarSaraBriefcaseHologramHighlighted, null, c_playerAny, true)

# campaigns/swarmstory.sc2campaign

— SwarmCampaignLib.galaxy

// L20010
TriggerAddEventUnitHighlight(libSwaC_gt_ZS_ArmyCustomEggHighlight, null, c_playerAny, true)

// L20054
TriggerAddEventUnitHighlight(libSwaC_gt_ZS_ArmyCustomEggUnhighlight, null, c_playerAny, false)

// L20243
TriggerAddEventUnitHighlight(libSwaC_gt_ZS_ArmyCustomEggMouseOver, null, c_playerAny, true)

// L20710
TriggerAddEventUnitHighlight(libSwaC_gt_ZS_ArmyCustomEvolutionUnitHighlight, null, c_playerAny, true)

// L20768
TriggerAddEventUnitHighlight(libSwaC_gt_ZS_ArmyCustomEvolutionUnitUnhighlight, null, c_playerAny, false)

# campaigns/swarmstoryutil.sc2mod

— Lib281DEC45.galaxy

// L12124
TriggerAddEventUnitHighlight(lib281DEC45_gt_ZSS_InteractiveHighlightStart, null, c_playerAny, true)

// L12169
TriggerAddEventUnitHighlight(lib281DEC45_gt_ZSS_InteractiveHighlightStop, null, c_playerAny, false)

# campaigns/voidstory.sc2campaign

— VoidCampaignStoryLib.galaxy

// L6654
TriggerAddEventUnitHighlight(libVCST_gt_PS_InteractiveHighlightStart, null, c_playerAny, true)

// L6703
TriggerAddEventUnitHighlight(libVCST_gt_PS_InteractiveHighlightStop, null, c_playerAny, false)

# mods/missionpacks/novacampaign.sc2mod

— LibNCST.galaxy

// L5476
TriggerAddEventUnitHighlight(libNCST_gt_NS_InteractiveHighlightStart, null, c_playerAny, true)

// L5524
TriggerAddEventUnitHighlight(libNCST_gt_NS_InteractiveHighlightStop, null, c_playerAny, false)