Class ParticleSystem3D

粒子系统

Hierarchy

Constructors

constructor

Properties

__class__ _activeParticles _attributes _awaked _colorBySpeed _colorOverLifetime _emission _emit _emitInfo _emitParticles _emitWithMove _emitWithTime _entity _forceOverLifetime _inheritVelocity _initParticleState _isPlaying _isSubParticleSystem _limitVelocityOverLifetime _main _modules _noise _particlePool _rotationBySpeed _rotationOverLifetime _shape _simulationSpaceChanged _sizeBySpeed _sizeOverLifetime _subEmitters _textureSheetAnimation _updateActiveParticlesState _updateParticleState _velocityOverLifetime castShadows emitter enabled geometry hideFlags material receiveShadows runEnvironment time

Accessors

colorBySpeed colorOverLifetime emission entity forceOverLifetime inheritVelocity isPaused isPlaying isStopped isVisibleAndEnabled limitVelocityOverLifetime main node noise particleCount rotationBySpeed rotationOverLifetime shape sizeBySpeed sizeOverLifetime subEmitters textureSheetAnimation velocityOverLifetime

Methods

TriggerSubEmitter addComponent addParticleAcceleration addParticlePosition addParticleVelocity beforeRender continue destroy getComponent getComponentInChildren getComponentInParent getComponents getComponentsInChildren getComponentsInParent getShareTargets init pause play removeParticleAcceleration removeParticlePosition removeParticleVelocity setEntity stop update __create__ getDependencies isSingleComponent

Constructors

constructor

Properties

__class__

__class__: "ParticleSystem3D"

Private _activeParticles

_activeParticles: any

活跃的粒子列表

Private _attributes

_attributes: any

属性数据列表

Private _awaked

_awaked: any

Private _colorBySpeed

_colorBySpeed: any

Private _colorOverLifetime

_colorOverLifetime: any

Private _emission

_emission: any

Private _emit

_emit: any

发射粒子

Param

发射起始时间

Param

发射终止时间

Param

发射起始位置

Param

发射终止位置

_emitInfo

_emitInfo: ParticleSystemEmitInfo

发射信息

Private _emitParticles

_emitParticles: any

发射粒子

Param

发射时间

Param

发射数量

Private _emitWithMove

_emitWithMove: any

计算在指定移动的位移线段中发射的粒子列表。

Param

Param

Param

Private _emitWithTime

_emitWithTime: any

计算在指定时间段内发射的粒子列表

Param

Param

Param

Param

Protected _entity

_entity: Node3D

Private _forceOverLifetime

_forceOverLifetime: any

Private _inheritVelocity

_inheritVelocity: any

Private _initParticleState

_initParticleState: any

初始化粒子状态

Param

粒子

Private _isPlaying

_isPlaying: any

_isSubParticleSystem

_isSubParticleSystem: boolean

是否为被上级粒子系统引用的子粒子系统。

Private _limitVelocityOverLifetime

_limitVelocityOverLifetime: any

Private _main

_main: any

Private Readonly _modules

_modules: any

Private _noise

_noise: any

Private _particlePool

_particlePool: any

粒子池，用于存放未发射或者死亡粒子

Private _rotationBySpeed

_rotationBySpeed: any

Private _rotationOverLifetime

_rotationOverLifetime: any

Private _shape

_shape: any

Private _simulationSpaceChanged

_simulationSpaceChanged: any

Private _sizeBySpeed

_sizeBySpeed: any

Private _sizeOverLifetime

_sizeOverLifetime: any

Private _subEmitters

_subEmitters: any

Private _textureSheetAnimation

_textureSheetAnimation: any

Private _updateActiveParticlesState

_updateActiveParticlesState: any

更新活跃粒子状态

Private _updateParticleState

_updateParticleState: any

更新粒子状态

Param

粒子

Private _velocityOverLifetime

_velocityOverLifetime: any

castShadows

castShadows: boolean

Readonly emitter

emitter: EventEmitter<Node3DEventMap>

enabled

enabled: boolean

是否启用update方法

geometry

geometry: QuadGeometry

hideFlags

hideFlags: HideFlags

隐藏标记，用于控制是否在层级界面、检查器显示，是否保存

material

material: Material

receiveShadows

receiveShadows: boolean

runEnvironment

runEnvironment: RunEnvironment

可运行环境

time

time: number

Playback position in seconds.

回放位置(秒)

Accessors

colorBySpeed

colorOverLifetime

emission

entity

  • get entity(): Node3D

  • 此组件附加到的游戏对象。组件总是附加到游戏对象上。

    Returns Node3D

forceOverLifetime

inheritVelocity

  • get inheritVelocity(): ParticleInheritVelocityModule

  • Script interface for the Particle System velocity inheritance module.

    粒子系统速度继承模块。

    Returns ParticleInheritVelocityModule

  • set inheritVelocity(v): void

  • Parameters

    Returns void

isPaused

  • get isPaused(): boolean

  • Is the particle system paused right now ?

    粒子系统现在暂停了吗?

    Returns boolean

isPlaying

  • get isPlaying(): boolean

  • Is the particle system playing right now ?

    粒子系统正在运行吗?

    Returns boolean

isStopped

  • get isStopped(): boolean

  • Is the particle system stopped right now ?

    粒子系统现在停止了吗?

    Returns boolean

isVisibleAndEnabled

  • get isVisibleAndEnabled(): boolean

  • Has the Behaviour had enabled called. 是否所在Object3D显示且该行为已启动。

    Returns boolean

limitVelocityOverLifetime

main

  • get main(): ParticleMainModule

  • Returns ParticleMainModule

  • set main(v): void

  • Parameters

    Returns void

node

  • get node(): Node

  • 2D节点。

    Returns Node

