@scml-dol-maplebirch/types 5.0.4 → 5.1.1

package/modules/NamedNPCAddon/NPCSchedules.d.ts

@@ -0,0 +1,77 @@
+import type NPCManager from '../NamedNPC.js';
+export interface ScheduleCondition {
+    (date: EnhancedDate): boolean;
+}
+export type ScheduleTime = number | [number, number?];
+export type ScheduleLocation = string | ((date: EnhancedDate) => string | Schedule | void | null | undefined);
+export type ScheduleBuilder = (schedule: Schedule) => void | Schedule;
+export interface SpecialSchedule {
+    id: string | number;
+    condition: ScheduleCondition;
+    location: ScheduleLocation;
+    before?: string | number;
+    after?: string | number;
+    insteadOf?: string | number;
+    override?: boolean;
+}
+export interface DailyScheduleConfig {
+    time: ScheduleTime;
+    location: string;
+}
+export interface SpecialScheduleConfig extends Partial<Omit<SpecialSchedule, 'condition' | 'location'>> {
+    condition: ScheduleCondition;
+    location: ScheduleLocation;
+}
+export interface ScheduleConfig {
+    daily?: DailyScheduleConfig[];
+    special?: SpecialScheduleConfig[];
+}
+export interface EnhancedDate extends DateTime {
+    schedule: Schedule;
+    schoolDay: boolean;
+    spring: boolean;
+    summer: boolean;
+    autumn: boolean;
+    winter: boolean;
+    dawn: boolean;
+    daytime: boolean;
+    dusk: boolean;
+    night: boolean;
+    weekEnd: boolean;
+    isAt(time: ScheduleTime): boolean;
+    isAfter(time: ScheduleTime): boolean;
+    isBefore(time: ScheduleTime): boolean;
+    isBetween(start: ScheduleTime, end: ScheduleTime): boolean;
+    isHour(...hours: number[]): boolean;
+    isHourBetween(start: number, end: number): boolean;
+    isMinuteBetween(start: number, end: number): boolean;
+}
+export declare class Schedule {
+    daily: string[];
+    specials: SpecialSchedule[];
+    sortedSpecials: SpecialSchedule[] | null;
+    at(scheduleConfig: ScheduleTime, location: string): this;
+    when(condition: ScheduleCondition, location: ScheduleLocation, options?: Partial<Omit<SpecialSchedule, 'condition' | 'location'>>): this;
+    update(specialId: string | number, updates: Partial<Omit<SpecialSchedule, 'id'>>): this;
+    remove(specialId: string | number): this;
+    sortSpecials(): void;
+    topologicalSort(items: SpecialSchedule[]): SpecialSchedule[];
+    get location(): string;
+    resolveLocation(loc: ScheduleLocation, date: EnhancedDate): string;
+    createEnhancedDate(date: DateTime): EnhancedDate;
+    buildEnhancedDateProto(): EnhancedDate;
+    private dailyLocation;
+}
+declare const NPCSchedules: typeof Schedule & {
+    readonly schedules: Map<string, Schedule>;
+    init: (manager: NPCManager) => boolean;
+    set: (npcName: string, config: ScheduleConfig | ScheduleBuilder) => Schedule;
+    get: (npcName: string) => Schedule;
+    update: (npcName: string, specialId: string | number, updates: Partial<Omit<SpecialSchedule, 'id'>>) => Schedule;
+    remove: (npcName: string, specialId: string | number) => Schedule;
+    clear: (npcName: string) => Schedule;
+    clearAll: () => void;
+    readonly npcList: string[];
+    readonly location: Record<string, string>;
+};
+export default NPCSchedules;

package/modules/NamedNPCAddon/NPCSidebar.d.ts

