Unity - Scripting API: HandleUtility.PickGameObject
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.
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.
Declaration
public static GameObject PickGameObject(Vector2 position, out int materialIndex);
Declaration
public static GameObject PickGameObject(Vector2 position, GameObject[] ignore, out int materialIndex);
Declaration
public static GameObject PickGameObject(Vector2 position, GameObject[] ignore, GameObject[] selection, out int materialIndex);
Declaration
public static GameObject PickGameObject(Vector2 position, bool selectPrefabRoot);
Declaration
public static GameObject PickGameObject(Vector2 position, bool selectPrefabRoot, GameObject[] ignore);
Declaration
public static GameObject PickGameObject(Vector2 position, bool selectPrefabRoot, GameObject[] ignore, GameObject[] filter);
Declaration
public static GameObject PickGameObject(Vector2 position, bool selectPrefabRoot, GameObject[] ignore, GameObject[] filter, out int materialIndex);
Parameters
| Parameter | Description |
|---|---|
| selectPrefabRoot | Select Prefab. |
| materialIndex | Returns index into material array of the Renderer component that is closest to specified position. |
| position | A position in screen coordinates. The top-left of the window is (0,0), and the bottom-right is (Screen.width, Screen.height). |
| ignore | An array of GameObjects that will not be considered when selecting the nearest GameObject. |
| filter | An array of GameObjects to be exclusively considered for selection. If null, all GameObjects in open scenes are eligible for selection. |
| selection | An array of GameObjects to be exclusively considered for selection. If null, all GameObjects in open scenes are eligible for selection. |
Returns
GameObject The GameObject that is under the requested position.
Description
Pick game object closest to specified position.
HandleUtility.PickGameObject must not be called during a repaint. In most cases it is appropriate to call during EventType.MouseDown or EventType.MouseUp.