Sound Effect

SoundEffect

STD Library
Component
Combine:
Transform
Playable
Loopable

The sound entity represents a playing sound effect.

Properties

Name Type Description Script Name
Resource SoundEffect Type Resource path, default is empty Resource
Times played Int Play count, default is 1 RepeatTimes
Volume Int Volume, default is 50 Volume
Max. Distance Float Max. Distance MaxDistance
Min. Distance Float Min. Distance MinDistance
Is 3D Bool Whether the music is 3D or not Is3D
Priority Int Priority Priority
Start Time Float Wait time before start, in seconds StartTime
Is Playing Int Read Only
Is Playing
IsPlaying
Elapsed Time (ms) Int Read Only
The playback duration of the sound effect in milliseconds. This property can only be accessed on the client side.
ElapsedTime