Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Particle

example
entity.addComponent(Particle, {
   emitter: { x: 0, y: 0, z: 1 },
   texture: {
     diffuse: { url: "PATH_TO_PARTICLE_TEXTURE" }
   }
});

Hierarchy

  • Particle

Implements

Index

Properties

Optional angle

angle: undefined | number
memberof

Cone

Optional capacity

capacity: undefined | number = 100

Optional color

direction1

direction1: XYZProperties = xyz()
memberof

Point, Box, DirectedSphere, Cylinder

default

0,0,0

direction2

direction2: XYZProperties = xyz(10, 10, 10)
memberof

Point, Box, DirectedSphere, Cylinder

default

10,10,10

Optional emitRate

emitRate: undefined | number

emitter

emitter: XYZProperties = xyz()

Optional height

height: undefined | number
memberof

Cylinder

maxEmitBox

maxEmitBox: XYZProperties = xyz()
memberof

Box

default

0,0,0

minEmitBox

minEmitBox: XYZProperties = xyz()
memberof

Box

default

0,0,0

object

object: ParticleSystem

Optional radius

radius: undefined | number
memberof

Sphere, DirectedSphere, Hemispheric, Cylinder, Cone

Optional radiusRange

radiusRange: undefined | number
memberof

Hemispheric, Cylinder

Optional scene

scene: Entity

Optional texture

Optional type

type: ParticleTypes = ParticleTypes.Point
default

"Point"

Generated using TypeDoc