EditorGUILayout.ObjectField

Parameters

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("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;
    }
}

Parameters

Description

Make a field to receive any object type.

Obsoleted. Use the overloads at the top of the page, with the allowSceneObjects parameter.