renovate[bot]
063e0802f4
* Update dependency knip to v6 * Make knip happy --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Michael Telatynski <7t3chguy@gmail.com>
38 lines
1.0 KiB
TypeScript
38 lines
1.0 KiB
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 OR LicenseRef-Element-Commercial
|
|
Please see LICENSE files in the repository root for full details.
|
|
*/
|
|
|
|
import type ICanvasEffect from "./ICanvasEffect.ts";
|
|
|
|
export type Effect = {
|
|
/**
|
|
* 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 TODO
|
|
*/
|
|
getRenderer(): Promise<ICanvasEffect>;
|
|
};
|