Component:ButtonLoopSet: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
This is no longer a stub. Added a description, added field descriptions, added usage description.
 
Line 3: Line 3:
|Name=Button Loop Set
|Name=Button Loop Set
}}
}}
{{stub}}


== Usage ==
The '''ButtonLoopSet''' component takes in an [[Type:IPlayable|IPlayable]]. When an [[Type:IButton|IButton]] is pressed while this component is in the same [[Slot|slot]], it will set the loop on this playable media depending on what is set up in this component.
 
{{Table ComponentFields
{{Table ComponentFields
|Playback|IPlayable|
|Playback|IPlayable| The referenced playable media.
|OnPress|LoopSetOptions|
|OnPress|LoopSetOptions| Sets the type of loop for this media when pressed.
|OnRelease|LoopSetOptions|
|OnRelease|LoopSetOptions| Sets the type of loop for this media when released.
}}
}}


== Behavior ==
== Usage ==
Basically a loop button that can be setup anywhere.


== Examples ==
== Examples ==
Line 20: Line 21:
[[Category:Components:Common UI:Button Interactions:Media{{#translation:}}|Button Loop Set]]
[[Category:Components:Common UI:Button Interactions:Media{{#translation:}}|Button Loop Set]]
[[Category:Components{{#translation:}}|Button Loop Set]]
[[Category:Components{{#translation:}}|Button Loop Set]]
[[Category:ComponentStubs]]

Latest revision as of 01:39, 12 September 2024

Component image 
Button Loop Set component as seen in the Scene Inspector


The ButtonLoopSet component takes in an IPlayable. When an IButton is pressed while this component is in the same slot, it will set the loop on this playable media depending on what is set up in this component.

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.
Playback IPlayable The referenced playable media.
OnPress LoopSetOptions Sets the type of loop for this media when pressed.
OnRelease LoopSetOptions Sets the type of loop for this media when released.

Usage

Basically a loop button that can be setup anywhere.

Examples

See Also