491f0cd08a
* Copyright headers 1 * Licence headers 2 * Copyright Headers 3 * Copyright Headers 4 * Copyright Headers 5 * Copyright Headers 6 * Copyright headers 7 * Add copyright headers for html and config file * Replace license files and update package.json * Update with CLA * lint
38 lines
1016 B
TypeScript
38 lines
1016 B
TypeScript
/*
|
|
Copyright 2024 New Vector Ltd.
|
|
Copyright 2020 Nurjin Jafar
|
|
Copyright 2020 Nordeck IT + Consulting GmbH.
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import { TranslationKey } 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 translatable description of the effect
|
|
*/
|
|
description: () => TranslationKey;
|
|
/**
|
|
* 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;
|
|
};
|