W3Booster SDK 4.6.0
    Preparing search index...

    Interface GameData

    interface GameData {
        abilities: TypeCatalog<AbilityType>;
        assets: {
            abilityIcon(typeId: string, options: IconOptions): string | undefined;
            icon(
                kind: ObjectKind,
                typeId: string,
                options: IconOptions,
            ): string | undefined;
            itemIcon(typeId: string, options: IconOptions): string | undefined;
            unitIcon(typeId: string, options: IconOptions): string | undefined;
            upgradeIcon(typeId: string, options: IconOptions): string | undefined;
        };
        gameVersion: string;
        id: string;
        items: TypeCatalog<ItemType>;
        ruleset: "current-melee";
        units: TypeCatalog<UnitType>;
        upgrades: TypeCatalog<UpgradeType>;
        unitGameplay(
            typeId: string,
            options?: { signal?: AbortSignal },
        ): Promise<
            Readonly<Record<string, Readonly<Record<string, string>>>>
            | undefined,
        >;
    }
    Index
    abilities assets gameVersion id items ruleset units upgrades
    unitGameplay
    abilities: TypeCatalog<AbilityType>
    assets: {
        abilityIcon(typeId: string, options: IconOptions): string | undefined;
        icon(
            kind: ObjectKind,
            typeId: string,
            options: IconOptions,
        ): string | undefined;
        itemIcon(typeId: string, options: IconOptions): string | undefined;
        unitIcon(typeId: string, options: IconOptions): string | undefined;
        upgradeIcon(typeId: string, options: IconOptions): string | undefined;
    }
    gameVersion: string
    id: string
    items: TypeCatalog<ItemType>
    ruleset: "current-melee"
    units: TypeCatalog<UnitType>
    upgrades: TypeCatalog<UpgradeType>

    • Optional broad gameplay projection. Static source values, not observed unit stats.

      Parameters

      • typeId: string
      • Optionaloptions: { signal?: AbortSignal }

      Returns Promise<Readonly<Record<string, Readonly<Record<string, string>>>> | undefined>

    Settings

    On This Page
    Properties
    Methods