Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParticleSystemComponent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private _capacity

_capacity: number = 100

Private _curWPos

_curWPos: Vec3

Private _customData1

_customData1: Vec2

Private _customData2

_customData2: Vec2

Private _emitRateDistanceCounter

_emitRateDistanceCounter: number

Private _emitRateTimeCounter

_emitRateTimeCounter: number

Private _enabled

_enabled: boolean = true
property

_enabled

type

{Boolean}

_id

_id: string = idGenerator.getNewId()

For internal usage.

Private _isEmitting

_isEmitting: boolean

Private _isPaused

_isPaused: boolean

Private _isStopped

_isStopped: boolean

Protected _materials

_materials: Array<Material | null> = []

Protected _name

_name: string

_objFlags

_objFlags: number

Private _oldWPos

_oldWPos: Vec3

Private _prewarm

_prewarm: boolean = false

sceneGetter

sceneGetter: null | function = null

Private _simulationSpace

_simulationSpace: number = Space.Local

Private _subEmitters

_subEmitters: any[]

Private _time

_time: number

Protected _visFlags

_visFlags: VisibilityFlags = VisibilityFlags.GENERAL

bursts

bursts: any[] = new Array()

设定在指定时间发射指定数量的粒子的 Brust 的数量。

colorOverLifetimeModule

colorOverLifetimeModule: ColorOvertimeModule = new ColorOverLifetimeModule()

颜色控制模块。

duration

duration: number = 5

粒子系统运行时间。

forceOvertimeModule

forceOvertimeModule: ForceOvertimeModule = new ForceOvertimeModule()

粒子加速度模块。

gravityModifier

gravityModifier: CurveRange = new CurveRange()

粒子受重力影响的重力系数。

limitVelocityOvertimeModule

limitVelocityOvertimeModule: LimitVelocityOvertimeModule = new LimitVelocityOvertimeModule()

粒子限制速度模块(只支持 CPU 粒子)。

loop

loop: boolean = true

粒子系统是否循环播放。

node

node: INode = NullNode

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

property

node

type

{Node}

example
cc.log(comp.node);

playOnAwake

playOnAwake: boolean = true

粒子系统加载后是否自动开始播放。

rateOverDistance

rateOverDistance: CurveRange = new CurveRange()

每移动单位距离发射的粒子数。

rateOverTime

rateOverTime: CurveRange = new CurveRange()

每秒发射的粒子数。

renderer

renderer: ParticleSystemRenderer = new ParticleSystemRenderer()

rotationOvertimeModule

rotationOvertimeModule: RotationOvertimeModule = new RotationOvertimeModule()

粒子旋转模块。

scaleSpace

scaleSpace: number = Space.Local

shapeModule

shapeModule: ShapeModule = new ShapeModule()

粒子发射器模块。

simulationSpeed

simulationSpeed: number = 1

控制整个粒子系统的更新速度。

sizeOvertimeModule

sizeOvertimeModule: SizeOvertimeModule = new SizeOvertimeModule()

粒子大小模块。

startColor

startColor: GradientRange = new GradientRange()

粒子初始颜色。

startDelay

startDelay: CurveRange = new CurveRange()

粒子系统开始运行后,延迟粒子发射的时间。

startLifetime

startLifetime: CurveRange = new CurveRange()

粒子生命周期。

startRotation

startRotation: CurveRange = new CurveRange()

粒子初始旋转角度。

startSize

startSize: CurveRange = new CurveRange()

粒子初始大小。

startSpeed

startSpeed: CurveRange = new CurveRange()

粒子初始速度。

textureAnimationModule

textureAnimationModule: TextureAnimationModule = new TextureAnimationModule()

贴图动画模块。

trailModule

trailModule: TrailModule = new TrailModule()

粒子轨迹模块。

velocityOvertimeModule

velocityOvertimeModule: VelocityOvertimeModule = new VelocityOvertimeModule()

粒子速度模块。

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

isOnLoadCalled

  • get isOnLoadCalled(): number

capacity

  • get capacity(): number
  • set capacity(val: number): void

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

isEmitting

  • get isEmitting(): boolean

isPaused

  • get isPaused(): boolean

isStopped

  • get isStopped(): boolean

