forge.timers
    Preparing search index...

    Interface ITimerRunnable

    interface ITimerRunnable {
        allowTopLevelReturn?: boolean;
        args?: string[];
        author?: User | null;
        authorMember?: GuildMember | null;
        client: ForgeClient;
        command: BaseCommand<unknown> | null;
        container?: Container;
        data: IExtendedCompilationResult;
        disableConsoleErrors?: boolean;
        doNotSend?: boolean;
        environment?: Record<string, unknown>;
        event?: ITimerEventData | null;
        extras?: unknown;
        keywords?: Record<string, unknown>;
        localFunctions?: Record<string, ILocalFunctionData>;
        obj: Sendable;
        redirectErrorsToConsole?: boolean;
        states?: States;
        timer?: Timer | null;
    }

    Hierarchy

    • IRunnable
      • ITimerRunnable
    Index
    allowTopLevelReturn? args? author? authorMember? client command container? data disableConsoleErrors? doNotSend? environment? event? extras? keywords? localFunctions? obj redirectErrorsToConsole? states? timer?
    allowTopLevelReturn?: boolean
    args?: string[]

    The args used in the message command

    author?: User | null

    Scheduling user, refetched on restore - fills in once the original message is gone

    authorMember?: GuildMember | null

    The scheduling user as a guild member, when the timer belongs to a guild.

    client: ForgeClient

    The available discord client

    command: BaseCommand<unknown> | null

    The command used for this execution

    container?: Container

    The container reference to use

    data: IExtendedCompilationResult

    The compiled data to execute

    disableConsoleErrors?: boolean

    Removes errors output to console

    doNotSend?: boolean

    Whether to suppress sending the response to discord.

    environment?: Record<string, unknown>

    The already existing env variables

    event?: ITimerEventData | null

    What the event added on top of its timer, read by the event/ natives

    extras?: unknown

    Extras data

    keywords?: Record<string, unknown>

    The already existing variables defined with $let

    localFunctions?: Record<string, ILocalFunctionData>

    The already existing local functions

    obj: Sendable

    The context this code will run in

    redirectErrorsToConsole?: boolean

    Whether to suppress errors from being sent to discord, and be sent to console instead

    states?: States

    The old and new states of an event

    timer?: Timer | null

    The timer this run is about.

    Settings
    Member Visibility

    On This Page
    Properties