overlay-toolkit 0.10.0 → 0.10.1

package/dist/otk.d.ts

@@ -0,0 +1,121 @@
+import { OverlayHID } from './hid';
+import { OverlayCallMessage, OverlayPluginAPI } from './overlay';
+import { PacketFilter, PacketHandler } from './packet';
+export interface DispatchMessage {
+    type: string;
+}
+export interface GameVersion {
+    version: string;
+    lang: number;
+}
+export declare class OverlayToolkit {
+    /**
+     * HID interface
+     */
+    hid: OverlayHID;
+    api: OverlayPluginAPI;
+    constructor();
+    /**
+     * Fetch acts like window.fetch but without CORS restrictions
+     * @param url target URL
+     * @param options options
+     * @returns response
+     */
+    Fetch(url: string, options?: RequestInit): Promise<Response>;
+    /**
+     * Subscribe to game packets
+     * @param name subscription name
+     * @param filters optional filters. receive ALL packets when no filter is provided
+     * @param handler callback when packet is send/receive
+     * @returns subscription name
+     */
+    SubscribePacket(name: string, filters: PacketFilter[], handler: PacketHandler): Promise<string>;
+    /**
+     * Unsubscribe from game packets
+     * @param name subscription name
+     */
+    UnsubscribePacket(name: string): Promise<void>;
+    private handlerMap;
+    private packetHandler;
+    /**
+     * Game version
+     */
+    GetGameVersion(): Promise<GameVersion>;
+    /**
+     * Call start overlay events
+     *
+     * Must be called after any listeners are added
+     */
+    Start(): void;
+    /**
+     * Call dispatch overlay event
+     *
+     * @param msg The message to dispatch
+     */
+    Dispatch(msg: DispatchMessage): void;
+    AddListener(event: string, cb: (msg: DispatchMessage) => void): void;
+    AddListener(event: "LogLine", cb: (msg: {
+        type: string;
+        line: string[];
+        rawLine: string;
+    }) => void): void;
+    AddListener(event: "CombatData", cb: (msg: DispatchMessage) => void): void;
+    AddListener(event: "ImportedLogLines", cb: (msg: {
+        type: string;
+        logLines: string[];
+    }) => void): void;
+    AddListener(event: "ChangeZone", cb: (msg: {
+        type: string;
+        zoneID: number;
+    }) => void): void;
+    AddListener(event: "ChangePrimaryPlayer", cb: (msg: {
+        type: string;
+        charID: string;
+        charName: string;
+    }) => void): void;
+    AddListener(event: "OnlineStatusChanged", cb: (msg: {
+        type: string;
+        target: string;
+        status: string;
+        rawStatus: number;
+    }) => void): void;
+    AddListener(event: "PartyChanged", cb: (msg: {
+        type: string;
+        party: {
+            id: string;
+            name: string;
+            worldID: number;
+            job: number;
+            inParty: boolean;
+        }[];
+    }) => void): void;
+    AddListener(event: "BroadcastMessage", cb: (msg: {
+        type: string;
+        source: string;
+        msg: any;
+    }) => void): void;
+    /**
+     * Remove an overlay listener
+     * @param event
+     * @param cb
+     */
+    RemoveListener(event: string, cb: (msg: DispatchMessage) => void): void;
+    /**
+     * Call overlay handler
+     * @param msg
+     * @returns
+     */
+    Call(msg: OverlayCallMessage): Promise<any>;
+    /**
+     * Get if running in OverlayPlugin CEF environment
+     * @returns
+     */
+    IsOverlayPluginCEF(): boolean;
+    private tryConnectToCEF;
+    /**
+     * Connect to OverlayPlugin via CEF or WebSocket
+     * @param wsUrl WebSocket URL, leave empty to auto-detect from query string
+     * @returns
+     */
+    Connect(wsUrl?: string | null): void;
+}