Component:SnapGrid

CollapseComponent 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 Collapse

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.
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	field drive of 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 drawing tools.