Skip to content

Sound

An Entity can have a single physical representation. Sound can be turned on and off with active (which is distinct to entity visible flag). Sound derives from Entity so if you have a Sound you can do any of these functions as well as the functions in Entity. You can do entity:IsA(Sound) to see if a particular entity variable is a Sound type entity.

Parameters

Parameter Name Usage Description Notes
active bool active Set whether the sound is playing or not.
sound SoundAsset sound Set the SoundAsset that this entity plays
volume number volume Set the volume of the sound (0 = Silent, 1 = Full volume)
pitch number pitch Set the pitch of the sound (1 = Default pitch, 0.125 = 8 times slower, 2 = 2 times faster)

Overrides

Override Name Usage Description Notes
new_index sound.var = object value