@nativewrappers/client/lib/ParticleEffect.js

Javascript/Typescript wrapper for the FiveM natives

import { InvertAxisFlags } from './enums';
import { Color, Vector3 } from './utils';
// TODO: Lots of Matrix stuff through memory access
/**
 * UNFINISHED! Class to manage particle effects.
 */
export class ParticleEffect {
    /**
     * Creates a particle effect.
     *
     * @param asset Particle effect asset.
     * @param effectName Name of effect.
     */
    constructor(asset, effectName) {
        this.offset = new Vector3(0, 0, 0);
        this.rotation = new Vector3(0, 0, 0);
        this.color = Color.empty;
        this.scale = 1.0;
        this.range = 1.0;
        this.invertAxis = { flags: InvertAxisFlags.None };
        this.handle = -1;
        this.asset = asset;
        this.effectName = effectName;
    }
    /**
     * Get the particle effect handle.
     */
    get Handle() {
        return this.handle;
    }
    /**
     * Get whether particle effect is currently active.
     */
    get IsActive() {
        return this.Handle !== -1 && DoesParticleFxLoopedExist(this.Handle);
    }
    /**
     * Stop a particle effect.
     */
    stop() {
        if (this.IsActive) {
            RemoveParticleFx(this.Handle, false);
        }
        this.handle = -1;
    }
    /**
     * Get the rotation of the particle effect.
     */
    get Rotation() {
        return this.rotation;
    }
    /**
     * Set the rotation of the particle effect.
     */
    set Rotation(rotation) {
        this.rotation = rotation;
        if (this.IsActive) {
            const off = this.offset; // TODO Matrix stuff to access from memory
            SetParticleFxLoopedOffsets(this.Handle, off.x, off.y, off.z, rotation.x, rotation.y, rotation.z);
        }
    }
    /**
     * Get the range of the particle effect.
     */
    get Range() {
        return this.range;
    }
    /**
     * Set the range of the particle effect.
     */
    set Range(range) {
        this.range = range;
        SetParticleFxLoopedRange(this.Handle, range);
    }
    /**
     * Get the invert axis flag of the particle effect.
     */
    get InvertAxis() {
        return this.invertAxis;
    }
    /**
     * Set the inverted axis of the particle effect.
     */
    set InvertAxis(invertAxis) {
        this.invertAxis = invertAxis;
        if (this.IsActive) {
            this.stop();
            this.start();
        }
    }
    /**
     * Set a paramaeter of a particle effect.
     *
     * @param parameterName Name of parameter.
     * @param value Value of parameter.
     */
    setParameter(parameterName, value) {
        if (this.IsActive) {
            SetParticleFxLoopedEvolution(this.Handle, parameterName, value, false);
        }
    }
    /**
     * Get the name of the particle effect asset. Same as ParticleEffect.AssetName.
     */
    get AssetName() {
        return this.asset.AssetName;
    }
    /**
     * Get the name of the particle effect.
     */
    get EffectName() {
        return this.effectName;
    }
    /**
     * Return the particle effect as string. `AssetName`\\`EffectName`.
     */
    toString() {
        return `${this.AssetName}\\${this.EffectName}`;
    }
}