Button
Related Doc:
package phaser
Current game instance.
X position of the Button.
Y position of the Button.
The image key (in the Game.Cache) to use as the texture for this Button.
The function to call when this Button is pressed.
The context in which the callback will be called (usually 'this').
The frame / frameName when the button is in the Over state.
The frame / frameName when the button is in the Out state.
The frame / frameName when the button is in the Down state.
The frame / frameName when the button is in the Up state.
Aligns this Game Object to the side of another Game Object, or Rectangle, known as the 'parent', in one of 11 possible positions.
Aligns this Game Object to the side of another Game Object, or Rectangle, known as the 'parent', in one of 11 possible positions. The parent must be a Game Object, or Phaser.Rectangle object. This can include properties such as World.bounds or Camera.view, for aligning Game Objects within the world and camera bounds. Or it can include other Sprites, Images, Text objects, BitmapText, TileSprites or Buttons. Please note that aligning a Sprite to another Game Object does not make it a child of the parent. It simply modifies its position coordinates so it aligns with it.
The Game Object or Rectangle with which to align this Game Object to. Can also include properties such as World.bounds or Camera.view
The position constant. One of Phaser.TOP_LEFT (default), Phaser.TOP_CENTER, Phaser.TOP_RIGHT, Phaser.LEFT_CENTER, Phaser.CENTER, Phaser.RIGHT_CENTER, Phaser.BOTTOM_LEFT, Phaser.BOTTOM_CENTER or Phaser.BOTTOM_RIGHT
A horizontal adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.
A vertical adjustment of the Containers bounds, applied to the aligned position of the Game Object. Use a negative value to shrink the bounds, positive to increase it.
This Game Object.
A useful flag to control if the Game Object is alive or dead.
A useful flag to control if the Game Object is alive or dead.
This is set automatically by the Health components damage method should the object run out of health. Or you can toggle it via your game code.
This property is mostly just provided to be used by your game - it doesn't effect rendering or logic updates. However you can use Group.getFirstAlive in conjunction with this property for fast object pooling and recycling.
Phaser.Component.LifeSpan#alive
The angle property is the rotation of the Game Object in degrees from its original orientation.
The angle property is the rotation of the Game Object in degrees from its original orientation.
Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation.
Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement player.angle = 450 is the same as player.angle = 90.
If you wish to work in radians instead of degrees you can use the property rotation instead. Working in radians is slightly faster as it doesn't have to perform any calculations.
If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance.
If the Game Object is enabled for animation (such as a Phaser.Sprite) this is a reference to its AnimationManager instance. Through it you can create, play, pause and stop animations.
A Game Object with autoCull set to true will check its bounds against the World Camera every frame.
A Game Object with autoCull set to true will check its bounds against the World Camera every frame.
If it is not intersecting the Camera bounds at any point then it has its renderable property set to false.
This keeps the Game Object alive and still processing updates, but forces it to skip the render step entirely.
*
This is a relatively expensive operation, especially if enabled on hundreds of Game Objects. So enable it only if you know it's required,
or you have tested performance and find it acceptable.
The sum of the y and height properties.
The sum of the y and height properties.
This is the same as y + height - offsetY.
The function to call when this Button is pressed.
The context in which the callback will be called (usually 'this').
The center x coordinate of the Game Object.
The center x coordinate of the Game Object.
This is the same as (x - offsetX) + (width / 2).
The center y coordinate of the Game Object.
The center y coordinate of the Game Object.
This is the same as (y - offsetY) + (height / 2).
An empty Object that belongs to this Game Object.
An empty Object that belongs to this Game Object. This value isn't ever used internally by Phaser, but may be used by your own code, or by Phaser Plugins, to store data that needs to be associated with the Game Object, without polluting the Game Object directly.
A debug flag designed for use with Game.enableStep.
A debug flag designed for use with Game.enableStep.
Base destroy method for generic display objects.
Base destroy method for generic display objects.
Destroys the Game Object.
Destroys the Game Object. This removes it from its parent group, destroys the input, event and animation handlers if present and nulls its reference to game, freeing it up for garbage collection.
If this Game Object has the Events component it will also dispatch the onDestroy event. You can optionally also destroy the BaseTexture this Game Object is using. Be careful if you've more than one Game Object sharing the same BaseTexture.
Should every child of this object have its destroy method called as well?
Destroy the BaseTexture this Game Object is using? Note that if another Game Object is sharing the same BaseTexture it will invalidate it.
As a Game Object runs through its destroy method this flag is set to true, and can be checked in any sub-systems or plugins it is being destr
As a Game Object runs through its destroy method this flag is set to true, and can be checked in any sub-systems or plugins it is being destr
The frame / frameName when the button is in the Down state.
When the Button is touched / clicked and then released you can force it to enter a state of "out" instead of "up".
When the Button is touched / clicked and then released you can force it to enter a state of "out" instead of "up". This can also accept a pointer mode bitmask for more refined control.
If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
If this Image is using part of a sprite sheet or texture atlas you can specify the exact frame to use by giving a string or numeric index.
When true the the texture frame will not be automatically switched on up/down/over/out events.
A reference to the currently running game.
A reference to the currently running game.
Suppress the over event if a pointer was just released and it matches the given pointer mode bitmask.
Suppress the over event if a pointer was just released and it matches the given pointer mode bitmask. This behavior was introduced in Phaser 2.3.1; this property is a soft-revert of the change.
The texture used by the Image during rendering.
The texture used by the Image during rendering. It can be a string which is a reference to the Cache entry, or an instance of a RenderTexture, BitmapData or PIXI.Texture.
The left coordinate of the Game Object.
The left coordinate of the Game Object.
This is the same as x - offsetX.
The amount the Game Object is visually offset from its x coordinate.
The amount the Game Object is visually offset from its x coordinate. This is the same as width * anchor.x. It will only be > 0 if anchor.x is not equal to zero.
The amount the Game Object is visually offset from its y coordinate.
The amount the Game Object is visually offset from its y coordinate. This is the same as height * anchor.y. It will only be > 0 if anchor.y is not equal to zero.
The Sound Marker used in conjunction with the onDownSound.
The Signal (or event) dispatched when this Button is in an Down state.
The Signal (or event) dispatched when this Button is in an Out state.
The Signal (or event) dispatched when this Button is in an Over state.
The Signal (or event) dispatched when this Button is in an Up state.
The Sound to be played when this Buttons Out state is activated.
The Sound Marker used in conjunction with the onOutSound.
If true then onOver events (such as onOverSound) will only be triggered if the Pointer object causing them was the Mouse Pointer.
If true then onOver events (such as onOverSound) will only be triggered if the Pointer object causing them was the Mouse Pointer. The frame will still be changed as applicable.
The Sound to be played when this Buttons Over state is activated.
The Sound Marker used in conjunction with the onOverSound.
The Sound to be played when this Buttons Up state is activated.
The Sound Marker used in conjunction with the onUpSound.
The frame / frameName when the button is in the Out state.
The frame / frameName when the button is in the Over state.
A Game Object is that is pendingDestroy is flagged to have its destroy method called on the next logic update.
A Game Object is that is pendingDestroy is flagged to have its destroy method called on the next logic update. You can set it directly to allow you to flag an object to be destroyed on its next update.
This is extremely useful if you wish to destroy an object from within one of its own callbacks such as with Buttons or other Input events.
The const physics body type of this object.
The position the Game Object was located in the previous frame.
The rotation the Game Object was in set to in the previous frame.
The rotation the Game Object was in set to in the previous frame. Value is in radians.
The render order ID is used internally by the renderer and Input Manager and should not be modified.
The render order ID is used internally by the renderer and Input Manager and should not be modified. This property is mostly used internally by the renderers, but is exposed for the use of plugins.
The right coordinate of the Game Object.
The right coordinate of the Game Object.
This is the same as x + width - offsetX.
The maximum scale this Game Object will scale up to.
The maximum scale this Game Object will scale up to.
It allows you to prevent a parent from scaling this Game Object higher than the given value.
Set it to null to remove the limit.
The minimum scale this Game Object will scale down to.
The minimum scale this Game Object will scale down to.
It allows you to prevent a parent from scaling this Game Object lower than the given value.
Set it to null to remove the limit.
Sets the scaleMin and scaleMax values.
Sets the scaleMin and scaleMax values. These values are used to limit how far this Game Object will scale based on its parent. For example if this Game Object has a minScale value of 1 and its parent has a scale value of 0.5, the 0.5 will be ignored and the scale value of 1 will be used, as the parents scale is lower than the minimum scale this Game Object should adhere to. By setting these values you can carefully control how Game Objects deal with responsive scaling. If only one parameter is given then that value will be used for both scaleMin and scaleMax: setScaleMinMax(1) = scaleMin.x, scaleMin.y, scaleMax.x and scaleMax.y all = 1 If only two parameters are given the first is set as scaleMin.x and y and the second as scaleMax.x and y: setScaleMinMax(0.5, 2) = scaleMin.x and y = 0.5 and scaleMax.x and y = 2 If you wish to set scaleMin with different values for x and y then either modify Game Object.scaleMin directly, or pass null for the maxX and maxY parameters. Call setScaleMinMax(null) to clear all previously set values.
The minimum horizontal scale value this Game Object can scale down to.
The minimum vertical scale value this Game Object can scale down to.
The maximum horizontal scale value this Game Object can scale up to.
The maximum vertical scale value this Game Object can scale up to.
Enable or disable texture smoothing for this Game Object.
Enable or disable texture smoothing for this Game Object. It only takes effect if the Game Object is using an image based texture. Smoothing is enabled by default.
The y coordinate of the Game Object.
The y coordinate of the Game Object.
This is the same as y - offsetY.
The callback that will apply any scale limiting to the worldTransform.
The callback that will apply any scale limiting to the worldTransform.
The context under which transformCallback is called.
The context under which transformCallback is called.
The const type of this object.
The const type of this object.
The frame / frameName when the button is in the Up state.
The world coordinates of this Game Object in pixels.
The world coordinates of this Game Object in pixels.
Depending on where in the display list this Game Object is placed this value can differ from position,
which contains the x/y coordinates relative to the Game Objects parent.
The x coordinate of the Image.
The x coordinate of the Image. The coordinate is relative to any parent container this Image may be in.
The y coordinate of the Image.
The y coordinate of the Image. The coordinate is relative to any parent container this Image may be in.
The z depth of this Game Object within its parent Group.
The z depth of this Game Object within its parent Group. No two objects in a Group can have the same z value. This value is adjusted automatically whenever the Group hierarchy changes. If you wish to re-order the layering of a Game Object then see methods like Group.moveUp or Group.bringToTop.
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. A different texture/frame and activation sound can be specified for any of the states.
Frames can be specified as either an integer (the frame ID) or a string (the frame name); the same values that can be used with a Sprite constructor.