The basic object that is rendered to the game screen.
The image for the sprite
use heavy renderer that will reduce border artifacts and apply advanced blendModes
The image for the sprite.
The blend mode to be applied to the sprite.
[read-only] The array of children of the sprite.
Sets the filters for the sprite.
The height of the sprite without the scale.
The opacity of the sprite (0 to 255).
[read-only] The object that contains the sprite.
The origin point of the sprite. (0,0) to (1,1).
The rotation of the sprite in radians.
The scale factor of the sprite.
The visibility of the sprite.
The width of the sprite without the scale.
The x coordinate of the sprite.
The y coordinate of the sprite.
Number of the created objects.
checks if we need to speed up custom blendmodes
Adds a child to the container.
The child to add
The child that was added
Adds a child to the container at a specified index.
The child to add
The index to place the child in
The child that was added
Calls the handler method bound to the button.
Changes the x coordinate of the screen to local sprite x coordinate.
Changes the y coordinate of the screen to local sprite y coordinate.
Calls each of the listeners registered for a given event.
The event name.
Arguments that are passed to registered listeners
true
if the event had listeners, else false
.
Return an array listing the events for which the emitter has registered listeners.
Gets the blend color for the sprite.
The blend color [r, g, b, a]
Gets the color tone for the sprite.
The color tone [r, g, b, gray]
Returns true if the sprite button is currently active.
Returns true is the button is presently being touched.
Return the listeners registered for a given event.
The event name.
Check if there listeners for a given event.
If exists
argument is not true
lists listeners.
The event name.
Only check if there are listeners.
Sets the x and y at once.
The x coordinate of the sprite
The y coordinate of the sprite
Processes weather or not the button is being touched and calls the handler bound to the button.
Removes a child from the container.
The child to remove
The child that was removed
Removes a child from the specified index position.
The index to get the child from
The child that was removed
Sets the blend color for the sprite.
The blend color [r, g, b, a]
Creates a new handler and binds it to the button.
Set the button sprites cold frame.
Sets the color tone for the sprite.
The color tone [r, g, b, gray]
Sets the rectagle of the bitmap that the sprite displays.
The x coordinate of the frame
The y coordinate of the frame
The width of the frame
The height of the frame
Set the button sprites hot frame
This function doesn't apply anymore.
Updates the sprite for each frame.
Update method, which checks if the sprite is being touched and updates the current frame.
Generated using TypeDoc
Sprite_Button
The sprite for displaying a button.