Class ParticleType

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

Index

Constructors

Methods

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

Constructors

constructor

new ParticleType(textureName, minU, minV, maxU, maxV, textureCountHorizontal, textureCountVertical, isUsingBlockLight): Particles.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 Particles.ParticleType
- Defined in Particles.d.ts:315
new ParticleType(locationName, isUsingBlockLight, uv, textureCountHorizontal, textureCountVertical): Particles.ParticleType
Constructs new Particles.ParticleType object from given needed params (unfinished documentation).
Parameters
- locationName: string
- isUsingBlockLight: boolean
- uv: number[]
- textureCountHorizontal: number
- textureCountVertical: number
Returns Particles.ParticleType
- Defined in Particles.d.ts:320
new ParticleType(descriptor): Particles.ParticleType
Constructs new Particles.ParticleType object from given descriptor object.
Parameters
- descriptor: ParticleDescription
Returns Particles.ParticleType
- Defined in Particles.d.ts:325

Methods

getId

getId(): number
Returns number
Following particle type's numeric ID.
- Defined in Particles.d.ts:329

setAnimator

setAnimator(name, animator): void
Parameters
- name:
      | "color"
      | "size"
      | "icon"
      | "alpha"
- animator: ParticleAnimator
Returns void
- Defined in Particles.d.ts:341

setCollisionParams

setCollisionParams(collision, keepVelocityAfterImpact, addLifetimeAfterImpact): void
Parameters
- collision: boolean
- keepVelocityAfterImpact: boolean
- addLifetimeAfterImpact: number
Returns void
- Defined in Particles.d.ts:334

setColor

setColor(r, g, b, a): void
Parameters
- r: number
- g: number
- b: number
- a: number
Returns void
- Defined in Particles.d.ts:332
setColor(r, g, b, a, r2, g2, b2, a2): void
Parameters
- r: number
- g: number
- b: number
- a: number
- r2: number
- g2: number
- b2: number
- a2: number
Returns void
- Defined in Particles.d.ts:333

setDefaultAcceleration

setDefaultAcceleration(x, y, z): void
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in Particles.d.ts:339

setDefaultVelocity

setDefaultVelocity(x, y, z): void
Parameters
- x: number
- y: number
- z: number
Returns void
- Defined in Particles.d.ts:338

setFriction

setFriction(air, block): void
Parameters
- air: number
- block: number
Returns void
- Defined in Particles.d.ts:335

setLifetime

setLifetime(min, max): void
Parameters
- min: number
- max: number
Returns void
- Defined in Particles.d.ts:337

setRebuildDelay

setRebuildDelay(delay): void
Parameters
- delay: number
Returns void
- Defined in Particles.d.ts:331

setRenderType

setRenderType(renderType): void
Parameters
- renderType: 0 | 1 | 2
Returns void
- Defined in Particles.d.ts:330

setSize

setSize(min, max): void
Parameters
- min: number
- max: number
Returns void
- Defined in Particles.d.ts:336

setSubEmitter

setSubEmitter(name, emitter): void
Parameters
- name: "idle" | "impact" | "death"
- emitter: ParticleSubEmitter
Returns void
- Defined in Particles.d.ts:340

Class ParticleType

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Particles.ParticleType

Parameters

Returns Particles.ParticleType

Parameters

Returns Particles.ParticleType

Methods

getId

Returns number

setAnimator

Parameters

Returns void

setCollisionParams

Parameters

Returns void

setColor

Parameters

Returns void

Parameters

Returns void

setDefaultAcceleration

Parameters

Returns void

setDefaultVelocity

Parameters

Returns void

setFriction

Parameters

Returns void

setLifetime

Parameters

Returns void

setRebuildDelay

Parameters

Returns void

setRenderType

Parameters

Returns void

setSize

Parameters

Returns void

setSubEmitter

Parameters

Returns void

Settings

On This Page