Skip to content

Play Sound Effect

Play Sound Effect

Plays a one-shot sound effect, specified directly or constructed from variables for dynamic audio.

Properties

System

Name Explanation Type
Asset Name The audio asset file name when using variable mode. Variable or Value
Pan The stereo panning value when using variable mode. Ranges from -1 (left) to 1 (right). Variable or Value
Pitch The pitch adjustment when using variable mode. Variable or Value
Sound Effect The sound effect asset to play. Sound Effect
Use Variable When enabled, the sound effect is constructed from variable values instead of a direct asset reference. Toggle
Volume The playback volume when using variable mode. Ranges from 0 (silent) to 1 (full volume). Variable or Value

Examples

Play a Sound Effect by Asset Reference

Plays a sound effect using a direct asset reference with default settings.

play_sfx({name: "Content/Audio/Hit.ogg"});

{"Data":{"IsVariable":false,"Value":{"Name":"Content/Audio/Hit.ogg","Volume":1,"Pitch":0,"Pan":0,"IsPreventingMultiple":false},"VariableName":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"VariablePan":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"VariablePitch":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"VariableVolume":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Audio.SoundEffectCommand"}

Play a Sound Effect with Custom Volume and Pitch

Plays a sound effect at 80 percent volume with a pitch shift applied.

play_sfx({name: "Content/Audio/Hit.ogg", volume: 0.8, pitch: 0.5});

{"Data":{"IsVariable":false,"Value":{"Name":"Content/Audio/Hit.ogg","Volume":0.8,"Pitch":0.5,"Pan":0,"IsPreventingMultiple":false},"VariableName":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"VariablePan":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"VariablePitch":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"VariableVolume":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"1","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Audio.SoundEffectCommand"}

Play a Sound Effect from Variables

Plays a sound effect constructed from variable values with a custom name and volume.

play_sfx(name: $gv[0], volume: 0.5);

{"Data":{"IsVariable":true,"Value":{"Name":"","Volume":1,"Pitch":0,"Pan":0,"IsPreventingMultiple":false},"VariableName":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"VariablePan":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"VariablePitch":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0","VariableIndex":0,"Metadata":null},"VariableVolume":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"0.5","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Audio.SoundEffectCommand"}