A list of all Actions, Conditions and Expressions supported in this addon.
Navigation
-
Actions
Move {my} forward/up to the next item
Select the next item. Safe to run every tick while an input is held.
Move {my} backward/down to the previous item
Select the previous item. Safe to run every tick while an input is held.
Move {my} to item {0}
Move a zero-based item index to the foreground.
Move {my} to child UID {0}
Move a child with a specific UID to the foreground.
Move {my} to a random item after {0} revolutions at speed {1} with {2}
Choose a random item, spin by the signed number of full revolutions, and move it to the foreground.
Set child UID {0} enabled {1} in {my}
Enable an item for selection or disable it so navigation skips it.
Refresh {my} children
Re-read the parent's direct scene-graph children after children are added or removed.
-
Conditions
{my} on item selected
Triggered when the selected item reaches the foreground.
{my} on random item selected
Triggered when a randomly selected item reaches the foreground.
{my} on move started
Triggered when the carousel starts moving.
{my} on item passed the foreground
Triggered each time an item passes the foreground during a move.
{my} on move finished
Triggered when the carousel finishes moving.
{my} is moving
True while the carousel is moving between items.
-
Expressions
ItemCount
The number of direct child items.
SelectedIndex
The zero-based index currently at the foreground, or -1 when empty.
SelectedUID
The latched UID currently at the foreground, available immediately in selection triggers, or -1 when empty.
TargetIndex
The index moving toward the foreground, or -1 when empty.
TargetUID
The UID moving toward the foreground, or -1 when empty.
IndexOfUID
Find the child index for a UID, or -1 if it is not in the carousel.
LastRandomIndex
The index chosen by the most recent random selection, or -1.
LastRandomUID
The UID chosen by the most recent random selection, or -1.
LastPassedIndex
The index that most recently passed the foreground, or -1.
LastPassedUID
The UID that most recently passed the foreground, or -1.
EnabledItemCount
The number of items currently enabled for selection.
ItemEnabled
Return 1 if a child UID is enabled for selection, otherwise 0.
ScrollDirection
Movement direction: 1 for next and -1 for previous, or 0 when idle.
DirectionName
The named movement direction for the current layout mode, or Idle.
Appearance
-
Actions
Set {my} orientation to {0}
Choose the layout mode used by the carousel.
Set {my} radius to {0}
Set the carousel radius.
Set {my} minimum opacity to {0}%
Set the opacity of items at the back.
Set {my} minimum scale to {0}%
Set the scale of items at the back.
Set {my} vertical offset to {0}
Tilt the carousel ring vertically.
Set {my} horizontal offset to {0}
Tilt the carousel ring horizontally.
Set {my} wheel selected angle to {0} degrees
Set where the selected item stops in Wheel mode.
-
Expressions
Radius
The current carousel radius.
MinimumOpacity
The minimum opacity as a percentage from 0 to 100.
MinimumScale
The minimum scale as a percentage from 0 to 100.
VerticalOffset
The current signed vertical offset in layout units.
HorizontalOffset
The current signed horizontal offset in layout units.
WheelSelectedAngle
The Wheel mode selected-item stopping point in degrees clockwise from the top.
Motion
-
Actions
Set {my} turn speed to {0} items per second
Set how quickly the carousel advances.
Set {my} looping {0}
Enable or disable wrapping at the ends.
Set {my} easing to {0}
Set the transition easing.
-
Expressions
TurnSpeed
The current speed in item positions per second.
MoveProgress
Current transition progress from 0 to 1.