diff --git a/Docs/out/Animation-Phaser.Animation.html b/Docs/out/Animation-Phaser.Animation.html index c35f1eed..b0ae5081 100644 --- a/Docs/out/Animation-Phaser.Animation.html +++ b/Docs/out/Animation-Phaser.Animation.html @@ -1147,13 +1147,13 @@
diff --git a/Docs/out/Animation.html b/Docs/out/Animation.html index 46dd954e..d94b20b4 100644 --- a/Docs/out/Animation.html +++ b/Docs/out/Animation.html @@ -120,13 +120,13 @@
diff --git a/Docs/out/Camera-Phaser.Camera.html b/Docs/out/Camera-Phaser.Camera.html index 1ccf8e45..cecb3cf6 100644 --- a/Docs/out/Camera-Phaser.Camera.html +++ b/Docs/out/Camera-Phaser.Camera.html @@ -438,7 +438,7 @@ -bool +boolean @@ -1155,7 +1155,7 @@ -bool +boolean @@ -1330,13 +1330,13 @@
diff --git a/Docs/out/Camera.html b/Docs/out/Camera.html index d0d10d17..32a781ae 100644 --- a/Docs/out/Camera.html +++ b/Docs/out/Camera.html @@ -120,13 +120,13 @@
diff --git a/Docs/out/Game-Phaser.Game.html b/Docs/out/Game-Phaser.Game.html index 4c2447d6..f040922c 100644 --- a/Docs/out/Game-Phaser.Game.html +++ b/Docs/out/Game-Phaser.Game.html @@ -204,7 +204,7 @@ -bool +boolean @@ -227,7 +227,7 @@ -bool +boolean @@ -461,7 +461,7 @@ -bool +boolean @@ -1492,7 +1492,7 @@ -bool +boolean @@ -1596,7 +1596,7 @@ -bool +boolean @@ -3147,7 +3147,7 @@ -bool +boolean @@ -3527,13 +3527,13 @@
diff --git a/Docs/out/Game.html b/Docs/out/Game.html index f5b57424..4fbf90a8 100644 --- a/Docs/out/Game.html +++ b/Docs/out/Game.html @@ -120,13 +120,13 @@
diff --git a/Docs/out/Group-Phaser.Group.html b/Docs/out/Group-Phaser.Group.html index 63066302..c1c5e5ed 100644 --- a/Docs/out/Group-Phaser.Group.html +++ b/Docs/out/Group-Phaser.Group.html @@ -30,7 +30,7 @@ Group -
An Animation instance contains a single animation and the controls to play it. It is created by the AnimationManager, consists of Animation.Frame objects and belongs to a single Game Object such as a Sprite.
+
A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
@@ -158,7 +158,7 @@ -bool +boolean @@ -199,7 +199,7 @@
Source:
@@ -288,7 +288,7 @@ -bool +boolean @@ -329,7 +329,7 @@
Source:
@@ -430,7 +430,7 @@
Source:
@@ -531,7 +531,7 @@
Source:
@@ -632,7 +632,7 @@
Source:
@@ -671,7 +671,7 @@
diff --git a/Docs/out/Group.html b/Docs/out/Group.html index e5bb4cc7..1f2da26a 100644 --- a/Docs/out/Group.html +++ b/Docs/out/Group.html @@ -126,7 +126,7 @@
diff --git a/Docs/out/Group_.html b/Docs/out/Group_.html new file mode 100644 index 00000000..9dd621b3 --- /dev/null +++ b/Docs/out/Group_.html @@ -0,0 +1,135 @@ + + + + + JSDoc: Module: Group + + + + + + + + + + +
+ +

Module: Group

+ + + + + +
+ +
+

+ Phaser. + + Group +

+ +
+ +
+
+ + + + + + +
+ + + + + + + + + + + +
Author:
+
+ +
+ + + +
Copyright:
+
  • 2013 Photon Storm Ltd.
+ + + +
License:
+
+ + + + + +
Source:
+
  • + core/Group.js, line 1 +
