Component:SnapGrid: Difference between revisions

From Resonite Wiki
m ProbablePrime moved page SnapGrid (Component) to Component:SnapGrid: Creating component Namespace
added much more info. still a stub though
Line 7: Line 7:
|Name=Snap Grid
|Name=Snap Grid
}}
}}
A snap grid is a component that is able to generate a point in a grid of points given a point by another component. 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). Since this generates a grid of points, it takes the inserted point and rounds it to the nearest grid point, then returns it to the component that called it.
The functionality of this component is internal, and cannot be used by [[ProtoFlux]] to snap points using in game code.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|BoundsSize|Float3|
|BoundsSize|Float3| How big the grid is in total, and determines the total size available for grid points to take up
|GridSize|Float3|
|GridSize|Float3| How big each grid point is, or in other words, how far apart they are.
|ColliderSize|IField`1|TypeString2=IField<float3>|
|ColliderSize|IField`1|TypeString2=IField<float3>| {{Stub}}
|SnapParent|Slot|
|SnapParent|Slot| Where to put slots if the component is being used for slot placement.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Used as an anchor point generator in the [[Component:MultiUserAvatarAnchor|Multi User Avatar Anchor Component]] and other components.


<!--T:4-->
<!--T:4-->

Revision as of 18:45, 29 February 2024


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


Component image 
Snap Grid component as seen in the Scene Inspector


A snap grid is a component that is able to generate a point in a grid of points given a point by another component. 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). Since this generates a grid of points, it takes the inserted point and rounds it to the nearest grid point, then returns it to the component that called it.

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.
BoundsSize Float3 How big the grid is in total, and determines the total size available for grid points to take up
GridSize Float3 How big each grid point is, or in other words, how far apart they are.
ColliderSize IField<float3> This article or section is a Stub. You can help the Resonite Wiki by expanding it.
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 other components.

Examples

Related Components