isValid

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

    property

    {Boolean} isValid

    default

    true

    readonly
    example
    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

    Returns boolean

material

materials

  • get materials(): (null | Material)[]
  • set materials(val: (null | Material)[]): void

name

  • get name(): string
  • set name(value: string): void

prewarm

  • get prewarm(): boolean
  • set prewarm(val: boolean): void

sharedMaterial

sharedMaterials

  • get sharedMaterials(): (null | Material)[]
  • set sharedMaterials(val: (null | Material)[]): void

simulationSpace

  • get simulationSpace(): number
  • set simulationSpace(val: number): void

time

  • get time(): number

uuid

  • get uuid(): string

visibility

  • get visibility(): VisibilityFlags
  • set visibility(val: VisibilityFlags): void

Methods

Optional Private preload

  • __preload(): void
  • __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.

    Returns void

Protected clearMaterials

  • _clearMaterials(): void

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • 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; } } }

    Returns void

Private emit

  • emit(dt: any): void

Protected Optional getLocalBounds

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

    Parameters

    • out_rect: Rect

      提供包围盒的 Rect

    Returns void

getModel

  • _getModel(): Model | null

getRenderScene

  • _getRenderScene(): RenderScene

instantiate

  • instantiate(cloned: any): any

onMaterialModified

  • onMaterialModified(index: number, material: Material): void

onPreDestroy

  • _onPreDestroy(): void

onRebuildPSO

  • onRebuildPSO(index: number, material: Material): void

Protected onVisiblityChange

  • onVisiblityChange(val: any): void

Private prewarmSystem

  • _prewarmSystem(): void

Private resetPosition

  • _resetPosition(): void

Private addBurst

  • addBurst(burst: any): void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

Private addSubEmitter

  • addSubEmitter(subEmitter: any): void

clear

  • clear(): void

destroy

  • destroy(): any

Private emit

  • emit(count: any, dt: any): void

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null
  • 获取节点上指定类型的组件,如果节点有附加指定类型的组件,则返回,如果没有则为空。
    传入参数也可以是脚本的名称。

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Type parameters

    Parameters

    Returns T | null

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

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Parameters

    • className: string

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

getMaterial

  • getMaterial(idx: number, inEditor?: boolean, autoUpdate?: boolean): Material | null

getParticleCount

  • getParticleCount(): number

getSharedMaterial

  • getSharedMaterial(idx: number): Material | null

Protected Optional lateUpdate

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

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

Protected onDestroy

  • onDestroy(): void

Protected onDisable

  • onDisable(): void

Protected onEnable

  • onEnable(): void

Protected Optional onFocusInEditor

  • onFocusInEditor(): void

onLoad

  • onLoad(): void

Protected Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Protected Optional onRestore

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

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

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

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

    Returns void

pause

  • pause(): void

play

  • play(): void

recreateModel

  • recreateModel(): void

Private removeBurst

  • removeBurst(idx: any): void

Private removeSubEmitter

  • removeSubEmitter(idx: any): void

Protected Optional resetInEditor

  • resetInEditor(): void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void
  • 调度一个自定义的回调函数。
    如果回调函数已调度,那么将不会重复调度它,只会更新时间间隔参数。

    method

    schedule

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

    Parameters

    • callback: any

      回调函数。

    • Default value interval: number = 0

      时间间隔,0 表示每帧都重复。

    • Default value repeat: number = cc.macro.REPEAT_FOREVER

      将被重复执行(repeat+ 1)次,您可以使用 cc.macro.REPEAT_FOREVER 进行无限次循环。

    • Default value delay: number = 0

      第一次执行前等待的时间(延时执行)。

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void
  • 调度一个只运行一次的回调函数,可以指定 0 让回调函数在下一帧立即执行或者在一定的延时之后执行。

    method

    scheduleOnce

    see

    [[cc.Node.schedule]]

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

    Parameters

    • callback: any

      回调函数。

    • Default value delay: number = 0

      第一次执行前等待的时间(延时执行)。

    Returns void

setCustomData2

  • setCustomData2(x: any, y: any): void

setMaterial

  • setMaterial(material: Material | null, index: number, notify?: boolean): void

Protected Optional start

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

    Returns void

stop

  • stop(): void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void

Protected update

  • update(dt: any): void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc