Select your preferred scripting language. All code snippets will be displayed in this language.
class in UnityEngine
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
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.Close
A Collider that can merge other Colliders together.
A CompositeCollider2D merges other Colliders together when their Collider2D.usedByComposite is set to true.
When a Collider is used by a Composite Collider, the Editor will ignore and not show the Collider2D.sharedMaterial, Collider2D.isTrigger & Collider2D.usedByComposite properties. The same properties on the CompositeCollider2D will be used instead. You should set these properties on the Composite Collider instead to merge all Colliders into the Composite Collider.
Composite Colliders can only merge BoxCollider2D and PolygonCollider2D.
|Controls the radius of all edges created by the Collider.
|Specifies when to generate the Composite Collider geometry.
|Specifies the type of geometry the Composite Collider should generate.
|The number of paths in the Collider.
|Gets the total number of points in all the paths within the Collider.
|Controls the minimum distance allowed between generated vertices.
|Regenerates the Composite Collider geometry.
|Gets a path from the Collider by its index.
|Gets the number of points in the specified path from the Collider by its index.
|Enabled Behaviours are Updated, disabled Behaviours are not.
|Has the Behaviour had enabled called.
|The Rigidbody2D attached to the Collider2D.
|Get the bounciness used by the collider.
|The world space bounding area of the collider.
|Get the CompositeCollider2D that is available to be attached to the collider.
|The density of the collider used to calculate its mass (when auto mass is enabled).
|Get the friction used by the collider.
|Is this collider configured as a trigger?
|The local offset of the collider geometry.
|The number of separate shaped regions in the collider.
|The PhysicsMaterial2D that is applied to this collider.
|Sets whether the Collider will be used or not used by a CompositeCollider2D.
|Whether the collider is used by an attached effector or not.
|The game object this component is attached to. A component is always attached to a game object.
|The tag of this game object.
|The Transform attached to this GameObject.
|Should the object be hidden, saved with the scene or modifiable by the user?
|The name of the object.
|Casts the collider shape into the scene starting at the collider position ignoring the collider itself.
|Calculates the minimum separation of this collider against another collider.
|Retrieves all contact points for this collider.
|Check whether this collider is touching the collider or not.
|Checks whether this collider is touching any colliders on the specified layerMask or not.
|Get a list of all colliders that overlap this collider.
|Check if a collider overlaps a point in space.
|Casts a ray into the scene starting at the collider position ignoring the collider itself.
|Calls the method named methodName on every MonoBehaviour in this game object or any of its children.
|Is this game object tagged with tag ?
|Returns the component of Type type if the game object has one attached, null if it doesn't.
|Returns the component of Type type in the GameObject or any of its children using depth first search.
|Returns the component of Type type in the GameObject or any of its parents.
|Returns all components of Type type in the GameObject.
|Returns all components of Type type in the GameObject or any of its children.
|Returns all components of Type type in the GameObject or any of its parents.
|Calls the method named methodName on every MonoBehaviour in this game object.
|Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
|Returns the instance id of the object.
|Returns the name of the GameObject.
|Removes a gameobject, component or asset.
|Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
|Makes the object target not be destroyed automatically when loading a new scene.
|Returns the first active loaded object of Type type.
|Returns a list of all active loaded objects of Type type.
|Clones the object original and returns the clone.
|Does the object exist?
|Compares if two objects refer to a different object.
|Compares two object references to see if they refer to the same object.
|Sent when an incoming collider makes contact with this object's collider (2D physics only).
|Sent when a collider on another object stops touching this object's collider (2D physics only).
|Sent each frame where a collider on another object is touching this object's collider (2D physics only).
|Sent when another object enters a trigger collider attached to this object (2D physics only).
|Sent when another object leaves a trigger collider attached to this object (2D physics only).
|Sent each frame where another object is within a trigger collider attached to this object (2D physics only).
Did you find this page useful? Please give it a rating: