Class: Utils

Classes

Debug

Methods

<static> extend(deep, target)

This is a slightly modified version of http://api.jquery.com/jQuery.extend/

Parameters:

Name	Type	Description
deep	boolean	Perform a deep copy?
target	object	The target object to copy to.

Source:

src/utils/Utils.js line 380

Returns:

The extended object.

Type

object

<static> getProperty(obj, name)

Gets an object's property by string.

Parameters:

Name	Type	Description
obj	object	The object to traverse.
name	string	The property name, or a series of names separated by . (for nested properties).

Source:

src/utils/Utils.js line 43

Returns:

• The value of the property or undefined if the property isn't found.

Type

any

<static> isPlainObject(obj)

This is a slightly modified version of jQuery.isPlainObject. A plain object is an object whose internal class property is [object Object].

Parameters:

Name	Type	Description
obj	object	The object to inspect.

Source:

src/utils/Utils.js line 335

Returns:

• true if the object is plain, otherwise false.

Type

boolean

<static> mixin(from, to)

Mixes the source object into the destination object, returning the newly modified destination object. Based on original code by @mudcube

Parameters:

Name	Type	Description
from	object	The object to copy (the source object).
to	object	The object to copy to (the destination object).

Source:

src/utils/Utils.js line 509

Returns:

The modified destination object.

Type

object

<static> mixinPrototype(target, mixin [, replace])

Mixes in an existing mixin object with the target.

Values in the mixin that have either get or set functions are created as properties via defineProperty except if they also define a clone method - if a clone method is defined that is called instead and the result is assigned directly.

Parameters:

Name	Type	Argument	Default	Description
target	object			The target object to receive the new functions.
mixin	object			The object to copy the functions from.
replace	boolean	<optional>	false	If the target object already has a matching function should it be overwritten or not?

Source:

src/utils/Utils.js line 460

<static> pad(str [, len] [, pad] [, dir])

Takes the given string and pads it out, to the length required, using the character specified. For example if you need a string to be 6 characters long, you can call:

pad('bob', 6, '-', 2)

This would return: bob--- as it has padded it out to 6 characters, using the - on the right.

You can also use it to pad numbers (they are always returned as strings):

pad(512, 6, '0', 1)

Would return: 000512 with the string padded to the left.

If you don't specify a direction it'll pad to both sides:

pad('c64', 7, '*')

Would return: **c64**

Parameters:

Name	Type	Argument	Default	Description
str	string			The target string. toString() will be called on the string, which means you can also pass in common data types like numbers.
len	integer	<optional>	0	The number of characters to be added.
pad	string	<optional>	" "	The string to pad it out with (defaults to a space).
dir	integer	<optional>	3	The direction dir = 1 (left), 2 (right), 3 (both).

Source:

src/utils/Utils.js line 275

Returns:

The padded string.

Type

string

<static> parseDimension(size, dimension)

Get a unit dimension from a string.

Parameters:

Name	Type	Description
size	string | number	The size to parse.
dimension	number	The window dimension to check.

Source:

src/utils/Utils.js line 233

Returns:

The parsed dimension.

Type

number

<static> reverseString(string)

Takes the given string and reverses it, returning the reversed string. For example if given the string Atari 520ST it would return TS025 iratA.

Parameters:

Name	Type	Description
string	string	The string to be reversed.

Source:

src/utils/Utils.js line 30

Returns:

The reversed string.

Type

string

<static> setProperties(obj, props)

Sets an object's properties from a map of property names and values.

Phaser.Utils.setProperties(sprite, {
 'animations.paused': true,
 'body.enable': false,
 'input.draggable': true,
});

Parameters:

Name	Type	Description
obj	object	The object to modify.
props	object	The property names and values to set on the object (see #setProperty).

Source:

src/utils/Utils.js line 70

Returns:

The modified object.

Type

object

<static> setProperty(obj, name, value)

Sets an object's property by name and value.

Phaser.Utils.setProperty(sprite, 'body.velocity.x', 60);

Parameters:

Name	Type	Description
obj	object	The object to modify.
name	string	The property name, or a series of names separated by . (for nested properties).
value	any	The value.

Source:

src/utils/Utils.js line 96

Returns:

The modified object.

Type

object

chanceRoll(chance)

Generate a random bool result based on the chance value.

Returns true or false based on the chance value (default 50%). For example if you wanted a player to have a 30% chance of getting a bonus, call chanceRoll(30) - true means the chance passed, false means it failed.

Parameters:

Name	Type	Description
chance	number	The chance of receiving the value. A number between 0 and 100 (effectively 0% to 100%).

Source:

src/utils/Utils.js line 204

Returns:

True if the roll passed, or false otherwise.

Type

boolean

randomChoice(choice1, choice2)

Choose between one of two values randomly.

Parameters:

Name	Type	Description
choice1	any
choice2	any

Source:

src/utils/Utils.js line 220

Returns:

The randomly selected choice

Type

any