ParticleSystem 类型

继承于 RenderComponent, BlendFunc(mixin)

模块: cc

Particle System base class.
Attributes of a Particle System:

• emmision rate of the particles
  
• Gravity Mode (Mode A):
  
• gravity
  
• direction
  
• speed +- variance
  
• tangential acceleration +- variance
  
• radial acceleration +- variance
  
• Radius Mode (Mode B):
  
• startRadius +- variance
  
• endRadius +- variance
  
• rotate +- variance
  
• Properties common to all modes:
  
• life +- life variance
  
• start spin +- variance
  
• end spin +- variance
  
• start size +- variance
  
• end size +- variance
  
• start color +- variance
  
• end color +- variance
  
• life +- variance
  
• blending function
  
• texture
  
  cocos2d also supports particles generated by Particle Designer (http://particledesigner.71squared.com/).
  'Radius Mode' in Particle Designer uses a fixed emit rate of 30 hz. Since that can't be guarateed in cocos2d,
  cocos2d uses a another approach, but the results are almost identical.
  cocos2d supports all the variables used by Particle Designer plus a bit more:
  
• spinning particles (supported when using ParticleSystem)
  
• tangential acceleration (Gravity mode)
  
• radial acceleration (Gravity mode)
  
• radius direction (Radius mode) (Particle Designer supports outwards to inwards direction only)
  It is possible to customize any of the above mentioned properties in runtime. Example:
  

示例

emitter.radialAccel = 15;
emitter.startSpin = 0;

索引

属性（properties）

• preview Boolean 在编辑器模式下预览粒子，启用后选中粒子时，粒子将自动播放。
• custom Boolean 是否自定义粒子属性。
• file ParticleAsset plist 格式的粒子配置文件。
• spriteFrame SpriteFrame 用于粒子呈现的 SpriteFrame
• texture String 粒子贴图，只读属性，请使用 spriteFrame 属性来替换贴图。
• particleCount Number 当前播放的粒子数量。
• stopped Boolean 指示粒子播放是否完毕。
• playOnLoad Boolean 如果设置为 true 运行时会自动发射粒子。
• autoRemoveOnFinish Boolean 粒子播放完毕后自动销毁所在的节点。
• active Boolean 是否激活粒子。
• totalParticles Number 粒子最大数量。
• duration Number 发射器生存时间，单位秒，-1表示持续发射。
• emissionRate Number 每秒发射的粒子数目。
• life Number 粒子的运行时间。
• lifeVar Number 粒子的运行时间变化范围。
• startColor cc.Color 粒子初始颜色。
• startColorVar cc.Color 粒子初始颜色变化范围。
• endColor cc.Color 粒子结束颜色。
• endColorVar cc.Color 粒子结束颜色变化范围。
• angle Number 粒子角度。
• angleVar Number 粒子角度变化范围。
• startSize Number 粒子的初始大小。
• startSizeVar Number 粒子初始大小的变化范围。
• endSize Number 粒子结束时的大小。
• endSizeVar Number 粒子结束大小的变化范围。
• startSpin Number 粒子开始自旋角度。
• startSpinVar Number 粒子开始自旋角度变化范围。
• endSpin Number 粒子结束自旋角度。
• endSpinVar Number 粒子结束自旋角度变化范围。
• sourcePos Vec2 发射器位置。
• posVar Vec2 发射器位置的变化范围。
• positionType ParticleSystem.PositionType 粒子位置类型。
• emitterMode ParticleSystem.EmitterMode 发射器类型。
• gravity Vec2 重力。
• speed Number 速度。
• speedVar Number 速度变化范围。
• tangentialAccel Number 每个粒子的切向加速度，即垂直于重力方向的加速度，只有在重力模式下可用。
• tangentialAccelVar Number 每个粒子的切向加速度变化范围。
• radialAccel Number 粒子径向加速度，即平行于重力方向的加速度，只有在重力模式下可用。
• radialAccelVar Number 粒子径向加速度变化范围。
• rotationIsDir Boolean 每个粒子的旋转是否等于其方向，只有在重力模式下可用。
• startRadius Number 初始半径，表示粒子出生时相对发射器的距离，只有在半径模式下可用。
• startRadiusVar Number 初始半径变化范围。
• endRadius Number 结束半径，只有在半径模式下可用。
• endRadiusVar Number 结束半径变化范围。
• rotatePerS Number 粒子每秒围绕起始点的旋转角度，只有在半径模式下可用。
• rotatePerSVar Number 粒子每秒围绕起始点的旋转角度变化范围。
• DURATION_INFINITY Number 表示发射器永久存在
• START_SIZE_EQUAL_TO_END_SIZE Number 表示粒子的起始大小等于结束大小。
• START_RADIUS_EQUAL_TO_END_RADIUS Number 表示粒子的起始半径等于结束半径。
• sharedMaterials [Material] 渲染组件使用的材质。
• srcBlendFactor macro.BlendFactor 指定原图的混合模式，这会克隆一个新的材质对象，注意这带来的开销
• dstBlendFactor macro.BlendFactor 指定目标的混合模式
• __eventTargets Array 注册所有相关的 EventTargets，所有事件回调将在 _onPreDestroy 中删除。
• node Node 该组件被附加到的节点。
• uuid String 组件的 uuid，用于编辑器。
• _enabled Boolean
• enabled Boolean 表示该组件自身是否启用。
• enabledInHierarchy Boolean 表示该组件是否被启用并且所在的节点也处于激活状态。
• _isOnLoadCalled Number 返回一个值用来判断 onLoad 是否被调用过，不等于 0 时调用过，等于 0 时未调用。
• _name String
• _objFlags Number
• name String 该对象的名称。
• isValid Boolean 表示该对象是否可用（被 destroy 后将不可用）。

方法

• stopSystem 停止发射器发射粒子，发射出去的粒子将继续运行，直至粒子生命结束。
• resetSystem 杀死所有存在的粒子，然后重新启动粒子发射器。
• isFull 发射器中粒子是否大于等于设置的总粒子数量。
• setTextureWithRect 设置一张新贴图和关联的矩形。
• getMaterial 根据指定索引获取材质
• getMaterials 获取所有材质。
• setMaterial 根据指定索引设置材质
• update 如果该组件启用，则每帧调用 update。
• lateUpdate 如果该组件启用，则每帧调用 LateUpdate。
• __preload __preload is called before every onLoad....
• onLoad 当附加到一个激活的节点上或者其节点第一次激活时候调用。
• start 如果该组件第一次启用，则在所有组件的 update 之前调用。
• onEnable 当该组件被启用，并且它的节点也激活时。
• onDisable 当该组件被禁用或节点变为无效时调用。
• onDestroy 该方法为生命周期方法，父类未必会有实现。
• onFocusInEditor
• onLostFocusInEditor
• resetInEditor 用来初始化组件或节点的一些属性，当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。
• addComponent 向节点添加一个组件类，你还可以通过传入脚本的名称来添加组件。
• getComponent 获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
• getComponents 返回节点上指定类型的所有组件。
• getComponentInChildren 递归查找所有子节点中第一个匹配指定类型的组件。
• getComponentsInChildren 递归查找自身或所有子节点中指定类型的组件
• _getLocalBounds 以便编辑器的场景视图可以正确地执行点选测试。
• onRestore onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。
• schedule 调度一个自定义的回调函数。
• scheduleOnce 调度一个只运行一次的回调函数，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。
• unschedule 取消调度一个自定义的回调函数。
• unscheduleAllCallbacks 取消调度所有已调度的回调函数：定制的回调函数以及 update 回调函数。
• destroy 销毁该对象，并释放所有它对其它对象的引用。
• _destruct 清除实例中的所有引用。
• _onPreDestroy 在对象被销毁之前调用。
• _serialize 为此对象定制序列化。
• _deserialize 从自定义序列化数据初始化此对象。

Details

属性（properties）

preview

在编辑器模式下预览粒子，启用后选中粒子时，粒子将自动播放。

custom

是否自定义粒子属性。

file

plist 格式的粒子配置文件。

spriteFrame

用于粒子呈现的 SpriteFrame

texture

粒子贴图，只读属性，请使用 spriteFrame 属性来替换贴图。

particleCount

当前播放的粒子数量。

stopped

指示粒子播放是否完毕。

playOnLoad

如果设置为 true 运行时会自动发射粒子。

autoRemoveOnFinish

粒子播放完毕后自动销毁所在的节点。

active

是否激活粒子。

totalParticles

粒子最大数量。

duration

发射器生存时间，单位秒，-1表示持续发射。

emissionRate

每秒发射的粒子数目。

life

粒子的运行时间。

lifeVar

粒子的运行时间变化范围。

startColor

粒子初始颜色。

startColorVar

粒子初始颜色变化范围。

endColor

粒子结束颜色。

endColorVar

粒子结束颜色变化范围。

angle

粒子角度。

angleVar

粒子角度变化范围。

startSize

粒子的初始大小。

startSizeVar

粒子初始大小的变化范围。

endSize

粒子结束时的大小。

endSizeVar

粒子结束大小的变化范围。

startSpin

粒子开始自旋角度。

startSpinVar

粒子开始自旋角度变化范围。

endSpin

粒子结束自旋角度。

endSpinVar

粒子结束自旋角度变化范围。

sourcePos

发射器位置。

posVar

发射器位置的变化范围。（横向和纵向）

positionType

粒子位置类型。

emitterMode

发射器类型。

gravity

重力。

speed

速度。

speedVar

速度变化范围。

tangentialAccel

每个粒子的切向加速度，即垂直于重力方向的加速度，只有在重力模式下可用。

tangentialAccelVar

每个粒子的切向加速度变化范围。

radialAccel

粒子径向加速度，即平行于重力方向的加速度，只有在重力模式下可用。

radialAccelVar

粒子径向加速度变化范围。

rotationIsDir

每个粒子的旋转是否等于其方向，只有在重力模式下可用。

startRadius

初始半径，表示粒子出生时相对发射器的距离，只有在半径模式下可用。

startRadiusVar

初始半径变化范围。

endRadius

结束半径，只有在半径模式下可用。

endRadiusVar

结束半径变化范围。

rotatePerS

粒子每秒围绕起始点的旋转角度，只有在半径模式下可用。

rotatePerSVar

粒子每秒围绕起始点的旋转角度变化范围。

DURATION_INFINITY

表示发射器永久存在

START_SIZE_EQUAL_TO_END_SIZE

表示粒子的起始大小等于结束大小。

START_RADIUS_EQUAL_TO_END_RADIUS

表示粒子的起始半径等于结束半径。

sharedMaterials

渲染组件使用的材质。

srcBlendFactor

指定原图的混合模式，这会克隆一个新的材质对象，注意这带来的开销

示例

sprite.srcBlendFactor = cc.macro.BlendFactor.ONE;

dstBlendFactor

指定目标的混合模式

示例

sprite.dstBlendFactor = cc.macro.BlendFactor.ONE;

__eventTargets

注册所有相关的 EventTargets，所有事件回调将在 _onPreDestroy 中删除。

node

该组件被附加到的节点。组件总会附加到一个节点。

示例

cc.log(comp.node);

uuid

组件的 uuid，用于编辑器。

示例

cc.log(comp.uuid);

_enabled

enabled

表示该组件自身是否启用。

示例

comp.enabled = true;
cc.log(comp.enabled);

enabledInHierarchy

表示该组件是否被启用并且所在的节点也处于激活状态。

示例

cc.log(comp.enabledInHierarchy);

_isOnLoadCalled

返回一个值用来判断 onLoad 是否被调用过，不等于 0 时调用过，等于 0 时未调用。

示例

cc.log(this._isOnLoadCalled > 0);

_name

_objFlags

name

该对象的名称。

示例

obj.name = "New Obj";

isValid

表示该对象是否可用（被 destroy 后将不可用）。
当一个对象的 destroy 调用以后，会在这一帧结束后才真正销毁。因此从下一帧开始 isValid 就会返回 false，而当前帧内 isValid 仍然会是 true。如果希望判断当前帧是否调用过 destroy，请使用 cc.isValid(obj, true)，不过这往往是特殊的业务需求引起的，通常情况下不需要这样。

示例

var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

方法

stopSystem

停止发射器发射粒子，发射出去的粒子将继续运行，直至粒子生命结束。

示例

// stop particle system.
myParticleSystem.stopSystem();

resetSystem

杀死所有存在的粒子，然后重新启动粒子发射器。

示例

// play particle system.
myParticleSystem.resetSystem();

isFull

发射器中粒子是否大于等于设置的总粒子数量。

setTextureWithRect

设置一张新贴图和关联的矩形。 请直接设置 spriteFrame 属性，这个函数从 v1.9 版本开始已经被废弃

参数列表

• texture Texture2D
• rect Rect

getMaterial

根据指定索引获取材质

参数列表

• index Number

getMaterials

获取所有材质。

setMaterial

根据指定索引设置材质

参数列表

• index Number
• material Material

update

如果该组件启用，则每帧调用 update。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

参数列表

• dt Number the delta time in seconds it took to complete the last frame

lateUpdate

如果该组件启用，则每帧调用 LateUpdate。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

参数列表

• dt Number the delta time in seconds it took to complete the last frame

__preload

__preload is called before every onLoad. It is used to initialize the builtin components internally, to avoid checking whether onLoad is called before every public method calls. This method should be removed if script priority is supported.

onLoad

当附加到一个激活的节点上或者其节点第一次激活时候调用。onLoad 总是会在任何 start 方法调用前执行，这能用于安排脚本的初始化顺序。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

start

如果该组件第一次启用，则在所有组件的 update 之前调用。通常用于需要在所有组件的 onLoad 初始化完毕后执行的逻辑。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onEnable

当该组件被启用，并且它的节点也激活时。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onDisable

当该组件被禁用或节点变为无效时调用。
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onDestroy

当该组件被销毁时调用
该方法为生命周期方法，父类未必会有实现。并且你只能在该方法内部调用父类的实现，不可在其它地方直接调用该方法。

onFocusInEditor

onLostFocusInEditor

resetInEditor

用来初始化组件或节点的一些属性，当该组件被第一次添加到节点上或用户点击了它的 Reset 菜单时调用。这个回调只会在编辑器下调用。

addComponent

向节点添加一个组件类，你还可以通过传入脚本的名称来添加组件。

参数列表

• typeOrClassName Function | String the constructor or the class name of the component to add

示例

var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");

getComponent

获取节点上指定类型的组件，如果节点有附加指定类型的组件，则返回，如果没有则为空。
传入参数也可以是脚本的名称。

参数列表

• typeOrClassName Function | String

示例

// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");

getComponents

返回节点上指定类型的所有组件。

参数列表

• typeOrClassName Function | String

示例

var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");

getComponentInChildren

递归查找所有子节点中第一个匹配指定类型的组件。

参数列表

• typeOrClassName Function | String

示例

var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");

getComponentsInChildren

递归查找自身或所有子节点中指定类型的组件

参数列表

• typeOrClassName Function | String

示例

var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");

_getLocalBounds

如果组件的包围盒与节点不同，您可以实现该方法以提供自定义的轴向对齐的包围盒（AABB）， 以便编辑器的场景视图可以正确地执行点选测试。

参数列表

• out_rect Rect the Rect to receive the bounding box

onRestore

onRestore 是用户在检查器菜单点击 Reset 时，对此组件执行撤消操作后调用的。

如果组件包含了“内部状态”（不在 CCClass 属性中定义的临时成员变量），那么你可能需要实现该方法。

编辑器执行撤销/重做操作时，将调用组件的 get set 来录制和还原组件的状态。然而，在极端的情况下，它可能无法良好运作。
那么你就应该实现这个方法，手动根据组件的属性同步“内部状态”。一旦你实现这个方法，当用户撤销或重做时，组件的所有 get set 都不会再被调用。这意味着仅仅指定了默认值的属性将被编辑器记录和还原。

同样的，编辑可能无法在极端情况下正确地重置您的组件。如果你需要支持组件重置菜单，则需要在该方法中手工同步组件属性到“内部状态”。一旦你实现这个方法，组件的所有 get set 都不会在重置操作时被调用。这意味着仅仅指定了默认值的属性将被编辑器重置。
此方法仅在编辑器下会被调用。

schedule

调度一个自定义的回调函数。
如果回调函数已调度，那么将不会重复调度它，只会更新时间间隔参数。

参数列表

• callback function The callback function
• interval Number Tick interval in seconds. 0 means tick every frame.
• repeat Number The selector will be executed (repeat + 1) times, you can use cc.macro.REPEAT_FOREVER for tick infinitely.
• delay Number The amount of time that the first tick will wait before execution. Unit: s

示例

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);

