Unity - Scripting API: Object.FindFirstObjectByType

Method group is Obsolete

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.

Your name Your email Suggestion*

Cancel

Switch to Manual

Obsolete FindFirstObjectByType has been deprecated because it relies on instance ID ordering. Use FindAnyObjectByType instead, which does not depend on ordering.

Declaration

public static T FindFirstObjectByType();

Obsolete FindFirstObjectByType has been deprecated because it relies on instance ID ordering. Use FindAnyObjectByType instead, which does not depend on ordering.

Declaration

public static T FindFirstObjectByType(FindObjectsInactive findObjectsInactive);

Obsolete FindFirstObjectByType has been deprecated because it relies on instance ID ordering. Use FindAnyObjectByType instead, which does not depend on ordering.

Declaration

public static Object FindFirstObjectByType(Type type);

Obsolete FindFirstObjectByType has been deprecated because it relies on instance ID ordering. Use FindAnyObjectByType instead, which does not depend on ordering.

Declaration

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

Parameters

Parameter	Description
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.FindFirstObjectByType 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.FindAnyObjectByType