GetAttachedColliders
Returns all Collider2D that are attached to this Rigidbody2D.
Read time 2 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
GetAttachedColliders(Collider2D[], bool)
Returns all Collider2D that are attached to this Rigidbody2D.
public int GetAttachedColliders(Collider2D[] results, bool findTriggers = true)
Parameters
An array of Collider2D used to receive the results.
Whether Collider2D that are triggers should be returned or not.
Returns
Type | Description |
|---|---|
| int | Returns the number of Collider2D placed in the results array. |
Remarks
Calculates all Collider2D that are attached to this Rigidbody2D and returns them in the results array.
When retrieving colliders, you should ensure that the provided array is large enough to contain all the colliders you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of colliders. This function also means that no allocations occur which means no work is produced for the garbage collector.
Additional Resources: Rigidbody2D.attachedColliderCount.
GetAttachedColliders(List<Collider2D>, bool)
Returns all Collider2D that are attached to this Rigidbody2D.
public int GetAttachedColliders(List<Collider2D> results, bool findTriggers = true)
Parameters
A list of Collider2D used to receive the results.
Whether Collider2D that are triggers should be returned or not.
Returns
Type | Description |
|---|---|
| int | Returns the number of Collider2D placed in the results list. |
Remarks
Calculates all Collider2D that are attached to this Rigidbody2D and returns them in the results list.
The integer return value is the number of results written into the results list. The results list will be resized if it doesn't contain enough elements to report all the results. This prevents memory from being allocated for results when the results list does not need to be resized, and improves garbage collection performance when the query is performed frequently.
Additional Resources: Rigidbody2D.attachedColliderCount.