mirror of
https://github.com/photonstorm/phaser
synced 2024-11-23 13:13:43 +00:00
765 lines
17 KiB
HTML
765 lines
17 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>
|
|
<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>
|
|
|
|
<li>
|
|
<a href="Phaser.BitmapText.html">BitmapText</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Bullet.html">Bullet</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>
|
|
|
|
<li>
|
|
<a href="Phaser.Events.html">Events</a>
|
|
</li>
|
|
|
|
<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>
|
|
|
|
<li>
|
|
<a href="Phaser.GameObjectFactory.html">GameObjectFactory</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Graphics.html">Graphics</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Group.html">Group</a>
|
|
</li>
|
|
|
|
<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>
|
|
|
|
<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>
|
|
|
|
<li>
|
|
<a href="Phaser.Physics.Arcade.Body.html">Body</a>
|
|
</li>
|
|
|
|
<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>
|
|
|
|
<li>
|
|
<a href="Phaser.QuadTree.html">QuadTree</a>
|
|
</li>
|
|
|
|
<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>
|
|
|
|
<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>
|
|
|
|
<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>
|
|
|
|
<li>
|
|
<a href="Phaser.TileSprite.html">TileSprite</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="Phaser.Time.html">Time</a>
|
|
</li>
|
|
|
|
<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>
|
|
|
|
<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#bottom">bottom</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="global.html#HEXtoRGB">HEXtoRGB</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="global.html#right">right</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 2013 Photon Storm Ltd.
|
|
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
|
|
*/
|
|
|
|
|
|
/**
|
|
* Create a new <code>Button</code> object.
|
|
* @class Phaser.Button
|
|
* @constructor
|
|
*
|
|
* @param {Phaser.Game} game Current game instance.
|
|
* @param {number} [x] X position of the button.
|
|
* @param {number} [y] 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.
|
|
*/
|
|
Phaser.Button = function (game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame) {
|
|
|
|
x = x || 0;
|
|
y = y || 0;
|
|
key = key || null;
|
|
callback = callback || null;
|
|
callbackContext = callbackContext || this;
|
|
|
|
Phaser.Sprite.call(this, game, x, y, key, outFrame);
|
|
|
|
/**
|
|
* @property {Description} type - Description.
|
|
*/
|
|
this.type = Phaser.BUTTON;
|
|
|
|
/**
|
|
* @property {Description} _onOverFrameName - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onOverFrameName = null;
|
|
|
|
/**
|
|
* @property {Description} _onOutFrameName - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onOutFrameName = null;
|
|
|
|
/**
|
|
* @property {Description} _onDownFrameName - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onDownFrameName = null;
|
|
|
|
/**
|
|
* @property {Description} _onUpFrameName - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onUpFrameName = null;
|
|
|
|
/**
|
|
* @property {Description} _onOverFrameID - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onOverFrameID = null;
|
|
|
|
/**
|
|
* @property {Description} _onOutFrameID - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onOutFrameID = null;
|
|
|
|
/**
|
|
* @property {Description} _onDownFrameID - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onDownFrameID = null;
|
|
|
|
/**
|
|
* @property {Description} _onUpFrameID - Description.
|
|
* @private
|
|
* @default
|
|
*/
|
|
this._onUpFrameID = null;
|
|
|
|
// These are the signals the game will subscribe to
|
|
/**
|
|
* @property {Phaser.Signal} onInputOver - Description.
|
|
*/
|
|
this.onInputOver = new Phaser.Signal;
|
|
|
|
/**
|
|
* @property {Phaser.Signal} onInputOut - Description.
|
|
*/
|
|
this.onInputOut = new Phaser.Signal;
|
|
|
|
/**
|
|
* @property {Phaser.Signal} onInputDown - Description.
|
|
*/
|
|
this.onInputDown = new Phaser.Signal;
|
|
|
|
/**
|
|
* @property {Phaser.Signal} onInputUp - Description.
|
|
*/
|
|
this.onInputUp = new Phaser.Signal;
|
|
|
|
this.setFrames(overFrame, outFrame, downFrame);
|
|
|
|
if (callback !== null)
|
|
{
|
|
this.onInputUp.add(callback, callbackContext);
|
|
}
|
|
|
|
this.freezeFrames = false;
|
|
|
|
this.input.start(0, true);
|
|
|
|
// 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 = Phaser.Utils.extend(true, Phaser.Sprite.prototype, PIXI.Sprite.prototype);
|
|
Phaser.Button.prototype.constructor = Phaser.Button;
|
|
|
|
/**
|
|
* Used to manually set the frames that will be used for the different states of the button
|
|
* exactly like setting them in the constructor.
|
|
*
|
|
* @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.
|
|
*/
|
|
Phaser.Button.prototype.setFrames = function (overFrame, outFrame, downFrame) {
|
|
|
|
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;
|
|
this._onUpFrameName = outFrame;
|
|
|
|
if (this.input.pointerOver() == false)
|
|
{
|
|
this.frameName = outFrame;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
this._onOutFrameID = outFrame;
|
|
this._onUpFrameID = outFrame;
|
|
|
|
if (this.input.pointerOver() == false)
|
|
{
|
|
this.frame = outFrame;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (downFrame !== null)
|
|
{
|
|
if (typeof downFrame === 'string')
|
|
{
|
|
this._onDownFrameName = downFrame;
|
|
|
|
if (this.input.pointerOver())
|
|
{
|
|
this.frameName = downFrame;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
this._onDownFrameID = downFrame;
|
|
|
|
if (this.input.pointerOver())
|
|
{
|
|
this.frame = downFrame;
|
|
}
|
|
}
|
|
}
|
|
|
|
};
|
|
|
|
/**
|
|
* Description.
|
|
*
|
|
* @method Phaser.Button.prototype.onInputOverHandler
|
|
* @param {Description} pointer - Description.
|
|
*/
|
|
Phaser.Button.prototype.onInputOverHandler = function (pointer) {
|
|
|
|
if (this.freezeFrames == false)
|
|
{
|
|
if (this._onOverFrameName != null)
|
|
{
|
|
this.frameName = this._onOverFrameName;
|
|
}
|
|
else if (this._onOverFrameID != null)
|
|
{
|
|
this.frame = this._onOverFrameID;
|
|
}
|
|
}
|
|
|
|
if (this.onInputOver)
|
|
{
|
|
this.onInputOver.dispatch(this, pointer);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Description.
|
|
*
|
|
* @method Phaser.Button.prototype.onInputOutHandler
|
|
* @param {Description} pointer - Description.
|
|
*/
|
|
Phaser.Button.prototype.onInputOutHandler = function (pointer) {
|
|
|
|
if (this.freezeFrames == false)
|
|
{
|
|
if (this._onOutFrameName != null)
|
|
{
|
|
this.frameName = this._onOutFrameName;
|
|
}
|
|
else if (this._onOutFrameID != null)
|
|
{
|
|
this.frame = this._onOutFrameID;
|
|
}
|
|
}
|
|
|
|
if (this.onInputOut)
|
|
{
|
|
this.onInputOut.dispatch(this, pointer);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Description.
|
|
*
|
|
* @method Phaser.Button.prototype.onInputDownHandler
|
|
* @param {Description} pointer - Description.
|
|
*/
|
|
Phaser.Button.prototype.onInputDownHandler = function (pointer) {
|
|
|
|
if (this.freezeFrames == false)
|
|
{
|
|
if (this._onDownFrameName != null)
|
|
{
|
|
this.frameName = this._onDownFrameName;
|
|
}
|
|
else if (this._onDownFrameID != null)
|
|
{
|
|
this.frame = this._onDownFrameID;
|
|
}
|
|
}
|
|
|
|
if (this.onInputDown)
|
|
{
|
|
this.onInputDown.dispatch(this, pointer);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Description.
|
|
*
|
|
* @method Phaser.Button.prototype.onInputUpHandler
|
|
* @param {Description} pointer - Description.
|
|
*/
|
|
Phaser.Button.prototype.onInputUpHandler = function (pointer) {
|
|
|
|
if (this.freezeFrames == false)
|
|
{
|
|
if (this._onUpFrameName != null)
|
|
{
|
|
this.frameName = this._onUpFrameName;
|
|
}
|
|
else if (this._onUpFrameID != null)
|
|
{
|
|
this.frame = this._onUpFrameID;
|
|
}
|
|
}
|
|
|
|
if (this.onInputUp)
|
|
{
|
|
this.onInputUp.dispatch(this, pointer);
|
|
}
|
|
};
|
|
</pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<div class="clearfix"></div>
|
|
<footer>
|
|
|
|
|
|
<span class="copyright">
|
|
Phaser Copyright © 2012-2013 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 Fri Oct 25 2013 17:05:24 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( {
|
|
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>
|