+ + + + + + + +
+ + + + +
+ + + + + + + + + + + + + + + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/Docs/out/Phaser.Animation.Frame.html b/Docs/out/Phaser.Animation.Frame.html index 1ae6098f..a23166c3 100644 --- a/Docs/out/Phaser.Animation.Frame.html +++ b/Docs/out/Phaser.Animation.Frame.html @@ -963,7 +963,7 @@ -bool +boolean @@ -1789,7 +1789,7 @@ -bool +boolean @@ -2306,7 +2306,7 @@ -bool +boolean @@ -2526,13 +2526,13 @@
diff --git a/Docs/out/Phaser.Animation.FrameData.html b/Docs/out/Phaser.Animation.FrameData.html index 150d583f..6a0abe3f 100644 --- a/Docs/out/Phaser.Animation.FrameData.html +++ b/Docs/out/Phaser.Animation.FrameData.html @@ -1359,7 +1359,7 @@
-

<static> total() → {Number}

+

<static> total() → {number}

@@ -1436,7 +1436,7 @@
-Number +number
@@ -1463,13 +1463,13 @@
diff --git a/Docs/out/Phaser.Animation.Parser.html b/Docs/out/Phaser.Animation.Parser.html index 0d846933..bd9f4609 100644 --- a/Docs/out/Phaser.Animation.Parser.html +++ b/Docs/out/Phaser.Animation.Parser.html @@ -993,13 +993,13 @@
diff --git a/Docs/out/Phaser.AnimationManager.html b/Docs/out/Phaser.AnimationManager.html index c5af2ecc..d544bd0a 100644 --- a/Docs/out/Phaser.AnimationManager.html +++ b/Docs/out/Phaser.AnimationManager.html @@ -1679,13 +1679,13 @@
diff --git a/Docs/out/Phaser.Group.html b/Docs/out/Phaser.Group.html new file mode 100644 index 00000000..342a6e3f --- /dev/null +++ b/Docs/out/Phaser.Group.html @@ -0,0 +1,5067 @@ + + + + + JSDoc: Class: Group + + + + + + + + + + +
+ +

Class: Group

+ + + + + +
+ +
+

+ Phaser. + + Group +

+ +
A Group is a container for display objects that allows for fast pooling, recycling and collision checks.
+ +
+ +
+
+ + + + +
+

new Group(game, parent, name, useStage)

+ + +
+
+ + +
+ Phaser Group constructor. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
game + + +Phaser.Game + + + + A reference to the currently running game.
parent + + +Description + + + + Description.
name + + +string + + + + The unique name for this animation, used in playback commands.
useStage + + +boolean + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 18 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + +
+ + + + + + + + + + + + +

Members

+ +
+ +
+

exists

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
exists + + +boolean + + + + Description.
+ + + + + + + + + + + + + + + + + + +
Default Value:
+
  • true
+ + + +
Source:
+
  • + core/Group.js, line 72 +
+ + + + + + + +
+ + + +
+ + + +
+

game

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
game + + +Phaser.Game + + + + A reference to the currently running Game.
+ + + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 30 +
+ + + + + + + +
+ + + +
+ + + +
+

name

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
name + + +Phaser.Game + + + + Description.
+ + + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 35 +
+ + + + + + + +
+ + + +
+ + + +
+

type

+ + +
+
+ + + + + +
+ + +
Properties:
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
type + + +Description + + + + Description.
+ + + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 66 +
+ + + + + + + +
+ + + +
+ +
+ + + +

Methods

+ +
+ +
+

<static> add(child) → {Description}

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
child + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 85 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ Description. +
+ + + +
+
+ Type +
+
+ +Description + + +
+
+ + + + +
+ + + +
+

<static> addAll(property, amount, checkAlive, checkVisible)

+ + +
+
+ + +
+ Adds the amount to the given property on all children in this Group. Group.addAll('x', 10) will add 10 to the child.x value. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
property + + +string + + + + The property to increment, for example 'body.velocity.x' or 'angle'.
amount + + +number + + + + The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50.
checkAlive + + +boolean + + + + If true the property will only be changed if the child is alive.
checkVisible + + +boolean + + + + If true the property will only be changed if the child is visible.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 481 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> addAt(child, index) → {Description}

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
child + + +Description + + + + Description.
index + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 111 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ Description. +
+ + + +
+
+ Type +
+
+ +Description + + +
+
+ + + + +
+ + + +
+

<static> bringToTop(child) → {Description}

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
child + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 313 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ Description. +
+ + + +
+
+ Type +
+
+ +Description + + +
+
+ + + + +
+ + + +
+

