Difference between revisions of "CircleAligner (Component)"
Jump to navigation
Jump to search
Circle Aligner component as seen in the Scene Inspector
(Added field description) |
(Wrote Article) |
||
| Line 7: | Line 7: | ||
|Name=Circle Aligner | |Name=Circle Aligner | ||
}} | }} | ||
| + | |||
| + | The CircleAligner component is used to position a list of slots in a circle. | ||
<!--T:2--> | <!--T:2--> | ||
| Line 12: | Line 14: | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|AutoAddChildren|Bool| Controls whether slots below this component's slot in the hierarchy are automatically added to <code>_targets</code> | |AutoAddChildren|Bool| Controls whether slots below this component's slot in the hierarchy are automatically added to <code>_targets</code> | ||
| − | |Axis|Float3| | + | |Axis|Float3| The axis around which the slots will be aligned. |
| − | |Radius|Float| | + | |Radius|Float| The radius of the circle that the slots will be positioned on. |
| − | |Offset|Float| | + | |Offset|Float| Offsets the starting position of the circle. |
| − | |Arc|Float| | + | |Arc|Float| 360 by default. If smaller, the slots will only fill that section of a circle. Likewise, if it is larger than 360, the slots will wrap around the circle multiple times. |
| − | |FillWholeArc|Bool| | + | |FillWholeArc|Bool| If true, the last slot will be at the very end of the arch, otherwise there will be a gap after the last slots. |
| − | |RotationOffset|Float| | + | |RotationOffset|Float| An offset, in degrees, that is applied to the rotation of the target slots. |
| − | |Items|SyncList`1|TypeString7=SyncList<Item>| | + | |Items|SyncList`1|TypeString7=SyncList<Item>| The list of slots to be aligned. |
}} | }} | ||
| Line 29: | Line 31: | ||
* [https://www.youtube.com/watch?v=5nX-eb9p9s4 CircleAligner tutorial] by [[User:ProbablePrime|ProbablePrime]] | * [https://www.youtube.com/watch?v=5nX-eb9p9s4 CircleAligner tutorial] by [[User:ProbablePrime|ProbablePrime]] | ||
| + | <!--T:5--> | ||
| + | == Related Issues == | ||
| + | [https://github.com/Neos-Metaverse/NeosPublic/issues/2354 #2354 - Add the LerpSpeed property to all aligner components] | ||
| − | <!--T: | + | <!--T:6--> |
== Related Components == | == Related Components == | ||
</translate> | </translate> | ||
Latest revision as of 10:27, 25 December 2021
This article or section is a Stub. You can help the Neos Wiki by expanding it.
The CircleAligner component is used to position a list of slots in a circle.
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 |
AutoAddChildren
|
Bool | Controls whether slots below this component's slot in the hierarchy are automatically added to _targets
|
Axis
|
Float3 | The axis around which the slots will be aligned. |
Radius
|
Float | The radius of the circle that the slots will be positioned on. |
Offset
|
Float | Offsets the starting position of the circle. |
Arc
|
Float | 360 by default. If smaller, the slots will only fill that section of a circle. Likewise, if it is larger than 360, the slots will wrap around the circle multiple times. |
FillWholeArc
|
Bool | If true, the last slot will be at the very end of the arch, otherwise there will be a gap after the last slots. |
RotationOffset
|
Float | An offset, in degrees, that is applied to the rotation of the target slots. |
Items
|
SyncList<Item> | The list of slots to be aligned. |
Usage
Examples
Related Issues
#2354 - Add the LerpSpeed property to all aligner components