diff --git a/CapsuleColliderHelper.md b/CapsuleColliderHelper.md new file mode 100644 index 0000000..4e5a92f --- /dev/null +++ b/CapsuleColliderHelper.md @@ -0,0 +1,35 @@ +# CapsuleColliderHelper + + +## Component: GameObject + + +| The component attached to the Capsule Collider. We use this as a simple way to retrieve information from the Capsule Collider in one call and send the information to the GPU. | ![https://i.imgur.com/lmADk5H.png](https://i.imgur.com/lmADk5H.png) | +| -------- | -------- | + +## Friction +Float: Min 0, Max 1, Default 0.8. ++ Low Friction (e.g., 0.1): The cloth will slide more easily over the surface. It will maintain more of its velocity when colliding with the collider. ++ High Friction (e.g., 0.9): The cloth will "stick" more to the surface. It will lose more of its velocity when colliding with the collider. ++ High Friction (e.g., 1.0): The cloth will behave as if it's "stuck" to the surface, maintaining its position relative to the collider. + +## Gizmo Color +Color: Default Green. ++ Changes the color of the outliner for the Capsule Collider. + +----- + +# API +## GetCollidableCapsuleStruct() + ++ Returns the following Struct: +```csharp +public struct CollidableCapsuleStruct { + public Vector3 center; + public Vector3 rotation; + public Vector3 direction; + public float radius; + public float length; + public float friction; +} +``` \ No newline at end of file