Particles.ParticleType

Class to create custom particle types. Mostly for internal use, you can use Particles.registerParticleType instead.

Index

Constructors

• constructor

Methods

• getId
• setAnimator
• setCollisionParams
• setColor
• setDefaultAcceleration
• setDefaultVelocity
• setFriction
• setLifetime
• setRebuildDelay
• setRenderType
• setSize
• setSubEmitter

Constructors

constructor

• new ParticleType(textureName: string, minU: number, minV: number, maxU: number, maxV: number, textureCountHorizontal: number, textureCountVertical: number, isUsingBlockLight: boolean): ParticleType
• new ParticleType(locationName: string, isUsingBlockLight: boolean, uv: number[], textureCountHorizontal: number, textureCountVertical: number): ParticleType
• new ParticleType(descriptor: ParticleDescription): ParticleType

• Constructs new Particles.ParticleType object from given needed params.

  ---

  Parameters

  • textureName: string

  • minU: number

  • minV: number

  • maxU: number

  • maxV: number

  • textureCountHorizontal: number

  • textureCountVertical: number

  • isUsingBlockLight: boolean

  Returns ParticleType

Methods

getId

• getId(): number

• Returns number

  Following particle type's numeric ID.

setAnimator

• setAnimator(name: size | icon | alpha | color, animator: ParticleAnimator): void

• Parameters

  • name: size | icon | alpha | color

  • animator: ParticleAnimator

  Returns void

setCollisionParams

• setCollisionParams(collision: boolean, keepVelocityAfterImpact: boolean, addLifetimeAfterImpact: number): void

• Parameters

  • collision: boolean

  • keepVelocityAfterImpact: boolean

  • addLifetimeAfterImpact: number

  Returns void

setColor

• setColor(r: number, g: number, b: number, a: number): void
• setColor(r: number, g: number, b: number, a: number, r2: number, g2: number, b2: number, a2: number): void

• Parameters

  • r: number

  • g: number

  • b: number

  • a: number

  Returns void

setDefaultAcceleration

• setDefaultAcceleration(x: number, y: number, z: number): void

• Parameters

  • x: number

  • y: number

  • z: number

  Returns void

setDefaultVelocity

• setDefaultVelocity(x: number, y: number, z: number): void

• Parameters

  • x: number

  • y: number

  • z: number

  Returns void

setFriction

• setFriction(air: number, block: number): void

• Parameters

  • air: number

  • block: number

  Returns void

setLifetime

• setLifetime(min: number, max: number): void

• Parameters

  • min: number

  • max: number

  Returns void

setRebuildDelay

• setRebuildDelay(delay: number): void

• Parameters

  • delay: number

  Returns void

setRenderType

• setRenderType(renderType: 0 | 1 | 2): void

• Parameters

  • renderType: 0 | 1 | 2

  Returns void

setSize

• setSize(min: number, max: number): void

• Parameters

  • min: number

  • max: number

  Returns void

setSubEmitter

• setSubEmitter(name: idle | impact | death, emitter: ParticleSubEmitter): void

• Parameters

  • name: idle | impact | death

  • emitter: ParticleSubEmitter

  Returns void