Function bulk

  • Registers any number of registrations of a single type. Any other registration type can be used.

    Note: Not all registration types have been tested. If you run into any issues with one report a bug!

    Example

    const itemColors = ["red", "blue", "green"];
    class Mod {
        @Register.bulk("item", ...itemColors
            .map(color => Tuple(`${color}Item`, { weight: 1 })))
     public readonly items: ItemType[];
    }

    Type Parameters

    • REG_TYPE extends "message" | "action" | "skill" | "status" | "stat" | "npc" | "doodad" | "tileEvent" | "item" | "creature" | "bindable" | "load" | "prompt" | "biome" | "registry" | "language" | "languageExtension" | "genericEnum" | "musicTrack" | "soundEffect" | "packet" | "helpArticle" | "note" | "terrain" | "tileGroup" | "terrainDecoration" | "dialog" | "quadrantComponent" | "dictionary" | "interruptChoice" | "messageSource" | "overlay" | "inspectionType" | "menuBarButton" | "itemGroup" | "doodadGroup" | "worldLayer" | "tileLayer" | "quest" | "questRequirement" | "magicalProperty" | "itemTag" | "doodadTag" | "entityTag" | "usableActions" | "usableActionType" | "usableActionTypePlaceholder" | "equipType" | "interModRegistry" | "interModRegistration" | "override" | "bulk" | "command" | "optionsSection"

    • REG extends AnyFunction<any> = typeof default[REG_TYPE]

    Parameters

    • type: REG_TYPE

      The type of registration to register — the name of another @Register.<type> decorator.

    • Rest ...entries: Parameters<REG>[]

      The registration definitions — each entry is a tuple containing the parameters that would be given to the registration decorator.

    Returns (<K, T>(target: T, key: K) => void)

      • <K, T>(target: T, key: K): void

      • Type Parameters

        • K extends string | number | symbol

        • T extends Record<K, (REG extends ((...args: any) => infer F2) ? F2 extends ((t: infer T, k: infer K) => any) ? T[Extract<K, keyof T>] : never : never)[]>

        Parameters

        • target: T
        • key: K

        Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc