ParticleSystem3D Class

Extends RenderComponent

Module: cc Parent Module: cc

The ParticleSystem3D Component.

Index

Properties
  • duration Number The run time of particle.
  • capacity Number The maximum number of particles that a particle system can generate.
  • loop Boolean Whether the particle system loops.
  • playOnAwake Boolean Whether the particles start playing automatically after loaded.
  • prewarm Boolean When selected, the particle system will start playing after one round has been played (only effective when loop is enabled).
  • simulationSpace Space The coordinate system in which the particle system is located.
    ...
  • simulationSpeed Number Controlling the update speed of the entire particle system.
  • startDelay CurveRange Delay particle emission time after particle system starts running.
  • startLifetime CurveRange Particle life cycle。
  • startColor GradientRange Particle initial color
  • scaleSpace Space Particle scale space
  • startSize CurveRange Initial particle size
  • startSpeed CurveRange Initial particle speed
  • startRotation CurveRange Particle initial rotation angle
  • gravityModifier CurveRange Gravity coefficient of particles affected by gravity
  • rateOverTime CurveRange Particles emitted per second
  • rateOverDistance CurveRange Number of particles emitted per unit distance moved
  • bursts [Burst] The number of Brusts that emit a specified number of particles at a specified time
  • shapeModule ShapeModule Particle emitter module
  • colorOverLifetimeModule ColorOverLifetimeModule Color control module
  • sizeOvertimeModule SizeOvertimeModule Particle size module
  • velocityOvertimeModule VelocityOvertimeModule Particle speed module
  • forceOvertimeModule ForceOvertimeModule Particle acceleration module
  • limitVelocityOvertimeModule LimitVelocityOvertimeModule Particle limit speed module (only CPU particles are supported)
  • rotationOvertimeModule RotationOvertimeModule Particle rotation module
  • textureAnimationModule TextureAnimationModule Texture Animation Module
  • trailModule TrailModule Particle Trajectory Module
  • renderMode RenderMode Particle generation mode
  • velocityScale Number When the particle generation mode is StrecthedBillboard, in the direction of movement of the particles is stretched by velocity magnitude
  • lengthScale Number When the particle generation method is StrecthedBillboard, the particles are stretched according to the particle size in the direction of motion
  • mesh Mesh Particle model
  • particleMaterial Material Particle material
  • trailMaterial Material Particle trail material
  • sharedMaterials [Material] The materials used by this render component.
  • __eventTargets Array Register all related EventTargets,...
  • node Node The node this component is attached to.
  • uuid String The uuid for editor.
  • _enabled Boolean
  • enabled Boolean indicates whether this component is enabled or not.
  • enabledInHierarchy Boolean indicates whether this component is enabled and its node is also active in the hierarchy.
  • _isOnLoadCalled Number Returns a value which used to indicate the onLoad get called or not.
  • _name String
  • _objFlags Number
  • name String The name of the object.
  • isValid Boolean Indicates whether the object is not yet destroyed.
Methods
  • play Playing particle effects
  • pause Pause particle effect
  • stop Stop particle effect
  • clear Remove all particle effect
  • getMaterial Get the material by index.
  • getMaterials Gets all the materials.
  • setMaterial Set the material by index.
  • update This is a lifecycle method.
  • lateUpdate This is a lifecycle method.
  • __preload __preload is called before every onLoad.
  • onLoad When attaching to an active node or its node first activated.
  • start Called before all scripts' update if the Component is enabled the first time.
  • onEnable This is a lifecycle method.
  • onDisable This is a lifecycle method.
  • onDestroy This is a lifecycle method.
  • onFocusInEditor
  • onLostFocusInEditor
  • resetInEditor Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used.
  • addComponent Adds a component class to the node.
  • getComponent Returns the component of supplied type if the node has one attached, null if it doesn't....
  • getComponents Returns all components of supplied Type in the node.
  • getComponentInChildren Returns the component of supplied type in any of its children using depth first search.
  • getComponentsInChildren Returns the components of supplied type in self or any of its children using depth first search.
  • _getLocalBounds If the component's bounding box is different from the node's, you can implement this method to supply
  • onRestore for undo/redo operation.
  • schedule Schedules a custom selector....
  • scheduleOnce Schedules a callback function that runs only once, with a delay of 0 or larger.
  • unschedule Unschedules a custom callback function.
  • unscheduleAllCallbacks unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function....
  • destroy Actual object destruction will delayed until before rendering.
  • _destruct Clear all references in the instance.
  • _onPreDestroy Called before the object being destroyed.
  • _serialize The customized serialization for this object.
  • _deserialize Init this object from the custom serialized data.

