Home Reference Source
public class | source

Button

Extends:

Phaser~Phaser.Group → Button

Draws an interactive button in the display

Constructor Summary

Public Constructor
public

constructor(app: object, parentGroup: object, callback: function, callbackContext: object, width: number, height: number, label: string, keyCode: number | null, outlineKey: string, fillKey: string, labelFont: string)

Member Summary

Public Members
public
public
public
public
public
public

keyCode: *

public

label: *

public
public
public

tweens: *

Method Summary

Public Methods
public
public

fill()

public

handlePointerOutput(thisPointer: *)

Public Constructors

public constructor(app: object, parentGroup: object, callback: function, callbackContext: object, width: number, height: number, label: string, keyCode: number | null, outlineKey: string, fillKey: string, labelFont: string) source

Params:

NameTypeAttributeDescription
app object

The container App

parentGroup object
  • optional
  • default: null

Parent Group of this Button

callback function
  • optional
  • default: null

Bind a callback function to this Button

callbackContext object
  • optional
  • default: null

Context of your optional bound callback function

width number
  • optional
  • default: 60

Display width in pixels

height number
  • optional
  • default: 60

Display height in pixels

label string
  • optional
  • default: "OK"

Text displayed inside the Button

keyCode number | null
  • optional
  • default: null

Bind a JS keyCode to this Button

outlineKey string
  • optional
  • default: "squircle"

Name of a registered outline Sprite

fillKey string
  • optional
  • default: "squircle_fill"

Name of a registered fill Sprite

labelFont string
  • optional
  • default: "proxima_nova"

Name of a registered Bitmap Font

Public Members

public callback: * source

public callbackContext: * source

public fillSprite: * source

public fillTween: * source

public inputKey: * source

public keyCode: * source

public label: * source

public outlineSprite: * source

public submitSignal: * source

public tweens: * source

Public Methods

public destroy() source

public fill() source

public handlePointerOutput(thisPointer: *) source

Params:

NameTypeAttributeDescription
thisPointer *