Version: 2020.2
LanguageEnglish
  • C#

GameObject.GetComponents

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
public Component[] GetComponents(Type type);

Parameters

type The type of component to retrieve.

Description

Returns all components of Type type in the GameObject.

Note: If the type you request is a derivative of MonoBehaviour and the associated script can not be loaded then this function will return `null` for that component.

// Disable the spring on all HingeJoints in this game object
using UnityEngine;

public class GetComponentsExample : MonoBehaviour { // Disable the spring on all HingeJoints in this game object

void Start() { Component[] hingeJoints;

hingeJoints = GetComponents(typeof(HingeJoint));

foreach (HingeJoint joint in hingeJoints) joint.useSpring = false; } }

public T[] GetComponents();

Description

Generic version of this method.

Note: If the type you request is a derivative of MonoBehaviour and the associated script can not be loaded then this function will return `null` for that component.

// Disable the spring on all HingeJoints in this game object
using UnityEngine;

public class GetComponentsExample : MonoBehaviour { // Disable the spring on all HingeJoints in this game object

void Start() { HingeJoint[] hingeJoints;

hingeJoints = GetComponents<HingeJoint>();

foreach (HingeJoint joint in hingeJoints) joint.useSpring = false; } }

public void GetComponents(Type type, List<Component> results);

Parameters

type The type of Component to retrieve.
results List to receive the results.

Description

Returns all components of Type type in the GameObject into List results. Note that results is of type Component, not the type of the component retrieved.

Note: If the type you request is a derivative of MonoBehaviour and the associated script can not be loaded then this function will return `null` for that component.

// Disable the spring on all HingeJoints in this game object
using UnityEngine;
using System.Collections.Generic;

public class GetComponentsExample : MonoBehaviour { // Disable the spring on all HingeJoints in this game object

void Start() { // Disable the spring on all HingeJoints in this game object List<Component> hingeJoints = new List<Component>();

GetComponents(typeof(HingeJoint), hingeJoints);

foreach (HingeJoint joint in hingeJoints) joint.useSpring = false; } }

public void GetComponents(List<T> results);

Parameters

results List of type T to receive the results.

Description

Returns all components of Type type in the GameObject into List results.

Note: If the type you request is a derivative of MonoBehaviour and the associated script can not be loaded then this function will return `null` for that component.

// Disable the spring on all HingeJoints in this game object
using UnityEngine;
using System.Collections.Generic;

public class GetComponentsExample : MonoBehaviour { // Disable the spring on all HingeJoints in this game object

void Start() { // Disable the spring on all HingeJoints in this game object List<HingeJoint> hingeJoints = new List<HingeJoint>();

GetComponents(hingeJoints);

foreach (HingeJoint joint in hingeJoints) joint.useSpring = false; } }