added much more info. still a stub though |
not a stub |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=SnapGridComponent.png | |Image=SnapGridComponent.png | ||
| Line 17: | Line 16: | ||
|BoundsSize|Float3| How big the grid is in total, and determines the total size available for grid points to take up | |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. | |GridSize|Float3| How big each grid point is, or in other words, how far apart they are. | ||
|ColliderSize| | |ColliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv2=true| {{Stub}} | ||
|SnapParent|Slot| Where to put slots if the component is being used for slot placement. | |SnapParent|Slot| Where to put slots if the component is being used for slot placement. | ||
}} | }} | ||
| Line 23: | Line 22: | ||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == Usage == | ||
Used as an anchor point generator in the [[Component:MultiUserAvatarAnchor|Multi User Avatar Anchor Component]] and | Used as an anchor point generator in the [[Component:MultiUserAvatarAnchor|Multi User Avatar Anchor Component]] and drawing tools. | ||
<!--T:4--> | <!--T:4--> | ||
| Line 31: | Line 30: | ||
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Snap Grid]] | [[Category:Components{{#translation:}}|Snap Grid]] | ||
[[Category:Components:Transform:Snapping{{#translation:}}|Snap Grid]] | [[Category:Components:Transform:Snapping{{#translation:}}|Snap Grid]] | ||
Latest revision as of 17:52, 26 October 2024
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
| 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
|
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.