flixel.system.ui.FlxSoundTray

The flixel sound tray, the little volume meter that pops down sometimes. Accessed via FlxG.game.soundTray or FlxG.sound.soundTray.

Constructor

`@:keepnew()`

Sets up the "sound tray", the little volume meter that pops down sometimes.

Variables

`active:Bool`

Because reading any data from DisplayObject is insanely expensive in hxcpp, keep track of whether we need to update it or not.

`@:value(false)silent:Bool = false`

Whether or not changing the volume should make noise.

`@:value("flixel/sounds/beep")volumeDownSound:FlxSoundAsset = "flixel/sounds/beep"`

The sound used when decreasing the volume.

`@:value("flixel/sounds/beep")volumeUpSound:FlxSoundAsset = "flixel/sounds/beep"`

The sound used when increasing the volume.

Methods

`screenCenter():Void`

`@:value({ up : false })show(up:Bool = false):Void`

Deprecated: "show is deprecated, use showAnim"

Makes the little volume tray slide out.

Parameters:

`up`	Whether the volume is increasing.

`@:value({ label : "VOLUME", duration : 1.0 })showAnim(volume:Float, ?sound:Null<FlxSoundAsset>, duration:Float = 1.0, label:String = "VOLUME"):Void`

Shows the volume animation for the desired settings

Parameters:

`volume`	The volume, 1.0 is full volume
`sound`	The sound to play, if any
`duration`	How long the tray will show
`label`	The test label to display

`update(MS:Float):Void`

This function updates the soundtray object.

class FlxSoundTray

package flixel.system.ui

extends Sprite › DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher

Constructor

@:keepnew()

Variables

active:Bool

@:value(false)silent:Bool = false

@:value("flixel/sounds/beep")volumeDownSound:FlxSoundAsset = "flixel/sounds/beep"

@:value("flixel/sounds/beep")volumeUpSound:FlxSoundAsset = "flixel/sounds/beep"

Methods

screenCenter():Void

@:value({ up : false })show(up:Bool = false):Void

@:value({ label : "VOLUME", duration : 1.0 })showAnim(volume:Float, ?sound:Null<FlxSoundAsset>, duration:Float = 1.0, label:String = "VOLUME"):Void

update(MS:Float):Void

Inherited Variables

Defined by Sprite

@:flash.propertybuttonMode:Bool

@:flash.propertyread onlydropTarget:DisplayObject

@:flash.propertyread onlygraphics:Graphics

@:flash.propertyhitArea:Sprite

@:flash.propertysoundTransform:SoundTransform

@:flash.propertyuseHandCursor:Bool

Defined by DisplayObjectContainer

@:flash.propertymouseChildren:Bool

@:flash.propertyread onlynumChildren:Int

@:flash.propertytabChildren:Bool

@:flash.propertyread onlytextSnapshot:TextSnapshot

Defined by InteractiveObject

@:flash.propertyaccessibilityImplementation:AccessibilityImplementation

@:flash.propertycontextMenu:ContextMenu

@:flash.propertydoubleClickEnabled:Bool

@:flash.propertyfocusRect:Dynamic

@:flash.propertymouseEnabled:Bool

@:flash.property@:require(flash11)needsSoftKeyboard:Bool

@:flash.property@:require(flash11)softKeyboardInputAreaOfInterest:Rectangle

@:flash.propertytabEnabled:Bool

@:flash.propertytabIndex:Int

Defined by DisplayObject

@:flash.propertyaccessibilityProperties:AccessibilityProperties

@:flash.propertyalpha:Float

@:flash.propertyblendMode:BlendMode

@:flash.property@:require(flash10)write onlyblendShader:Shader

@:flash.propertycacheAsBitmap:Bool

@:flash.propertycacheAsBitmapMatrix:Matrix

@:flash.propertyfilters:Array<BitmapFilter>

@:flash.propertyheight:Float

@:flash.propertyread onlyloaderInfo:LoaderInfo

@:flash.propertymask:DisplayObject

@:flash.propertyread onlymouseX:Float

@:flash.propertyread onlymouseY:Float

@:flash.propertyname:String

@:flash.propertyopaqueBackground:Null<UInt>

@:flash.propertyread onlyparent:DisplayObjectContainer

@:flash.propertyread onlyroot:DisplayObject

@:flash.propertyrotation:Float

@:flash.property@:require(flash10)rotationX:Float

@:flash.property@:require(flash10)rotationY:Float

@:flash.property@:require(flash10)rotationZ:Float

@:flash.propertyscale9Grid:Rectangle

@:flash.propertyscaleX:Float

@:flash.propertyscaleY:Float

@:flash.property@:require(flash10)scaleZ:Float

@:flash.propertyscrollRect:Rectangle

@:flash.propertyshader:Shader

@:flash.propertyread onlystage:Stage

@:flash.propertytransform:Transform

@:flash.propertyvisible:Bool

@:flash.propertywidth:Float

@:flash.propertyx:Float

@:flash.propertyy:Float

@:flash.property@:require(flash10)z:Float

Inherited Methods

Defined by Sprite

@:value({ bounds : null, lockCenter : false })startDrag(lockCenter:Bool = false, ?bounds:Null<Rectangle>):Void

@:value({ bounds : null, lockCenter : false })@:require(flash10_1)startTouchDrag(touchPointID:Int, lockCenter:Bool = false, ?bounds:Null<Rectangle>):Void

