View source

class flaxen.component.GlobalAudio

import flaxen.component.Audio;

Available on all platforms

Global Audio instance. An entity with this component is added automatically when Flaxen.getGlobalAudio is called. Provides a manner for adjusting overall audio settings.

Instance Fields

var cutoff:Timestamp

var muted:Bool

Stop new audio from playing; see mute()

var stopping:Bool

var volume:Float

Audio volume multiplier

function new():Void

function mute():Void

function stop(?cutoff:Timestamp = null):Void

Stops all sounds that are playing.

If you supply a cutoff value, any sounds that began playing AFTER this cutoff will not be stopped.