Highlight Plus · Core Concepts
Highlight Plus distinguishes between two modes of highlighting: Highlighting (hover/proximity) and Selection (click/toggle). Understanding the difference lets you build intuitive selection systems for your game.
| Feature | Highlighting | Selection |
|---|---|---|
| Trigger | Mouse hover, proximity, or scripting | Mouse click or scripting |
| Duration | Temporary — ends when trigger stops | Persistent — stays until deselected |
| Profile | Uses the object's main Highlight Effect profile | Uses a separate Selection Profile (if assigned) |
| Multiple objects | Only one object highlighted at a time (by default) | Multiple objects can be selected simultaneously |
| Option | Description | Default |
|---|---|---|
| Selected Profile | Profile applied when the object is selected (overrides highlight appearance) | None |
| Selection Mode | How selection is triggered: None, Click, Toggle | None |
| Selected | Whether the object is currently selected (can be toggled via Inspector or script) | Off |
| Selected On Start | Automatically select this object when the scene starts | Off |
You can control selection programmatically:
// Select an object
HighlightEffect effect = GetComponent<HighlightEffect>();
effect.SetSelected(true);
// Deselect
effect.SetSelected(false);
// Toggle
effect.ToggleSelection();
// Check if selected
bool isSelected = effect.isSelected;
Help us improve this documentation page.