Component:SnapPoint: Difference between revisions

Latest revision as of 19:05, 29 February 2024

Component image

**Snap Point** component as seen in the Scene Inspector

A snap point is a component that when called by another component always returns the point of the slot it is on (0,0,0). Usually this is used in components like the Multi User Avatar Anchor Component to determine where to place the anchors upon clicking (click point is used in such case). This component will take a given point by another component and return the position the slot is on, acting as a nullifier of incoming data.

The functionality of this component is internal, and cannot be used by ProtoFlux to snap points using in game code.

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.
`SnapParent`	Slot	Where to put slots if the component is being used for slot placement.

Usage

Used as an anchor point generator in the Multi User Avatar Anchor Component and drawing tools.

Examples

Related Components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=SnapPointComponent.png
 |Name=Snap Point
 }}
+A snap point is a component that when called by another component always returns the point of the slot it is on (0,0,0). Usually this is used in components like the [[Component:MultiUserAvatarAnchor|Multi User Avatar Anchor Component]] to determine where to place the anchors upon clicking (click point is used in such case). This component will take a given point by another component and return the position the slot is on, acting as a nullifier of incoming data.
+The functionality of this component is internal, and cannot be used by [[ProtoFlux]] to snap points using in game code.
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|SnapParent|Slot|
+|SnapParent|Slot| Where to put slots if the component is being used for slot placement.
 }}
 <!--T:3-->
 == Usage ==
+Used as an anchor point generator in the [[Component:MultiUserAvatarAnchor|Multi User Avatar Anchor Component]] and drawing tools.
 <!--T:4-->
@@ Line 23: / Line 26: @@
 == Related Components ==
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Snap Point]]
 [[Category:Components:Transform:Snapping{{#translation:}}|Snap Point]]