noise

  • get noise(): ParticleNoiseModule

  • 旋转角度随速度变化模块

    Returns ParticleNoiseModule

  • set noise(v): void

  • Parameters

    Returns void

particleCount

  • get particleCount(): number

  • The current number of particles (Read Only).

    当前粒子数(只读)。

    Returns number

rotationBySpeed

rotationOverLifetime

shape

sizeBySpeed

sizeOverLifetime

subEmitters

textureSheetAnimation

velocityOverLifetime

Methods

TriggerSubEmitter

  • 触发子发射器

    Parameters

    • subEmitterIndex: number

      子发射器索引

    • Optional particles: Particle[]

    Returns void

addComponent

  • Adds a component class of type componentType to the game object.

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • type: K

      组件类定义。

    • Optional params: gPartial<ComponentMap[K]>

    Returns ComponentMap[K]

    被添加的组件。

addParticleAcceleration

  • 给指定粒子添加指定空间的速度。

    Parameters

    • particle: Particle

      粒子。

    • acceleration: Vector3

      加速度。

    • space: ParticleSystemSimulationSpace

      加速度所在空间。

    • Optional name: string

      加速度名称。如果不为 undefined 时保存，调用 removeParticleVelocity 可以移除该部分速度。

    Returns void

addParticlePosition

  • 给指定粒子添加指定空间的位移。

    Parameters

    • particle: Particle

      粒子。

    • position: Vector3

      速度。

    • space: ParticleSystemSimulationSpace

      速度所在空间。

    • Optional name: string

      速度名称。如果不为 undefined 时保存，调用 removeParticleVelocity 可以移除该部分速度。

    Returns void

addParticleVelocity

  • 给指定粒子添加指定空间的速度。

    Parameters

    • particle: Particle

      粒子。

    • velocity: Vector3

      速度。

    • space: ParticleSystemSimulationSpace

      速度所在空间。

    • Optional name: string

      速度名称。如果不为 undefined 时保存，调用 removeParticleVelocity 可以移除该部分速度。

    Returns void

beforeRender

continue

  • 继续

    Returns void

destroy

  • 销毁

    Returns void

getComponent

  • 返回游戏对象附加的一个指定类型的组件，如果没有，则返回 null。

    使用 Entity.GetComponent 将返回找到的第一个组件。如果您希望有多个相同类型的组件，请改用 Entity.GetComponents，并循环通过返回的组件测试某些唯一属性。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    Returns ComponentMap[K]

    要检索的组件。

getComponentInChildren

  • 使用深度优先搜索返回 Entity 或其任何子项中的 Type 组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      是否包含不活跃组件。

    Returns ComponentMap[K]

    匹配类型的组件（如果找到）。

getComponentInParent

  • 检索 Entity 或其任何父项type中的 Type 组件。

    此方法向上递归，直到找到具有匹配组件的 Entity。仅匹配活动游戏对象上的组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要查找的组件类型。

    • Optional includeInactive: boolean

      是否包含不活跃组件。

    Returns ComponentMap[K]

    如果找到与类型匹配的组件，则返回一个组件。否则返回 null。

getComponents

  • 返回Entity中指定类型的所有组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • type: K

      要检索的组件类型。

    • Optional results: ComponentMap[K][]

      列出接收找到的组件。

    Returns ComponentMap[K][]

    实体中指定类型的所有组件。

getComponentsInChildren

  • 使用深度优先搜索返回 当前实体 或其任何子子项中 Type 的所有组件。递归工作。

    在子游戏对象上递归搜索组件。这意味着它还包括目标实体的所有子实体，以及所有后续子实体。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      非活动游戏对象上的组件是否应该包含在搜索结果中？

    • Optional results: ComponentMap[K][]

      列出接收找到的组件。

    Returns ComponentMap[K][]

    所有找到的组件。

getComponentsInParent

  • 返回当前实体或其任何父级中指定的所有组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      要检索的组件类型。

    • Optional includeInactive: boolean

      非活动组件是否应该包含在搜索结果中？

    • Optional results: ComponentMap[K][]

      列出找到的组件。

    Returns ComponentMap[K][]

    实体或其任何父级中指定的所有组件。

getShareTargets

  • 把事件分享到实体上。

    Returns Entity[]

init

  • 初始化组件

    在添加到Entity时立即被调用。

    Returns void

pause

  • 暂停

    Returns void

play

  • 播放

    Returns void

removeParticleAcceleration

  • 移除指定粒子上的加速度

    Parameters

    • particle: Particle

      粒子。

    • name: string

      加速度名称。

    Returns void

removeParticlePosition

  • 移除指定粒子上的位移

    Parameters

    • particle: Particle

      粒子。

    • name: string

      位移名称。

    Returns void

removeParticleVelocity

  • 移除指定粒子上的速度

    Parameters

    • particle: Particle

      粒子。

    • name: string

      速度名称。

    Returns void

Private setEntity

  • Private

    该方法仅在Entity中使用

    Parameters

    • entity: Entity

      游戏对象

    Returns void

stop

  • 停止

    Returns void

update

  • Parameters

    • interval: number

    Returns void

Static Private __create__

  • __create__<T>(this): T
  • Private

    组件无法直接使用关键字 new 来构造。

    Type Parameters

    • T

    Parameters

    Returns T

    新建的组件实例。

    See

    getInstance

Static getDependencies

  • 获取组件依赖列表

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K

      组件类定义

    Returns "Component"[]

Static isSingleComponent

  • 判断组件是否为唯一组件。

    Type Parameters

    • K extends keyof ComponentMap

    Parameters

    • component: K | ComponentMap[K] | Constructor<ComponentMap[K]>

      组件类定义

    Returns boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc