989onan bot (talk | contribs) Automated: update SyncDelegates |
add info |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
|Name=Sync Playback Editor | |Name=Sync Playback Editor | ||
}} | }} | ||
The '''SyncPlaybackEditor''' component is used to interact with and modify the playback of a Sync playback like a video, animation, or a sound player. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|_playback|{{RootFieldType|RelayRef`1|[[Type:SyncPlayback|SyncPlayback]]}}|TypeAdv0=true| | |_playback|{{RootFieldType|RelayRef`1|[[Type:SyncPlayback|SyncPlayback]]}}|TypeAdv0=true| The playback to edit and influence with this component. | ||
|_sliderValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv1=true| | |_sliderValue|{{RootFieldType|FieldDrive`1|[[Type:Float|Float]]}}|TypeAdv1=true| The field to drive with the current playback of <code>_playback</code> | ||
|_loopToggleSprite|{{RootFieldType|FieldDrive`1|[[Type:Uri|Uri]]}}|TypeAdv2=true| | |_loopToggleSprite|{{RootFieldType|FieldDrive`1|[[Type:Uri|Uri]]}}|TypeAdv2=true| The sprite URI field of the toggle loop button. Used to switch between a loop and a play once icon URI. | ||
|_speedField|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv3=true| | |_speedField|'''[[Component:FloatTextEditorParser|FloatTextEditorParser]]'''|TypeAdv3=true| The field used to change the speed of the playback of <code>_playback</code> | ||
|_slider|'''[[Component:Slider`1|Slider`1]]<[[Type:Float|Float]]>'''|TypeAdv4=true| | |_slider|'''[[Component:Slider`1|Slider`1]]<[[Type:Float|Float]]>'''|TypeAdv4=true| The slider used to change the play head/position of <code>_playback</code>. | ||
}} | }} | ||
== Sync Delegates == | == Sync Delegates == | ||
{{Table ComponentTriggers | {{Table ComponentTriggers | ||
|Play[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |Play:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Plays the playback of <code>_playback</code> | ||
|Pause[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |Pause:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Pauses the playback of <code>_playback</code> | ||
|Stop[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |Stop:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Stops the playback of <code>_playback</code> | ||
|ToggleLoop[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| | |ToggleLoop:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Toggles the looping property of the playback of <code>_playback</code> | ||
}} | }} | ||
== | == Usage == | ||
Used commonly in inspectors and video players to allow interaction with playback fields directly. | |||
== Examples == | == Examples == | ||
{{stub}} | |||
== See Also == | == See Also == | ||
| Line 30: | Line 32: | ||
[[Category:Components:Uncategorized{{#translation:}}|Sync Playback Editor]] | [[Category:Components:Uncategorized{{#translation:}}|Sync Playback Editor]] | ||
[[Category:Components{{#translation:}}|Sync Playback Editor]] | [[Category:Components{{#translation:}}|Sync Playback Editor]] | ||
Latest revision as of 15:04, 30 April 2025
Component image 
Sync Playback Editor component as seen in the Scene Inspector
The SyncPlaybackEditor component is used to interact with and modify the playback of a Sync playback like a video, animation, or a sound player.
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. |
_playback
|
direct RelayRef`1<SyncPlayback> | The playback to edit and influence with this component. |
_sliderValue
|
field drive of Float | The field to drive with the current playback of _playback
|
_loopToggleSprite
|
field drive of Uri | The sprite URI field of the toggle loop button. Used to switch between a loop and a play once icon URI. |
_speedField
|
FloatTextEditorParser | The field used to change the speed of the playback of _playback
|
_slider
|
Slider`1<Float> | The slider used to change the play head/position of _playback.
|
Sync Delegates
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|---|---|---|
Play:ButtonEventHandler
|
ButtonEventHandler | ✓ | Plays the playback of _playback
|
Pause:ButtonEventHandler
|
ButtonEventHandler | ✓ | Pauses the playback of _playback
|
Stop:ButtonEventHandler
|
ButtonEventHandler | ✓ | Stops the playback of _playback
|
ToggleLoop:ButtonEventHandler
|
ButtonEventHandler | ✓ | Toggles the looping property of the playback of _playback
|
Usage
Used commonly in inspectors and video players to allow interaction with playback fields directly.
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.