GetComponents
The non-generic version of this method.
Read time 3 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
GetComponents(Type)
The non-generic version of this method.
public Component[] GetComponents(Type type)
Parameters
The type of component to search for.
Returns
Type | Description |
|---|---|
| Component[] | An array containing all matching components of type |
Remarks
This version of GetComponents is not as efficient as the Generic version (above), so you should only use it if necessary.
GetComponents(Type, List<Component>)
The non-generic version of this method which allows you to supply your own List to be filled with results.
public void GetComponents(Type type, List<Component> results)
Parameters
The type of component to search for.
A list to use for the returned results.
Remarks
This version of GetComponents is not as efficient as the Generic version (above), so you should only use it if necessary.
GetComponents<T>(List<T>)
A variation of the GetComponents method which allows you to supply your own List to be filled with results.
public void GetComponents<T>(List<T> results)
Parameters
A list to use for the returned results.
Remarks
This allows you to avoid allocating new List objects for each call to the method. The list you supply is resized to match the number of results found, and any existing values in the list are overwritten.
GetComponents<T>()
Gets references to all components of type on the same GameObject as the component specified.
Tpublic T[] GetComponents<T>()
Returns
Type | Description |
|---|---|
| <T>[] | An array containing all matching components of type |
Remarks
The typical usage for this method is to call it from a MonoBehaviour script (which itself is a type of component), to find references to other Components or MonoBehaviours attached to the same GameObject as that script. In this case you can call the method with no preceding object specified. For example:
myResults = GetComponents<ComponentType>()You can also call this method on a reference to different component, which might be attached to a different GameObject. In this case, the GameObject to which that component is attached is searched. For example:
myResults = otherComponent.GetComponents<ComponentType>()To find components attached to a particular GameObject, you need a reference to that other GameObject (or any component attached to that GameObject). You can then call on that reference.
GetComponentsSee the Component and GameObject class reference pages for the other variations of the family of methods.
GetComponentThe following example gets a reference to all hinge joint components on the specified GameObject, and sets a property on each hinge joint component that was found.
using UnityEngine;public class Example : MonoBehaviour{ void Start() { HingeJoint[] hinges = GetComponents<HingeJoint>(); for (int i = 0; i < hinges.Length; i++) { hinges[i].useSpring = false; } }}
Note: If the type you request is a derivative of MonoBehaviour and the associated script can't be loaded then this function will return for that component.
null