Add some info, will need to find out what GracePeriod does |
Finish, remove stub category |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
|Name=Stopped Playable Cleaner | |Name=Stopped Playable Cleaner | ||
}} | }} | ||
Stopped playable cleaner is used on [[ProtoFlux:Play One Shot|play one shots]] in order to delete or clean them once they have finished playing. | |||
Stopped playable cleaner is used on [[ProtoFlux: | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Playable|IPlayable| the audio player that is playing audio | |Playable|IPlayable| the audio player that is playing audio | ||
|GracePeriod|Float| | |GracePeriod|Float| How long to wait before deleting the component after it has finished playing. | ||
|CheckingUser|User| The user that is monitoring the <code>Playable</code> on their machine to check when it has stopped playing | |CheckingUser|User| The user that is monitoring the <code>Playable</code> on their machine to check when it has stopped playing | ||
}} | }} | ||
| Line 19: | Line 18: | ||
== See Also == | == See Also == | ||
* [[ProtoFlux: | * [[ProtoFlux:Play One Shot|Play One Shot ProtoFlux Node]] | ||
* [[Component:AudioClipPlayer|Audio Clip Player Component]] | * [[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]] | ||
Latest revision as of 05:22, 13 November 2024
Component image File:StoppedPlayableCleanerComponent.pngStopped Playable Cleaner component as seen in the Scene Inspector
Stopped playable cleaner is used on play one shots in order to delete or clean 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 | How long to wait before deleting the component after it has finished playing. |
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.