Component:CapsuleCollider: Difference between revisions

From Resonite Wiki
mNo edit summary
No edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Infobox Component
|Image=CapsuleCollider.png
|Name=Capsule Collider
}}
The CapsuleCollider component creates a simple capsule collision shape from the defined height and radius.
The CapsuleCollider component creates a simple capsule collision shape from the defined height and radius.


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Offset|Float3|
|Offset|Float3| {{Template:ColliderOffsetField}}
|Type|ColliderType|
|Type|ColliderType| {{Template:ColliderTypeField}}
|Mass|Float|
|Mass|Float| {{Template:ColliderMassField}}
|CharacterCollider|Bool|
|CharacterCollider|Bool| {{Template:ColliderCharacterColliderField}}
|IgnoreRaycasts|Bool|
|IgnoreRaycasts|Bool| {{Template:ColliderIgnoreRaycastsField}}
|Height|Float|
|Height|Float| The height of the capsule. Does not include the added height from the rounded ends
|Radius|Float|
|Radius|Float| the radius of the body of the capsule and it's rounded ends.
}}
}}


Line 15: Line 19:


* The CapsuleCollider is used in [[Locomotion Modules (Slot)|Locomotion Modules]] to represent the player's width and height.
* The CapsuleCollider is used in [[Locomotion Modules (Slot)|Locomotion Modules]] to represent the player's width and height.
[[Category:Components:Physics:Colliders{{#translation:}}|Capsule Collider]]
[[Category:Components{{#translation:}}|Capsule Collider]]

Latest revision as of 20:33, 14 October 2024

Component image 
Capsule Collider component as seen in the Scene Inspector

The CapsuleCollider component creates a simple capsule collision shape from the defined height and radius.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
Offset Float3 The offset of the collider shape's position from the slot's position.
Type ColliderType The type of collider. See the enum page for details.
Mass Float How heavy this collider is in total.
CharacterCollider Bool Whether an avatar should be prevented from moving into the collider's volume.
IgnoreRaycasts Bool Whether an avatar's laser should be prevented from hitting the collider's volume. Also this applies to raycasting nodes or components.
Height Float The height of the capsule. Does not include the added height from the rounded ends
Radius Float the radius of the body of the capsule and it's rounded ends.

Examples

  • The CapsuleCollider is used in Locomotion Modules to represent the player's width and height.