scheduleOnce

调度一个只运行一次的回调函数，可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

参数列表

• callback function A function wrapped as a selector
• delay Number The amount of time that the first tick will wait before execution. Unit: s

示例

var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);

unschedule

取消调度一个自定义的回调函数。

参数列表

• callback_fn function A function wrapped as a selector

示例

this.unschedule(_callback);

unscheduleAllCallbacks

取消调度所有已调度的回调函数：定制的回调函数以及 update 回调函数。动作不受此方法影响。

示例

this.unscheduleAllCallbacks();

destroy

销毁该对象，并释放所有它对其它对象的引用。
实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始，该对象将不再可用。 您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。

示例

obj.destroy();

_destruct

清除实例中的所有引用。

注意：此方法不会清除在 CCObject 实例中定义的 getter 或 setter。如果需要，你可以重写 _destruct 方法。例如：

_destruct: function () {
    for (var key in this) {
        if (this.hasOwnProperty(key)) {
            switch (typeof this[key]) {
                case 'string':
                    this[key] = '';
                    break;
                case 'object':
                case 'function':
                    this[key] = null;
                    break;
        }
    }
}

_onPreDestroy

在对象被销毁之前调用。

_serialize

为此对象定制序列化。

参数列表

• exporting Boolean

_deserialize

从自定义序列化数据初始化此对象。

参数列表

• data Object the serialized json data
• ctx _Deserializer