Stop Background Effect

Stop Background Effect

Stops all active background effects or a specific one identified by its unique ID.

Properties

System

Name	Explanation	Type
Stop All	When enabled, all active background effects are stopped.	Toggle
Unique ID	The unique ID of the specific background effect instance to stop.	Variable or Value

Examples

Stop All Background Effects

Stops all currently active background sound effects.

Code ScriptVisual Script

stop_bgfx();

{"Data":{"IsAll":true,"Value":{"IsGlobalVariable":false,"IsLocalVariable":false,"IsValue":true,"Value":"","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Audio.StopBackgroundEffectCommand"}

Stop a Specific Background Effect by Unique ID

Stops a single background effect identified by a unique ID stored in a global variable.

Code ScriptVisual Script

stop_bgfx($gv[0]);

{"Data":{"IsAll":false,"Value":{"IsGlobalVariable":true,"IsLocalVariable":false,"IsValue":false,"Value":"","VariableIndex":0,"Metadata":null},"Metadata":null},"TypeName":"MAR.Game.Shared.Models.Scripts.Commands.Audio.StopBackgroundEffectCommand"}