2013-10-03 00:21:08 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Class: Sound< / title >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/sunlight.default.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/site.cerulean.css" >
< / head >
< body >
< div class = "container-fluid" >
< div class = "navbar navbar-fixed-top navbar-inverse" >
< div class = "navbar-inner" >
< a class = "brand" href = "index.html" > Phaser< / a >
< ul class = "nav" >
< li class = "dropdown" >
2013-10-03 01:38:35 +00:00
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
2013-10-03 00:21:08 +00:00
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.html" > Phaser< / a >
2013-10-03 00:21:08 +00:00
< / li >
< / ul >
< / li >
< li class = "dropdown" >
< a href = "classes.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Classes< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "Phaser.Animation.html" > Animation< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
2013-10-03 00:21:08 +00:00
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.BitmapData.html" > BitmapData< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.BitmapFont.html" > BitmapFont< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.BitmapText.html" > BitmapText< / a >
< / li >
< li >
< a href = "Phaser.Button.html" > Button< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Cache.html" > Cache< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Camera.html" > Camera< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Canvas.html" > Canvas< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Circle.html" > Circle< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Color.html" > Color< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Device.html" > Device< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.Easing.html" > Easing< / a >
< / li >
< li >
< a href = "Phaser.Easing.Back.html" > Back< / a >
< / li >
< li >
< a href = "Phaser.Easing.Bounce.html" > Bounce< / a >
< / li >
< li >
< a href = "Phaser.Easing.Circular.html" > Circular< / a >
< / li >
< li >
< a href = "Phaser.Easing.Cubic.html" > Cubic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Elastic.html" > Elastic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Exponential.html" > Exponential< / a >
< / li >
< li >
< a href = "Phaser.Easing.Linear.html" > Linear< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quadratic.html" > Quadratic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quartic.html" > Quartic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Quintic.html" > Quintic< / a >
< / li >
< li >
< a href = "Phaser.Easing.Sinusoidal.html" > Sinusoidal< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.Ellipse.html" > Ellipse< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Events.html" > Events< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Filter.html" > Filter< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
< a href = "Phaser.Game.html" > Game< / a >
< / li >
2014-02-21 15:37:26 +00:00
< li >
< a href = "Phaser.GameObjectCreator.html" > GameObjectCreator< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.GameObjectFactory.html" > GameObjectFactory< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Gamepad.html" > Gamepad< / a >
< / li >
< li >
< a href = "Phaser.GamepadButton.html" > GamepadButton< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Graphics.html" > Graphics< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Group.html" > Group< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "Phaser.Image.html" > Image< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Input.html" > Input< / a >
< / li >
< li >
< a href = "Phaser.InputHandler.html" > InputHandler< / a >
< / li >
< li >
< a href = "Phaser.Key.html" > Key< / a >
< / li >
< li >
< a href = "Phaser.Keyboard.html" > Keyboard< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.Line.html" > Line< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
2013-10-03 01:38:35 +00:00
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
2013-10-03 00:21:08 +00:00
< / li >
< li >
< a href = "Phaser.Math.html" > Math< / a >
< / li >
< li >
< a href = "Phaser.Mouse.html" > Mouse< / a >
< / li >
< li >
< a href = "Phaser.MSPointer.html" > MSPointer< / a >
< / li >
< li >
< a href = "Phaser.Net.html" > Net< / a >
< / li >
< li >
< a href = "Phaser.Particles.html" > Particles< / a >
< / li >
< li >
< a href = "Phaser.Particles.Arcade.Emitter.html" > Emitter< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Physics.html" > Physics< / a >
< / li >
< li >
< a href = "Phaser.Physics.Arcade.html" > Arcade< / a >
< / li >
2014-02-21 15:37:26 +00:00
< li >
< a href = "Phaser.Physics.Body.html" > Body< / a >
< / li >
< li >
< a href = "Phaser.Physics.CollisionGroup.html" > CollisionGroup< / a >
< / li >
< li >
< a href = "Phaser.Physics.ContactMaterial.html" > ContactMaterial< / a >
< / li >
< li >
< a href = "Phaser.Physics.InversePointProxy.html" > InversePointProxy< / a >
< / li >
< li >
< a href = "Phaser.Physics.Material.html" > Material< / a >
< / li >
< li >
< a href = "Phaser.Physics.PointProxy.html" > PointProxy< / a >
< / li >
< li >
< a href = "Phaser.Physics.Spring.html" > Spring< / a >
< / li >
< li >
< a href = "Phaser.Physics.World.html" > World< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Plugin.html" > Plugin< / a >
< / li >
< li >
< a href = "Phaser.PluginManager.html" > PluginManager< / a >
< / li >
< li >
< a href = "Phaser.Point.html" > Point< / a >
< / li >
< li >
< a href = "Phaser.Pointer.html" > Pointer< / a >
< / li >
2013-11-07 06:10:15 +00:00
< li >
< a href = "Phaser.Polygon.html" > Polygon< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.RequestAnimationFrame.html" > RequestAnimationFrame< / a >
< / li >
< li >
< a href = "Phaser.Signal.html" > Signal< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.SinglePad.html" > SinglePad< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Sprite.html" > Sprite< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "Phaser.SpriteBatch.html" > SpriteBatch< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Stage.html" > Stage< / a >
< / li >
< li >
< a href = "Phaser.StageScaleMode.html" > StageScaleMode< / a >
< / li >
< li >
< a href = "Phaser.State.html" > State< / a >
< / li >
< li >
< a href = "Phaser.StateManager.html" > StateManager< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.Text.html" > Text< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Tile.html" > Tile< / a >
< / li >
< li >
< a href = "Phaser.Tilemap.html" > Tilemap< / a >
< / li >
< li >
< a href = "Phaser.TilemapLayer.html" > TilemapLayer< / a >
< / li >
< li >
< a href = "Phaser.TilemapParser.html" > TilemapParser< / a >
< / li >
< li >
< a href = "Phaser.Tileset.html" > Tileset< / a >
< / li >
2013-10-25 15:54:40 +00:00
< li >
< a href = "Phaser.TileSprite.html" > TileSprite< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Time.html" > Time< / a >
< / li >
2013-11-28 15:57:09 +00:00
< li >
< a href = "Phaser.Timer.html" > Timer< / a >
< / li >
2014-02-05 06:29:17 +00:00
< li >
< a href = "Phaser.TimerEvent.html" > TimerEvent< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
2013-10-03 01:38:35 +00:00
< li >
< a href = "Phaser.Tween.html" > Tween< / a >
< / li >
< li >
< a href = "Phaser.TweenManager.html" > TweenManager< / a >
< / li >
< li >
< a href = "Phaser.Utils.html" > Utils< / a >
< / li >
< li >
< a href = "Phaser.Utils.Debug.html" > Debug< / a >
< / li >
2013-10-03 00:21:08 +00:00
< li >
< a href = "Phaser.World.html" > World< / a >
< / li >
< li >
< a href = "SignalBinding.html" > SignalBinding< / a >
< / li >
< / ul >
< / li >
2014-02-08 07:24:22 +00:00
< li class = "dropdown" >
< a href = "global.html" class = "dropdown-toggle" data-toggle = "dropdown" > Global< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "global.html#canUseNewCanvasBlendModes" > canUseNewCanvasBlendModes< / a >
< / li >
2014-02-18 03:01:51 +00:00
< li >
< a href = "global.html#getBounds" > getBounds< / a >
< / li >
2014-02-08 07:24:22 +00:00
< li >
< a href = "global.html#getNextPowerOfTwo" > getNextPowerOfTwo< / a >
< / li >
< li >
< a href = "global.html#hex2rgb" > hex2rgb< / a >
< / li >
< li >
< a href = "global.html#hitTest" > hitTest< / a >
< / li >
< li >
< a href = "global.html#rgb2hex" > rgb2hex< / a >
< / li >
< / ul >
< / li >
2013-10-03 00:21:08 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span8" >
< div id = "main" >
< h1 class = "page-title" > Class: Sound< / h1 >
< section >
< header >
< h2 >
2013-10-03 01:38:35 +00:00
< span class = "ancestors" > < a href = "Phaser.html" > Phaser< / a > .< / span >
2013-10-03 00:21:08 +00:00
Sound
< / h2 >
< div class = "class-description" > < p > The Sound class< / p > < / div >
< / header >
< article >
< div class = "container-overview" >
< dt >
< h4 class = "name" id = "Sound" > < span class = "type-signature" > < / span > new Sound< span class = "signature" > (game, key, < span class = "optional" > volume< / span > , < span class = "optional" > loop< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > The Sound class constructor.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > Reference to the current game instance.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > Asset key for the sound.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
< td class = "description last" > < p > Default value for the volume, between 0 and 1.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > loop< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > Whether or not the sound will loop.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-18" > line 18< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / div >
< h3 class = "subsection-title" > Members< / h3 >
< dl >
< dt >
2013-11-28 15:57:09 +00:00
< h4 class = "name" id = "autoplay" > < span class = "type-signature" > < / span > autoplay< span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
2013-11-28 15:57:09 +00:00
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > autoplay< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > Boolean indicating whether the sound should start automatically.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-77" > line 77< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "context" > < span class = "type-signature" > < / span > context< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
2013-10-03 00:21:08 +00:00
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > context< / code > < / td >
< td class = "type" >
< span class = "param-type" > AudioContext< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > Reference to the AudioContext instance.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-59" > line 59< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "currentMarker" > < span class = "type-signature" > < / span > currentMarker< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > currentMarker< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The string ID of the currently playing marker, if any.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-131" > line 131< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "currentTime" > < span class = "type-signature" > < / span > currentTime< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > currentTime< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The current time the sound is at.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-93" > line 93< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "duration" > < span class = "type-signature" > < / span > duration< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > duration< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The duration of the sound.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
2013-11-28 15:57:09 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-98" > line 98< / a >
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "externalNode" > < span class = "type-signature" > < / span > externalNode< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > externalNode< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
< td class = "description last" > < p > If defined this Sound won't connect to the SoundManager master gain node, but will instead connect to externalNode.input.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
2013-10-03 00:21:08 +00:00
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-159" > line 159< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "game" > < span class = "type-signature" > < / span > game< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > A reference to the currently running Game.< / p >
< / div >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > game< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Game.html" > Phaser.Game< / a > < / span >
< / td >
< td class = "description last" > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-28" > line 28< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "isDecoded" > < span class = "type-signature" > < readonly> < / span > isDecoded< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > isDecoded< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > Returns true if the sound file has decoded.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-734" > line 734< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "isDecoding" > < span class = "type-signature" > < readonly> < / span > isDecoding< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > isDecoding< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > Returns true if the sound file is still decoding.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-721" > line 721< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "isPlaying" > < span class = "type-signature" > < / span > isPlaying< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > isPlaying< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > true if the sound is currently playing, otherwise false.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-125" > line 125< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "key" > < span class = "type-signature" > < / span > key< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > Asset key for the sound.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-38" > line 38< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "loop" > < span class = "type-signature" > < / span > loop< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > loop< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > Whether or not the sound will loop.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-43" > line 43< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "markers" > < span class = "type-signature" > < / span > markers< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > markers< / code > < / td >
< td class = "type" >
< span class = "param-type" > object< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The sound markers.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-54" > line 54< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "mute" > < span class = "type-signature" > < / span > mute< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > mute< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "description last" > < p > Gets or sets the muted state of this sound.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-747" > line 747< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "name" > < span class = "type-signature" > < / span > name< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > Name of the sound.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-33" > line 33< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onDecoded" > < span class = "type-signature" > < / span > onDecoded< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onDecoded< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The onDecoded event is dispatched when the sound has finished decoding (typically for mp3 files)< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-203" > line 203< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onLoop" > < span class = "type-signature" > < / span > onLoop< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onLoop< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The onLoop event is dispatched when this sound loops during playback.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-223" > line 223< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onMarkerComplete" > < span class = "type-signature" > < / span > onMarkerComplete< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onMarkerComplete< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The onMarkerComplete event is dispatched when a marker within this sound completes playback.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-238" > line 238< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onMute" > < span class = "type-signature" > < / span > onMute< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onMute< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The onMouse event is dispatched when this sound is muted.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-233" > line 233< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onPause" > < span class = "type-signature" > < / span > onPause< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onPause< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The onPause event is dispatched when this sound is paused.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-213" > line 213< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onPlay" > < span class = "type-signature" > < / span > onPlay< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onPlay< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The onPlay event is dispatched each time this sound is played.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-208" > line 208< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onResume" > < span class = "type-signature" > < / span > onResume< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onResume< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The onResume event is dispatched when this sound is resumed from a paused state.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-218" > line 218< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "onStop" > < span class = "type-signature" > < / span > onStop< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > onStop< / code > < / td >
< td class = "type" >
< span class = "param-type" > < a href = "Phaser.Signal.html" > Phaser.Signal< / a > < / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The onStop event is dispatched when this sound stops playback.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-228" > line 228< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "override" > < span class = "type-signature" > < / span > override< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > override< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > if true when you play this sound it will always start from the beginning.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-143" > line 143< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "paused" > < span class = "type-signature" > < / span > paused< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > paused< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > true if the sound is paused, otherwise false.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > false< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-109" > line 109< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pausedPosition" > < span class = "type-signature" > < / span > pausedPosition< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pausedPosition< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The position the sound had reached when it was paused.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-114" > line 114< / a >
2013-10-25 15:54:40 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pausedTime" > < span class = "type-signature" > < / span > pausedTime< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pausedTime< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The game time at which the sound was paused.< / p > < / td >
2013-10-25 15:54:40 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-119" > line 119< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-11-28 15:57:09 +00:00
< h4 class = "name" id = "pendingPlayback" > < span class = "type-signature" > < readonly> < / span > pendingPlayback< span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > pendingPlayback< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > true if the sound file is pending playback< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-137" > line 137< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "startTime" > < span class = "type-signature" > < / span > startTime< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > startTime< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The time the Sound starts at (typically 0 unless starting from a marker)< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-default" > Default Value:< / dt >
< dd class = "tag-default" > < ul class = "dummy" > < li > 0< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-88" > line 88< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "stopTime" > < span class = "type-signature" > < / span > stopTime< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
2013-10-25 15:54:40 +00:00
< td class = "name" > < code > stopTime< / code > < / td >
2013-10-03 00:21:08 +00:00
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The time the sound stopped.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-103" > line 103< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "totalDuration" > < span class = "type-signature" > < / span > totalDuration< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > totalDuration< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The total duration of the sound, in milliseconds< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-82" > line 82< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "usingAudioTag" > < span class = "type-signature" > < / span > usingAudioTag< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > usingAudioTag< / code > < / td >
< td class = "type" >
2013-11-28 15:57:09 +00:00
< span class = "param-type" > boolean< / span >
2013-10-03 00:21:08 +00:00
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > true if the sound is being played via the Audio tag.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-154" > line 154< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-11-28 15:57:09 +00:00
< h4 class = "name" id = "usingWebAudio" > < span class = "type-signature" > < readonly> < / span > usingWebAudio< span class = "type-signature" > < / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > usingWebAudio< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > true if this sound is being played with Web Audio.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-149" > line 149< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "volume" > < span class = "type-signature" > < readonly> < / span > volume< span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< dl class = "details" >
< h5 class = "subsection-title" > Properties:< / h5 >
< dl >
< table class = "props table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "description last" > < p > Gets or sets the volume of this sound, a value between 0 and 1.< / p > < / td >
< / tr >
< / tbody >
< / table >
< / dl >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-796" > line 796< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< h3 class = "subsection-title" > Methods< / h3 >
< dl >
< dt >
< h4 class = "name" id = "addMarker" > < span class = "type-signature" > < / span > addMarker< span class = "signature" > (name, start, stop, volume, loop)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Description.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > Description.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > start< / code > < / td >
< td class = "type" >
< span class = "param-type" > Description< / span >
< / td >
< td class = "description last" > < p > Description.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > stop< / code > < / td >
< td class = "type" >
< span class = "param-type" > Description< / span >
< / td >
< td class = "description last" > < p > Description.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > Description< / span >
< / td >
< td class = "description last" > < p > Description.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > loop< / code > < / td >
< td class = "type" >
< span class = "param-type" > Description< / span >
< / td >
< td class = "description last" > < p > Description.
addMarker: function (name, start, stop, volume, loop) {< / p >
< pre > < code > volume = volume || 1;
if (typeof loop == 'undefined') { loop = false; }
this.markers[name] = {
name: name,
start: start,
stop: stop,
volume: volume,
duration: stop - start,
loop: loop
};
},< / code > < / pre > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-261" > line 261< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "addMarker" > < span class = "type-signature" > < / span > addMarker< span class = "signature" > (name, start, duration, < span class = "optional" > volume< / span > , < span class = "optional" > loop< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Adds a marker into the current Sound. A marker is represented by a unique key and a start time and duration.
This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > A unique name for this marker, i.e. 'explosion', 'gunshot', etc.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > start< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The start point of this marker in the audio file, given in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > duration< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< / td >
< td class = "default" >
< / td >
< td class = "description last" > < p > The duration of the marker in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
< td class = "description last" > < p > The volume the sound will play back at, between 0 (silent) and 1 (full volume).< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > loop< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > Sets if the sound will loop or not.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-263" > line 263< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "pause" > < span class = "type-signature" > < / span > pause< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Pauses the sound< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-613" > line 613< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
2013-11-28 15:57:09 +00:00
< h4 class = "name" id = "play" > < span class = "type-signature" > < / span > play< span class = "signature" > (< span class = "optional" > marker< / span > , < span class = "optional" > position< / span > , < span class = "optional" > volume< / span > , < span class = "optional" > loop< / span > , < span class = "optional" > forceRestart< / span > )< / span > < span class = "type-signature" > → {< a href = "Phaser.Sound.html" > Phaser.Sound< / a > }< / span > < / h4 >
2013-10-03 00:21:08 +00:00
< / dt >
< dd >
< div class = "description" >
< p > Play this sound, or a marked section of it.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > marker< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
''
< / td >
< td class = "description last" > < p > If you want to play a marker then give the key here, otherwise leave blank to play the full sound.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > position< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The starting position to play the sound from - this is ignored if you provide a marker.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified).< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< tr >
< td class = "name" > < code > loop< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > Loop when it finished playing?< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > forceRestart< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
true
< / td >
< td class = "description last" > < p > If the sound is already playing you can set forceRestart to restart it from the beginning.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-387" > line 387< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
2013-11-28 15:57:09 +00:00
< p > This sound instance.< / p >
2013-10-03 00:21:08 +00:00
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
2013-11-28 15:57:09 +00:00
< span class = "param-type" > < a href = "Phaser.Sound.html" > Phaser.Sound< / a > < / span >
2013-10-03 00:21:08 +00:00
< / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "removeMarker" > < span class = "type-signature" > < / span > removeMarker< span class = "signature" > (name)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Removes a marker from the sound.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > name< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "description last" > < p > The key of the marker to remove.< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-314" > line 314< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "restart" > < span class = "type-signature" > < / span > restart< span class = "signature" > (< span class = "optional" > marker< / span > , < span class = "optional" > position< / span > , < span class = "optional" > volume< / span > , < span class = "optional" > loop< / span > )< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Restart the sound, or a marked section of it.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th > Argument< / th >
< th > Default< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > marker< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
''
< / td >
< td class = "description last" > < p > If you want to play a marker then give the key here, otherwise leave blank to play the full sound.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > position< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
0
< / td >
< td class = "description last" > < p > The starting position to play the sound from - this is ignored if you provide a marker.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > volume< / code > < / td >
< td class = "type" >
< span class = "param-type" > number< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
1
< / td >
< td class = "description last" > < p > Volume of the sound you want to play.< / p > < / td >
< / tr >
< tr >
< td class = "name" > < code > loop< / code > < / td >
< td class = "type" >
< span class = "param-type" > boolean< / span >
< / td >
< td class = "attributes" >
< optional>< br >
< / td >
< td class = "default" >
false
< / td >
< td class = "description last" > < p > Loop when it finished playing?< / p > < / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-594" > line 594< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "resume" > < span class = "type-signature" > < / span > resume< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Resumes the sound< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-631" > line 631< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "soundHasUnlocked" > < span class = "type-signature" > < protected> < / span > soundHasUnlocked< span class = "signature" > (key)< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Called automatically when this sound is unlocked.< / p >
< / div >
< h5 > Parameters:< / h5 >
< table class = "params table table-striped" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > key< / code > < / td >
< td class = "type" >
< span class = "param-type" > string< / span >
< / td >
2013-11-28 15:57:09 +00:00
< td class = "description last" > < p > The Phaser.Cache key of the sound file to check for decoding.< / p > < / td >
2013-10-03 00:21:08 +00:00
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-244" > line 244< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "stop" > < span class = "type-signature" > < / span > stop< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Stop playing this sound.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2014-02-05 06:29:17 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-683" > line 683< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< dt >
< h4 class = "name" id = "update" > < span class = "type-signature" > < protected> < / span > update< span class = "signature" > ()< / span > < span class = "type-signature" > < / span > < / h4 >
< / dt >
< dd >
< div class = "description" >
< p > Called automatically by Phaser.SoundManager.< / p >
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
2013-11-28 15:57:09 +00:00
< a href = "Sound.js.html" > sound/Sound.js< / a > , < a href = "Sound.js.html#sunlight-1-line-325" > line 325< / a >
2013-10-03 00:21:08 +00:00
< / li > < / ul > < / dd >
< / dl >
< / dd >
< / dl >
< / article >
< / section >
< / div >
< div class = "clearfix" > < / div >
< footer >
< span class = "copyright" >
2014-02-05 06:29:17 +00:00
Phaser Copyright © 2012-2014 Photon Storm Ltd.
2013-10-03 00:21:08 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
2013-10-25 15:54:40 +00:00
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-02-24 12:14:30 +00:00
on Mon Feb 24 2014 12:11:45 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-03 00:21:08 +00:00
< / span >
< / footer >
< / div >
< div class = "span3" >
< div id = "toc" > < / div >
< / div >
< br clear = "both" >
< / div >
< / div >
< script src = "scripts/sunlight.js" > < / script >
< script src = "scripts/sunlight.javascript.js" > < / script >
< script src = "scripts/sunlight-plugin.doclinks.js" > < / script >
< script src = "scripts/sunlight-plugin.linenumbers.js" > < / script >
< script src = "scripts/sunlight-plugin.menu.js" > < / script >
< script src = "scripts/jquery.min.js" > < / script >
< script src = "scripts/jquery.scrollTo.js" > < / script >
< script src = "scripts/jquery.localScroll.js" > < / script >
< script src = "scripts/bootstrap-dropdown.js" > < / script >
< script src = "scripts/toc.js" > < / script >
< script > Sunlight . highlightAll ( { lineNumbers : true , showMenu : true , enableDoclinks : true } ) ; < / script >
< script >
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
< / script >
< / body >
< / html >
