Component:SphereCollider: Difference between revisions

From Resonite Wiki
fix categories, stub, sections fixed
Format, Sync delegates
 
(7 intermediate revisions by 2 users not shown)
Line 4: Line 4:
}}
}}
The SphereCollider generates a spherical collision shape based on an inputted radius.
The SphereCollider generates a spherical collision shape based on an inputted radius.
See Also: [[Collider]]


== 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}}
|Radius|Float|
|Radius|Float| How big the sphere is from center to outside edge.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|SetFromLocalBounds()|[[Type:Action|Action]]|{{Template:SetFromLocalBounds}}
|SetFromGlobalBounds()|[[Type:Action|Action]]|{{Template:SetFromGlobalBounds}}
|SetFromPreciseBounds()|[[Type:Action|Action]]|{{Template:SetFromLocalBoundsPrecise}}
}}
}}


== Behavior ==
== Usage ==


== Examples ==
== Examples ==


== Related Components ==
== See Also ==
* [[Collider]]


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

Latest revision as of 16:16, 11 November 2024

Component image 
Sphere Collider component as seen in the Scene Inspector

The SphereCollider generates a spherical collision shape based on an inputted 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. 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.
Radius Float How big the sphere is from center to outside edge.

Sync Delegates

Triggers
Name Arguments Description
SetFromLocalBounds() 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.
SetFromGlobalBounds() 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 global space.
SetFromPreciseBounds() 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