#Interface: WorldSoundOptions

world sound

Beta

Contains additional options for a playSound occurrence.

#Properties

#isBroadcast?

optional isBroadcast?: boolean

Beta

---

#loopCount?

optional loopCount?: number

Beta

#Remarks

Number of additional times to repeat the sound after the initial play. 0 (the default) plays the sound once, -1 loops it forever, and a positive integer N plays the sound N + 1 times in total. For example, loopCount: 1 plays the sound twice. The loop count is fixed when the sound starts and cannot be changed afterward. When using -1, see SoundInstance for handle lifetime requirements.

---

#pitch?

optional pitch?: number

Beta

#Remarks

Pitch of the sound played.

---

#volume?

optional volume?: number

Beta

#Remarks

Relative volume and space by which this sound is heard.

#同领域相关

• LocationOutOfWorldBoundariesError
• PlayerSoundOptions
• SoundCompletedAfterEvent
• SoundCompletedAfterEventSignal
• SoundDefinition
• SoundDefinitionDurationInfo