<static> callAll(callback, parameter)

+ + +
+
+ + +
+ Calls a function on all of the children regardless if they are dead or alive (see callAllExists if you need control over that) After the callback parameter you can add as many extra parameters as you like, which will all be passed to the child. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
callback + + +function + + + + + + + + + + The function that exists on the children that will be called.
parameter + + +* + + + + + + + + + + <repeatable>
+ + 		Additional parameters that will be passed to the callback.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 582 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> callAllExists(callback, existsValue, parameter)

+ + +
+
+ + +
+ Calls a function on all of the children that have exists=true in this Group. After the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
callback + + +function + + + + + + + + + + The function that exists on the children that will be called.
existsValue + + +boolean + + + + + + + + + + Only children with exists=existsValue will be called.
parameter + + +* + + + + + + + + + + <repeatable>
+ + 		Additional parameters that will be passed to the callback.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 549 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> countDead() → {number}

+ + +
+
+ + +
+ Call this function to find out how many members of the group are dead. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 845 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ The number of children flagged as dead. Returns -1 if Group is empty. +
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + +
+ + + +
+

<static> countLiving() → {number}

+ + +
+
+ + +
+ Call this function to find out how many members of the group are alive. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 814 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ The number of children flagged as alive. Returns -1 if Group is empty. +
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + +
+ + + +
+

<static> create(x, y, key, frame, exists) → {Description}

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
x + + +number + + + + + + + + + + Description.
y + + +number + + + + + + + + + + Description.
key + + +string + + + + + + + + + + Description.
frame + + +string + + + + + + <optional>
+ + + + + + 		Description.
exists + + +boolean + + + + + + <optional>
+ + + + + + 		Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 152 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ Description. +
+ + + +
+
+ Type +
+
+ +Description + + +
+
+ + + + +
+ + + +
+

<static> destroy()

+ + +
+
+ + +
+ Description. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 968 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> divideAll(property, amount, checkAlive, checkVisible)

+ + +
+
+ + +
+ Divides the given property by the amount on all children in this Group. Group.divideAll('x', 2) will half the child.x value. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
property + + +string + + + + The property to divide, for example 'body.velocity.x' or 'angle'.
amount + + +number + + + + The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50.
checkAlive + + +boolean + + + + If true the property will only be changed if the child is alive.
checkVisible + + +boolean + + + + If true the property will only be changed if the child is visible.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 532 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> dump()

+ + +
+
+ + +
+ Description. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 988 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> forEach(callback, callbackContext, checkExists)

+ + +
+
+ + +
+ Description. After the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
callback + + +Description + + + + Description.
callbackContext + + +Description + + + + Description.
checkExists + + +boolean + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 614 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> forEachAlive(callback, callbackContext)

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
callback + + +Description + + + + Description.
callbackContext + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 654 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> forEachDead(callback, callbackContext)

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
callback + + +Description + + + + Description.
callbackContext + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 687 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> getAt(index) → {Description}

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
index + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 138 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ Description. +
+ + + +
+
+ Type +
+
+ +Description + + +
+
+ + + + +
+ + + +
+

<static> getFirstAlive() → {Any}

+ + +
+
+ + +
+ Call this function to retrieve the first object with alive == true in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 754 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ The first alive child, or null if none found. +
+ + + +
+
+ Type +
+
+ +Any + + +
+
+ + + + +
+ + + +
+

<static> getFirstDead() → {Any}

+ + +
+
+ + +
+ Call this function to retrieve the first object with alive == false in the group. This is handy for checking if everything's wiped out, or choosing a squad leader, etc. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 784 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ The first dead child, or null if none found. +
+ + + +
+
+ Type +
+
+ +Any + + +
+
+ + + + +
+ + + +
+

<static> getFirstExists(state) → {Any}

+ + +
+
+ + +
+ Call this function to retrieve the first object with exists == (the given state) in the group. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
state + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 719 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ The first child, or null if none found. +
+ + + +
+
+ Type +
+
+ +Any + + +
+
+ + + + +
+ + + +
+

<static> getIndex(child) → {Description}

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
child + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 333 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ Description. +
+ + + +
+
+ Type +
+
+ +Description + + +
+
+ + + + +
+ + + +
+

<static> getRandom(startIndex, length) → {Any}

