Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

Cloth

class in UnityEngine

/

Inherits from: Component

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

The Cloth class provides an interface to cloth simulation physics.

Variables

bendingStiffnessBending stiffness of the cloth.
capsuleCollidersAn array of CapsuleColliders which this Cloth instance should collide with.
clothSolverFrequencyNumber of cloth solver iterations per second.
coefficientsThe cloth skinning coefficients used to set up how the cloth interacts with the skinned mesh.
collisionMassScaleHow much to increase mass of colliding particles.
dampingDamp cloth motion.
enableContinuousCollisionEnable continuous collision to improve collision stability.
enabledIs this cloth enabled?
enableTethersEnable Tether Anchors.
externalAccelerationA constant, external acceleration applied to the cloth.
frictionThe friction of the cloth when colliding with the character.
normalsThe current normals of the cloth object.
randomAccelerationA random, external acceleration applied to the cloth.
sleepThresholdCloth's sleep threshold.
sphereCollidersAn array of ClothSphereColliderPairs which this Cloth instance should collide with.
stretchingStiffnessStretching stiffness of the cloth.
useGravityShould gravity affect the cloth simulation?
useVirtualParticlesAdd one virtual particle per triangle to improve collision stability.
verticesThe current vertex positions of the cloth object.
worldAccelerationScaleHow much world-space acceleration of the character will affect cloth vertices.
worldVelocityScaleHow much world-space movement of the character will affect cloth vertices.

Public Functions

ClearTransformMotionClear the pending transform changes from affecting the cloth simulation.
SetEnabledFadingFade the cloth simulation in or out.

Inherited members

Variables

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 (null if there is none attached).
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

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