Version: 2023.1
LanguageEnglish
  • C#

Object.FindFirstObjectByType

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

Switch to Manual

Declaration

public static T FindFirstObjectByType();

Declaration

public static T FindFirstObjectByType(FindObjectsInactive findObjectsInactive);

Declaration

public static Object FindFirstObjectByType(Type type);

Declaration

public static Object FindFirstObjectByType(Type type, FindObjectsInactive findObjectsInactive);

Parameters

type The type of object to find.
findObjectsInactive Whether to include components attached to inactive GameObjects. If you don't specify this parameter, this function doesn't include inactive objects in the results.

Returns

T Returns the first active loaded object that matches the specified type. If no object matches the specified type, returns null.

Description

Retrieves the first active loaded object of Type type.

Object.FindFirstObjectOfType doesn't return Assets (for example meshes, textures, or prefabs), or inactive objects. It also doesn't return objects that have HideFlags.DontSave set.

Note: This function is very resource intensive. It's best practice to not use this function every frame and instead, in most cases, use the singleton pattern. Alternatively if you only need any instance of a matching object rather than the first one you can use the faster Object.FindAnyObjectOfType

See Also: Object.FindAnyObjectByType, Object.FindObjectsByType.

using UnityEngine;
using System.Collections;

// Search for the first object of Types TextMesh and CanvasRenderer, // if found print the names, else print a message // that says that it was not found. public class ExampleClass : MonoBehaviour { void Start() { TextMesh texture = (TextMesh)FindFirstObjectByType(typeof(TextMesh)); if (texture) Debug.Log("TextMesh object found: " + texture.name); else Debug.Log("No TextMesh object could be found");

CanvasRenderer canvas = FindFirstObjectByType<CanvasRenderer>(); if (canvas) Debug.Log("CanvasRenderer object found: " + canvas.name); else Debug.Log("No CanvasRenderer object could be found"); } }