typed-adventureland/dist/src/parent/index.d.ts

Strong TypeScript declarations for the game AdventureLand

/// <reference types="jquery" />
/// <reference types="socket.io" />
/// <reference types="pixi.js" />
import { BankPacksInfos } from "../bank";
import { CharacterEntityCXInfos } from "../entities/character-entity";
import { CharacterEntity, MonsterEntity, NpcEntity, TradeSlotType } from "../entity";
import { PartyCharacter } from "../functions";
import { ClassKey, GDropList, GDropMaps, GDropMonsters, GDropNormalDrops, ItemKey, MapKey, MonsterKey, SkillKey } from "../G";
import { ApiCallRArgs, ApiCalls } from "../game-event-api-response";
import { PositionReal } from "../position";
import { IdentifierForRegion, ServerIdentifier, ServerKey, ServerRegion } from "../server";
import { SocketWithEventsFunctions } from "../socket-events";
import { BetterUXWrapper } from "../types/GTypes/utils";
import { SEventsInfos } from "./sevent-info";
/** Tracktrix informations */
export interface Tracker {
    /** How many points you have for each monster for the given character */
    monsters: Partial<Record<MonsterKey, number>>;
    /** How many points behind this character is from your character that has the most points for this monster */
    monsters_diff: Partial<Record<MonsterKey, number>>;
    /** How many exchanges this character has done for the various given items */
    exchanges: Partial<Record<ItemKey | "lostearring0" | "lostearring1" | "lostearring2" | "lostearring3" | "lostearring4", number>>;
    /** Contains drop information */
    maps: GDropMaps;
    /** For the "open" items in maps, this table has a list of the drops that could occur */
    tables: GDropNormalDrops;
    /** Contains information about your characters with the max points */
    max: {
        monsters: Partial<Record<MonsterKey, [score: number, char: string]>>;
    };
    drops: GDropMonsters;
    global: GDropList;
    global_static: GDropList;
}
export interface XOnlineCharacter {
    x: number;
    y: number;
    map: MapKey;
    in: MapKey | string;
    name: string;
    level: number;
    skin: string;
    server: string;
    secret: string;
    cx?: CharacterEntityCXInfos;
    online: number;
    home: ServerKey;
    type: ClassKey;
    id: string;
}
interface ServerInfo<SR extends ServerRegion, SI extends IdentifierForRegion<SR>> {
    addr: string;
    key: `${SR}${SI}`;
    name: SI;
    players: number;
    port: number;
    region: SR;
}
export type XServerInfos = {
    [SR in ServerRegion]: ServerInfo<SR, IdentifierForRegion<SR>>;
}[ServerRegion];
export {};
declare global {
    /** When you access parent via game code, this is what you have access to. */
    interface Window {
        $: JQueryStatic;
        clear_game_logs(): void;
        close_merchant(): void;
        exchange(inventoryPosition: number): void;
        open_merchant(standInventoryPostion: number): void;
        start_runner(): void;
        stop_runner(): void;
        /** The response is given via game.on('api_response',function(data){ where data.type is equal to for example merchants */
        api_call<K extends keyof ApiCalls = keyof ApiCalls>(call: K, arg1?: {}, arg2?: ApiCallRArgs<K>): void;
        /**
         * Joins a giveaway for the specified item
         * @param slot_name Trade slot containing the item you want to join the giveaway of
         * @param characterName Name of the character you want to join the giveaway of
         * @param rid Unique id of the item you want to join the giveaway of
         */
        join_giveaway(slot_name: TradeSlotType, characterName: string, rid: string): unknown;
        /** show a modal, TODO: investigate paramters */
        show_modal(arg1: any, arg2: any): any;
        sprite_image(name: string, args?: any): string;
        smart_eval(code: string): void;
        render_item(selector: string, args: any): string | undefined;
        render_computer(): string | undefined;
        open_chest(id: string | number): Promise<void>;
        d_text(message: string, entity: CharacterEntity, args?: {
            color: string;
        }): void;
        X: {
            characters: Array<XOnlineCharacter>;
            servers: Array<XServerInfos>;
        };
        chests: {
            [id: string]: ChestInfo;
        };
        entities: {
            [id: string]: BetterUXWrapper<CharacterEntity | MonsterEntity | NpcEntity>;
        };
        next_skill: {
            [T in SkillKey]?: Date;
        };
        /** @deprecated Prefer `get_party()` */
        party: Record<string, PartyCharacter>;
        /** Contains the name of every character in your party */
        party_list: string[];
        /** Contains a list of the last 40 ping response times */
        pings: number[];
        server_identifier: ServerIdentifier;
        server_region: ServerRegion;
        user_id: string;
        user_auth: string;
        socket: Omit<SocketIO.Socket, keyof SocketWithEventsFunctions> & SocketWithEventsFunctions;
        tracker: Record<string, never> | Tracker;
        bank_packs: BankPacksInfos;
        /** PIXI element for the game map */
        map: PIXI.Container;
        /** Contains user drawings for cleanup */
        drawings: Array<PIXI.Graphics>;
        S: SEventsInfos;
    }
}
export type ChestInfo = PositionReal & {
    alpha: number;
    skin: "chest3" | string;
};
export * from "./sevent-info";