Component:ObjectScroller

From Resonite Wiki
Revision as of 04:15, 31 January 2025 by 989onan (talk | contribs) (add info)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
Object Scroller component as seen in the Scene Inspector

The ObjectScroller component acts as a way to scroll a list of items with sizes by offsetting them within a region they should appear within. Objects outside of the region get disabled until the Offset allows them to appear within it again.

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.
Items list of Item A list of items to move and activate/deactivate if they are within/outside of the RegionSize
Offset Float3 How much to offset the positions of Items in order to scroll them.
RegionSize Float3 The size area objects have to be touching from their current position and size after Offset is applied in order to stay visible.

Item

Fields
Name Type Description
Position Float3 Original position of the item before Offset.
Size Float3 The size of this item.
PositionDrive field drive of Float3 Drives the item's position so Offset can affect it.
ScaleDrive field drive of Float3 Used to scale the item down if the item cannot fit within RegionSize at its current position.
ActiveDrive field drive of Bool Used to enable/disable the item if it's inside/outside of RegionSize.

Usage

Attach to a slot and add/setup Items entries to begin use.

Examples

Can be used to make a conveyor belt of items or a sliding wardrobe of avatars.

See Also