Component:CapsuleCollider: Difference between revisions

From Resonite Wiki
Automated: update Replace
Fix Sync delegates
 
Line 4: Line 4:
}}
}}
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.
The CapsuleCollider is used in [[Locomotion Modules (Slot)|Locomotion Modules]] to represent the player's width and height.


== Fields ==
== Fields ==
Line 18: Line 20:
== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|SetFromExactCylinder()|[[Type:Action|Action]]|
|SetFromExactCylinder()|[[Type:Action|Action]]|{{Template:SetFromLocalBoundsPrecise}}
}}
}}
== Usage ==


== Examples ==
== Examples ==


* The CapsuleCollider is used in [[Locomotion Modules (Slot)|Locomotion Modules]] to represent the player's width and height.
== See Also ==
* [[Collider]]


[[Category:Components:Physics:Colliders{{#translation:}}|Capsule Collider]]
[[Category:Components:Physics:Colliders{{#translation:}}|Capsule Collider]]
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Capsule Collider]]
[[Category:Components{{#translation:}}|Capsule Collider]]

Latest revision as of 16:11, 11 November 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.

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

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. according to ProbablePrime this is in 1 KG per cubic meter.
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.

Sync Delegates

Triggers
Method Name Method type and Arguments. Description
SetFromExactCylinder() Action Gathers all objects and slots under this component's slot, creates a Bounding box that encapsulates all the points and Bounding boxes, and uses the Bounding box to set this component's values. Does all calculations in local space. Ignores floating point error.

Usage

Examples

See Also