@tryforge/forgescript
    Preparing search index...

    Interface INativeFunction<T, Unwrap>

    interface INativeFunction<
        T extends [...IArg[]],
        Unwrap extends boolean = boolean,
    > {
        aliases?: `$${string}`[];
        args?: [...T[]];
        brackets?: boolean;
        deprecated?: boolean;
        description: string;
        examples?: string[];
        execute: NativeFunctionExecutor<T, Unwrap>;
        experimental?: boolean;
        name: `$${string}`;
        output?: ArgType | EnumLike<any> | (ArgType | EnumLike<any>)[];
        unwrap: Unwrap;
        version?: string;
    }

    Type Parameters

    • T extends [...IArg[]]
    • Unwrap extends boolean = boolean
    Index
    aliases? args? brackets? deprecated? description examples? execute experimental? name output? unwrap version?
    aliases?: `$${string}`[]

    Aliases this function has.

    args?: [...T[]]
    brackets?: boolean

    If undefined, function has no brackets.

    If false, function can have brackets.

    If true, function must have brackets.

    deprecated?: boolean
    description: string
    examples?: string[]

    Not being used.

    execute: NativeFunctionExecutor<T, Unwrap>
    experimental?: boolean
    name: `$${string}`
    output?: ArgType | EnumLike<any> | (ArgType | EnumLike<any>)[]
    unwrap: Unwrap

    Resolves all arguments and are passed through execute params.

    version?: string

    Do not provide this.

    Settings
    Member Visibility

    On This Page
    Properties