Class ParticleSystem

Hierarchy (view full)

Implements

  • IParticleSystem

Accessors

activeAndEnabled behaviours cameraScale container context currentParticles deltaTime destroyed duration enabled forward hideFlags isComponent isPlaying isSubsystem layer localspace matrixWorld maxParticles name particleSystem playOnAwake renderer right scale scene static tag time up worldEuler worldPos worldPosition worldQuaternion worldQuaternionInverted worldRotation worldScale worldspace

Methods

addBehaviour addEventListener awake destroy dispatchEvent earlyUpdate? emit lateUpdate? onAfterDeserialize onAfterRender? onBeforeRender onCollisionEnter? onCollisionExit? onCollisionStay? onDestroy onDisable onEnable onPausedChanged? onTriggerEnter? onTriggerExit? onTriggerStay? onValidate? pause play removeAllBehaviours removeEventListener reset resolveGuids? setWorldPosition setWorldQuaternion setWorldRotation start startCoroutine stop stopCoroutine update?

Accessors

activeAndEnabled

  • get activeAndEnabled(): boolean

  • Returns boolean

behaviours

  • get behaviours(): Behavior[]

  • Get the particlesystem behaviours. This can be used to fully customize the behaviour of the particles.

    Returns Behavior[]

cameraScale

  • get cameraScale(): number

  • Returns number

container

  • get container(): Object3D

  • Returns Object3D

context

  • get context(): Context

  • Returns Context

  • set context(context): void

  • Parameters

    Returns void

currentParticles

  • get currentParticles(): any

  • Returns any

deltaTime

  • get deltaTime(): number

  • Returns number

destroyed

  • get destroyed(): boolean

  • Returns boolean

duration

  • get duration(): number

  • Returns number

enabled

  • get enabled(): boolean

  • Returns boolean

  • set enabled(val): void

  • Parameters

    • val: boolean

    Returns void

forward

  • get forward(): Vector3

  • Forward (0,0,-1) vector in world space

    Returns Vector3

hideFlags

  • get hideFlags(): HideFlags

  • Returns HideFlags

isComponent

  • get isComponent(): boolean

  • Returns boolean

isPlaying

  • get isPlaying(): boolean

  • Returns boolean

isSubsystem

  • get isSubsystem(): boolean

  • Returns boolean

layer

  • get layer(): number

  • Returns number

localspace

  • get localspace(): boolean

  • Returns boolean

matrixWorld

  • get matrixWorld(): Matrix4

  • Returns Matrix4

maxParticles

  • get maxParticles(): number

  • Returns number

name

  • get name(): string

  • Returns string

  • set name(str): void

  • Parameters

    • str: string

    Returns void

particleSystem

playOnAwake

  • get playOnAwake(): boolean

  • Returns boolean

  • set playOnAwake(val): void

  • Parameters

    • val: boolean

    Returns void

renderer

right

  • get right(): Vector3

  • Right (1,0,0) vector in world space

    Returns Vector3

scale

  • get scale(): any

  • Returns any

scene

  • get scene(): Scene

  • Returns Scene

static

  • get static(): any

  • Returns any

tag

  • get tag(): string

  • Returns string

  • set tag(str): void

  • Parameters

    • str: string

    Returns void

time

  • get time(): number

  • Returns number

up

  • get up(): Vector3

  • Up (0,1,0) vector in world space

    Returns Vector3

worldEuler

  • get worldEuler(): Euler

  • Returns Euler

  • set worldEuler(val): void

  • Parameters

    • val: Euler

    Returns void

worldPos

  • get worldPos(): Vector3

  • Returns Vector3

worldPosition

  • get worldPosition(): Vector3

  • Returns Vector3

  • set worldPosition(val): void

  • Parameters

    • val: Vector3

    Returns void

worldQuaternion

  • get worldQuaternion(): Quaternion

  • Returns Quaternion

worldQuaternionInverted

  • get worldQuaternionInverted(): Quaternion

  • Returns Quaternion

worldRotation

  • get worldRotation(): Vector3

  • Returns Vector3

  • set worldRotation(val): void

  • Parameters

    • val: Vector3

    Returns void

worldScale

  • get worldScale(): Vector3

  • Returns Vector3

worldspace

  • get worldspace(): boolean

  • Returns boolean

Methods

