Component:BoxCollider: Difference between revisions

From Resonite Wiki
add info
Automated: update Replace
 
(2 intermediate revisions by the same user not shown)
Line 11: Line 11:
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Offset|Float3| How much to offset the center of this collider relative to the slot it is on
|Offset|Float3| {{Template:ColliderOffsetField}}
|Type|ColliderType| The type of this collider. See the enum page for details.
|Type|ColliderType| {{Template:ColliderTypeField}}
|Mass|Float| How heavy this collider is in total.
|Mass|Float| {{Template:ColliderMassField}}
|CharacterCollider|Bool| Whether this should physically stop character controllers like players.
|CharacterCollider|Bool| {{Template:ColliderCharacterColliderField}}
|IgnoreRaycasts|Bool| Whether raycast operations like guns should hit this collider.
|IgnoreRaycasts|Bool| {{Template:ColliderIgnoreRaycastsField}}
|Size|Float3| How big locally this collider is in the x, y, and z directions.
|Size|Float3| How big locally this collider is in the x, y, and z directions.
}}
== Sync Delegates ==
{{Table ComponentTriggers
|SetFromLocalBounds()|[[Type:Action|Action]]|
|SetFromGlobalBounds()|[[Type:Action|Action]]|
|SetFromLocalBoundsPrecise()|[[Type:Action|Action]]|
|SetFromGlobalBoundsPrecise()|[[Type:Action|Action]]|
}}
}}


Line 30: Line 38:
</translate>
</translate>
[[Category:Components{{#translation:}}|Box Collider]]
[[Category:Components{{#translation:}}|Box Collider]]
[[Category:ComponentStubs]]
[[Category:Components:Physics:Colliders{{#translation:}}|Box Collider]]
[[Category:Components:Physics:Colliders{{#translation:}}|Box Collider]]

Latest revision as of 21:06, 6 November 2024

Component image 
Box Collider component as seen in the Scene Inspector

Representing a simple box, this collider is the second most performant collider in the game, beaten by Sphere Colliders

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.
Size Float3 How big locally this collider is in the x, y, and z directions.

Sync Delegates

Triggers
Name Arguments Description
SetFromLocalBounds() Action
SetFromGlobalBounds() Action
SetFromLocalBoundsPrecise() Action
SetFromGlobalBoundsPrecise() Action

Usage

Examples

This is useful for floors and walls, and can also be set to NoCollide and used as a way to mark an area for a custom culling system.

Related Components