Version: 2018.2
public static int GetContacts (Collider2D collider, Collider2D[] colliders);

Parameters

colliderThe collider to retrieve contacts for.
collidersAn array of Collider2D used to receive the results.

Returns

int Returns the number of colliders placed in the colliders array.

Description

Retrieves all colliders in contact with the collider.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.


public static int GetContacts (Collider2D collider, ContactPoint2D[] contacts);

Parameters

colliderThe collider to retrieve contacts for.
contactsAn array of ContactPoint2D used to receive the results.

Returns

int Returns the number of contacts placed in the contacts array.

Description

Retrieves all contact points in contact with the collider.

Contacts involving a Collider2D set to be a trigger will never be returned here as trigger colliders do not have contact points.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.


public static int GetContacts (Collider2D collider, ContactFilter2D contactFilter, ContactPoint2D[] contacts);

Parameters

colliderThe collider to retrieve contacts for.
contactFilterThe contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
contactsAn array of ContactPoint2D used to receive the results.

Returns

int Returns the number of contacts placed in the contacts array.

Description

Retrieves all contact points in contact with the collider, with the results filtered by the ContactFilter2D.

Contacts involving a Collider2D set to be a trigger will never be returned here as trigger colliders do not have contact points. This is true even if the contactFilter has its ContactFilter2D.useTriggers set to true.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.


public static int GetContacts (Collider2D collider, ContactFilter2D contactFilter, Collider2D[] colliders);

Parameters

colliderThe collider to retrieve contacts for.
contactFilterThe contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
collidersAn array of Collider2D used to receive the results.

Returns

int Returns the number of colliders placed in the colliders array.

Description

Retrieves all colliders in contact with the collider, with the results filtered by the ContactFilter2D.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.


public static int GetContacts (Collider2D collider1, Collider2D collider2, ContactFilter2D contactFilter, ContactPoint2D[] contacts);

Parameters

collider1The collider to check if it has contacts against collider2.
collider2The collider to check if it has contacts against collider1.
contactFilterThe contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
contactsAn array of ContactPoint2D used to receive the results.

Returns

int Returns the number of contacts placed in the contacts array.

Description

Retrieves all contact points in for contacts between with the collider1 and collider2, with the results filtered by the ContactFilter2D.

Contacts involving a Collider2D set to be a trigger will never be returned here as trigger colliders do not have contact points. This is true even if the contactFilter has its ContactFilter2D.useTriggers set to true.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.


public static int GetContacts (Rigidbody2D rigidbody, ContactPoint2D[] contacts);

Parameters

rigidbodyThe rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked.
contactsAn array of ContactPoint2D used to receive the results.

Returns

int Returns the number of contacts placed in the contacts array.

Description

Retrieves all contact points in contact with any of the collider(s) attached to this rigidbody.

Contacts involving a Collider2D set to be a trigger will never be returned here as trigger colliders do not have contact points.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.


public static int GetContacts (Rigidbody2D rigidbody, Collider2D[] colliders);

Parameters

rigidbodyThe rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked.
collidersAn array of Collider2D used to receive the results.

Returns

int Returns the number of colliders placed in the colliders array.

Description

Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.


public static int GetContacts (Rigidbody2D rigidbody, ContactFilter2D contactFilter, ContactPoint2D[] contacts);

Parameters

rigidbodyThe rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked.
contactFilterThe contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
contactsAn array of ContactPoint2D used to receive the results.

Returns

int Returns the number of contacts placed in the contacts array.

Description

Retrieves all contact points in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D.

Contacts involving a Collider2D set to be a trigger will never be returned here as trigger colliders do not have contact points. This is true even if the contactFilter has its ContactFilter2D.useTriggers set to true.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.


public static int GetContacts (Rigidbody2D rigidbody, ContactFilter2D contactFilter, Collider2D[] colliders);

Parameters

rigidbodyThe rigidbody to retrieve contacts for. All colliders attached to this rigidbody will be checked.
contactFilterThe contact filter used to filter the results differently, such as by layer mask, Z depth, or normal angle.
collidersAn array of Collider2D used to receive the results.

Returns

int Returns the number of colliders placed in the colliders array.

Description

Retrieves all colliders in contact with any of the collider(s) attached to this rigidbody, with the results filtered by the ContactFilter2D.

When retrieving contacts, you should ensure that the provided array is large enough to contain all the contacts you are interested in. Typically the array would be reused therefore it would be a size to return a reasonable quantity of contacts. This function also means that no allocations occur which means no work is produced for the garbage collector.

See Also: Collider2D.GetContacts and Rigidbody2D.GetContacts.