Component:Snapper: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page Snapper (Component) to Component:Snapper: Creating component Namespace
m basic description to go alongside the behavior section instead of empty introduction header
 
(One intermediate revision by one other user not shown)
Line 4: Line 4:
|Name=Snapper
|Name=Snapper
}}
}}
 
The Snapper component allows a slot to parent to [[Component:SnapTarget|Snap Target]] slots.
== Introduction ==
{{stub}}


== Usage ==
== Usage ==
Line 13: Line 11:
|SnapCheckRadius|Float| {{stub}}
|SnapCheckRadius|Float| {{stub}}
|CheckStaticColliders|Bool| Allows the [[Snapper (Component)| Snapper]] to look for colliders that are set to Static rather then Trigger.
|CheckStaticColliders|Bool| Allows the [[Snapper (Component)| Snapper]] to look for colliders that are set to Static rather then Trigger.
|SnapTargetWhitelist|SnapTarget| List of [[SnapTarget (Component)| Snap Targets]] that the slot can attach to
|SnapTargetWhitelist|{{RootFieldType|SyncRefList`1|[[Component:SnapTarget|SnapTarget]]}}|TypeAdv3=true| List of [[SnapTarget (Component)| Snap Targets]] that the slot can attach to
|Keywords|String| List of keywords to match against a corresponding [[SnapTarget (Component)| Snap Targets]]. Can have multiple keywords to snap to multiple [[SnapTarget (Component)| Snap Targets]]
|Keywords|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv4=true| List of keywords to match against a corresponding [[SnapTarget (Component)| Snap Targets]]. Can have multiple keywords to snap to multiple [[SnapTarget (Component)| Snap Targets]]
}}
}}


Line 25: Line 23:
{{stub}}
{{stub}}


[[Category:Components|Snapper (Component)]]
[[Category:Components:Transform:Interaction{{#translation:}}|Snapper]]
[[Category:Components:Transform:Interaction|Snapper (Component)]]
[[Category:Components{{#translation:}}|Snapper]]

Latest revision as of 01:31, 20 April 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
Snapper component as seen in the Scene Inspector

The Snapper component allows a slot to parent to Snap Target slots.

Usage

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.
UseBoundingBoxCenter Bool This article or section is a Stub. You can help the Resonite Wiki by expanding it.
SnapCheckRadius Float This article or section is a Stub. You can help the Resonite Wiki by expanding it.
CheckStaticColliders Bool Allows the Snapper to look for colliders that are set to Static rather then Trigger.
SnapTargetWhitelist list of SnapTarget List of Snap Targets that the slot can attach to
Keywords direct SyncFieldList`1<String> List of keywords to match against a corresponding Snap Targets. Can have multiple keywords to snap to multiple Snap Targets

Behavior

Allows the slot in which this component resides in to snap to a Snap Target in another slot. The SnapTargetWhitelist allows you to specify a list of SnapTargets that this component will link to in case you want to limit its snapability. The keywords list allows you to provide a list of words which the Snap Target can use to filter for specific types of snappers.

It is important to have this in a slot shared with a Grabbable component in the root link of the object you wish to snap. Snapped components will become children of the snap target.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.