mirror of
https://github.com/photonstorm/phaser
synced 2025-03-01 22:07:24 +00:00
Further EmitterOp documentation.
This commit is contained in:
parent
584e8f9919
commit
7f232b6bed
2 changed files with 22 additions and 13 deletions
|
@ -116,7 +116,7 @@ var EmitterOp = new Class({
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The key of this Particle Emitter property.
|
* The key of this property.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#propertyKey
|
* @name Phaser.GameObjects.Particles.EmitterOp#propertyKey
|
||||||
* @type {string}
|
* @type {string}
|
||||||
|
@ -125,7 +125,7 @@ var EmitterOp = new Class({
|
||||||
this.propertyKey = key;
|
this.propertyKey = key;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The value of this Particle Emitter property.
|
* The value of this property.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#propertyValue
|
* @name Phaser.GameObjects.Particles.EmitterOp#propertyValue
|
||||||
* @type {number}
|
* @type {number}
|
||||||
|
@ -134,7 +134,7 @@ var EmitterOp = new Class({
|
||||||
this.propertyValue = defaultValue;
|
this.propertyValue = defaultValue;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The default value of this Particle Emitter property.
|
* The default value of this property.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#defaultValue
|
* @name Phaser.GameObjects.Particles.EmitterOp#defaultValue
|
||||||
* @type {number}
|
* @type {number}
|
||||||
|
@ -143,7 +143,8 @@ var EmitterOp = new Class({
|
||||||
this.defaultValue = defaultValue;
|
this.defaultValue = defaultValue;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* The number of steps for stepped easing between {@link Phaser.GameObjects.Particles.EmitterOp#start} and
|
||||||
|
* {@link Phaser.GameObjects.Particles.EmitterOp#end} values, per emit.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#steps
|
* @name Phaser.GameObjects.Particles.EmitterOp#steps
|
||||||
* @type {number}
|
* @type {number}
|
||||||
|
@ -153,7 +154,7 @@ var EmitterOp = new Class({
|
||||||
this.steps = 0;
|
this.steps = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* The step counter for stepped easing, per emit.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#counter
|
* @name Phaser.GameObjects.Particles.EmitterOp#counter
|
||||||
* @type {number}
|
* @type {number}
|
||||||
|
@ -163,7 +164,7 @@ var EmitterOp = new Class({
|
||||||
this.counter = 0;
|
this.counter = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* The start value for this property to ease between.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#start
|
* @name Phaser.GameObjects.Particles.EmitterOp#start
|
||||||
* @type {number}
|
* @type {number}
|
||||||
|
@ -173,7 +174,7 @@ var EmitterOp = new Class({
|
||||||
this.start = 0;
|
this.start = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* The end value for this property to ease between.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#end
|
* @name Phaser.GameObjects.Particles.EmitterOp#end
|
||||||
* @type {number}
|
* @type {number}
|
||||||
|
@ -183,7 +184,7 @@ var EmitterOp = new Class({
|
||||||
this.end = 0;
|
this.end = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* The easing function to use for interpolating this property.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#ease
|
* @name Phaser.GameObjects.Particles.EmitterOp#ease
|
||||||
* @type {?function}
|
* @type {?function}
|
||||||
|
@ -192,7 +193,13 @@ var EmitterOp = new Class({
|
||||||
this.ease;
|
this.ease;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* Whether this property can only be modified when a Particle is emitted.
|
||||||
|
*
|
||||||
|
* Set to `true` to allow only {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} callbacks to be set and
|
||||||
|
* affect this property.
|
||||||
|
*
|
||||||
|
* Set to `false` to allow both {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and
|
||||||
|
* {@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks to be set and affect this property.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#emitOnly
|
* @name Phaser.GameObjects.Particles.EmitterOp#emitOnly
|
||||||
* @type {boolean}
|
* @type {boolean}
|
||||||
|
@ -201,7 +208,7 @@ var EmitterOp = new Class({
|
||||||
this.emitOnly = emitOnly;
|
this.emitOnly = emitOnly;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* The callback to run for Particles when they are emitted from the Particle Emitter.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#onEmit
|
* @name Phaser.GameObjects.Particles.EmitterOp#onEmit
|
||||||
* @type {EmitterOpOnEmitCallback}
|
* @type {EmitterOpOnEmitCallback}
|
||||||
|
@ -210,7 +217,7 @@ var EmitterOp = new Class({
|
||||||
this.onEmit = this.defaultEmit;
|
this.onEmit = this.defaultEmit;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* The callback to run for Particles when they are updated.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.EmitterOp#onUpdate
|
* @name Phaser.GameObjects.Particles.EmitterOp#onUpdate
|
||||||
* @type {EmitterOpOnUpdateCallback}
|
* @type {EmitterOpOnUpdateCallback}
|
||||||
|
@ -290,7 +297,9 @@ var EmitterOp = new Class({
|
||||||
},
|
},
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* [description]
|
* Update the {@link Phaser.GameObjects.Particles.EmitterOp#onEmit} and
|
||||||
|
* {@link Phaser.GameObjects.Particles.EmitterOp#onUpdate} callbacks based on the type of the current
|
||||||
|
* {@link Phaser.GameObjects.Particles.EmitterOp#propertyValue}.
|
||||||
*
|
*
|
||||||
* @method Phaser.GameObjects.Particles.EmitterOp#setMethods
|
* @method Phaser.GameObjects.Particles.EmitterOp#setMethods
|
||||||
* @since 3.0.0
|
* @since 3.0.0
|
||||||
|
|
|
@ -356,7 +356,7 @@ var ParticleEmitter = new Class({
|
||||||
this.gravityY = 0;
|
this.gravityY = 0;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether accelerationX and accelerationY are nonzero. Set automatically during configuration.
|
* Whether accelerationX and accelerationY are non-zero. Set automatically during configuration.
|
||||||
*
|
*
|
||||||
* @name Phaser.GameObjects.Particles.ParticleEmitter#acceleration
|
* @name Phaser.GameObjects.Particles.ParticleEmitter#acceleration
|
||||||
* @type {boolean}
|
* @type {boolean}
|
||||||
|
|
Loading…
Add table
Reference in a new issue