@@ -0,0 +1,28 @@
+import type { ModZipReader } from '@scml/types/sugarcube-2-ModLoader/ModZipReader';
+import type NPCManager from '../NamedNPC.js';
+export interface NPCSidebarBootConfig {
+    clothes?: string[];
+    image?: string[];
+    config?: string[];
+}
+declare function config(manager: NPCManager, modName: string, modZip: ModZipReader, config: NPCSidebarBootConfig): Promise<void>;
+declare function loadFromMod(modZip: ModZipReader, npc_names: string[]): string[];
+declare class NPCPet {
+    private readonly pets;
+    private frame;
+    private syncing;
+    sync(): boolean;
+    private render;
+    reset(): void;
+    private cancel;
+}
+declare const NPCSidebar: {
+    new (): {};
+    readonly pet: NPCPet;
+    get display(): Map<string, Set<string>>;
+    config: typeof config;
+    loadFromMod: typeof loadFromMod;
+    hair_type(type: 'sides' | 'fringe'): Record<string, string>;
+    init(manager: NPCManager): void;
+};
+export default NPCSidebar;

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

@@ -0,0 +1,212 @@
+import type { NPCSidebarOptions } from './types.js';
+declare const base_layers: {
+    nnpc_body: {
+        masksrcfn: (options: NPCSidebarOptions) => string | undefined;
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filtersfn: (options: NPCSidebarOptions) => string[];
+        animation: string;
+    };
+    nnpc_head: {
+        masksrcfn: (options: NPCSidebarOptions) => string | undefined;
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filtersfn: (options: NPCSidebarOptions) => string[];
+        animation: string;
+    };
+    nnpc_face: {
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+    };
+    nnpc_neck: {
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+    };
+    nnpc_upper: {
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+    };
+    nnpc_lower: {
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+    };
+    nnpc_legs: {
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+    };
+    nnpc_feet: {
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+    };
+    nnpc_hands: {
+        srcfn: (options: NPCSidebarOptions) => string | undefined;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+    };
+    nnpc_breasts: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animation: string;
+    };
+    nnpc_leftarm: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => "img/body/left-arm-cover.png" | "img/body/left-arm-idle-classic.png";
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animation: string;
+    };
+    nnpc_rightarm: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animation: string;
+    };
+    nnpc_penis: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animation: string;
+    };
+    nnpc_freckles: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+    };
+    nnpc_ears: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+    };
+    nnpc_eyes: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+    };
+    nnpc_sclera: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+    };
+    nnpc_iris: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animation: string;
+    };
+    nnpc_eyelids: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animationfn: (options: NPCSidebarOptions) => "" | "blink";
+    };
+    nnpc_lashes: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animationfn: (options: NPCSidebarOptions) => "" | "blink";
+    };
+    nnpc_brows: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+    };
+    nnpc_mouth: {
+        masksrcfn: (options: NPCSidebarOptions) => string;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+    };
+    nnpc_hair_sides: {
+        masksrcfn: (options: NPCSidebarOptions) => string | string[] | undefined;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animation: string;
+    };
+    nnpc_hair_fringe: {
+        masksrcfn: (options: NPCSidebarOptions) => string | string[] | undefined;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animation: string;
+    };
+    nnpc_hair_extra: {
+        masksrcfn: (options: NPCSidebarOptions) => string | string[] | undefined;
+        srcfn: (options: NPCSidebarOptions) => string;
+        showfn: (options: NPCSidebarOptions) => boolean;
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        filters: string[];
+        animation: string;
+    };
+};
+export default base_layers;

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

@@ -0,0 +1,220 @@
+import type { NPCSidebarOptions } from './types.js';
+declare const face_layers: {
+    nnpc_face_main: {
+        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: import("./types.js").NPCClothesSlot;
+            integrity: string;
+            alt: string | undefined;
+            index: number;
+        });
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        animation: any;
+    };
+    nnpc_face_acc: {
+        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: import("./types.js").NPCClothesSlot;
+            integrity: string;
+            alt: string | undefined;
+            index: number;
+        });
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        animation: any;
+    };
+    nnpc_face_back: {
+        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: import("./types.js").NPCClothesSlot;
+            integrity: string;
+            alt: string | undefined;
+            index: number;
+        });
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        animation: any;
+    };
+    nnpc_face_back_acc: {
+        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: import("./types.js").NPCClothesSlot;
+            integrity: string;
+            alt: string | undefined;
+            index: number;
+        });
+        zfn: (options: NPCSidebarOptions) => number;
+        dxfn: (options: NPCSidebarOptions) => number;
+        dyfn: (options: NPCSidebarOptions) => number;
+        animation: any;
+    };
+};
+export default face_layers;