+ + +
+
+ + +
+ Returns a member at random from the group. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
startIndex + + +number + + + + Optional offset off the front of the array. Default value is 0, or the beginning of the array.
length + + +number + + + + Optional restriction on the number of values you want to randomly select from.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 876 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ A random child of this Group. +
+ + + +
+
+ Type +
+
+ +Any + + +
+
+ + + + +
+ + + +
+

<static> multiplyAll(property, amount, checkAlive, checkVisible)

+ + +
+
+ + +
+ Multiplies the given property by the amount on all children in this Group. Group.multiplyAll('x', 2) will x2 the child.x value. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
property + + +string + + + + The property to multiply, for example 'body.velocity.x' or 'angle'.
amount + + +number + + + + The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20.
checkAlive + + +boolean + + + + If true the property will only be changed if the child is alive.
checkVisible + + +boolean + + + + If true the property will only be changed if the child is visible.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 515 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> remove(child)

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
child + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 899 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> removeAll()

+ + +
+
+ + +
+ Description. +
+ + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 914 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> removeBetween(startIndex, endIndex)

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
startIndex + + +Description + + + + Description.
endIndex + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 939 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> replace(oldChild, newChild)

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
oldChild + + +Description + + + + Description.
newChild + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 347 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> setAll(key, value, checkAlive, checkVisible, operation)

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
key + + +Description + + + + Description.
value + + +Description + + + + Description.
checkAlive + + +Description + + + + Description.
checkVisible + + +Description + + + + Description.
operation + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 443 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> setProperty(child, key, value, operation) → {number}

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
child + + +Description + + + + Description.
key + + +array + + + + An array of values that will be set.
value + + +Description + + + + Description.
operation + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 379 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ An integer value: -1 (Obj1 before Obj2), 0 (same), or 1 (Obj1 after Obj2). (TODO) +
+ + + +
+
+ Type +
+
+ +number + + +
+
+ + + + +
+ + + +
+

<static> subAll(property, amount, checkAlive, checkVisible)

+ + +
+
+ + +
+ Subtracts the amount from the given property on all children in this Group. Group.subAll('x', 10) will minus 10 from the child.x value. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
property + + +string + + + + The property to decrement, for example 'body.velocity.x' or 'angle'.
amount + + +number + + + + The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10.
checkAlive + + +boolean + + + + If true the property will only be changed if the child is alive.
checkVisible + + +boolean + + + + If true the property will only be changed if the child is visible.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 498 +
+ + + + + + + +
+ + + + + + + + + + + + + +
+ + + +
+

<static> swap(child1, child2) → {boolean}

+ + +
+
+ + +
+ Description. +
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
child1 + + +Description + + + + Description.
child2 + + +Description + + + + Description.
+ + + +
+ + + + + + + + + + + + + + + + + + + +
Source:
+
  • + core/Group.js, line 184 +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+ Description. +
+ + + +
+
+ Type +
+
+ +boolean + + +
+
+ + + + +
+ +
+ + + + + +
+ +
+ + + + +
+ + + +
+ + + + + + + \ No newline at end of file diff --git a/Docs/out/Phaser.html b/Docs/out/Phaser.html index db2e43d5..5d48469d 100644 --- a/Docs/out/Phaser.html +++ b/Docs/out/Phaser.html @@ -103,6 +103,9 @@
AnimationManager
+ +
Group
+
@@ -125,13 +128,13 @@
diff --git a/Docs/out/global.html b/Docs/out/global.html index 4e445f3c..31952df2 100644 --- a/Docs/out/global.html +++ b/Docs/out/global.html @@ -91,7 +91,7 @@
-

multiplyAll(property, amount, checkAlive, checkVisible)

+

add(child) → {Description}