Details

Properties

duration

The run time of particle.

meta description
Type Number
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:64
capacity

The maximum number of particles that a particle system can generate.

meta description
Type Number
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:74
loop

Whether the particle system loops.

meta description
Type Boolean
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:91
playOnAwake

Whether the particles start playing automatically after loaded.

meta description
Type Boolean
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:99
prewarm

When selected, the particle system will start playing after one round has been played (only effective when loop is enabled).

meta description
Type Boolean
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:109
simulationSpace

The coordinate system in which the particle system is located.
World coordinates (does not change when the position of other objects changes)
Local coordinates (moving as the position of the parent node changes)
Custom coordinates (moving with the position of a custom node)

meta description
Type Space
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:128
simulationSpeed

Controlling the update speed of the entire particle system.

meta description
Type Number
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:154
startDelay

Delay particle emission time after particle system starts running.

meta description
Type CurveRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:162
startLifetime

Particle life cycle。

meta description
Type CurveRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:172
startColor

Particle initial color

meta description
Type GradientRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:182
scaleSpace

Particle scale space

meta description
Type Space
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:192
startSize

Initial particle size

meta description
Type CurveRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:202
startSpeed

Initial particle speed

meta description
Type CurveRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:212
startRotation

Particle initial rotation angle

meta description
Type CurveRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:223
gravityModifier

Gravity coefficient of particles affected by gravity

meta description
Type CurveRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:235
rateOverTime

Particles emitted per second

meta description
Type CurveRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:247
rateOverDistance

Number of particles emitted per unit distance moved

meta description
Type CurveRange
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:257
bursts

The number of Brusts that emit a specified number of particles at a specified time

meta description
Type Burst
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:267
shapeModule

Particle emitter module

meta description
Type ShapeModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:294
colorOverLifetimeModule

Color control module

meta description
Type ColorOverLifetimeModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:305
sizeOvertimeModule

Particle size module

meta description
Type SizeOvertimeModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:316
velocityOvertimeModule

Particle speed module

meta description
Type VelocityOvertimeModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:326
forceOvertimeModule

Particle acceleration module

meta description
Type ForceOvertimeModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:336
limitVelocityOvertimeModule

Particle limit speed module (only CPU particles are supported)

meta description
Type LimitVelocityOvertimeModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:346
rotationOvertimeModule

Particle rotation module

meta description
Type RotationOvertimeModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:356
textureAnimationModule

Texture Animation Module

meta description
Type TextureAnimationModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:366
trailModule

Particle Trajectory Module

meta description
Type TrailModule
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:376
renderMode

Particle generation mode

meta description
Type RenderMode
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:389
velocityScale

When the particle generation mode is StrecthedBillboard, in the direction of movement of the particles is stretched by velocity magnitude

meta description
Type Number
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:414
lengthScale

When the particle generation method is StrecthedBillboard, the particles are stretched according to the particle size in the direction of motion

meta description
Type Number
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:431
mesh

Particle model

meta description
Type Mesh
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:449
particleMaterial

Particle material

meta description
Type Material
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:466
trailMaterial

Particle trail material

meta description
Type Material
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:483
sharedMaterials

