Component:CircleAligner: Difference between revisions

From Resonite Wiki
fix
add info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=CircleAlignerComponent.png
|Image=CircleAlignerComponent.png
|Name=Circle Aligner
|Name=Circle Aligner
}}
}}
 
The '''CircleAligner''' component is used to position a list of slots in a circle.
The CircleAligner component is used to position a list of slots in a circle.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{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>Items</code>
|AutoAddIgnoreTags|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true|
|AutoAddIgnoreTags|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv1=true| If a slot has a Tag matching one of the tags in this list, it will not be auto added to <code>Items</code>
|Axis|Float3| The axis around which the slots will be aligned.
|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.
|Radius|Float| The radius of the circle that the slots will be positioned on.
Line 25: Line 23:


== Item ==
== Item ==
{{stub}}
{{Table TypeFields
{{Table TypeFields
|Root|Slot| The slot to align.
|AngleOffset|Float| The offset amount of degrees the object should rotate from the default of pointing towards the center.
|_position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv2=true| The position field of <code>Root</code>.
|_rotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv3=true| The Rotation field of <code>Root</code>.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{stub}}


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
* [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 ==


<!--T:6-->
<!--T:6-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Circle Aligner]]
[[Category:Components{{#translation:}}|Circle Aligner]]
[[Category:Components With Nested Types{{#translation:}}|Circle Aligner]]
[[Category:Components With Nested Types{{#translation:}}|Circle Aligner]]
[[Category:Components:Transform:Drivers{{#translation:}}|Circle Aligner]]
[[Category:Components:Transform:Drivers{{#translation:}}|Circle Aligner]]

Latest revision as of 19:27, 2 January 2025

Component image 
Circle Aligner component as seen in the Scene Inspector

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 Items
AutoAddIgnoreTags direct SyncFieldList`1<String> If a slot has a Tag matching one of the tags in this list, it will not be auto added to Items
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 list of Item The list of slots to be aligned.

Item

Fields
Name Type Description
Root Slot The slot to align.
AngleOffset Float The offset amount of degrees the object should rotate from the default of pointing towards the center.
_position field drive of Float3 The position field of Root.
_rotation field drive of FloatQ The Rotation field of Root.

Usage

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


Examples

See Also