Component:ObjectGridAligner

From Resonite Wiki
This page contains changes which are not marked for translation.
Component image 
Object Grid Aligner component as seen in the Scene Inspector

The ObjectGridAligner component aligns objects into a grid of items with x number of items per row.

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. Some components stop their functionality when this field is disabled, but some don't.
AutoAddChildren Bool Controls whether slots below this component's slot in the hierarchy are automatically added to _targets.
ItemsPerRow Int How many items per row.
CellSize Float2 The space between each item.
LerpSpeed Float How fast the items should move to align themselves in the specified grid arrangement.
HorizontalAlignment Align How to align the items horizontally.
VerticalAlignment Align How to align the items vertically.
RowAxis AxisDir The axis that items should be aligned on for the horizontal axis of the grid.
ColumnAxis AxisDir The axis that items should be aligned on for the vertical axis of the grid.
Items list of Item A list of items who's positions should be driven to place them into a grid alignment using this component's calculations.

Align

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


Controls how the items should align themselves along the axis specified by the component.

Values
Name Value Description
Neg 0 Aligns items so their values are always negative along the specified alignment axis (so if using x axis, x will always be negative for an item)
Mid 1 Aligns items so half are on the negative and half are on the positive along an axis, so they take up both directions equally.
Pos 2 Aligns items so their values are always positive along the specified alignment axis (so if using x axis, x will always be positive for an item)

AxisDir

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


Values
Name Value Description
Xpos 0 Align items along the positive x axis.
Xneg 1 Align items along the negative x axis.
Ypos 2 Align items along the positive y axis.
Yneg 3 Align items along the negative y axis.
Zpos 4 Align items along the positive z axis.
Zneg 5 Align items along the negative z axis.

Item

Fields
Name Type Description
Root Slot The slot to align.
PositionDrive field drive of Float3 The position field of Root.

Usage

Can be used for aligning tiles, shelves, boxes, or anything that needs consistent alignment.

Examples

See Also