The materials used by this render component.

meta description
Type [Material]
Defined in cocos2d/core/components/CCRenderComponent.js:60
__eventTargets

Register all related EventTargets, all event callbacks will be removed in _onPreDestroy

meta description
Type Array
Defined in cocos2d/core/components/CCComponent.js:61
node

The node this component is attached to. A component is always attached to a node.

meta description
Type Node
Defined in cocos2d/core/components/CCComponent.js:75
Examples
cc.log(comp.node);
uuid

The uuid for editor.

meta description
Type String
Defined in cocos2d/core/components/CCComponent.js:106
Examples
cc.log(comp.uuid);
_enabled
meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:147
enabled

indicates whether this component is enabled or not.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:154
Examples
comp.enabled = true;
cc.log(comp.enabled);
enabledInHierarchy

indicates whether this component is enabled and its node is also active in the hierarchy.

meta description
Type Boolean
Defined in cocos2d/core/components/CCComponent.js:186
Examples
cc.log(comp.enabledInHierarchy);
_isOnLoadCalled

Returns a value which used to indicate the onLoad get called or not.

meta description
Type Number
Defined in cocos2d/core/components/CCComponent.js:202
Examples
cc.log(this._isOnLoadCalled > 0);
_name
meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
Type Number
Defined in cocos2d/core/platform/CCObject.js:83
name

The name of the object.

meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:240
Examples
obj.name = "New Obj";
isValid

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use cc.isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

meta description
Type Boolean
Defined in cocos2d/core/platform/CCObject.js:258
Examples
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

Methods

play

Playing particle effects

meta description
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:563
pause

Pause particle effect

meta description
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:587
stop

Stop particle effect

meta description
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:604
clear

Remove all particle effect

meta description
Defined in cocos2d/core/3d/particle/particle-system-3d.ts:628
getMaterial

Get the material by index.

meta description
Returns MaterialVariant
Defined in cocos2d/core/components/CCRenderComponent.js:150
Parameters
getMaterials

Gets all the materials.

meta description
Returns [MaterialVariant]
Defined in cocos2d/core/components/CCRenderComponent.js:173
setMaterial

Set the material by index.

meta description
Returns Material
Defined in cocos2d/core/components/CCRenderComponent.js:187
Parameters
update

Update is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:223
Parameters
  • dt Number the delta time in seconds it took to complete the last frame
lateUpdate

LateUpdate is called every frame, if the Component is enabled.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:234
Parameters
  • 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.

meta description
Defined in cocos2d/core/components/CCComponent.js:245
onLoad

When attaching to an active node or its node first activated. onLoad is always called before any start functions, this allows you to order initialization of scripts.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:256
start

Called before all scripts' update if the Component is enabled the first time. Usually used to initialize some logic which need to be called after all components' onload methods called.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:269
onEnable

Called when this component becomes enabled and its node is active.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:282
onDisable

Called when this component becomes disabled or its node becomes inactive.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:292
onDestroy

Called when this component will be destroyed.
This is a lifecycle method. It may not be implemented in the super class. You can only call its super class method inside it. It should not be called manually elsewhere.

meta description
Defined in cocos2d/core/components/CCComponent.js:302
onFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:312
onLostFocusInEditor
meta description
Defined in cocos2d/core/components/CCComponent.js:317
resetInEditor

Called to initialize the component or node’s properties when adding the component the first time or when the Reset command is used. This function is only called in editor.

meta description
Defined in cocos2d/core/components/CCComponent.js:322
addComponent

Adds a component class to the node. You can also add component to node by passing in the name of the script.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:332
Parameters
  • typeOrClassName Function | String the constructor or the class name of the component to add
Examples
var sprite = node.addComponent(cc.Sprite);
var test = node.addComponent("Test");
getComponent

