Version: 5.6 (switch to 2017.1b)
LanguageEnglish
  • C#
  • JS

Script language

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

GUIUtility.GetControlID

Other Versions
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

public static function GetControlID(focus: FocusType): int;
public static int GetControlID(FocusType focus);
public static function GetControlID(focus: FocusType, position: Rect): int;
public static int GetControlID(FocusType focus, Rect position);

Description

Get a unique ID for a control.

    // Prints a not used ID that can be assigned to a control

    function OnGUI() {
        // Gets a ID for a control that cannot receive keyboard focus (A button)
        Debug.Log("Available id: " + GUIUtility.GetControlID(FocusType.Passive));
    }

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void OnGUI() {
        Debug.Log("Available id: " + GUIUtility.GetControlID(FocusType.Passive));
    }
}
public static function GetControlID(hint: int, focus: FocusType): int;
public static int GetControlID(int hint, FocusType focus);
public static function GetControlID(hint: int, focus: FocusType, position: Rect): int;
public static int GetControlID(int hint, FocusType focus, Rect position);

Description

Get a unique ID for a control, using an integer as a hint to help ensure correct matching of IDs to controls.

public static function GetControlID(contents: GUIContent, focus: FocusType): int;
public static int GetControlID(GUIContent contents, FocusType focus);
public static function GetControlID(contents: GUIContent, focus: FocusType, position: Rect): int;
public static int GetControlID(GUIContent contents, FocusType focus, Rect position);

Description

Get a unique ID for a control, using a the label content as a hint to help ensure correct matching of IDs to controls.

Leave Feedback

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2017 Unity Technologies. Publication: 5.6-001M. Built: 2017-06-19.
Tutorials Community Answers Knowledge Base Forums Asset Store