Component:SnapTarget: Difference between revisions

Revision as of 21:34, 3 March 2024

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

Component image

**SnapTarget** component as seen in the Scene Inspector

Introduction

The SnapTarget component allows a slot with a Snapper Component to attach to this slot.

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. Some components stop their functionality when this field is disabled, but some don't.
`SnapperWhitelist`	list of Snapper	List of Snappers that are allowed to attach to this component
`SnapperKeywordWhitelist`	direct SyncFieldList`1<String>	List of keywords to match against a corresponding Snapper
`Filters`	list of SnapperFilter	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`DirectSnapOnly`	Bool	Unused
`MaximumSnapDistance`	Float	The maximum distance the Snapper can snap with the Target. This value drives the SphereCollider radius
`MaximumAngleDeviation`	Float	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`AnimationTime`	Float	The time it takes for the Snapper to lerp to the Target
`AutoSnap`	Bool	This article or section is a Stub. You can help the Resonite Wiki by expanding it.
`_snapColliderRadius`	field drive of Float	The radius drive reference of the SphereCollider
`proxySphere`	SphereCollider	Reference of the SphereCollider that is added on adding the SnapTarget to a slot

Behavior

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

Examples

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

Related Components

@@ Line 8: / Line 8: @@
 == Usage ==
 {{Table ComponentFields
-|SnapperWhitelist|Snapper| List of [[Snapper (Component)|Snappers]] that are allowed to attach to this component
+|SnapperWhitelist|{{RootFieldType|SyncRefList`1|[[Component:Snapper|Snapper]]}}|TypeAdv0=true| List of [[Snapper (Component)|Snappers]] that are allowed to attach to this component
-|SnapperKeywordWhitelist|String| List of keywords to match against a corresponding [[Snapper (Component)|Snapper]]
+|SnapperKeywordWhitelist|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true| List of keywords to match against a corresponding [[Snapper (Component)|Snapper]]
-|Filters|SnapperFilter| {{stub}}
+|Filters|{{RootFieldType|SyncDelegateList`1|[[Type:SnapperFilter|SnapperFilter]]}}|TypeAdv2=true| {{stub}}
 |DirectSnapOnly|Bool| ''Unused''
 |MaximumSnapDistance|Float| The maximum distance the [[Snapper (Component)|Snapper]] can snap with the Target. This value drives the [[SphereCollider (Component)|SphereCollider]] radius
@@ Line 16: / Line 16: @@
 |AnimationTime|Float| The time it takes for the [[Snapper (Component)|Snapper]] to lerp to the Target
 |AutoSnap|Bool| {{stub}}
-|_snapColliderRadius|Float| The radius drive reference of the [[SphereCollider (Component)|SphereCollider]]
+|_snapColliderRadius|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv8=true| The radius drive reference of the [[SphereCollider (Component)|SphereCollider]]
-|proxySphere|SphereCollider| Reference of the [[SphereCollider (Component)|SphereCollider]] that is added on adding the [[SnapTarget (Component)|SnapTarget]] to a slot
+|proxySphere|'''[[Component:SphereCollider|SphereCollider]]'''|TypeAdv9=true| Reference of the [[SphereCollider (Component)|SphereCollider]] that is added on adding the [[SnapTarget (Component)|SnapTarget]] to a slot
 }}
@@ Line 26: / Line 26: @@
 == Related Components ==
-[[Category:Components|SnapTarget (Component)]]
+[[Category:Components:Transform:Interaction{{#translation:}}|Snap Target]]
-[[Category:Components:Transform:Interaction|SnapTarget (Component)]]
+[[Category:Components{{#translation:}}|Snap Target]]