Automated: create new component page |
Add some info, will need to find out what GracePeriod does |
||
| Line 4: | Line 4: | ||
}} | }} | ||
{{stub}} | {{stub}} | ||
Stopped playable cleaner is used on [[ProtoFlux:PlayOneShot|play one shots]] in order to delete them once they have finished playing. | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Playable|IPlayable| | |Playable|IPlayable| the audio player that is playing audio | ||
|GracePeriod|Float| | |GracePeriod|Float| | ||
|CheckingUser|User| | |CheckingUser|User| The user that is monitoring the <code>Playable</code> on their machine to check when it has stopped playing | ||
}} | }} | ||
== Behavior == | == Behavior == | ||
This component can stop working if the user is AFK or the slot is disabled, and can cause issues in items like boopers and overload the sound buffer. | |||
== Examples == | == Examples == | ||
== See Also == | == See Also == | ||
* [[ProtoFlux:PlayOneShot|Play One Shot ProtoFlux Node]] | |||
* [[Component:AudioClipPlayer|Audio Clip Player Component]] | |||
[[Category:Components:Utility{{#translation:}}|Stopped Playable Cleaner]] | [[Category:Components:Utility{{#translation:}}|Stopped Playable Cleaner]] | ||
[[Category:Components{{#translation:}}|Stopped Playable Cleaner]] | [[Category:Components{{#translation:}}|Stopped Playable Cleaner]] | ||
[[Category:ComponentStubs]] | [[Category:ComponentStubs]] | ||
Revision as of 16:40, 18 October 2024
Component image File:StoppedPlayableCleanerComponent.pngStopped Playable Cleaner component as seen in the Scene Inspector
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Stopped playable cleaner is used on play one shots in order to delete them once they have finished playing.
Usage
| 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. |
Playable
|
IPlayable | the audio player that is playing audio |
GracePeriod
|
Float | |
CheckingUser
|
User | The user that is monitoring the Playable on their machine to check when it has stopped playing
|
Behavior
This component can stop working if the user is AFK or the slot is disabled, and can cause issues in items like boopers and overload the sound buffer.