Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Object.FindObjectsByType

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 Object[] FindObjectsByType(Type type, FindObjectsSortMode sortMode);

Declaration

public static Object[] FindObjectsByType(Type type, FindObjectsInactive findObjectsInactive, FindObjectsSortMode sortMode);

Declaration

public static T[] FindObjectsByType(FindObjectsSortMode sortMode);

Declaration

public static T[] FindObjectsByType(FindObjectsInactive findObjectsInactive, FindObjectsSortMode sortMode);

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.
sortMode Whether and how to sort the returned array. Not sorting the array makes this function run significantly faster.

Returns

Object[] The array of objects found matching the type specified.

Description

Retrieves a list of all loaded objects of Type type.

This doesn't return Assets (for example meshes, textures, or prefabs). It also doesn't return objects that have HideFlags.DontSave set. Use Resources.FindObjectsOfTypeAll to avoid these limitations.

In Editor, this searches the Scene view by default. If you want to find an object in the Prefab stage, see the StageUtility APIs.

using UnityEngine;

// Ten GameObjects are created and have TextMesh and // CanvasRenderer components added. // When the game runs press the Space key to display the // number of TextMesh and CanvasRenderer components.

public class ScriptExample : MonoBehaviour { private const int count = 10;

void Start() { var gameObjects = new GameObject[count]; var expectedTextMeshObjects = new TextMesh[count]; var expectedCanvasObjects = new CanvasRenderer[count];

for (var i = 0; i < count; ++i) { gameObjects[i] = new GameObject(); expectedTextMeshObjects[i] = gameObjects[i].AddComponent<TextMesh>(); expectedCanvasObjects[i] = gameObjects[i].AddComponent<CanvasRenderer>(); } }

void Update() { if (Input.GetKeyDown(KeyCode.Space)) { var foundCanvasObjects = FindObjectsByType<CanvasRenderer>(FindObjectsSortMode.None); var foundTextMeshObjects = FindObjectsByType(typeof(TextMesh), FindObjectsSortMode.None); Debug.Log(foundCanvasObjects + " : " + foundCanvasObjects.Length); Debug.Log(foundTextMeshObjects + " : " + foundTextMeshObjects.Length); } } }