Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

CompositeCollider2D

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

Submission failed

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

Cancel

Switch to Manual

Description

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.

Variables

edgeRadiusControls the radius of all edges created by the Collider.
generationTypeSpecifies when to generate the Composite Collider geometry.
geometryTypeSpecifies the type of geometry the Composite Collider should generate.
pathCountThe number of paths in the Collider.
pointCountGets the total number of points in all the paths within the Collider.
vertexDistanceControls the minimum distance allowed between generated vertices.

Public Functions

GenerateGeometryRegenerates the Composite Collider geometry.
GetPathGets a path from the Collider by its index.
GetPathPointCountGets the number of points in the specified path from the Collider by its index.

Inherited members

Variables

enabledEnabled Behaviours are Updated, disabled Behaviours are not.
isActiveAndEnabledHas the Behaviour had enabled called.
attachedRigidbodyThe Rigidbody2D attached to the Collider2D.
bouncinessGet the bounciness used by the collider.
boundsThe world space bounding area of the collider.
compositeGet the CompositeCollider2D that is available to be attached to the collider.
densityThe density of the collider used to calculate its mass (when auto mass is enabled).
frictionGet the friction used by the collider.
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.
usedByCompositeSets whether the Collider will be used or not used by a CompositeCollider2D.
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

CastCasts the collider shape into the scene starting at the collider position ignoring the collider itself.
DistanceCalculates the minimum separation of this collider against another collider.
GetContactsRetrieves all contact points for this collider.
IsTouchingCheck whether this collider is touching the collider or not.
IsTouchingLayersChecks whether this collider is touching any colliders on the specified layerMask or not.
OverlapColliderGet a list of all colliders that overlap this collider.
OverlapPointCheck if a collider overlaps a point in space.
RaycastCasts a ray into the scene starting at the collider position ignoring the collider itself.
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.
InstantiateClones the object original and returns the clone.

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).
对文档有任何疑问,请移步至开发者社区提问,我们将尽快为您解答