@@ -99,7 +99,7 @@
- Multiplies the given property by the amount on all children in this Group. Group.multiplyAll('x', 2) will x2 the child.x value. + Description.
@@ -133,13 +133,13 @@ - property + child -string +Description @@ -149,76 +149,7 @@ - The property to multiply, for example 'body.velocity.x' or 'angle'. - - - - - - - amount - - - - - -number - - - - - - - - - - The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20. - - - - - - - checkAlive - - - - - -boolean - - - - - - - - - - If true the property will only be changed if the child is alive. - - - - - - - checkVisible - - - - - -boolean - - - - - - - - - - If true the property will only be changed if the child is visible. + Description. @@ -249,7 +180,7 @@
Source:
@@ -270,6 +201,28 @@ +
Returns:
+ + +
+ Description. +
+ + + +
+
+ Type +
+
+ +Description + + +
+
+ + @@ -290,13 +243,13 @@
diff --git a/Docs/out/index.html b/Docs/out/index.html index bb7dcca2..6552f435 100644 --- a/Docs/out/index.html +++ b/Docs/out/index.html @@ -48,13 +48,13 @@
diff --git a/Docs/out/module-Phaser.html b/Docs/out/module-Phaser.html index 7d5d6aba..c8e09028 100644 --- a/Docs/out/module-Phaser.html +++ b/Docs/out/module-Phaser.html @@ -105,13 +105,13 @@
diff --git a/src/core/Camera.js b/src/core/Camera.js index 2ca65f10..f93b2a77 100644 --- a/src/core/Camera.js +++ b/src/core/Camera.js @@ -93,7 +93,7 @@ Phaser.Camera.prototype = { /** * Tells this camera which sprite to follow. * @method follow - * @memberOf Phaser.Camera + * @memberof Phaser.Camera * @param {Phaser.Sprite} target - The object you want the camera to track. Set to null to not follow anything. * @param {number} [style] Leverage one of the existing "deadzone" presets. If you use a custom deadzone, ignore this parameter and manually specify the deadzone after calling follow(). */ @@ -134,7 +134,7 @@ Phaser.Camera.prototype = { /** * Move the camera focus to a location instantly. * @method focusOnXY - * @memberOf Phaser.Camera + * @memberof Phaser.Camera * @param {number} x - X position. * @param {number} y - Y position. */ @@ -148,7 +148,7 @@ Phaser.Camera.prototype = { /** * Update focusing and scrolling. * @method update - * @memberOf Phaser.Camera + * @memberof Phaser.Camera */ update: function () { @@ -199,7 +199,7 @@ Phaser.Camera.prototype = { /** * Method called to ensure the camera doesn't venture outside of the game world. * @method checkWorldBounds - * @memberOf Phaser.Camera + * @memberof Phaser.Camera */ checkWorldBounds: function () { @@ -240,7 +240,7 @@ Phaser.Camera.prototype = { * without having to use game.camera.x and game.camera.y. * * @method setPosition - * @memberOf Phaser.Camera + * @memberof Phaser.Camera * @param {number} x - X position. * @param {number} y - Y position. */ @@ -256,7 +256,7 @@ Phaser.Camera.prototype = { * Sets the size of the view rectangle given the width and height in parameters. * * @method setSize - * @memberOf Phaser.Camera + * @memberof Phaser.Camera * @param {number} width - The desired width. * @param {number} height - The desired height. */ diff --git a/src/core/Game.js b/src/core/Game.js index 92874a6c..ccf24255 100644 --- a/src/core/Game.js +++ b/src/core/Game.js @@ -253,7 +253,7 @@ Phaser.Game.prototype = { * Initialize engine sub modules and start the game. * * @method boot - * @memberOf Phaser.Game + * @memberof Phaser.Game */ boot: function () { @@ -334,7 +334,7 @@ Phaser.Game.prototype = { * Checks if the device is capable of using the requested renderer and sets it up or an alternative if not. * * @method setUpRenderer - * @memberOf Phaser.Game + * @memberof Phaser.Game */ setUpRenderer: function () { @@ -371,7 +371,7 @@ Phaser.Game.prototype = { * Called when the load has finished, after preload was run. * * @method loadComplete - * @memberOf Phaser.Game + * @memberof Phaser.Game */ loadComplete: function () { @@ -385,7 +385,7 @@ Phaser.Game.prototype = { * The core game loop. * * @method update - * @memberOf Phaser.Game + * @memberof Phaser.Game * @param {number} time - The current time as provided by RequestAnimationFrame. */ update: function (time) { @@ -420,7 +420,7 @@ Phaser.Game.prototype = { * Nuke the entire game from orbit * * @method destroy - * @memberOf Phaser.Game + * @memberof Phaser.Game */ destroy: function () { diff --git a/src/core/Group.js b/src/core/Group.js index e7698e8b..7d27d294 100644 --- a/src/core/Group.js +++ b/src/core/Group.js @@ -86,7 +86,7 @@ Phaser.Group.prototype = { * Description. * * @method add - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} child - Description. * @return {Description} Description. */ @@ -112,7 +112,7 @@ Phaser.Group.prototype = { * Description. * * @method addAt - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} child - Description. * @param {Description} index - Description. * @return {Description} Description. @@ -139,7 +139,7 @@ Phaser.Group.prototype = { * Description. * * @method getAt - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} index - Description. * @return {Description} Description. */ @@ -153,7 +153,7 @@ Phaser.Group.prototype = { * Description. * * @method create - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {number} x - Description. * @param {number} y - Description. * @param {string} key - Description. @@ -185,7 +185,7 @@ Phaser.Group.prototype = { * Description. * * @method swap - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} child1 - Description. * @param {Description} child2 - Description. * @return {boolean} Description. @@ -314,7 +314,7 @@ Phaser.Group.prototype = { * Description. * * @method bringToTop - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} child - Description. * @return {Description} Description. */ @@ -334,7 +334,7 @@ Phaser.Group.prototype = { * Description. * * @method getIndex - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} child - Description. * @return {Description} Description. */ @@ -348,7 +348,7 @@ Phaser.Group.prototype = { * Description. * * @method replace - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} oldChild - Description. * @param {Description} newChild - Description. */ @@ -380,7 +380,7 @@ Phaser.Group.prototype = { * Description. * * @method setProperty - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} child - Description. * @param {array} key - An array of values that will be set. * @param {Description} value - Description. @@ -444,7 +444,7 @@ Phaser.Group.prototype = { * Description. * * @method setAll - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} key - Description. * @param {Description} value - Description. * @param {Description} checkAlive - Description. @@ -483,7 +483,7 @@ Phaser.Group.prototype = { * Group.addAll('x', 10) will add 10 to the child.x value. * * @method addAll - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {string} property - The property to increment, for example 'body.velocity.x' or 'angle'. * @param {number} amount - The amount to increment the property by. If child.x = 10 then addAll('x', 40) would make child.x = 50. * @param {boolean} checkAlive - If true the property will only be changed if the child is alive. @@ -500,7 +500,7 @@ Phaser.Group.prototype = { * Group.subAll('x', 10) will minus 10 from the child.x value. * * @method subAll - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {string} property - The property to decrement, for example 'body.velocity.x' or 'angle'. * @param {number} amount - The amount to subtract from the property. If child.x = 50 then subAll('x', 40) would make child.x = 10. * @param {boolean} checkAlive - If true the property will only be changed if the child is alive. @@ -517,7 +517,7 @@ Phaser.Group.prototype = { * Group.multiplyAll('x', 2) will x2 the child.x value. * * @method multiplyAll - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {string} property - The property to multiply, for example 'body.velocity.x' or 'angle'. * @param {number} amount - The amount to multiply the property by. If child.x = 10 then multiplyAll('x', 2) would make child.x = 20. * @param {boolean} checkAlive - If true the property will only be changed if the child is alive. @@ -534,7 +534,7 @@ Phaser.Group.prototype = { * Group.divideAll('x', 2) will half the child.x value. * * @method divideAll - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {string} property - The property to divide, for example 'body.velocity.x' or 'angle'. * @param {number} amount - The amount to divide the property by. If child.x = 100 then divideAll('x', 2) would make child.x = 50. * @param {boolean} checkAlive - If true the property will only be changed if the child is alive. @@ -551,7 +551,7 @@ Phaser.Group.prototype = { * After the existsValue parameter you can add as many parameters as you like, which will all be passed to the child callback. * * @method callAllExists - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {function} callback - The function that exists on the children that will be called. * @param {boolean} existsValue - Only children with exists=existsValue will be called. * @param {...*} parameter - Additional parameters that will be passed to the callback. @@ -584,7 +584,7 @@ Phaser.Group.prototype = { * After the callback parameter you can add as many extra parameters as you like, which will all be passed to the child. * * @method callAll - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {function} callback - The function that exists on the children that will be called. * @param {...*} parameter - Additional parameters that will be passed to the callback. */ @@ -616,7 +616,7 @@ Phaser.Group.prototype = { * After the checkExists parameter you can add as many parameters as you like, which will all be passed to the callback along with the child. * * @method forEach - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} callback - Description. * @param {Description} callbackContext - Description. * @param {boolean} checkExists - Description. @@ -655,7 +655,7 @@ Phaser.Group.prototype = { * Description. * * @method forEachAlive - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} callback - Description. * @param {Description} callbackContext - Description. */ @@ -688,7 +688,7 @@ Phaser.Group.prototype = { * Description. * * @method forEachDead - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} callback - Description. * @param {Description} callbackContext - Description. */ @@ -720,7 +720,7 @@ Phaser.Group.prototype = { * Call this function to retrieve the first object with exists == (the given state) in the group. * * @method getFirstExists - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} state - Description. * @return {Any} The first child, or null if none found. */ @@ -756,7 +756,7 @@ Phaser.Group.prototype = { * This is handy for checking if everything's wiped out, or choosing a squad leader, etc. * * @method getFirstAlive - * @memberOf Phaser.Group + * @memberof Phaser.Group * @return {Any} The first alive child, or null if none found. */ getFirstAlive: function () { @@ -786,7 +786,7 @@ Phaser.Group.prototype = { * This is handy for checking if everything's wiped out, or choosing a squad leader, etc. * * @method getFirstDead - * @memberOf Phaser.Group + * @memberof Phaser.Group * @return {Any} The first dead child, or null if none found. */ getFirstDead: function () { @@ -815,7 +815,7 @@ Phaser.Group.prototype = { * Call this function to find out how many members of the group are alive. * * @method countLiving - * @memberOf Phaser.Group + * @memberof Phaser.Group * @return {number} The number of children flagged as alive. Returns -1 if Group is empty. */ countLiving: function () { @@ -846,7 +846,7 @@ Phaser.Group.prototype = { * Call this function to find out how many members of the group are dead. * * @method countDead - * @memberOf Phaser.Group + * @memberof Phaser.Group * @return {number} The number of children flagged as dead. Returns -1 if Group is empty. */ countDead: function () { @@ -877,7 +877,7 @@ Phaser.Group.prototype = { * Returns a member at random from the group. * * @method getRandom - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {number} startIndex - Optional offset off the front of the array. Default value is 0, or the beginning of the array. * @param {number} length - Optional restriction on the number of values you want to randomly select from. * @return {Any} A random child of this Group. @@ -900,7 +900,7 @@ Phaser.Group.prototype = { * Description. * * @method remove - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} child - Description. */ remove: function (child) { @@ -915,7 +915,7 @@ Phaser.Group.prototype = { * Description. * * @method removeAll - * @memberOf Phaser.Group + * @memberof Phaser.Group */ removeAll: function () { @@ -940,7 +940,7 @@ Phaser.Group.prototype = { * Description. * * @method removeBetween - * @memberOf Phaser.Group + * @memberof Phaser.Group * @param {Description} startIndex - Description. * @param {Description} endIndex - Description. */ @@ -969,7 +969,7 @@ Phaser.Group.prototype = { * Description. * * @method destroy - * @memberOf Phaser.Group + * @memberof Phaser.Group */ destroy: function () { @@ -989,7 +989,7 @@ Phaser.Group.prototype = { * Description. * * @method dump - * @memberOf Phaser.Group + * @memberof Phaser.Group */ dump: function (full) { diff --git a/src/core/SignalBinding.js b/src/core/SignalBinding.js index 6864a302..c91876a8 100644 --- a/src/core/SignalBinding.js +++ b/src/core/SignalBinding.js @@ -40,7 +40,7 @@ Phaser.SignalBinding = function (signal, listener, isOnce, listenerContext, prio /** * @property {object|undefined|null} context - Context on which listener will be executed (object that should represent the `this` variable inside listener function). - * @memberOf SignalBinding.prototype + * @memberof SignalBinding.prototype */ this.context = listenerContext; diff --git a/src/physics/arcade/Body.js b/src/physics/arcade/Body.js index dbd6b819..853d8002 100644 --- a/src/physics/arcade/Body.js +++ b/src/physics/arcade/Body.js @@ -171,7 +171,8 @@ Phaser.Physics.Arcade.Body.prototype = { if (this.allowRotation) { - this.sprite.angle = this.rotation; + // Needs to use rotation delta + // this.sprite.angle += this.rotation; } },