public int GetContacts (ContactPoint2D[] contacts);

Parameters

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 for all 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 Physics2D.GetContacts.


public int GetContacts (Collider2D[] colliders);

Parameters

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 Physics2D.GetContacts.


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

Parameters

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 for all 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 Physics2D.GetContacts.


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

Parameters

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 Physics2D.GetContacts.

Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961