Show / Hide Table of Contents

Class Collider2D

Inheritance
Object
Object
Component
Behaviour
Collider2D
BoxCollider2D
CapsuleCollider2D
CircleCollider2D
CompositeCollider2D
EdgeCollider2D
PolygonCollider2D
TilemapCollider2D
Inherited Members
Behaviour.enabled
Behaviour.isActiveAndEnabled
Component.transform
Component.gameObject
Component.GetComponent(Type)
Component.GetComponent<T>()
Component.GetComponent(String)
Component.GetComponentInChildren(Type, Boolean)
Component.GetComponentInChildren(Type)
Component.GetComponentInChildren<T>(Boolean)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren(Type, Boolean)
Component.GetComponentsInChildren(Type)
Component.GetComponentsInChildren<T>(Boolean)
Component.GetComponentsInChildren<T>(Boolean, List<T>)
Component.GetComponentsInChildren<T>()
Component.GetComponentsInChildren<T>(List<T>)
Component.GetComponentInParent(Type)
Component.GetComponentInParent<T>()
Component.GetComponentsInParent(Type, Boolean)
Component.GetComponentsInParent(Type)
Component.GetComponentsInParent<T>(Boolean)
Component.GetComponentsInParent<T>(Boolean, List<T>)
Component.GetComponentsInParent<T>()
Component.GetComponents(Type)
Component.GetComponents(Type, List<Component>)
Component.GetComponents<T>(List<T>)
Component.tag
Component.GetComponents<T>()
Component.CompareTag(String)
Component.SendMessageUpwards(String, Object, SendMessageOptions)
Component.SendMessageUpwards(String, Object)
Component.SendMessageUpwards(String)
Component.SendMessageUpwards(String, SendMessageOptions)
Component.SendMessage(String, Object)
Component.SendMessage(String)
Component.SendMessage(String, Object, SendMessageOptions)
Component.SendMessage(String, SendMessageOptions)
Component.BroadcastMessage(String, Object, SendMessageOptions)
Component.BroadcastMessage(String, Object)
Component.BroadcastMessage(String)
Component.BroadcastMessage(String, SendMessageOptions)
Object.GetInstanceID()
Object.GetHashCode()
Object.Equals(Object)
Object.name
Object.Instantiate(Object, Vector3, Quaternion)
Object.Instantiate(Object, Vector3, Quaternion, Transform)
Object.Instantiate(Object)
Object.Instantiate(Object, Transform)
Object.Instantiate(Object, Transform, Boolean)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.Instantiate<T>(T, Transform, Boolean)
Object.Destroy(Object, Single)
Object.Destroy(Object)
Object.DestroyImmediate(Object, Boolean)
Object.DestroyImmediate(Object)
Object.FindObjectsOfType(Type)
Object.DontDestroyOnLoad(Object)
Object.hideFlags
Object.DestroyObject(Object, Single)
Object.DestroyObject(Object)
Object.FindSceneObjectsOfType(Type)
Object.FindObjectsOfTypeIncludingAssets(Type)
Object.FindObjectsOfType<T>()
Object.FindObjectOfType<T>()
Object.FindObjectsOfTypeAll(Type)
Object.FindObjectOfType(Type)
Object.ToString()
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetType()
Object.MemberwiseClone()
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
[RequireComponent(typeof(Transform))]
public class Collider2D : Behaviour

Properties

attachedRigidbody

Declaration
public Rigidbody2D attachedRigidbody { get; }
Property Value
Type Description
Rigidbody2D

bounciness

Declaration
public float bounciness { get; }
Property Value
Type Description
Single

bounds

Declaration
public Bounds bounds { get; }
Property Value
Type Description
Bounds

composite

Declaration
public CompositeCollider2D composite { get; }
Property Value
Type Description
CompositeCollider2D

density

Declaration
public float density { get; set; }
Property Value
Type Description
Single

friction

Declaration
public float friction { get; }
Property Value
Type Description
Single

isTrigger

Declaration
public bool isTrigger { get; set; }
Property Value
Type Description
Boolean

offset

Declaration
public Vector2 offset { get; set; }
Property Value
Type Description
Vector2

shapeCount

Declaration
public int shapeCount { get; }
Property Value
Type Description
Int32

sharedMaterial

Declaration
public PhysicsMaterial2D sharedMaterial { get; set; }
Property Value
Type Description
PhysicsMaterial2D

