@scml-dol-maplebirch/types 5.0.4 → 5.1.1

package/modules/NamedNPCAddon/NPCSidebarConfig/functions.d.ts

@@ -0,0 +1,509 @@
+import type { NPCSidebarOptions, NPCSidebarState, NPCSidebarClothing, NPCClothesSlot } from './types.js';
+type Part = 'face' | 'neck' | 'upper' | 'lower' | 'legs' | 'feet' | 'hands';
+type ClothesType = 'main' | 'acc' | 'detail';
+type Side = 'left' | 'right';
+type ClothingIndexResolver = (slot: NPCClothesSlot, clothes: NPCSidebarClothing) => number;
+declare function clothingIndex(slot: NPCClothesSlot, clothes: NPCSidebarClothing, resolver?: ClothingIndexResolver): number;
+declare function normaliseClothingState(setupData: NPCSidebarClothing, data: NPCSidebarClothing, index: number): NPCSidebarClothing;
+declare function isAltPosition(clothes: NPCSidebarClothing, part?: string): boolean;
+declare function clothingZIndex(zIndices: Record<string, number>, clothes: NPCSidebarClothing, fallback: number): number;
+declare function previousFilterName(name: PropertyKey): PropertyKey;
+declare function normaliseFileName(text: string): string;
+declare function lookupColour(dict: Record<string, {
+    canvasfilter: CanvasLayerFilter;
+}>, key: string, prefilterName?: string): CanvasLayerFilter;
+declare function gray_suffix(path: string, _filter?: CanvasLayerFilter | null): string;
+declare function kaijuMask(options: NPCSidebarOptions): string | undefined;
+declare function selected_art(nnpc: NPCSidebarState): import("../NPCClothes/NPCSidebarArt.js").ResolvedArt | undefined;
+declare function nnpc_sidepart(part: Part): {
+    srcfn: (options: NPCSidebarOptions) => string | undefined;
+    showfn: (options: NPCSidebarOptions) => boolean;
+    zfn: (options: NPCSidebarOptions) => number;
+};
+declare function clothes_basic(slot: NPCClothesSlot, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+declare function clothes_layer(slot: NPCClothesSlot, type: ClothesType, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+declare function clothes_breasts(slot: NPCClothesSlot, type: ClothesType, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+declare function clothes_arm(slot: NPCClothesSlot, side: Side, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+declare function clothes_arm_acc(slot: NPCClothesSlot, side: Side, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+declare function clothes_back(slot: NPCClothesSlot, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+declare function clothes_back_acc(slot: NPCClothesSlot, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+declare function clothes_hand(side: Side, type: ClothesType, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+declare function clothes_handheld(type: ClothesType, overrides?: LayerConfig): {
+    name?: string;
+    model?: CanvasModel;
+    defaultOptions?: LayerConfig;
+    show?: boolean;
+    src?: CanvasLayerSrc;
+    z?: number;
+    alpha?: number;
+    maskAlpha?: number;
+    brightness?: number;
+    contrast?: number;
+    blend?: string;
+    blendMode?: string;
+    maskBlendMode?: string;
+    compositeOperation?: string;
+    desaturate?: boolean;
+    masksrc?: CanvasLayerMaskSrc;
+    filters?: CanvasLayerFilter[];
+    dx?: number;
+    dy?: number;
+    width?: number;
+    height?: number;
+    worn?: CanvasLayerWorn;
+    scale?: boolean | number;
+    frameDx?: number;
+    frameDy?: number;
+    showfn?: CanvasLayerValueFn<boolean>;
+    srcfn?: CanvasLayerValueFn<CanvasLayerSrc>;
+    maskAlphafn?: CanvasLayerValueFn<number>;
+    brightnessfn?: CanvasLayerValueFn<number>;
+    contrastfn?: CanvasLayerValueFn<number>;
+    blendfn?: CanvasLayerValueFn<string | undefined>;
+    blendModefn?: CanvasLayerValueFn<string | undefined>;
+    maskBlendModefn?: CanvasLayerValueFn<string | undefined>;
+    compositeOperationfn?: CanvasLayerValueFn<string | undefined>;
+    desaturatefn?: CanvasLayerValueFn<boolean>;
+    animationfn?: CanvasLayerValueFn<any>;
+    filtersfn?: CanvasLayerValueFn<CanvasLayerFilter[] | undefined>;
+    widthfn?: CanvasLayerValueFn<number>;
+    heightfn?: CanvasLayerValueFn<number>;
+    scalefn?: CanvasLayerValueFn<boolean | number | undefined>;
+    masksrcfn: (options: NPCSidebarOptions) => CanvasLayerMaskSrc;
+    alphafn: (options: NPCSidebarOptions) => number;
+    wornfn: CanvasLayerValueFn<CanvasLayerWorn | undefined> | ((options: NPCSidebarOptions) => {
+        slot: NPCClothesSlot;
+        integrity: string;
+        alt: string | undefined;
+        index: number;
+    });
+    zfn: (options: NPCSidebarOptions) => number;
+    dxfn: (options: NPCSidebarOptions) => number;
+    dyfn: (options: NPCSidebarOptions) => number;
+    animation: any;
+};
+export { lookupColour, gray_suffix, normaliseFileName, clothingIndex, normaliseClothingState, isAltPosition, clothingZIndex, previousFilterName, kaijuMask, selected_art, nnpc_sidepart, clothes_basic, clothes_layer, clothes_breasts, clothes_arm, clothes_arm_acc, clothes_back, clothes_back_acc, clothes_hand, clothes_handheld };