Skip to content

Commit c22668d

Browse files
committed
JSDoc blocks added.
1 parent 60d9133 commit c22668d

16 files changed

Lines changed: 118 additions & 3 deletions

v3/src/animations/frame/inc/GetFirstTick.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#getFirstTick
5+
* @since 3.0.0
6+
*
7+
* @param {Phaser.GameObjects.Components.Animation} component - [description]
8+
* @param {boolean} [includeDelay=true] - [description]
9+
*/
110
var GetFirstTick = function (component, includeDelay)
211
{
312
if (includeDelay === undefined) { includeDelay = true; }

v3/src/animations/frame/inc/GetFrameAt.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#getFrameAt
5+
* @since 3.0.0
6+
*
7+
* @param {integer} index - [description]
8+
*
9+
* @return {Phaser.Animations.AnimationFrame} [description]
10+
*/
111
var GetFrameAt = function (index)
212
{
313
return this.frames[index];

v3/src/animations/frame/inc/GetFrames.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
var Frame = require('../AnimationFrame');
22
var GetValue = require('../../../utils/object/GetValue');
33

4+
/**
5+
* [description]
6+
*
7+
* @method Phaser.Animations.Animation#getFrames
8+
* @since 3.0.0
9+
*
10+
* @param {[type]} textureManager - [description]
11+
* @param {[type]} frames - [description]
12+
*
13+
* @return {Phaser.Animations.AnimationFrame[]} [description]
14+
*/
415
var GetFrames = function (textureManager, frames)
516
{
617
// frames: [

v3/src/animations/frame/inc/GetNextTick.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#getNextTick
5+
* @since 3.0.0
6+
*
7+
* @param {Phaser.GameObjects.Components.Animation} component - [description]
8+
*/
19
var GetNextTick = function (component)
210
{
311
// accumulator += delta * _timeScale

v3/src/animations/frame/inc/Load.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#load
5+
* @since 3.0.0
6+
*
7+
* @param {Phaser.GameObjects.Components.Animation} component - [description]
8+
* @param {integer} startFrame - [description]
9+
*/
110
var Load = function (component, startFrame)
211
{
312
if (startFrame >= this.frames.length)

v3/src/animations/frame/inc/NextFrame.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#nextFrame
5+
* @since 3.0.0
6+
*
7+
* @param {Phaser.GameObjects.Components.Animation} component - [description]
8+
*/
19
var NextFrame = function (component)
210
{
311
var frame = component.currentFrame;

v3/src/animations/frame/inc/PreviousFrame.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#previousFrame
5+
* @since 3.0.0
6+
*
7+
* @param {Phaser.GameObjects.Components.Animation} component - [description]
8+
*/
19
var PreviousFrame = function (component)
210
{
311
var frame = component.currentFrame;

v3/src/animations/frame/inc/RemoveFrame.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
11
// Remove frame if it matches the given frame
2+
/**
3+
* [description]
4+
*
5+
* @method Phaser.Animations.Animation#removeFrame
6+
* @since 3.0.0
7+
*
8+
* @param {Phaser.Animations.AnimationFrame} frame - [description]
9+
*
10+
* @return {Phaser.Animations.Animation} [description]
11+
*/
212
var RemoveFrame = function (frame)
313
{
414
var index = this.frames.indexOf(frame);

v3/src/animations/frame/inc/RemoveFrameAt.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#removeFrameAt
5+
* @since 3.0.0
6+
*
7+
* @param {integer} index - [description]
8+
*
9+
* @return {Phaser.Animations.Animation} [description]
10+
*/
111
var RemoveFrameAt = function (index)
212
{
313
this.frames.splice(index, 1);

v3/src/animations/frame/inc/RepeatAnimation.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/**
2+
* [description]
3+
*
4+
* @method Phaser.Animations.Animation#repeatAnimation
5+
* @since 3.0.0
6+
*
7+
* @param {Phaser.GameObjects.Components.Animation} component - [description]
8+
*/
19
var RepeatAnimation = function (component)
210
{
311
if (component._repeatDelay > 0 && component.pendingRepeat === false)

0 commit comments

Comments
 (0)