addBehaviour

  • addBehaviour(particleSystemBehaviour): boolean

  • Add a custom quarks behaviour to the particle system. You can add a quarks.Behaviour type.

    Parameters

    • particleSystemBehaviour: any

    Returns boolean

    Link

    https://github.com/Alchemist0823/three.quarks

addEventListener

  • addEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((evt) => any)
        • (evt): any

        • Parameters

          • evt: T

          Returns any

    Returns void

awake

  • awake(): void

  • called once when the component becomes active for the first time

    Returns void

destroy

dispatchEvent

Optional earlyUpdate

emit

  • emit(count): void

  • Parameters

    • count: number

    Returns void

Optional lateUpdate

onAfterDeserialize

  • onAfterDeserialize(_): void

  • Parameters

    • _: any

    Returns void

Optional onAfterRender

onBeforeRender

Optional onCollisionEnter

Optional onCollisionExit

Optional onCollisionStay

onDestroy

onDisable

onEnable

  • onEnable(): void

  • called every time when the component gets enabled (this is invoked after awake and before start)

    Returns void

Optional onPausedChanged

  • onPausedChanged(isPaused, wasPaused): void

  • Called for all scripts when the context gets paused or unpaused

    Parameters

    • isPaused: boolean
    • wasPaused: boolean

    Returns void

Optional onTriggerEnter

Optional onTriggerExit

Optional onTriggerStay

Optional onValidate

  • onValidate(prop?): void

  • called when you decorate fields with the @validate() decorator

    Parameters

    • Optional prop: string

    Returns void

pause

  • pause(includeChildren?): void

  • Parameters

    • includeChildren: boolean = true

    Returns void

play

  • play(includeChildren?): void

  • Parameters

    • includeChildren: boolean = false

    Returns void

removeAllBehaviours

  • removeAllBehaviours(): boolean

  • Removes all behaviours from the particle system
    Note: this will also remove the default behaviours like SizeBehaviour, ColorBehaviour etc.

    Returns boolean

removeEventListener

  • removeEventListener<T>(type, listener): void

  • Type Parameters

    Parameters

    • type: string
    • listener: ((arg) => any)
        • (arg): any

        • Parameters

          • arg: T

          Returns any

    Returns void

reset

  • reset(): void

  • remove emitted particles and reset time

    Returns void

Optional resolveGuids

  • resolveGuids(guidsMap): void

  • called on a component with a map of old to new guids (e.g. when instantiate generated new guids and e.g. timeline track bindings needs to remape them)

    Parameters

    • guidsMap: GuidsMap

    Returns void

setWorldPosition

setWorldQuaternion

  • setWorldQuaternion(x, y, z, w): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • w: number

    Returns void

setWorldRotation

  • setWorldRotation(x, y, z, degrees?): void

  • Parameters

    • x: number
    • y: number
    • z: number
    • degrees: boolean = true

    Returns void

start

startCoroutine

stop

  • stop(includeChildren?, clear?): void

  • clear=true removes all emitted particles

    Parameters

    • includeChildren: boolean = true
    • clear: boolean = false

    Returns void

stopCoroutine

  • stopCoroutine(routine, evt?): void

  • Parameters

    • routine: Generator<unknown, any, unknown>
    • evt: FrameEvent = FrameEvent.Update

    Returns void

Optional update

Settings

Member Visibility

Theme

On This Page

activeAndEnabledbehaviourscameraScalecontainercontextcurrentParticlesdeltaTimedestroyeddurationenabledforwardhideFlagsisComponentisPlayingisSubsystemlayerlocalspacematrixWorldmaxParticlesnameparticleSystemplayOnAwakerendererrightscalescenestatictagtimeupworldEulerworldPosworldPositionworldQuaternionworldQuaternionInvertedworldRotationworldScaleworldspaceaddBehaviouraddEventListenerawakedestroydispatchEventearlyUpdateemitlateUpdateonAfterDeserializeonAfterRenderonBeforeRenderonCollisionEnteronCollisionExitonCollisionStayonDestroyonDisableonEnableonPausedChangedonTriggerEnteronTriggerExitonTriggerStayonValidatepauseplayremoveAllBehavioursremoveEventListenerresetresolveGuidssetWorldPositionsetWorldQuaternionsetWorldRotationstartstartCoroutinestopstopCoroutineupdate

Generated using TypeDoc