Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

EdgeCollider2D

class in UnityEngine

/

Inherits from: Collider2D

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Collider for 2D physics representing an arbitrary set of connected edges (lines) defined by its vertices.

Variables

edgeCountGets the number of edges.
pointCountGets the number of points.
pointsGet or set the points defining multiple continuous edges.

Public Functions

ResetReset to a single edge consisting of two points.

Inherited members

Variables

enabledEnabled Behaviours are Updated, disabled Behaviours are not.
isActiveAndEnabledHas the Behaviour had enabled called.
attachedRigidbodyThe Rigidbody2D attached to the Collider2D's GameObject.
boundsThe world space bounding area of the collider.
densityThe density of the collider used to calculate its mass (when auto mass is enabled).
isTriggerIs this collider configured as a trigger?
offsetThe local offset of the collider geometry.
shapeCountThe number of separate shaped regions in the collider.
sharedMaterialThe [[PhysicsMaterial2D that is applied to this collider.
usedByEffectorWhether the collider is used by an attached effector or not.
gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

IsTouchingCheck whether this collider is touching the collider or not.
IsTouchingLayersChecks whether this collider is touching any colliders on the specified layerMask or not.
OverlapPointCheck if a collider overlaps a point in space.
BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with tag ?
GetComponentReturns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildrenReturns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParentReturns the component of Type type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateReturns a copy of the object original.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

Messages

OnCollisionEnter2DSent when an incoming collider makes contact with this object's collider (2D physics only).
OnCollisionExit2DSent when a collider on another object stops touching this object's collider (2D physics only).
OnCollisionStay2DSent each frame where a collider on another object is touching this object's collider (2D physics only).
OnTriggerEnter2DSent when another object enters a trigger collider attached to this object (2D physics only).
OnTriggerExit2DSent when another object leaves a trigger collider attached to this object (2D physics only).
OnTriggerStay2DSent each frame where another object is within a trigger collider attached to this object (2D physics only).