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.
CloseFor 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.
Closelabel | Optional label in front of the field. |
obj | The object the field shows. |
objType | The type of the objects that can be assigned. |
allowSceneObjects | Allow assigning Scene objects. See Description for more info. |
options | An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style .
Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight,
GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. |
Object The object that has been set by the user.
Make a field to receive any object type.
You can assign objects either by drag and drop or by selecting an object using the Object Picker.
Ensure that the allowSceneObjects parameter is false if the object reference is stored as part of an asset, since assets can't store references to objects in a Scene.
If the ObjectField is part of a custom Editor for a script component, use EditorUtility.IsPersistent() to check if the component is on an asset or a Scene object.
See the example in the Editor class for further information.
Search for a help page by selecting the GameObject in the Object Field.
// EditorScript that quickly searches for a help page // about the selected Object. // // If no such page is found in the Manual it opens the Unity forum.
using UnityEditor; using UnityEngine; using System.Collections;
public class ExampleClass : EditorWindow { public Object source;
[MenuItem("Example/ObjectField Example _h")] static void Init() { var window = GetWindowWithRect<ExampleClass>(new Rect(0, 0, 165, 100)); window.Show(); }
void OnGUI() { EditorGUILayout.BeginHorizontal(); source = EditorGUILayout.ObjectField(source, typeof(Object), true); EditorGUILayout.EndHorizontal();
if (GUILayout.Button("Search!")) { if (source == null) ShowNotification(new GUIContent("No object selected for searching")); else if (Help.HasHelpForObject(source)) Help.ShowHelpForObject(source); else Help.BrowseURL("https://forum.unity3d.com/search.php"); } } }
You can also use the options parameter to change the look of the control. The following example changes the look of a Sprite ObjectField that is displayed with a large field format.
Two different layout options for a sprite field.
using UnityEditor; using UnityEngine;
public class SpriteExample : EditorWindow { public Sprite sprite;
[MenuItem("Example/ObjectField Sprite Example")] static void Init() { var window = GetWindowWithRect<SpriteExample>(new Rect(0, 0, 165, 100)); window.Show(); }
void OnGUI() { sprite = EditorGUILayout.ObjectField(sprite, typeof(Sprite), false, GUILayout.Height(EditorGUIUtility.singleLineHeight)) as Sprite; } }
property | The object reference property the field shows. |
objType | The type of the objects that can be assigned. |
label | Optional label in front of the field. Pass GUIContent.none to hide the label. |
options | An optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style .Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight. |
Make a field to receive any object type.
Obsoleted. Use the overloads at the top of the page, with the allowSceneObjects parameter.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.