ThreadNet-Web/src/components/views/elements/effects/index.ts

import { _t, _td } from "../../../../languageHandler";

export type Effect<TOptions extends { [key: string]: any }> = {
    /**
     * one or more emojis that will trigger this effect
     */
    emojis: Array<string>;
    /**
     * the matrix message type that will trigger this effect
     */
    msgType: string;
    /**
     * the room command to trigger this effect
     */
    command: string;
    /**
     * a function that returns the translated description of the effect
     */
    description: () => string;
    /**
     * a function that returns the translated fallback message. this message will be shown if the user did not provide a custom message
     */
    fallbackMessage: () => string;
    /**
     * animation options
     */
    options: TOptions;
}

type ConfettiOptions = {
    /**
     * max confetti count
     */
    maxCount: number,
    /**
     * particle animation speed
     */
    speed: number,
    /**
     * the confetti animation frame interval in milliseconds
     */
    frameInterval: number,
    /**
     * the alpha opacity of the confetti (between 0 and 1, where 1 is opaque and 0 is invisible)
     */
    alpha: number,
    /**
     * use gradient instead of solid particle color
     */
    gradient: boolean,
}

/**
 * This configuration defines room effects that can be triggered by custom message types and emojis
 */
const effects: Array<Effect<{ [key: string]: any }>> = [
    {
        emojis: ['🎊', '🎉'],
        msgType: 'nic.custom.confetti',
        command: 'confetti',
        description: () => _td("Sends the given message with confetti"),
        fallbackMessage: () => _t("sends confetti") + " 🎉",
        options: {
            maxCount: 150,
            speed: 3,
            frameInterval: 15,
            alpha: 1.0,
            gradient: false,
        },
    } as Effect<ConfettiOptions>,
];

export default effects;