glife/qsrc2tw/twine-code/twine-code.d.ts

declare module "twine-sugarcube" {
    export interface SugarCubeSetupObject {
        Example: { new(): Example };

        Filter: { new(): Filter };

        //#region Player Character
            attributes: string[];
            proficiencies: {[proficiencyId:string]: ProficiencyDefinition};
            skills: {[skillId:string]: SkillDefinition};
            PlayerCharacter: { new(): PlayerCharacter };
            Skill: { new(): Skill };
            Skills: {
                new(): Skills;
                createProxy: ((skills:Skills)=>{[skillId:string]:Skill});
            };
        //#endregion

        //#region Static Wardrobe
            OutfitItem: {new(itemId?:string): OutfitItem};
            OwnedOutfitItem: {new(itemId?:string): OwnedOutfitItem};

            outfitShop: {[shopId: string]: {
                outfitItems?: {
                    image?: (key:string)=>string;
                }
            }};

            Wardrobe: {new(): Wardrobe};
            wardrobeStatic: {[wardrobeItemId:string]: {[propertyKey:string]:(string|number|string[])}};
        //#endregion

        //#region Wardrobe Overwrites
            wardrobeItemVars: {[type:string]:string[]};
        //#endregion

        //#region Wardrobe Display
            wardrobeDisplay_setup:()=>void;
            wardrobeDisplay_setFilter:(filter:FilterData)=>void;
            wardrobeDisplay_showItemDetails:(itemId:string)=>void;
            wardrobeDisplay_updateAvailable:()=>void;
            wardrobeDisplay_updateWorn:()=>void;
        //#endregion

        /**
         * Provides functions to overwrite behavior of functions and variables
         */
        Overwrite: {

            /**
             * Registers code that will be run whenever a `setup.qsp_func()`- call occurs for the given `passageName`.
             *
             * If the function `func` returns anything but `undefined`, this value will be returned by `setup.qsp_func()` and default behavior (executing the code of the passage) is skipped.
             *
             * @type {(passageName:string, func:((args: any[])=>any))=>void}
             */
            funcRegister: (passageName:string, func:((args: any[])=>any))=>void,

            /**
             * Registers code that will be run whenever a `setup.qsp_gs()`- call occurs for the given `passageName`.
             *
             * If the function `exec` returns anything but `undefined`, the default behavior (executing the code of the passage) is skipped.
             *
             * @type {(passageName:string, func:((args: any[])=>any))=>void}
             */
            gsRegister: (passageName: string, exec:((args: any[])=>any))=>void,


            /**
             * Specify `get` to return a constant value when a certain value is requested. Alternatively, you can specify a function, that returns a value. If `undefined` is returned, standard behavior is executed.
             *
             * Likewise, you can specify `set` to execute code when a value is set. If `set` returns anything but `undefined` standard behavior (setting the var) is skipped.
             *
             */
            varRegister: (varname:string,
                get:number|string|((index?:number|string)=>any)|undefined,
                set:((index:number|string,val:number|string)=>any)|undefined,
            )=>void

            varRegisterByPrefix: (varname:string,
                get:number|string|((varname:string,index?:number|string)=>any)|undefined,
                set:((varname:string,index:number|string,val:number|string)=>any)|undefined,
            )=>void
        };

        NPCs: {new(): NPCs};
        NPCAccessor: {new(): NPCAccessor};
        npcsInit: (npcIds: string[]) => void;
        npcInit: (npcId: string) => void;
        npcStatic: {[npcID:string]: NPCStaticObject};

        qsp_dyneval: (code:string, ...args : (string|number)[]) => string|number;
        qsp_func: (passage:string,...arguments:(string|number)[]) => string|number;


        //#region External Code
            externalCodeURLs: {[key:string]:{code:string[],style:string[]}};
            externalCodePromises: {[key:string]:Promise<any>};
            externalCodePromise: (promiseId:string)=>Promise<any>;
        //#endregion

        getPassageLinks: (passageId:string) => {[passageId:string]:{type:string;line:number}[]};
        getPassageLinksToPassage: (passageId:string) => string[];
    }

    export interface SugarCubeStoryVariables{
        PC: PlayerCharacter;

        /**
         * The dynamic storage for NPC-data.
         *
         * @type {{[npcID:string]: {[field:string]:any}}}
         */
        npcDynamic: {[npcID:string]: {[field:string]:any}};

        npcs: NPCs;

        wardrobe: Wardrobe;
    }

    export interface SugarCubeTemporaryVariables{
        filter: Filter;
    }
}

declare global {
    interface Window { QSP: {[key:(string|number)]: any}; }
}

export interface NPCStaticObject{
    _defaults: string[];
    [field: string]: string | number | string[];
}

export interface ProficiencyDefinition{
    calc: (attributs:{[skillId:string]:Skill}, skills: {[skillId:string]:Skill}) => number;
}

export interface SkillDefinition{
    attributes: string[];
}

export {};