Component:IsPlayingDriver: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Is Playing Driver
|Name=Is Playing Driver
}}
}}
{{stub}}
The '''IsPlayingDriver''' component checks if a particular [[Type:SyncPlayback|SyncPlayback]] is currently playing, and drives a set of [[Type:Bool|Bool]] to reflect this status.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Playback|SyncPlayback|
|Playback|SyncPlayback| The playback to check if it is playing
|Targets|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]<[[Type:Bool|Bool]]>}}|TypeAdv1=true|
|Targets|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]&lt;[[Type:Bool|Bool]]&gt;}}|TypeAdv1=true| The set of booleans to drive to whether or not <code>Playback</code> is playing or not.
}}
}}


== Behavior ==
== Usage ==
Attach to a slot and provide a value for <code>Playback</code> then any boolean in the list of <code>Targets</code> will drive to whether or not <code>Playback</code> is currently playing.


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
* [[Component:PlaybackStateDriver]]


[[Category:Components:Media:Utility{{#translation:}}|Is Playing Driver]]
[[Category:Components:Media:Utility{{#translation:}}|Is Playing Driver]]
[[Category:Components{{#translation:}}|Is Playing Driver]]
[[Category:Components{{#translation:}}|Is Playing Driver]]
[[Category:ComponentStubs]]

Latest revision as of 18:23, 13 November 2024

Component image 
Is Playing Driver component as seen in the Scene Inspector

The IsPlayingDriver component checks if a particular SyncPlayback is currently playing, and drives a set of Bool to reflect this status.

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.
Playback SyncPlayback The playback to check if it is playing
Targets list of FieldDrive`1<Bool> The set of booleans to drive to whether or not Playback is playing or not.

Usage

Attach to a slot and provide a value for Playback then any boolean in the list of Targets will drive to whether or not Playback is currently playing.

Examples

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


See Also