2.0.0-beta
Bar that adjusts the size of a static sprite based on a value. This is done by masking the sprite and then resizing the mask.
Extends Bar
(Object)
Current game instance.
(Object)
Dictionary with the values for the bar's x and y position.
(Object)
The numerical values for the bar.
(boolean)
Determines if the bar should be vertical or horizontal.
(boolean)
Determines the direction the bar moves when adjusted.
(string)
The image key to use for the track.
(string)
The image key to use for the bar. Will automatically resize to fit.
(Object)
Object with duration and easing function for the scrolling tween.
Used by a QuantityBar to hold the bar's values.
(number)
The QuantityBar object that uses the range.
(number)
The initial value for the bar.
(number)
The maximum value the bar can have.
Used by a ValueBar to hold the bar's values.
(number)
The amount the bar is changed by.
(number)
The initial value for the bar.
(number)
The maximum value the bar can have.
Used by a Scrollbar to hold the values and adjust a viewport's position.
(Object)
The viewport to adjust.
(boolean)
If the viewport is vertical or horizontal.
Adjusts the viewport's position.
(any)
A bar that moves along a track. The bar is resized relative to the size of the track and size of the content to be scrolled.
Extends DraggableBar
(Object)
Current game instance.
(Object)
Anything that you want to move via the scrollbar.
(boolean)
Determines if the scrollbar responds to mouse clicks.
(boolean)
Determines if the scrollbar should be vertical or horizontal.
(string)
The image key to use for the track.
(string)
The image key to use for the bar. Will automatically resize to fit.
(Object)
Object with duration and easing function for the scrolling tween.
Bar that adjusts a number. This is done by masking the sprite and then resizing the mask.
Extends DraggableBar
(Object)
Current game instance.
(Object)
Dictionary with the values for the bar's x and y position.
(Object)
The numerical values for the bar.
(boolean)
Determines if the scrollbar responds to mouse clicks.
(boolean)
Determines if the bar should be vertical or horizontal.
(string)
The image key to use for the track.
(string)
The image key to use for the bar. Will automatically resize to fit.
(Object)
Object with duration and easing function for the scrolling tween.
Sets the draggable area of the bar.
Determine the distance the bar can scroll over
Ensure the bar starts off where it should be, according to the bar's logical position.
On mouse up, forces the value to equal the closest step.
Sprite with text added as a child.
Extends Phaser.Group
Phaser Group containing a button with text anchored in the button's center.
Extends Phaser.Group
(Object)
Current game instance.
(number)
The x coordinate on screen where the textSprite will be placed.
(number)
The y coordinate on screen where the textSprite will be placed.
(string)
The image to create a sprite with.
(Object)
Callback to use when the button is clicked.
(Object)
The context the callback is called in.
(number)
The frame to switch to when an over event is triggered.
(number)
The frame to switch to when an out event is triggered.
(number)
The frame to switch to when a down event is triggered.
(number)
The frame to switch to when an up event is triggered.
Adds an adjustment to the text on down/up events.
(any)
Frame that places new child nodes directly under the previous child.
Extends Frame
Group with a dedicated background image.
Extends Phaser.Group
(Object)
Current game instance.
(number
= 0
)
The x position of the Frame.
(number
= 0
)
The y position of the Frame.
(string
= null
)
The background image to use.
(boolean
= false
)
If the Frame should block external interaction until killed.
Frame that places new child nodes directly next to the previous child.
Extends Frame
A container with a limited viewable area. Uses a mask to hide children outside of the specified x/y/width/height area. Content outside the viewport has their input disabled.
Extends PhaserObjects.Group
(Object)
Current game instance.
(number)
The x coordinate on screen where the viewport will be placed.
(number)
The y coordinate on screen where the viewport will be placed.
(number)
The width of the viewport.
(number)
The height of the viewport.
Collection of sprites that can be selected with the keyboard. When the select key is hit, the sprite that was selected is now connected to the keyboard.
(Object)
Current game instance.
(Boolean)
If the selection should be controlled with up/down or left/right arrow keys.
(Object)
The context for the previous and next Events.
A Wheel of sprites where each item's position is projected in 3D space. The number of points is automatically determined by the number of items.
(Object)
Reference to current game instance.
(any)
(array)
List of sprites to use in the wheel.
(Number)
Determines which position on the wheel is the active one.
(Number)
Determines how far to project the points.
(String)
The axis the wheel3D places items around.
(Object)
Axis and angle to rotate the entire wheel after the initial projection.
(Object)
Determines which items on the wheel should be visible. If none provided, assumes all items should be visible.
(Object)
Array with the duration and easing function for the movement tween.
Move the wheel backwards.
Move the wheel forward.
Project every item in the wheel to it's physical location.
Called after movement starts.
Called after movement is finished.
Once the buttons have finished their move animation, allow them to move again.
Move all the WheelItem's position by 1.
(any)
Make sure rotation can't go past 360 in either direction.