phaser/resources/docgen/output/Phaser.AudioSprite.json

{"class":{"name":"Phaser.AudioSprite","extends":"","static":false,"constructor":true,"parameters":[{"name":"game","type":["Phaser.Game"],"help":"Reference to the current game instance.","optional":false,"default":null},{"name":"key","type":["string"],"help":"Asset key for the sound.","optional":false,"default":null}],"help":"Audio Sprites are a combination of audio files and a JSON configuration.\\nThe JSON follows the format of that created by https:\/\/github.com\/tonistiigi\/audiosprite"},"consts":[],"methods":{"public":[{"name":"get","static":false,"returns":{"types":["Phaser.Sound"],"help":"The sound instance."},"help":"Get a sound with the given name.","line":129,"public":true,"protected":false,"private":false,"parameters":[{"name":"marker","type":["string"],"help":"The name of sound to get.","optional":false,"default":null}],"inherited":false,"inheritedFrom":""},{"name":"play","static":false,"returns":{"types":["Phaser.Sound"],"help":"This sound instance."},"help":"Play a sound with the given name.","line":92,"public":true,"protected":false,"private":false,"parameters":[{"name":"marker","type":["string"],"help":"The name of sound to play","optional":true,"default":null},{"name":"volume","type":["number"],"help":"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).","optional":true,"default":"1"}],"inherited":false,"inheritedFrom":""},{"name":"stop","static":false,"returns":null,"help":"Stop a sound with the given name.","line":106,"public":true,"protected":false,"private":false,"parameters":[{"name":"marker","type":["string"],"help":"The name of sound to stop. If none is given it will stop all sounds in the audio sprite.","optional":true,"default":"''"}],"inherited":false,"inheritedFrom":""}],"protected":[],"private":[],"static":[]},"properties":{"public":[{"name":"autoplay","type":["boolean"],"help":"Is a sound set to autoplay or not?","inlineHelp":"","line":48,"default":"false","public":true,"protected":false,"private":false,"readOnly":false},{"name":"autoplayKey","type":["string"],"help":"If a sound is set to auto play, this holds the marker key of it.","inlineHelp":"","line":41,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"config","type":["object"],"help":"JSON audio atlas object.","inlineHelp":"","line":35,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"game","type":["Phaser.Game"],"help":"A reference to the currently running Game.","inlineHelp":"","line":23,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"key","type":["string"],"help":"Asset key for the Audio Sprite.","inlineHelp":"","line":29,"default":null,"public":true,"protected":false,"private":false,"readOnly":false},{"name":"sounds","type":["object"],"help":"An object containing the Phaser.Sound objects for the Audio Sprite.","inlineHelp":"","line":54,"default":null,"public":true,"protected":false,"private":false,"readOnly":false}],"protected":[],"private":[]}}