You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Phaser/Group.ts
+40-31Lines changed: 40 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -187,9 +187,9 @@ module Phaser {
187
187
* <p>WARNING: If the group has a maxSize that has already been met,
188
188
* the object will NOT be added to the group!</p>
189
189
*
190
-
* @paramObjectThe object you want to add to the group.
190
+
* @param {Basic} ObjectThe object you want to add to the group.
191
191
*
192
-
* @returnThe same <code>Basic</code> object that was passed in.
192
+
* @return {Basic} The same <code>Basic</code> object that was passed in.
193
193
*/
194
194
publicadd(Object: Basic){
195
195
@@ -269,9 +269,9 @@ module Phaser {
269
269
* and no object class was provided, it will return null
270
270
* instead of a valid object!</p>
271
271
*
272
-
* @paramObjectClassThe class type you want to recycle (e.g. Basic, EvilRobot, etc). Do NOT "new" the class in the parameter!
272
+
* @param {class} ObjectClassThe class type you want to recycle (e.g. Basic, EvilRobot, etc). Do NOT "new" the class in the parameter!
273
273
*
274
-
* @returnA reference to the object that was created. Don't forget to cast it back to the Class you want (e.g. myObject = myGroup.recycle(myObjectClass) as myObjectClass;).
274
+
* @return {any} A reference to the object that was created. Don't forget to cast it back to the Class you want (e.g. myObject = myGroup.recycle(myObjectClass) as myObjectClass;).
275
275
*/
276
276
publicrecycle(ObjectClass=null){
277
277
@@ -321,10 +321,10 @@ module Phaser {
321
321
/**
322
322
* Removes an object from the group.
323
323
*
324
-
* @paramobjectThe <code>Basic</code> you want to remove.
325
-
* @paramspliceWhether the object should be cut from the array entirely or not.
324
+
* @param {Basic} objectThe <code>Basic</code> you want to remove.
325
+
* @param {boolean} spliceWhether the object should be cut from the array entirely or not.
* <code>State.update()</code> override. To sort all existing objects after
380
380
* a big explosion or bomb attack, you might call <code>myGroup.sort("exists",Group.DESCENDING)</code>.
381
381
*
382
-
* @paramindexThe <code>string</code> name of the member variable you want to sort on. Default value is "y".
383
-
* @paramorderA <code>Group</code> constant that defines the sort order. Possible values are <code>Group.ASCENDING</code> and <code>Group.DESCENDING</code>. Default value is <code>Group.ASCENDING</code>.
382
+
* @param {string} indexThe <code>string</code> name of the member variable you want to sort on. Default value is "y".
383
+
* @param {number} orderA <code>Group</code> constant that defines the sort order. Possible values are <code>Group.ASCENDING</code> and <code>Group.DESCENDING</code>. Default value is <code>Group.ASCENDING</code>.
* Go through and set the specified variable to the specified value on all members of the group.
395
395
*
396
-
* @paramVariableName The string representation of the variable name you want to modify, for example "visible" or "scrollFactor".
397
-
* @paramValueThe value you want to assign to that variable.
398
-
* @paramRecurse Default value is true, meaning if <code>setAll()</code> encounters a member that is a group, it will call <code>setAll()</code> on that group rather than modifying its variable.
396
+
* @param {string} VariableName The string representation of the variable name you want to modify, for example "visible" or "scrollFactor".
397
+
* @param {Object} ValueThe value you want to assign to that variable.
398
+
* @param {boolean} Recurse Default value is true, meaning if <code>setAll()</code> encounters a member that is a group, it will call <code>setAll()</code> on that group rather than modifying its variable.
* Go through and call the specified function on all members of the group.
425
425
* Currently only works on functions that have no required parameters.
426
426
*
427
-
* @paramFunctionName The string representation of the function you want to call on each object, for example "kill()" or "init()".
428
-
* @paramRecurse Default value is true, meaning if <code>callAll()</code> encounters a member that is a group, it will call <code>callAll()</code> on that group rather than calling the group's function.
427
+
* @param {string} FunctionName The string representation of the function you want to call on each object, for example "kill()" or "init()".
428
+
* @param {boolean} Recurse Default value is true, meaning if <code>callAll()</code> encounters a member that is a group, it will call <code>callAll()</code> on that group rather than calling the group's function.
0 commit comments