mirror of
https://github.com/photonstorm/phaser
synced 2024-11-10 23:24:41 +00:00
1236 lines
32 KiB
HTML
1236 lines
32 KiB
HTML
<!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 class="class-depth-0">
|
|
<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 class="class-depth-1">
|
|
<a href="Phaser.Animation.html">Animation</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.AnimationManager.html">AnimationManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.AnimationParser.html">AnimationParser</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.ArrayList.html">ArrayList</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.BitmapData.html">BitmapData</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.BitmapText.html">BitmapText</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Button.html">Button</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Cache.html">Cache</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Camera.html">Camera</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Canvas.html">Canvas</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Circle.html">Circle</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Color.html">Color</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Device.html">Device</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Easing.html">Easing</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Back.html">Back</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Bounce.html">Bounce</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Circular.html">Circular</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Cubic.html">Cubic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Elastic.html">Elastic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Exponential.html">Exponential</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Linear.html">Linear</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Quadratic.html">Quadratic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Quartic.html">Quartic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Quintic.html">Quintic</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Easing.Sinusoidal.html">Sinusoidal</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Ellipse.html">Ellipse</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Events.html">Events</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Filter.html">Filter</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Frame.html">Frame</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.FrameData.html">FrameData</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Game.html">Game</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.GameObjectCreator.html">GameObjectCreator</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Gamepad.html">Gamepad</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.GamepadButton.html">GamepadButton</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Graphics.html">Graphics</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Group.html">Group</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Image.html">Image</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Input.html">Input</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.InputHandler.html">InputHandler</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Key.html">Key</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Keyboard.html">Keyboard</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Line.html">Line</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.LinkedList.html">LinkedList</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Loader.html">Loader</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.LoaderParser.html">LoaderParser</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Math.html">Math</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Mouse.html">Mouse</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.MSPointer.html">MSPointer</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Net.html">Net</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Particle.html">Particle</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Particles.html">Particles</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Particles.Arcade.Emitter.html">Emitter</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Physics.html">Physics</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Physics.Arcade.html">Arcade</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Physics.Ninja.html">Ninja</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Ninja.AABB.html">AABB</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Ninja.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Ninja.Circle.html">Circle</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.Ninja.Tile.html">Tile</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Physics.P2.html">P2</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.Body.html">Body</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.BodyDebug.html">BodyDebug</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.CollisionGroup.html">CollisionGroup</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.ContactMaterial.html">ContactMaterial</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.DistanceConstraint.html">DistanceConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.FixtureList.html">FixtureList</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.GearConstraint.html">GearConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.InversePointProxy.html">InversePointProxy</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.LockConstraint.html">LockConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.Material.html">Material</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.PointProxy.html">PointProxy</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.PrismaticConstraint.html">PrismaticConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.RevoluteConstraint.html">RevoluteConstraint</a>
|
|
</li>
|
|
|
|
<li class="class-depth-3">
|
|
<a href="Phaser.Physics.P2.Spring.html">Spring</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Plugin.html">Plugin</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.PluginManager.html">PluginManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Point.html">Point</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Pointer.html">Pointer</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Polygon.html">Polygon</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.QuadTree.html">QuadTree</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.RandomDataGenerator.html">RandomDataGenerator</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Rectangle.html">Rectangle</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.RenderTexture.html">RenderTexture</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.RequestAnimationFrame.html">RequestAnimationFrame</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.RetroFont.html">RetroFont</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.ScaleManager.html">ScaleManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Signal.html">Signal</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.SignalBinding.html">SignalBinding</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.SinglePad.html">SinglePad</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Sound.html">Sound</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.SoundManager.html">SoundManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Sprite.html">Sprite</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.SpriteBatch.html">SpriteBatch</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Stage.html">Stage</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.State.html">State</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.StateManager.html">StateManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Text.html">Text</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Tile.html">Tile</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Tilemap.html">Tilemap</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TilemapLayer.html">TilemapLayer</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TilemapParser.html">TilemapParser</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Tileset.html">Tileset</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TileSprite.html">TileSprite</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Time.html">Time</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Timer.html">Timer</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TimerEvent.html">TimerEvent</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Touch.html">Touch</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Tween.html">Tween</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.TweenManager.html">TweenManager</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.Utils.html">Utils</a>
|
|
</li>
|
|
|
|
<li class="class-depth-2">
|
|
<a href="Phaser.Utils.Debug.html">Debug</a>
|
|
</li>
|
|
|
|
<li class="class-depth-1">
|
|
<a href="Phaser.World.html">World</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
</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>
|
|
* @copyright 2014 Photon Storm Ltd.
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
*/
|
|
|
|
/**
|
|
* @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.
|
|
*
|
|
* You can set a unique texture frame and Sound for any of these states.
|
|
*
|
|
* @constructor
|
|
* @extends Phaser.Image
|
|
*
|
|
* @param {Phaser.Game} game Current game instance.
|
|
* @param {number} [x=0] - X position of the Button.
|
|
* @param {number} [y=0] - Y position of the Button.
|
|
* @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.
|
|
* @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.
|
|
*/
|
|
Phaser.Button = function (game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame) {
|
|
|
|
x = x || 0;
|
|
y = y || 0;
|
|
key = key || null;
|
|
callback = callback || null;
|
|
callbackContext = callbackContext || this;
|
|
|
|
Phaser.Image.call(this, game, x, y, key, outFrame);
|
|
|
|
/**
|
|
* @property {number} type - The Phaser Object Type.
|
|
*/
|
|
this.type = Phaser.BUTTON;
|
|
|
|
/**
|
|
* @property {string} _onOverFrameName - Internal variable.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onOverFrameName = null;
|
|
|
|
/**
|
|
* @property {string} _onOutFrameName - Internal variable.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onOutFrameName = null;
|
|
|
|
/**
|
|
* @property {string} _onDownFrameName - Internal variable.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onDownFrameName = null;
|
|
|
|
/**
|
|
* @property {string} _onUpFrameName - Internal variable.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onUpFrameName = null;
|
|
|
|
/**
|
|
* @property {number} _onOverFrameID - Internal variable.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onOverFrameID = null;
|
|
|
|
/**
|
|
* @property {number} _onOutFrameID - Internal variable.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onOutFrameID = null;
|
|
|
|
/**
|
|
* @property {number} _onDownFrameID - Internal variable.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onDownFrameID = null;
|
|
|
|
/**
|
|
* @property {number} _onUpFrameID - Internal variable.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onUpFrameID = null;
|
|
|
|
/**
|
|
* @property {boolean} onOverMouseOnly - If true then onOver events (such as onOverSound) will only be triggered if the Pointer object causing them was the Mouse Pointer.
|
|
* @default
|
|
*/
|
|
this.onOverMouseOnly = false;
|
|
|
|
/**
|
|
* @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 = '';
|
|
|
|
/**
|
|
* @property {Phaser.Signal} onInputOver - The Signal (or event) dispatched when this Button is in an Over state.
|
|
*/
|
|
this.onInputOver = new Phaser.Signal();
|
|
|
|
/**
|
|
* @property {Phaser.Signal} onInputOut - The Signal (or event) dispatched when this Button is in an Out state.
|
|
*/
|
|
this.onInputOut = new Phaser.Signal();
|
|
|
|
/**
|
|
* @property {Phaser.Signal} onInputDown - The Signal (or event) dispatched when this Button is in an Down state.
|
|
*/
|
|
this.onInputDown = new Phaser.Signal();
|
|
|
|
/**
|
|
* @property {Phaser.Signal} onInputUp - The Signal (or event) dispatched when this Button is in an Up state.
|
|
*/
|
|
this.onInputUp = new Phaser.Signal();
|
|
|
|
/**
|
|
* @property {boolean} freezeFrames - When true the Button will cease to change texture frame on all events (over, out, up, down).
|
|
*/
|
|
this.freezeFrames = false;
|
|
|
|
/**
|
|
* When the Button is touched / clicked and then released you can force it to enter a state of "out" instead of "up".
|
|
* @property {boolean} forceOut
|
|
* @default
|
|
*/
|
|
this.forceOut = false;
|
|
|
|
this.inputEnabled = true;
|
|
|
|
this.input.start(0, true);
|
|
|
|
this.setFrames(overFrame, outFrame, downFrame, upFrame);
|
|
|
|
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);
|
|
|
|
};
|
|
|
|
Phaser.Button.prototype = Object.create(Phaser.Image.prototype);
|
|
Phaser.Button.prototype.constructor = Phaser.Button;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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.
|
|
* @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.
|
|
*/
|
|
Phaser.Button.prototype.setFrames = function (overFrame, outFrame, downFrame, upFrame) {
|
|
|
|
this.clearFrames();
|
|
|
|
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;
|
|
|
|
if (this.input.pointerOver() === false)
|
|
{
|
|
this.frameName = outFrame;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
this._onOutFrameID = outFrame;
|
|
|
|
if (this.input.pointerOver() === false)
|
|
{
|
|
this.frame = outFrame;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (downFrame !== null)
|
|
{
|
|
if (typeof downFrame === 'string')
|
|
{
|
|
this._onDownFrameName = downFrame;
|
|
|
|
if (this.input.pointerDown())
|
|
{
|
|
this.frameName = downFrame;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
this._onDownFrameID = downFrame;
|
|
|
|
if (this.input.pointerDown())
|
|
{
|
|
this.frame = downFrame;
|
|
}
|
|
}
|
|
}
|
|
|
|
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;
|
|
}
|
|
}
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* 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);
|
|
this.setUpSound(upSound, upMarker);
|
|
|
|
};
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* The Sound to be played when a Pointer presses down on this Button.
|
|
*
|
|
* @method Phaser.Button.prototype.setDownSound
|
|
* @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.setDownSound = function (sound, marker) {
|
|
|
|
this.onDownSound = null;
|
|
this.onDownSoundMarker = '';
|
|
|
|
if (sound instanceof Phaser.Sound)
|
|
{
|
|
this.onDownSound = sound;
|
|
}
|
|
|
|
if (typeof marker === 'string')
|
|
{
|
|
this.onDownSoundMarker = marker;
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* The Sound to be played when a Pointer has pressed down and is released from this Button.
|
|
*
|
|
* @method Phaser.Button.prototype.setUpSound
|
|
* @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.setUpSound = function (sound, marker) {
|
|
|
|
this.onUpSound = null;
|
|
this.onUpSoundMarker = '';
|
|
|
|
if (sound instanceof Phaser.Sound)
|
|
{
|
|
this.onUpSound = sound;
|
|
}
|
|
|
|
if (typeof marker === 'string')
|
|
{
|
|
this.onUpSoundMarker = marker;
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* Internal function that handles input events.
|
|
*
|
|
* @protected
|
|
* @method Phaser.Button.prototype.onInputOverHandler
|
|
* @param {Phaser.Button} sprite - The Button that the event occured on.
|
|
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
|
|
*/
|
|
Phaser.Button.prototype.onInputOverHandler = function (sprite, pointer) {
|
|
|
|
if (this.freezeFrames === false)
|
|
{
|
|
this.setState(1);
|
|
}
|
|
|
|
if (this.onOverMouseOnly && !pointer.isMouse)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (this.onOverSound)
|
|
{
|
|
this.onOverSound.play(this.onOverSoundMarker);
|
|
}
|
|
|
|
if (this.onInputOver)
|
|
{
|
|
this.onInputOver.dispatch(this, pointer);
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* Internal function that handles input events.
|
|
*
|
|
* @protected
|
|
* @method Phaser.Button.prototype.onInputOutHandler
|
|
* @param {Phaser.Button} sprite - The Button that the event occured on.
|
|
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
|
|
*/
|
|
Phaser.Button.prototype.onInputOutHandler = function (sprite, pointer) {
|
|
|
|
if (this.freezeFrames === false)
|
|
{
|
|
this.setState(2);
|
|
}
|
|
|
|
if (this.onOutSound)
|
|
{
|
|
this.onOutSound.play(this.onOutSoundMarker);
|
|
}
|
|
|
|
if (this.onInputOut)
|
|
{
|
|
this.onInputOut.dispatch(this, pointer);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Internal function that handles input events.
|
|
*
|
|
* @protected
|
|
* @method Phaser.Button.prototype.onInputDownHandler
|
|
* @param {Phaser.Button} sprite - The Button that the event occured on.
|
|
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
|
|
*/
|
|
Phaser.Button.prototype.onInputDownHandler = function (sprite, pointer) {
|
|
|
|
if (this.freezeFrames === false)
|
|
{
|
|
this.setState(3);
|
|
}
|
|
|
|
if (this.onDownSound)
|
|
{
|
|
this.onDownSound.play(this.onDownSoundMarker);
|
|
}
|
|
|
|
if (this.onInputDown)
|
|
{
|
|
this.onInputDown.dispatch(this, pointer);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Internal function that handles input events.
|
|
*
|
|
* @protected
|
|
* @method Phaser.Button.prototype.onInputUpHandler
|
|
* @param {Phaser.Button} sprite - The Button that the event occured on.
|
|
* @param {Phaser.Pointer} pointer - The Pointer that activated the Button.
|
|
*/
|
|
Phaser.Button.prototype.onInputUpHandler = function (sprite, pointer, isOver) {
|
|
|
|
if (this.onUpSound)
|
|
{
|
|
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 !== null || this._onUpFrameID !== null)
|
|
{
|
|
this.setState(4);
|
|
}
|
|
else
|
|
{
|
|
if (isOver)
|
|
{
|
|
this.setState(1);
|
|
}
|
|
else
|
|
{
|
|
this.setState(2);
|
|
}
|
|
}
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* 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)
|
|
{
|
|
// Over
|
|
if (this._onOverFrameName != null)
|
|
{
|
|
this.frameName = this._onOverFrameName;
|
|
}
|
|
else if (this._onOverFrameID != null)
|
|
{
|
|
this.frame = this._onOverFrameID;
|
|
}
|
|
}
|
|
else if (newState === 2)
|
|
{
|
|
// Out
|
|
if (this._onOutFrameName != null)
|
|
{
|
|
this.frameName = this._onOutFrameName;
|
|
}
|
|
else if (this._onOutFrameID != null)
|
|
{
|
|
this.frame = this._onOutFrameID;
|
|
}
|
|
}
|
|
else if (newState === 3)
|
|
{
|
|
// 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;
|
|
}
|
|
}
|
|
|
|
};
|
|
</pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="clearfix"></div>
|
|
<footer>
|
|
|
|
|
|
<span class="copyright">
|
|
Phaser Copyright © 2012-2014 Photon Storm Ltd.
|
|
</span>
|
|
<br />
|
|
|
|
<span class="jsdoc-message">
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
|
|
on Thu Jul 10 2014 20:18:55 GMT+0100 (BST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
|
|
</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( {
|
|
anchorName : function(i, heading, prefix) {
|
|
return $(heading).attr("id") || ( prefix + i );
|
|
},
|
|
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>
|