Returns the component of supplied type if the node has one attached, null if it doesn't.
You can also get component in the node by passing in the name of the script.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:350
Parameters
Examples
// get sprite component.
var sprite = node.getComponent(cc.Sprite);
// get custom test calss.
var test = node.getComponent("Test");
getComponents

Returns all components of supplied Type in the node.

meta description
Returns Component[]
Defined in cocos2d/core/components/CCComponent.js:374
Parameters
Examples
var sprites = node.getComponents(cc.Sprite);
var tests = node.getComponents("Test");
getComponentInChildren

Returns the component of supplied type in any of its children using depth first search.

meta description
Returns Component
Defined in cocos2d/core/components/CCComponent.js:392
Parameters
Examples
var sprite = node.getComponentInChildren(cc.Sprite);
var Test = node.getComponentInChildren("Test");
getComponentsInChildren

Returns the components of supplied type in self or any of its children using depth first search.

meta description
Returns Component[]
Defined in cocos2d/core/components/CCComponent.js:410
Parameters
Examples
var sprites = node.getComponentsInChildren(cc.Sprite);
var tests = node.getComponentsInChildren("Test");
_getLocalBounds

If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

meta description
Defined in cocos2d/core/components/CCComponent.js:430
Parameters
  • out_rect Rect the Rect to receive the bounding box
onRestore

onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

If the component contains the "internal state", short for "temporary member variables which not included
in its CCClass properties", then you may need to implement this function.

The editor will call the getset accessors of your component to record/restore the component's state
for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
this function to manually synchronize your component's "internal states" with its public properties.
Once you implement this function, all the getset accessors of your component will not be called when
the user performs an undo/redo operation. Which means that only the properties with default value
will be recorded or restored by editor.

Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
to support the reset menu, you should manually synchronize your component's "internal states" with its
properties in this function. Once you implement this function, all the getset accessors of your component
will not be called during reset operation. Which means that only the properties with default value
will be reset by editor.

This function is only called in editor mode.

meta description
Defined in cocos2d/core/components/CCComponent.js:443
schedule

Schedules a custom selector.
If the selector is already scheduled, then the interval parameter will be updated without scheduling it again.

meta description
Defined in cocos2d/core/components/CCComponent.js:537
Parameters
  • 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
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.schedule(timeCallback, 1);
scheduleOnce

Schedules a callback function that runs only once, with a delay of 0 or larger.

meta description
Defined in cocos2d/core/components/CCComponent.js:575
Parameters
  • callback function A function wrapped as a selector
  • delay Number The amount of time that the first tick will wait before execution. Unit: s
Examples
var timeCallback = function (dt) {
  cc.log("time: " + dt);
}
this.scheduleOnce(timeCallback, 2);
unschedule

Unschedules a custom callback function.

meta description
Defined in cocos2d/core/components/CCComponent.js:592
Parameters
  • callback_fn function A function wrapped as a selector
Examples
this.unschedule(_callback);
unscheduleAllCallbacks

unschedule all scheduled callback functions: custom callback functions, and the 'update' callback function.
Actions are not affected by this method.

meta description
Defined in cocos2d/core/components/CCComponent.js:608
Examples
this.unscheduleAllCallbacks();
destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering. From the next frame, this object is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

meta description
Returns Boolean
Defined in cocos2d/core/platform/CCObject.js:293
Examples
obj.destroy();
_destruct

Clear all references in the instance.

NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _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; } } }

meta description
Defined in cocos2d/core/platform/CCObject.js:427
_onPreDestroy

Called before the object being destroyed.

meta description
Defined in cocos2d/core/platform/CCObject.js:460
_serialize

The customized serialization for this object. (Editor Only)

meta description
Returns object
Defined in cocos2d/core/platform/CCObject.js:485
Parameters
_deserialize

Init this object from the custom serialized data.

meta description
Defined in cocos2d/core/platform/CCObject.js:495
Parameters
  • data Object the serialized json data
  • ctx _Deserializer

results matching ""

    No results matching ""