Garry's Mod Wiki

Revision Difference

Global.EmitSound#547071

<function name="EmitSound" parent="Global" type="libraryfunc"> <description> Emits the specified sound at the specified position. <bug>Sounds must be precached serverside manually before they can be played. <page>util.PrecacheSound</page> does not work for this purpose, <page>Entity:EmitSound</page> does the trick</bug> </description> <realm>Shared</realm> <args> <arg name="soundName" type="string">The sound to play</arg>⤶ <arg name="soundName" type="string">The sound to play⤶ ⤶ This should either be a sound script name (<page>sound.Add</page>) or a file path relative to the `sound/` folder. (Make note that it's not sound**s**)⤶ </arg>⤶ <arg name="position" type="Vector">The position where the sound is meant to play, used only for a network filter (`CPASAttenuationFilter`) to decide which players will hear the sound.</arg> <arg name="entity" type="number">The entity to emit the sound from. Can be an <page>Entity:EntIndex</page> or one of the following: * `0` - Plays sound on the world (position set to `0,0,0`) * `-1` - Plays sound on the local player (on server acts as `0`) * `-2` - Plays UI sound (position set to `0,0,0`, no spatial sound, on server acts as `0`)</arg> <arg name="channel" type="number" default="CHAN_AUTO">The sound channel, see <page>Enums/CHAN</page>.</arg> <arg name="volume" type="number" default="1">The volume of the sound, from 0 to 1</arg> <arg name="soundLevel" type="number" default="75">The sound level of the sound, see <page>Enums/SNDLVL</page></arg> <arg name="soundFlags" type="number" default="0">The flags of the sound, see <page>Enums/SND</page></arg> <arg name="pitch" type="number" default="100">The pitch of the sound, 0-255</arg> <arg name="dsp" type="number" default="0">The DSP preset for this sound. [List of DSP presets](https://developer.valvesoftware.com/wiki/Dsp_presets)</arg> </args> </function> <example> <description>Plays magical sound on first player.</description> <code>EmitSound( Sound( "garrysmod/save_load1.wav" ), Entity(1):GetPos(), 1, CHAN_AUTO, 1, 75, 0, 100 )</code> </example>