Class Particles

Hierarchy

Component
- Particles

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Particles(props?: ObjectProps<Particles>): Particles

- Defined in src/graphics/particles/Particles.ts:213
Parameters
- Optional props: ObjectProps<Particles>
Returns Particles

Properties

direction

direction: ParticleEmitDirection = ParticleEmitDirection.Up

duration

duration: number = 6

gravity

gravity: number = 9.8

initialColor

initialColor: Color = new Color(1, 1, 1, 1)

initialSize

initialSize: Range = new Range(1, 2)

initialSpeed

initialSpeed: Range = new Range(1, 2)

isLooping

isLooping: boolean = false

life

life: Range = new Range(1, 2)

maxParticles

maxParticles: number = 128

particlesPerSecond

particlesPerSecond: number = 30

worldSpace

worldSpace: boolean = false

Accessors

active

get active(): boolean
set active(active: boolean): void

Inherited from Component.active
- Defined in src/core/Component.ts:12
Returns boolean
Inherited from Component.active
- Defined in src/core/Component.ts:13
Parameters
- active: boolean
Returns void

colorOverLife

set colorOverLife(samples: ParticleColorOverLife[]): void

- Defined in src/graphics/particles/Particles.ts:168
Parameters
- samples: ParticleColorOverLife[]
Returns void

entity

get entity(): Entity

Inherited from Component.entity
- Defined in src/core/Component.ts:10
Returns Entity

geometry

get geometry(): ParticlesGeometry

- Defined in src/graphics/particles/Particles.ts:157
Returns ParticlesGeometry

group

set group(group: VisualGroup): void

- Defined in src/graphics/particles/Particles.ts:172
Parameters
- group: VisualGroup
Returns void

id

get id(): string

Inherited from Component.id
- Defined in src/core/Component.ts:11
Returns string

material

set material(material: Material): void

- Defined in src/graphics/particles/Particles.ts:175
Parameters
- material: Material
Returns void

parent

get parent(): undefined | Entity

Inherited from Component.parent
- Defined in src/core/Component.ts:9
Returns undefined | Entity

shape

set shape(shape: ParticleShape | undefined): void

- Defined in src/graphics/particles/Particles.ts:159
Parameters
- shape: ParticleShape | undefined
Returns void

sizeOverLife

set sizeOverLife(samples: ParticleNumberOverLife[]): void

- Defined in src/graphics/particles/Particles.ts:164
Parameters
- samples: ParticleNumberOverLife[]
Returns void

speedOverLife

set speedOverLife(samples: ParticleNumberOverLife[]): void

- Defined in src/graphics/particles/Particles.ts:160
Parameters
- samples: ParticleNumberOverLife[]
Returns void

version

get version(): number

- Defined in src/graphics/particles/Particles.ts:155
Returns number

visual

get visual(): Visual

- Defined in src/graphics/particles/Particles.ts:156
Returns Visual

volume

set volume(volume: Volume | undefined): void

- Defined in src/graphics/particles/Particles.ts:158
Parameters
- volume: Volume | undefined
Returns void

Methods

checkCollisions

checkCollisions(shape: CollisionShape, shapeTransform: Transform, onCollision: function): void

- Defined in src/graphics/particles/Particles.ts:429
Parameters
- shape: CollisionShape
- shapeTransform: Transform
- onCollision: function
  - - (particleIndex: number): void
    - Parameters
      - particleIndex: number
      Returns void
Returns void

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Overrides SerializableObject.destroy
- Defined in src/graphics/particles/Particles.ts:277
Returns void

emitParticle

emitParticle(): void

- Defined in src/graphics/particles/Particles.ts:288
Returns void

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Inherited from Component.isLoaded
- Defined in src/core/Component.ts:36
Returns boolean

onReplace

onReplace(previous: Component): void

Inherited from Component.onReplace
- Defined in src/core/Component.ts:46
Parameters
- previous: Component
Returns void

reset

reset(): void

Inherited from Component.reset
- Defined in src/core/Component.ts:40
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setEntity

setEntity(entity: Entity): void

Overrides Component.setEntity
- Defined in src/graphics/particles/Particles.ts:239
Parameters
- entity: Entity
Returns void

setParticleLife

setParticleLife(index: number, life: number): void

- Defined in src/graphics/particles/Particles.ts:235
Parameters
- index: number
- life: number
Returns void

setProperty

setProperty(name: string, value: any): void

Overrides SerializableObject.setProperty
- Defined in src/graphics/particles/Particles.ts:253
Parameters
- name: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

update

update(): void

- Defined in src/graphics/particles/Particles.ts:295
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/graphics/particles/Particles.ts:462
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject