Version: 2017.3 (switch to 2018.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Selectable.IsHighlighted

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

protected method IsHighlighted(eventData: EventSystems.BaseEventData): bool;
protected bool IsHighlighted(EventSystems.BaseEventData eventData);

Description

Returns whether the selectable is currently 'highlighted' or not.

Use this to check if the selectable UI element is currently highlighted.

no example available in JavaScript
//Create a UI element. To do this go to Create>UI and select from the list. Attach this script to the UI GameObject to see this script working. The script also works with non-UI elements, but highlighting works better with UI.

using UnityEngine; using UnityEngine.Events; using UnityEngine.EventSystems; using UnityEngine.UI;

//Use the Selectable class as a base class to access the IsHighlighted method public class Example : Selectable { //Use this to check what Events are happening BaseEventData m_BaseEvent;

void Update() { //Check if the GameObject is being highlighted if (IsHighlighted(m_BaseEvent) == true) { //Output that the GameObject was highlighted, or do something else Debug.Log("Selectable is Highlighted"); } } }

Did you find this page useful? Please give it a rating: