Class ParticleType

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

Hierarchy

ParticleType

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in core-engine.d.ts:14807
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 core-engine.d.ts:14812
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 core-engine.d.ts:14816
Constructs new Particles.ParticleType object from given descriptor object

Parameters
- descriptor: ParticleDescription
Returns Particles.ParticleType

Methods

getId

getId(): number

- Defined in core-engine.d.ts:14820
Returns number
following particle type's numeric id

setAnimator

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

- Defined in core-engine.d.ts:14832
Parameters
- name: "color" | "size" | "icon" | "alpha"
- animator: ParticleAnimator
Returns void

setCollisionParams

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

- Defined in core-engine.d.ts:14825
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

- Defined in core-engine.d.ts:14823
Parameters
- r: number
- g: number
- b: number
- a: number
Returns void
- Defined in core-engine.d.ts:14824
Parameters
- r: number
- g: number
- b: number
- a: number
- r2: number
- g2: number
- b2: number
- a2: number
Returns void

setDefaultAcceleration

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

- Defined in core-engine.d.ts:14830
Parameters
- x: number
- y: number
- z: number
Returns void

setDefaultVelocity

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

- Defined in core-engine.d.ts:14829
Parameters
- x: number
- y: number
- z: number
Returns void

setFriction

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

- Defined in core-engine.d.ts:14826
Parameters
- air: number
- block: number
Returns void

setLifetime

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

- Defined in core-engine.d.ts:14828
Parameters
- min: number
- max: number
Returns void

setRebuildDelay

setRebuildDelay(delay: number): void

- Defined in core-engine.d.ts:14822
Parameters
- delay: number
Returns void

setRenderType

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

- Defined in core-engine.d.ts:14821
Parameters
- renderType: 0 | 2 | 1
Returns void

setSize

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

- Defined in core-engine.d.ts:14827
Parameters
- min: number
- max: number
Returns void

setSubEmitter

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

- Defined in core-engine.d.ts:14831
Parameters
- name: "idle" | "impact" | "death"
- emitter: ParticleSubEmitter
Returns void

Generated using TypeDoc