Interface ParticleDescription

Custom particle type params object.

interface ParticleDescription {
    acceleration?: [number, number, number];
    addLifetimeAfterImpact?: number;
    animators?: {
        alpha?: AnimatorDescription;
        color?: ColorAnimatorDescription;
        icon?: AnimatorDescription;
        size?: AnimatorDescription;
        texture?: AnimatorDescription;
    };
    collision?: boolean;
    color?: [number, number, number, number];
    color2?: [number, number, number, number];
    emitters?: {
        death?: SubEmitterDescription;
        idle?: SubEmitterDescription;
        impact?: SubEmitterDescription;
    };
    framesX?: number;
    framesY?: number;
    friction?: {
        air?: number;
        block?: number;
    };
    isUsingBlockLight?: boolean;
    keepVelocityAfterImpact?: boolean;
    lifetime: [number, number];
    rebuildDelay?: number;
    render?: number;
    size: [number, number];
    texture: string;
    velocity?: [number, number, number];
}

Properties

acceleration? addLifetimeAfterImpact? animators? collision? color? color2? emitters? framesX? framesY? friction? isUsingBlockLight? keepVelocityAfterImpact? lifetime rebuildDelay? render? size texture velocity?

Properties

Optionalacceleration

acceleration?: [number, number, number]

Particle's acceleration, if it's spawned without this parameter.

Default

[0, 0, 0]

OptionaladdLifetimeAfterImpact

addLifetimeAfterImpact?: number

Particle will lose given number of ticks from it's maximum lifetime, when touching a block.

Remarks

This value makes sense only if collision param is true.

Default

0

Optionalanimators

animators?: {
    alpha?: AnimatorDescription;
    color?: ColorAnimatorDescription;
    icon?: AnimatorDescription;
    size?: AnimatorDescription;
    texture?: AnimatorDescription;
}

Animators allow to change some properties of the specific particle depending on the time, each animator is described as an object of definite format and can be not described, if it's not needed.

Type declaration

  • Optionalalpha?: AnimatorDescription

    Describes the particle's opacity, for the unit value the alpha in the color parameter from the type's description is taken.

  • Optionalcolor?: ColorAnimatorDescription

    Describes the animated color value, if particle supports it. Accepts values in RGBA ranges, like color property in descriptor.

    Since

    2.0.4b38

  • Optionalicon?: AnimatorDescription

    Describes the animation frame, if particle supports it. Must have the value between 0 and 1.

  • Optionalsize?: AnimatorDescription

    Describes the behavior of particle's size, for the unit size the size from the type's description is taken.

  • Optionaltexture?: AnimatorDescription

    Describes the animation frame, if particle supports it. Must have the value between 0 and 1.

    Deprecated

    Use icon instead.

Optionalcollision

collision?: boolean

If true, particle won't go through blocks. It reduces performance if there are lots of these particles.

Default

false.

Optionalcolor

color?: [number, number, number, number]

Four component color of the particle (RGBA).

Default

[1, 1, 1, 1]

Optionalcolor2

color2?: [number, number, number, number]

Since

2.0.4b38

Optionalemitters

emitters?: {
    death?: SubEmitterDescription;
    idle?: SubEmitterDescription;
    impact?: SubEmitterDescription;
}

Sub-emitters (don't confuse with emitters) describe how specific particle can emit other particles, according to some events, that may happen to it. Each sub-emitter is described as an object of definite format and can be not described if it's not needed.

Type declaration

OptionalframesX

framesX?: number

Animation frame grid size around width.

Since

2.0.4b38

OptionalframesY

framesY?: number

Animation frame grid size around height.

Since

2.0.4b38

Optionalfriction

friction?: {
    air?: number;
    block?: number;
}

Particle's speed modifier in the air and when touching a block. Usually it's a number between 0 and 1, close to 1, but in fact it can be any value. Both values are 1 by default.

Type declaration

  • Optionalair?: number
  • Optionalblock?: number

    Remarks

    This value makes sense only if collision param is true.

OptionalisUsingBlockLight

isUsingBlockLight?: boolean

If true, the particle will be exposed to the world's lighting. If false, the particle will always have maximum brightness. Enabling this parameter may reduce the performance when having lots of particles.

Default

false.

OptionalkeepVelocityAfterImpact

keepVelocityAfterImpact?: boolean

If false, particle's speed will be set to zero when touching a block. If true, the speed will be saved.

Remarks

This value makes sense only if collision param is true.

lifetime

lifetime: [number, number]

Minimum and maximum particle's lifetime in ticks.

OptionalrebuildDelay

rebuildDelay?: number

Time in ticks between particle mesh updates.

Since

2.0.4b38

Optionalrender

render?: number

Particle's render type:

  • 0 - additive
  • 1 - without blending
  • 2 - with blending

size

size: [number, number]

Minimum and maximum size of the particle.

texture

texture: string

Particle's texture name from /particle-atlas resource directory.

Optionalvelocity

velocity?: [number, number, number]

Particle's initial velocity, if it's spawned without initial speed parameter.

Default

[0, 0, 0]

Settings

Member Visibility

On This Page

Properties

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.