stopDrag():Void

@:require(flash10_1)stopTouchDrag(touchPointID:Int):Void

Defined by DisplayObjectContainer

addChild(child:DisplayObject):DisplayObject

`@:keepnew()`

`active:Bool`

`@:value(false)silent:Bool = false`

`@:value("flixel/sounds/beep")volumeDownSound:FlxSoundAsset = "flixel/sounds/beep"`

`@:value("flixel/sounds/beep")volumeUpSound:FlxSoundAsset = "flixel/sounds/beep"`

`screenCenter():Void`

`@:value({ up : false })show(up:Bool = false):Void`

`@:value({ label : "VOLUME", duration : 1.0 })showAnim(volume:Float, ?sound:Null<FlxSoundAsset>, duration:Float = 1.0, label:String = "VOLUME"):Void`

`update(MS:Float):Void`

`@:flash.propertybuttonMode:Bool`

`@:flash.propertyread onlydropTarget:DisplayObject`

`@:flash.propertyread onlygraphics:Graphics`

`@:flash.propertyhitArea:Sprite`

`@:flash.propertysoundTransform:SoundTransform`

`@:flash.propertyuseHandCursor:Bool`

`@:flash.propertymouseChildren:Bool`

`@:flash.propertyread onlynumChildren:Int`

`@:flash.propertytabChildren:Bool`

`@:flash.propertyread onlytextSnapshot:TextSnapshot`

`@:flash.propertyaccessibilityImplementation:AccessibilityImplementation`

`@:flash.propertycontextMenu:ContextMenu`

`@:flash.propertydoubleClickEnabled:Bool`

`@:flash.propertyfocusRect:Dynamic`

`@:flash.propertymouseEnabled:Bool`

`@:flash.property@:require(flash11)needsSoftKeyboard:Bool`

`@:flash.property@:require(flash11)softKeyboardInputAreaOfInterest:Rectangle`

`@:flash.propertytabEnabled:Bool`

`@:flash.propertytabIndex:Int`

`@:flash.propertyaccessibilityProperties:AccessibilityProperties`

`@:flash.propertyalpha:Float`

`@:flash.propertyblendMode:BlendMode`

`@:flash.property@:require(flash10)write onlyblendShader:Shader`

`@:flash.propertycacheAsBitmap:Bool`

`@:flash.propertycacheAsBitmapMatrix:Matrix`

`@:flash.propertyfilters:Array<BitmapFilter>`

`@:flash.propertyheight:Float`

`@:flash.propertyread onlyloaderInfo:LoaderInfo`

`@:flash.propertymask:DisplayObject`

`@:flash.propertyread onlymouseX:Float`

`@:flash.propertyread onlymouseY:Float`

`@:flash.propertyname:String`

`@:flash.propertyopaqueBackground:Null<UInt>`

`@:flash.propertyread onlyparent:DisplayObjectContainer`

`@:flash.propertyread onlyroot:DisplayObject`

`@:flash.propertyrotation:Float`

`@:flash.property@:require(flash10)rotationX:Float`

`@:flash.property@:require(flash10)rotationY:Float`

`@:flash.property@:require(flash10)rotationZ:Float`

`@:flash.propertyscale9Grid:Rectangle`

`@:flash.propertyscaleX:Float`

`@:flash.propertyscaleY:Float`

`@:flash.property@:require(flash10)scaleZ:Float`

`@:flash.propertyscrollRect:Rectangle`

`@:flash.propertyshader:Shader`

`@:flash.propertyread onlystage:Stage`

`@:flash.propertytransform:Transform`

`@:flash.propertyvisible:Bool`

`@:flash.propertywidth:Float`

`@:flash.propertyx:Float`

`@:flash.propertyy:Float`

`@:flash.property@:require(flash10)z:Float`

`@:value({ bounds : null, lockCenter : false })startDrag(lockCenter:Bool = false, ?bounds:Null<Rectangle>):Void`

`@:value({ bounds : null, lockCenter : false })@:require(flash10_1)startTouchDrag(touchPointID:Int, lockCenter:Bool = false, ?bounds:Null<Rectangle>):Void`

`stopDrag():Void`

`@:require(flash10_1)stopTouchDrag(touchPointID:Int):Void`

`addChild(child:DisplayObject):DisplayObject`

`addChildAt(child:DisplayObject, index:Int):DisplayObject`

`areInaccessibleObjectsUnderPoint(point:Point):Bool`

`contains(child:DisplayObject):Bool`

`getChildAt(index:Int):DisplayObject`

`getChildByName(name:String):DisplayObject`

`getChildIndex(child:DisplayObject):Int`

`getObjectsUnderPoint(point:Point):Array<DisplayObject>`

`removeChild(child:DisplayObject):DisplayObject`

`removeChildAt(index:Int):DisplayObject`

`@:value({ endIndex : 0x7FFFFFFF, beginIndex : 0 })@:require(flash11)removeChildren(beginIndex:Int = 0, endIndex:Int = 0x7FFFFFFF):Void`

`setChildIndex(child:DisplayObject, index:Int):Void`

`@:require(flash11_8)stopAllMovieClips():Void`

`swapChildren(child1:DisplayObject, child2:DisplayObject):Void`

`swapChildrenAt(index1:Int, index2:Int):Void`