View source

{{Func
|Description=Plays a sound on an entity. If run clientside, the sound will only be heard locally.

If used on a player or NPC character with the mouth rigged, the character will "lip-sync". ( Does not work with all sounds )

{{Note|You can only override the volume and pitch if you use a direct filename, not a
 [https://developer.valvesoftware.com/wiki/Soundscripts sound script] name.}}

{{Note|It is recommended to use sound scripts ( see {{LibraryFunction|sound|Add}} ) over direct file paths. This will allow you to use {{ClassFunction|Entity|StopSound}} to stop the played sound scripts.}}

{{Note|When using this function with weapons, use the {{Type|Weapon}} itself as the entity, not its owner!}}

{{Bug|Issue=2651|This does not respond to {{GlobalFunction|SuppressHostEvents}}.}}
|Realm=Shared
|IsClass=Yes
}}
{{Arg
|type=string
|name=soundName
|desc=The name of the sound to be played.
{{Note|Ensure this string has no whitespace at the start or end (you can use string.Trim), or else you'll get an error.}}
}}
{{Arg
|type=number
|name=soundLevel
|desc=A modifier for the distance this sound will reach, acceptable range is 0 to 511. 100 means no adjustment to the level. See {{Enum|SNDLVL}}
|default=75
}}
{{Arg
|type=number
|name=pitchPercent
|desc=The pitch applied to the sound. The acceptable range is from 0 to 255. 100 means the pitch is not changed.
|default=100
}}
{{Arg
|type=number
|name=volume
|desc=The volume, from 0 to 1.
|default=1
}}
{{Arg
|type=number
|name=channel
|desc=The sound channel , see {{Enum|CHAN}}
{{Note|For weapons, the default is CHAN_WEAPON.}}
|default=CHAN_AUTO
}}
{{Example
|Description=Plays sound from the first player on the server.
|Code=Entity(1):EmitSound( "path/to/sound.wav", 75, 100, 1, CHAN_AUTO ) -- Same as below
Entity(1):EmitSound( "path/to/sound.wav" ) -- You can remove the arguments that have default values.
}}