Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

EditorGUILayout.ObjectField

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 Object ObjectField(Object obj, Type objType, bool allowSceneObjects, params GUILayoutOption[] options);
public static Object ObjectField(string label, Object obj, Type objType, bool allowSceneObjects, params GUILayoutOption[] options);
public static Object ObjectField(GUIContent label, Object obj, Type objType, bool allowSceneObjects, params GUILayoutOption[] options);

Parameters

labelOptional label in front of the field.
objThe object the field shows.
objTypeThe type of the objects that can be assigned.
allowSceneObjectsAllow assigning scene objects. See Description for more info.
optionsAn optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style. See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

Object The object that has been set by the user.

Description

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("http://forum.unity3d.com/search.php"); } } }

public static void ObjectField(SerializedProperty property, params GUILayoutOption[] options);
public static void ObjectField(SerializedProperty property, GUIContent label, params GUILayoutOption[] options);
public static void ObjectField(SerializedProperty property, Type objType, params GUILayoutOption[] options);
public static void ObjectField(SerializedProperty property, Type objType, GUIContent label, params GUILayoutOption[] options);

Parameters

propertyThe object reference property the field shows.
objTypeThe type of the objects that can be assigned.
labelOptional label in front of the field. Pass GUIContent.none to hide the label.
optionsAn optional list of layout options that specify extra layout properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Description

Make a field to receive any object type.

Obsoleted

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