usedByComposite

Declaration
public bool usedByComposite { get; set; }
Property Value
Type Description
Boolean

usedByEffector

Declaration
public bool usedByEffector { get; set; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

Cast(Vector2, ContactFilter2D, RaycastHit2D[])

Declaration
[ExcludeFromDocs]
public int Cast(Vector2 direction, ContactFilter2D contactFilter, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 direction
ContactFilter2D contactFilter
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

Cast(Vector2, ContactFilter2D, RaycastHit2D[], Single)

Declaration
[ExcludeFromDocs]
public int Cast(Vector2 direction, ContactFilter2D contactFilter, RaycastHit2D[] results, float distance)
Parameters
Type Name Description
Vector2 direction
ContactFilter2D contactFilter
RaycastHit2D[] results
Single distance
Returns
Type Description
Int32
| Improve this Doc View Source

Cast(Vector2, ContactFilter2D, RaycastHit2D[], Single, Boolean)

Declaration
public int Cast(Vector2 direction, ContactFilter2D contactFilter, RaycastHit2D[] results, [DefaultValue("Mathf.Infinity")] float distance, [DefaultValue("true")] bool ignoreSiblingColliders)
Parameters
Type Name Description
Vector2 direction
ContactFilter2D contactFilter
RaycastHit2D[] results
Single distance
Boolean ignoreSiblingColliders
Returns
Type Description
Int32
| Improve this Doc View Source

Cast(Vector2, RaycastHit2D[])

Declaration
[ExcludeFromDocs]
public int Cast(Vector2 direction, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 direction
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

Cast(Vector2, RaycastHit2D[], Single)

Declaration
[ExcludeFromDocs]
public int Cast(Vector2 direction, RaycastHit2D[] results, float distance)
Parameters
Type Name Description
Vector2 direction
RaycastHit2D[] results
Single distance
Returns
Type Description
Int32
| Improve this Doc View Source

Cast(Vector2, RaycastHit2D[], Single, Boolean)

Declaration
public int Cast(Vector2 direction, RaycastHit2D[] results, [DefaultValue("Mathf.Infinity")] float distance, [DefaultValue("true")] bool ignoreSiblingColliders)
Parameters
Type Name Description
Vector2 direction
RaycastHit2D[] results
Single distance
Boolean ignoreSiblingColliders
Returns
Type Description
Int32
| Improve this Doc View Source

Distance(Collider2D)

Declaration
public ColliderDistance2D Distance(Collider2D collider)
Parameters
Type Name Description
Collider2D collider
Returns
Type Description
ColliderDistance2D
| Improve this Doc View Source

GetContacts(Collider2D[])

Declaration
public int GetContacts(Collider2D[] colliders)
Parameters
Type Name Description
Collider2D[] colliders
Returns
Type Description
Int32
| Improve this Doc View Source

GetContacts(ContactFilter2D, Collider2D[])

Declaration
public int GetContacts(ContactFilter2D contactFilter, Collider2D[] colliders)
Parameters
Type Name Description
ContactFilter2D contactFilter
Collider2D[] colliders
Returns
Type Description
Int32
| Improve this Doc View Source

GetContacts(ContactFilter2D, ContactPoint2D[])

Declaration
public int GetContacts(ContactFilter2D contactFilter, ContactPoint2D[] contacts)
Parameters
Type Name Description
ContactFilter2D contactFilter
ContactPoint2D[] contacts
Returns
Type Description
Int32
| Improve this Doc View Source

GetContacts(ContactPoint2D[])

Declaration
public int GetContacts(ContactPoint2D[] contacts)
Parameters
Type Name Description
ContactPoint2D[] contacts
Returns
Type Description
Int32

IsTouching(Collider2D)

Declaration
public bool IsTouching(Collider2D collider)
Parameters
Type Name Description
Collider2D collider
Returns
Type Description
Boolean
| Improve this Doc View Source

IsTouching(Collider2D, ContactFilter2D)

Declaration
public bool IsTouching(Collider2D collider, ContactFilter2D contactFilter)
Parameters
Type Name Description
Collider2D collider
ContactFilter2D contactFilter
Returns
Type Description
Boolean
| Improve this Doc View Source

IsTouching(ContactFilter2D)

Declaration
public bool IsTouching(ContactFilter2D contactFilter)
Parameters
Type Name Description
ContactFilter2D contactFilter
Returns
Type Description
Boolean
| Improve this Doc View Source

IsTouchingLayers()

Declaration
[ExcludeFromDocs]
public bool IsTouchingLayers()
Returns
Type Description
Boolean

IsTouchingLayers(Int32)

Declaration
public bool IsTouchingLayers([DefaultValue("Physics2D.AllLayers")] int layerMask)
Parameters
Type Name Description
Int32 layerMask
Returns
Type Description
Boolean
| Improve this Doc View Source

OverlapCollider(ContactFilter2D, Collider2D[])

Declaration
public int OverlapCollider(ContactFilter2D contactFilter, Collider2D[] results)
Parameters
Type Name Description
ContactFilter2D contactFilter
Collider2D[] results
Returns
Type Description
Int32

OverlapPoint(Vector2)

Declaration
public bool OverlapPoint(Vector2 point)
Parameters
Type Name Description
Vector2 point
Returns
Type Description
Boolean
| Improve this Doc View Source

Raycast(Vector2, ContactFilter2D, RaycastHit2D[])

Declaration
[ExcludeFromDocs]
public int Raycast(Vector2 direction, ContactFilter2D contactFilter, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 direction
ContactFilter2D contactFilter
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

Raycast(Vector2, ContactFilter2D, RaycastHit2D[], Single)

Declaration
public int Raycast(Vector2 direction, ContactFilter2D contactFilter, RaycastHit2D[] results, [DefaultValue("Mathf.Infinity")] float distance)
Parameters
Type Name Description
Vector2 direction
ContactFilter2D contactFilter
RaycastHit2D[] results
Single distance
Returns
Type Description
Int32
| Improve this Doc View Source

Raycast(Vector2, RaycastHit2D[])

Declaration
[ExcludeFromDocs]
public int Raycast(Vector2 direction, RaycastHit2D[] results)
Parameters
Type Name Description
Vector2 direction
RaycastHit2D[] results
Returns
Type Description
Int32
| Improve this Doc View Source

Raycast(Vector2, RaycastHit2D[], Single)

Declaration
[ExcludeFromDocs]
public int Raycast(Vector2 direction, RaycastHit2D[] results, float distance)
Parameters
Type Name Description
Vector2 direction
RaycastHit2D[] results
Single distance
Returns
Type Description
Int32
| Improve this Doc View Source

Raycast(Vector2, RaycastHit2D[], Single, Int32)

Declaration
[ExcludeFromDocs]
public int Raycast(Vector2 direction, RaycastHit2D[] results, float distance, int layerMask)
Parameters
Type Name Description
Vector2 direction
RaycastHit2D[] results
Single distance
Int32 layerMask
Returns
Type Description
Int32
| Improve this Doc View Source

Raycast(Vector2, RaycastHit2D[], Single, Int32, Single)

Declaration
[ExcludeFromDocs]
public int Raycast(Vector2 direction, RaycastHit2D[] results, float distance, int layerMask, float minDepth)
Parameters
Type Name Description
Vector2 direction
RaycastHit2D[] results
Single distance
Int32 layerMask
Single minDepth
Returns
Type Description
Int32
| Improve this Doc View Source

Raycast(Vector2, RaycastHit2D[], Single, Int32, Single, Single)

Declaration
public int Raycast(Vector2 direction, RaycastHit2D[] results, [DefaultValue("Mathf.Infinity")] float distance, [DefaultValue("Physics2D.AllLayers")] int layerMask, [DefaultValue("-Mathf.Infinity")] float minDepth, [DefaultValue("Mathf.Infinity")] float maxDepth)
Parameters
Type Name Description
Vector2 direction
RaycastHit2D[] results
Single distance
Int32 layerMask
Single minDepth
Single maxDepth
Returns
Type Description
Int32

Extension Methods

MustExtensions.MustBeEqual<T>(T, T)
MustExtensions.MustBeEqual<T>(T, T, String)
MustExtensions.MustNotBeEqual<T>(T, T)
MustExtensions.MustNotBeEqual<T>(T, T, String)
MustExtensions.MustBeNull<T>(T)
MustExtensions.MustBeNull<T>(T, String)
MustExtensions.MustNotBeNull<T>(T)
MustExtensions.MustNotBeNull<T>(T, String)
  • Improve this Doc
  • View Source
Back to top Generated by DocFX