Garry's Mod Wiki

Home / CreateSound

CreateSound

  CSoundPatch CreateSound( Entity targetEnt, string soundName, CRecipientFilter filter = nil )
Search Github

Description

Returns a sound parented to the specified entity.

You can only create one CSoundPatch per audio file, per entity at the same time.
Valid sample rates: 11025 Hz, 22050 Hz and 44100 Hz, otherwise you may see this kind of message:

Unsupported 32-bit wave file your_sound.wav and Invalid sample rate (48000) for sound 'your_sound.wav'

Arguments

1 Entity targetEnt
The target entity.
2 string soundName
The sound to play. (Sound path or a soundscript) Soundscript Characters are supported.
3 CRecipientFilter filter = nil
A CRecipientFilter of the players that will have this sound networked to them.

If not set, the default is a CPASAttenuationFilter.

This argument only works serverside.

Returns

1 CSoundPatch
The sound object. You should keep a reference to this object for as long as you wish the sound to play!

Example

Play a sound everywhere, similar to surface.PlaySound but available clientside and serverside.

local LoadedSounds if CLIENT then LoadedSounds = {} -- this table caches existing CSoundPatches end local function ReadSound( FileName ) local sound local filter if SERVER then filter = RecipientFilter() filter:AddAllPlayers() end if SERVER or !LoadedSounds[FileName] then -- The sound is always re-created serverside because of the RecipientFilter. sound = CreateSound( game.GetWorld(), FileName, filter ) -- create the new sound, parented to the worldspawn (which always exists) if sound then sound:SetSoundLevel( 0 ) -- play everywhere if CLIENT then LoadedSounds[FileName] = { sound, filter } -- cache the CSoundPatch end end else sound = LoadedSounds[FileName][1] filter = LoadedSounds[FileName][2] end if sound then if CLIENT then sound:Stop() -- it won't play again otherwise end sound:Play() end return sound -- useful if you want to stop the sound yourself end -- When we are ready, we play the sound: ReadSound( "phx/hmetal1.wav" )

Account Management

Special Pages

Wiki List