2013-10-25 15:54:40 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > Phaser Source: gameobjects/Button.js< / 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" >
< a href = "namespaces.list.html" class = "dropdown-toggle" data-toggle = "dropdown" > Namespaces< b
class="caret">< / b > < / a >
< ul class = "dropdown-menu " >
< li >
< a href = "Phaser.html" > Phaser< / a >
< / 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 >
< a href = "Phaser.AnimationManager.html" > AnimationManager< / a >
< / li >
< li >
< a href = "Phaser.AnimationParser.html" > AnimationParser< / a >
< / 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 >
< li >
< a href = "Phaser.Cache.html" > Cache< / a >
< / li >
< li >
< a href = "Phaser.Camera.html" > Camera< / a >
< / li >
< li >
< a href = "Phaser.Canvas.html" > Canvas< / a >
< / li >
< li >
< a href = "Phaser.Circle.html" > Circle< / a >
< / li >
< li >
< a href = "Phaser.Color.html" > Color< / a >
< / li >
< li >
< a href = "Phaser.Device.html" > Device< / a >
< / li >
< li >
< 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-25 15:54:40 +00:00
< li >
< a href = "Phaser.Frame.html" > Frame< / a >
< / li >
< li >
< a href = "Phaser.FrameData.html" > FrameData< / a >
< / 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 >
< 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-25 15:54:40 +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-25 15:54:40 +00:00
< li >
< a href = "Phaser.LinkedList.html" > LinkedList< / a >
< / li >
< li >
< a href = "Phaser.Loader.html" > Loader< / a >
< / li >
< li >
< a href = "Phaser.LoaderParser.html" > LoaderParser< / a >
< / 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 >
< 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-25 15:54:40 +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-25 15:54:40 +00:00
< li >
< a href = "Phaser.RandomDataGenerator.html" > RandomDataGenerator< / a >
< / li >
< li >
< a href = "Phaser.Rectangle.html" > Rectangle< / a >
< / li >
< li >
< a href = "Phaser.RenderTexture.html" > RenderTexture< / a >
< / li >
< 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-25 15:54:40 +00:00
< li >
< a href = "Phaser.Sound.html" > Sound< / a >
< / li >
< li >
< a href = "Phaser.SoundManager.html" > SoundManager< / a >
< / li >
< 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-25 15:54:40 +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 >
< 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 >
< 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-25 15:54:40 +00:00
< li >
< a href = "Phaser.Touch.html" > Touch< / a >
< / li >
< 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 >
< 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-25 15:54:40 +00:00
< / ul >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span12" >
< div id = "main" >
< h1 class = "page-title" > Source: gameobjects/Button.js< / h1 >
< section >
< article >
< pre class = "sunlight-highlight-javascript linenums" > /**
* @author Richard Davey < rich@photonstorm.com>
2014-02-05 06:29:17 +00:00
* @copyright 2014 Photon Storm Ltd.
2013-10-25 15:54:40 +00:00
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
/**
2013-11-28 15:57:09 +00:00
* @class Phaser.Button
*
* @classdesc Create a new `Button` object. A Button is a special type of Sprite that is set-up to handle Pointer events automatically. The four states a Button responds to are:
*
* * 'Over' - when the Pointer moves over the Button. This is also commonly known as 'hover'.
* * 'Out' - when the Pointer that was previously over the Button moves out of it.
* * 'Down' - when the Pointer is pressed down on the Button. I.e. touched on a touch enabled device or clicked with the mouse.
* * 'Up' - when the Pointer that was pressed down on the Button is released again.
*
2013-11-01 18:16:52 +00:00
* You can set a unique texture frame and Sound for any of these states.
*
2013-10-25 15:54:40 +00:00
* @constructor
2014-02-08 07:24:22 +00:00
* @extends Phaser.Image
2013-10-25 15:54:40 +00:00
*
* @param {Phaser.Game} game Current game instance.
2014-02-05 06:29:17 +00:00
* @param {number} [x=0] - X position of the Button.
* @param {number} [y=0] - Y position of the Button.
2013-11-01 18:16:52 +00:00
* @param {string} [key] - The image key as defined in the Game.Cache to use as the texture for this Button.
* @param {function} [callback] - The function to call when this Button is pressed.
* @param {object} [callbackContext] - The context in which the callback will be called (usually 'this').
* @param {string|number} [overFrame] - This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [outFrame] - This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [downFrame] - This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
2014-02-05 06:29:17 +00:00
* @param {string|number} [upFrame] - This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
2013-10-25 15:54:40 +00:00
*/
2014-02-05 06:29:17 +00:00
Phaser.Button = function (game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame) {
2013-10-25 15:54:40 +00:00
x = x || 0;
y = y || 0;
key = key || null;
callback = callback || null;
callbackContext = callbackContext || this;
2014-02-08 07:24:22 +00:00
Phaser.Image.call(this, game, x, y, key, outFrame);
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
/**
* @property {number} type - The Phaser Object Type.
*/
2013-10-25 15:54:40 +00:00
this.type = Phaser.BUTTON;
2013-11-28 15:57:09 +00:00
/**
* @property {string} _onOverFrameName - Internal variable.
* @private
* @default
*/
2013-10-25 15:54:40 +00:00
this._onOverFrameName = null;
2013-11-28 15:57:09 +00:00
/**
* @property {string} _onOutFrameName - Internal variable.
* @private
* @default
*/
2013-10-25 15:54:40 +00:00
this._onOutFrameName = null;
2013-11-28 15:57:09 +00:00
/**
* @property {string} _onDownFrameName - Internal variable.
* @private
* @default
*/
2013-10-25 15:54:40 +00:00
this._onDownFrameName = null;
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
/**
* @property {string} _onUpFrameName - Internal variable.
* @private
* @default
*/
2013-10-25 15:54:40 +00:00
this._onUpFrameName = null;
2013-11-28 15:57:09 +00:00
/**
* @property {number} _onOverFrameID - Internal variable.
* @private
* @default
*/
2013-10-25 15:54:40 +00:00
this._onOverFrameID = null;
2013-11-28 15:57:09 +00:00
/**
* @property {number} _onOutFrameID - Internal variable.
* @private
* @default
*/
2013-10-25 15:54:40 +00:00
this._onOutFrameID = null;
2013-11-28 15:57:09 +00:00
/**
* @property {number} _onDownFrameID - Internal variable.
* @private
* @default
*/
2013-10-25 15:54:40 +00:00
this._onDownFrameID = null;
2014-02-05 06:29:17 +00:00
2013-11-28 15:57:09 +00:00
/**
* @property {number} _onUpFrameID - Internal variable.
* @private
* @default
*/
2013-10-25 15:54:40 +00:00
this._onUpFrameID = null;
2013-11-01 18:16:52 +00:00
/**
* @property {Phaser.Sound} onOverSound - The Sound to be played when this Buttons Over state is activated.
* @default
*/
this.onOverSound = null;
/**
* @property {Phaser.Sound} onOutSound - The Sound to be played when this Buttons Out state is activated.
* @default
*/
this.onOutSound = null;
/**
* @property {Phaser.Sound} onDownSound - The Sound to be played when this Buttons Down state is activated.
* @default
*/
this.onDownSound = null;
/**
* @property {Phaser.Sound} onUpSound - The Sound to be played when this Buttons Up state is activated.
* @default
*/
this.onUpSound = null;
/**
* @property {string} onOverSoundMarker - The Sound Marker used in conjunction with the onOverSound.
* @default
*/
this.onOverSoundMarker = '';
/**
* @property {string} onOutSoundMarker - The Sound Marker used in conjunction with the onOutSound.
* @default
*/
this.onOutSoundMarker = '';
/**
* @property {string} onDownSoundMarker - The Sound Marker used in conjunction with the onDownSound.
* @default
*/
this.onDownSoundMarker = '';
/**
* @property {string} onUpSoundMarker - The Sound Marker used in conjunction with the onUpSound.
* @default
*/
this.onUpSoundMarker = '';
2013-11-28 15:57:09 +00:00
/**
* @property {Phaser.Signal} onInputOver - The Signal (or event) dispatched when this Button is in an Over state.
*/
this.onInputOver = new Phaser.Signal();
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
/**
* @property {Phaser.Signal} onInputOut - The Signal (or event) dispatched when this Button is in an Out state.
*/
this.onInputOut = new Phaser.Signal();
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
/**
* @property {Phaser.Signal} onInputDown - The Signal (or event) dispatched when this Button is in an Down state.
*/
this.onInputDown = new Phaser.Signal();
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
/**
* @property {Phaser.Signal} onInputUp - The Signal (or event) dispatched when this Button is in an Up state.
*/
this.onInputUp = new Phaser.Signal();
2013-10-25 15:54:40 +00:00
2013-11-01 18:16:52 +00:00
/**
* @property {boolean} freezeFrames - When true the Button will cease to change texture frame on all events (over, out, up, down).
*/
this.freezeFrames = false;
2013-11-07 06:10:15 +00:00
/**
2014-02-05 06:29:17 +00:00
* When the Button is touched / clicked and then released you can force it to enter a state of "out" instead of "up".
2013-11-07 06:10:15 +00:00
* @property {boolean} forceOut
* @default
*/
2014-02-05 06:29:17 +00:00
this.forceOut = false;
2013-11-07 06:10:15 +00:00
2014-02-08 07:24:22 +00:00
this.inputEnabled = true;
this.input.start(0, true);
2014-02-05 06:29:17 +00:00
this.setFrames(overFrame, outFrame, downFrame, upFrame);
2013-10-25 15:54:40 +00:00
if (callback !== null)
{
this.onInputUp.add(callback, callbackContext);
}
// Redirect the input events to here so we can handle animation updates, etc
this.events.onInputOver.add(this.onInputOverHandler, this);
this.events.onInputOut.add(this.onInputOutHandler, this);
this.events.onInputDown.add(this.onInputDownHandler, this);
this.events.onInputUp.add(this.onInputUpHandler, this);
};
2014-02-08 07:24:22 +00:00
Phaser.Button.prototype = Object.create(Phaser.Image.prototype);
2013-10-25 15:54:40 +00:00
Phaser.Button.prototype.constructor = Phaser.Button;
/**
2014-02-05 06:29:17 +00:00
* Clears all of the frames set on this Button.
*
* @method Phaser.Button.prototype.clearFrames
*/
Phaser.Button.prototype.clearFrames = function () {
this._onOverFrameName = null;
this._onOverFrameID = null;
this._onOutFrameName = null;
this._onOutFrameID = null;
this._onDownFrameName = null;
this._onDownFrameID = null;
this._onUpFrameName = null;
this._onUpFrameID = null;
}
/**
* Used to manually set the frames that will be used for the different states of the Button.
2013-10-25 15:54:40 +00:00
*
* @method Phaser.Button.prototype.setFrames
* @param {string|number} [overFrame] - This is the frame or frameName that will be set when this button is in an over state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [outFrame] - This is the frame or frameName that will be set when this button is in an out state. Give either a number to use a frame ID or a string for a frame name.
* @param {string|number} [downFrame] - This is the frame or frameName that will be set when this button is in a down state. Give either a number to use a frame ID or a string for a frame name.
2014-02-05 06:29:17 +00:00
* @param {string|number} [upFrame] - This is the frame or frameName that will be set when this button is in an up state. Give either a number to use a frame ID or a string for a frame name.
2013-10-25 15:54:40 +00:00
*/
2014-02-05 06:29:17 +00:00
Phaser.Button.prototype.setFrames = function (overFrame, outFrame, downFrame, upFrame) {
this.clearFrames();
2013-10-25 15:54:40 +00:00
if (overFrame !== null)
{
if (typeof overFrame === 'string')
{
this._onOverFrameName = overFrame;
if (this.input.pointerOver())
{
this.frameName = overFrame;
}
}
else
{
this._onOverFrameID = overFrame;
if (this.input.pointerOver())
{
this.frame = overFrame;
}
}
}
if (outFrame !== null)
{
if (typeof outFrame === 'string')
{
this._onOutFrameName = outFrame;
2013-11-28 15:57:09 +00:00
if (this.input.pointerOver() === false)
2013-10-25 15:54:40 +00:00
{
this.frameName = outFrame;
}
}
else
{
this._onOutFrameID = outFrame;
2013-11-28 15:57:09 +00:00
if (this.input.pointerOver() === false)
2013-10-25 15:54:40 +00:00
{
this.frame = outFrame;
}
}
}
if (downFrame !== null)
{
if (typeof downFrame === 'string')
{
this._onDownFrameName = downFrame;
2013-11-07 06:10:15 +00:00
if (this.input.pointerDown())
2013-10-25 15:54:40 +00:00
{
this.frameName = downFrame;
}
}
else
{
this._onDownFrameID = downFrame;
2013-11-07 06:10:15 +00:00
if (this.input.pointerDown())
2013-10-25 15:54:40 +00:00
{
this.frame = downFrame;
}
}
}
2014-02-05 06:29:17 +00:00
if (upFrame !== null)
{
if (typeof upFrame === 'string')
{
this._onUpFrameName = upFrame;
if (this.input.pointerUp())
{
this.frameName = upFrame;
}
}
else
{
this._onUpFrameID = upFrame;
if (this.input.pointerUp())
{
this.frame = upFrame;
}
}
}
2013-10-25 15:54:40 +00:00
};
/**
2013-11-01 18:16:52 +00:00
* Sets the sounds to be played whenever this Button is interacted with. Sounds can be either full Sound objects, or markers pointing to a section of a Sound object.
* The most common forms of sounds are 'hover' effects and 'click' effects, which is why the order of the parameters is overSound then downSound.
* Call this function with no parameters at all to reset all sounds on this Button.
*
* @method Phaser.Button.prototype.setSounds
* @param {Phaser.Sound} [overSound] - Over Button Sound.
* @param {string} [overMarker] - Over Button Sound Marker.
* @param {Phaser.Sound} [downSound] - Down Button Sound.
* @param {string} [downMarker] - Down Button Sound Marker.
* @param {Phaser.Sound} [outSound] - Out Button Sound.
* @param {string} [outMarker] - Out Button Sound Marker.
* @param {Phaser.Sound} [upSound] - Up Button Sound.
* @param {string} [upMarker] - Up Button Sound Marker.
*/
Phaser.Button.prototype.setSounds = function (overSound, overMarker, downSound, downMarker, outSound, outMarker, upSound, upMarker) {
this.setOverSound(overSound, overMarker);
this.setOutSound(outSound, outMarker);
this.setDownSound(downSound, downMarker);
2014-02-05 06:29:17 +00:00
this.setUpSound(upSound, upMarker);
2013-11-01 18:16:52 +00:00
}
/**
* The Sound to be played when a Pointer moves over this Button.
*
* @method Phaser.Button.prototype.setOverSound
* @param {Phaser.Sound} sound - The Sound that will be played.
* @param {string} [marker] - A Sound Marker that will be used in the playback.
*/
Phaser.Button.prototype.setOverSound = function (sound, marker) {
this.onOverSound = null;
this.onOverSoundMarker = '';
if (sound instanceof Phaser.Sound)
{
this.onOverSound = sound;
}
if (typeof marker === 'string')
{
this.onOverSoundMarker = marker;
}
}
/**
* The Sound to be played when a Pointer moves out of this Button.
*
* @method Phaser.Button.prototype.setOutSound
* @param {Phaser.Sound} sound - The Sound that will be played.
* @param {string} [marker] - A Sound Marker that will be used in the playback.
*/
Phaser.Button.prototype.setOutSound = function (sound, marker) {
this.onOutSound = null;
this.onOutSoundMarker = '';
if (sound instanceof Phaser.Sound)
{
this.onOutSound = sound;
}
if (typeof marker === 'string')
{
this.onOutSoundMarker = marker;
}
}
/**
2014-02-05 06:29:17 +00:00
* The Sound to be played when a Pointer presses down on this Button.
2013-10-25 15:54:40 +00:00
*
2014-02-05 06:29:17 +00:00
* @method Phaser.Button.prototype.setDownSound
2013-11-01 18:16:52 +00:00
* @param {Phaser.Sound} sound - The Sound that will be played.
* @param {string} [marker] - A Sound Marker that will be used in the playback.
*/
2014-02-05 06:29:17 +00:00
Phaser.Button.prototype.setDownSound = function (sound, marker) {
2013-11-01 18:16:52 +00:00
2014-02-05 06:29:17 +00:00
this.onDownSound = null;
this.onDownSoundMarker = '';
2013-11-01 18:16:52 +00:00
if (sound instanceof Phaser.Sound)
{
2014-02-05 06:29:17 +00:00
this.onDownSound = sound;
2013-11-01 18:16:52 +00:00
}
if (typeof marker === 'string')
{
2014-02-05 06:29:17 +00:00
this.onDownSoundMarker = marker;
2013-11-01 18:16:52 +00:00
}
}
/**
2014-02-05 06:29:17 +00:00
* The Sound to be played when a Pointer has pressed down and is released from this Button.
2013-11-01 18:16:52 +00:00
*
2014-02-05 06:29:17 +00:00
* @method Phaser.Button.prototype.setUpSound
2013-11-01 18:16:52 +00:00
* @param {Phaser.Sound} sound - The Sound that will be played.
* @param {string} [marker] - A Sound Marker that will be used in the playback.
*/
2014-02-05 06:29:17 +00:00
Phaser.Button.prototype.setUpSound = function (sound, marker) {
2013-11-01 18:16:52 +00:00
2014-02-05 06:29:17 +00:00
this.onUpSound = null;
this.onUpSoundMarker = '';
2013-11-01 18:16:52 +00:00
if (sound instanceof Phaser.Sound)
{
2014-02-05 06:29:17 +00:00
this.onUpSound = sound;
2013-11-01 18:16:52 +00:00
}
if (typeof marker === 'string')
{
2014-02-05 06:29:17 +00:00
this.onUpSoundMarker = marker;
2013-11-01 18:16:52 +00:00
}
}
/**
* Internal function that handles input events.
*
* @protected
2013-10-25 15:54:40 +00:00
* @method Phaser.Button.prototype.onInputOverHandler
2014-02-05 06:29:17 +00:00
* @param {Phaser.Button} sprite - The Button that the event occured on.
2013-11-01 18:16:52 +00:00
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
2013-10-25 15:54:40 +00:00
*/
2014-02-05 06:29:17 +00:00
Phaser.Button.prototype.onInputOverHandler = function (sprite, pointer) {
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
if (this.freezeFrames === false)
2013-10-25 15:54:40 +00:00
{
2014-02-05 06:29:17 +00:00
this.setState(1);
2013-10-25 15:54:40 +00:00
}
2013-11-01 18:16:52 +00:00
if (this.onOverSound)
{
this.onOverSound.play(this.onOverSoundMarker);
}
2013-10-25 15:54:40 +00:00
if (this.onInputOver)
{
this.onInputOver.dispatch(this, pointer);
}
};
/**
2013-11-01 18:16:52 +00:00
* Internal function that handles input events.
2013-10-25 15:54:40 +00:00
*
2013-11-01 18:16:52 +00:00
* @protected
2014-02-21 15:37:26 +00:00
* @method Phaser.Button.prototype.onInputOutHandler
2014-02-05 06:29:17 +00:00
* @param {Phaser.Button} sprite - The Button that the event occured on.
2013-11-01 18:16:52 +00:00
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
2013-10-25 15:54:40 +00:00
*/
2014-02-05 06:29:17 +00:00
Phaser.Button.prototype.onInputOutHandler = function (sprite, pointer) {
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
if (this.freezeFrames === false)
2013-10-25 15:54:40 +00:00
{
2014-02-05 06:29:17 +00:00
this.setState(2);
2013-10-25 15:54:40 +00:00
}
2013-11-01 18:16:52 +00:00
if (this.onOutSound)
{
this.onOutSound.play(this.onOutSoundMarker);
}
2013-10-25 15:54:40 +00:00
if (this.onInputOut)
{
this.onInputOut.dispatch(this, pointer);
}
};
/**
2013-11-01 18:16:52 +00:00
* Internal function that handles input events.
2013-10-25 15:54:40 +00:00
*
2013-11-01 18:16:52 +00:00
* @protected
2014-02-21 15:37:26 +00:00
* @method Phaser.Button.prototype.onInputDownHandler
2014-02-05 06:29:17 +00:00
* @param {Phaser.Button} sprite - The Button that the event occured on.
2013-11-01 18:16:52 +00:00
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
2013-10-25 15:54:40 +00:00
*/
2014-02-05 06:29:17 +00:00
Phaser.Button.prototype.onInputDownHandler = function (sprite, pointer) {
2013-10-25 15:54:40 +00:00
2013-11-28 15:57:09 +00:00
if (this.freezeFrames === false)
2013-10-25 15:54:40 +00:00
{
2014-02-05 06:29:17 +00:00
this.setState(3);
2013-10-25 15:54:40 +00:00
}
2013-11-01 18:16:52 +00:00
if (this.onDownSound)
{
this.onDownSound.play(this.onDownSoundMarker);
}
2013-10-25 15:54:40 +00:00
if (this.onInputDown)
{
this.onInputDown.dispatch(this, pointer);
}
};
/**
2013-11-01 18:16:52 +00:00
* Internal function that handles input events.
2013-10-25 15:54:40 +00:00
*
2013-11-01 18:16:52 +00:00
* @protected
2014-02-21 15:37:26 +00:00
* @method Phaser.Button.prototype.onInputUpHandler
2014-02-05 06:29:17 +00:00
* @param {Phaser.Button} sprite - The Button that the event occured on.
2013-11-01 18:16:52 +00:00
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
2013-10-25 15:54:40 +00:00
*/
2014-02-05 06:29:17 +00:00
Phaser.Button.prototype.onInputUpHandler = function (sprite, pointer, isOver) {
2013-10-25 15:54:40 +00:00
2014-02-05 06:29:17 +00:00
if (this.onUpSound)
2013-10-25 15:54:40 +00:00
{
2014-02-05 06:29:17 +00:00
this.onUpSound.play(this.onUpSoundMarker);
}
if (this.onInputUp)
{
this.onInputUp.dispatch(this, pointer, isOver);
}
if (this.freezeFrames)
{
return;
}
if (this.forceOut)
{
// Button should be forced to the Out frame when released.
this.setState(2);
}
else
{
if (this._onUpFrameName || this._onUpFrameID)
2013-10-25 15:54:40 +00:00
{
2014-02-05 06:29:17 +00:00
this.setState(4);
2013-10-25 15:54:40 +00:00
}
2014-02-05 06:29:17 +00:00
else
2013-10-25 15:54:40 +00:00
{
2014-02-05 06:29:17 +00:00
if (isOver)
{
this.setState(1);
}
else
{
this.setState(2);
}
2013-10-25 15:54:40 +00:00
}
}
2014-02-05 06:29:17 +00:00
};
/**
* Internal function that handles Button state changes.
*
* @protected
* @method Phaser.Button.prototype.setState
* @param {number} newState - The new State of the Button.
*/
Phaser.Button.prototype.setState = function (newState) {
if (newState === 1)
2013-11-01 18:16:52 +00:00
{
2014-02-05 06:29:17 +00:00
// Over
if (this._onOverFrameName != null)
{
this.frameName = this._onOverFrameName;
}
else if (this._onOverFrameID != null)
{
this.frame = this._onOverFrameID;
}
2013-11-01 18:16:52 +00:00
}
2014-02-05 06:29:17 +00:00
else if (newState === 2)
2013-11-07 06:10:15 +00:00
{
2014-02-05 06:29:17 +00:00
// Out
2013-11-07 06:10:15 +00:00
if (this._onOutFrameName != null)
{
this.frameName = this._onOutFrameName;
}
else if (this._onOutFrameID != null)
{
this.frame = this._onOutFrameID;
}
}
2014-02-05 06:29:17 +00:00
else if (newState === 3)
2013-10-25 15:54:40 +00:00
{
2014-02-05 06:29:17 +00:00
// Down
if (this._onDownFrameName != null)
{
this.frameName = this._onDownFrameName;
}
else if (this._onDownFrameID != null)
{
this.frame = this._onDownFrameID;
}
}
else if (newState === 4)
{
// Up
if (this._onUpFrameName != null)
{
this.frameName = this._onUpFrameName;
}
else if (this._onUpFrameID != null)
{
this.frame = this._onUpFrameID;
}
2013-10-25 15:54:40 +00:00
}
2013-11-07 06:10:15 +00:00
2013-10-25 15:54:40 +00:00
};
< / pre >
< / 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-25 15:54:40 +00:00
< / span >
< br / >
< span class = "jsdoc-message" >
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.3.0-dev< / a >
2014-02-21 15:37:26 +00:00
on Fri Feb 21 2014 15:36:21 GMT-0000 (GMT) using the < a href = "https://github.com/terryweiss/docstrap" > DocStrap template< / a > .
2013-10-25 15:54:40 +00:00
< / span >
< / footer >
< / 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 >
