@chronodivide/game-api 0.73.0 → 0.74.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+# 0.74.0
+
+- Update game engine version to 0.79
+- Deprecated `GameApi.mapApi` in favor of `GameApi.map`
+- Deprecated `GameApi.rulesApi` in favor of `GameApi.rules`
+- Add `options` parameter to `GameApi.canPlaceBuilding` method
+- **BREAKING**: Remove deprecated `MapApi.findPath` method signature
+- Add `MapApi.getReachabilityMap`
+- Add `PlayerApi`, including player-scoped functionality from `GameApi` as well as from `ActionsApi` and `ProductionApi`
+- Group bot-scoped APIs under a single `Bot.context` property and deprecate `*Api` properties
+- Add `Bot.onGameInit` method
+
 # 0.73.0
 
 - Update game engine version to 0.78

package/dist/index.d.ts

@@ -102,10 +102,16 @@ export declare class Bot {
     #private;
     name: string;
     country: string;
-    protected gameApi: GameApi;
-    protected actionsApi: ActionsApi;
-    protected productionApi: ProductionApi;
-    protected logger: LoggerApi;
+    protected context: BotContext;
+    protected get game(): GameApi;
+    protected get player(): PlayerApi;
+    /** @deprecated Use {@link Bot.game} instead */
+    protected get gameApi(): GameApi;
+    /** @deprecated Use {@link Bot.player} instead */
+    protected get actionsApi(): ActionsApi;
+    /** @deprecated Use {@link Bot.player} instead */
+    protected get productionApi(): ProductionApi;
+    protected get logger(): LoggerApi;
     constructor(name: string, country: string);
     /**
      * Toggles bot debug mode, allowing the bot implementation to switch some debug features on or off.
@@ -115,11 +121,18 @@ export declare class Bot {
      */
     setDebugMode(debugMode: boolean): this;
     getDebugMode(): boolean;
+    onGameInit(gameApi: GameApi): void;
     onGameStart(gameApi: GameApi): void;
     onGameTick(gameApi: GameApi): void;
     onGameEvent(ev: ApiEvent, gameApi: GameApi): void;
 }
 
+export declare class BotContext {
+    game: GameApi;
+    player: PlayerApi;
+    logger: LoggerApi;
+}
+
 export declare class Box2 extends THREE.Box2 {
 }
 
@@ -271,6 +284,8 @@ export declare class CrewRules {
     sovietCrew: string;
     sovietSurvivorDivisor: number;
     survivorRate: number;
+    thirdCrew: string;
+    thirdSurvivorDivisor: number;
     readIni(ini: IniSection): this;
 }
 
@@ -320,11 +335,15 @@ export declare enum FactoryType {
 
 export declare class GameApi {
     #private;
-    mapApi: MapApi;
-    rulesApi: RulesApi;
+    map: MapApi;
+    rules: RulesApi;
+    /** @deprecated Use {@link GameApi.map} instead */
+    get mapApi(): MapApi;
+    /** @deprecated Use {@link GameApi.rules} instead */
+    get rulesApi(): RulesApi;
     isPlayerDefeated(playerName: string): boolean;
     areAlliedPlayers(p1Name: string, p2Name: string): boolean;
-    canPlaceBuilding(playerName: string, buildingName: string, tile: Tile): boolean;
+    canPlaceBuilding(playerName: string, buildingName: string, tile: Tile, options?: PlaceCheckOptions): boolean;
     getBuildingPlacementData(objName: string): BuildingPlacementData;
     getPlayers(): string[];
     getPlayerData(playerName: string): PlayerData;
@@ -503,6 +522,7 @@ export declare class GeneralRules {
     spyMoneyStealPercent: number;
     spyPowerBlackout: number;
     technician: string;
+    thirdDisguise: string;
     threat: ThreatRules;
     treeStrength: number;
     unitsUnsellable: boolean;
@@ -708,8 +728,13 @@ export declare class MapApi {
      * This method has a big performance penalty and should be used with care.
      */
     findPath(speedType: SpeedType, subCell: boolean, from: PathNode, to: PathNode, options?: PathFinderOptions): PathNode[];
-    /** @deprecated Use overload with explicit subCell instead */
-    findPath(speedType: SpeedType, from: PathNode, to: PathNode, options?: PathFinderOptions): PathNode[];
+    /**
+     * Used to determine connectivity between path nodes for the given SpeedType.
+     *
+     * Should only be used with ground, non-teleporting units.
+     * Preferred over {@link MapApi.findPath} when the full path is not needed. Complexity is O(1).
+     */
+    getReachabilityMap(speedType: SpeedType, subCell: boolean): ReachabilityMap;
     /** If the tile is not covered by shroud for the specified player */
     isVisibleTile(tile: Tile, playerName: string, tileElevation?: number): boolean;
     getTileResourceData(tile: Tile): TileResourceData | undefined;
@@ -929,6 +954,7 @@ export declare class ParadropRules {
     /** In leptons */
     paradropRadius: number;
     sovParaDrop: ParadropSquad[];
+    yuriParaDrop: ParadropSquad[];
     readIni(ini: IniSection): this;
     private readParadropSquad;
     getParadropSquads(sideType: SideType): ParadropSquad[];
@@ -963,6 +989,24 @@ export declare enum PipColor {
     Blue = 4
 }
 
+export declare interface PlaceCheckOptions {
+    /** Skips adjacency checks. Defaults to false, except for buildings with ConstructionYard=yes */
+    ignoreAdjacent?: boolean;
+}
+
+export declare class PlayerApi {
+    #private;
+    name: string;
+    actions: ActionsApi;
+    production: ProductionApi;
+    getPlayerData(): PlayerData;
+    isDefeated(): boolean;
+    isAlliedWith(otherPlayerName: string): boolean;
+    canPlaceBuilding(buildingName: string, tile: Tile): boolean;
+    /** See {@link GameApi.getVisibleUnits} */
+    getVisibleUnits(type: "self" | "allied" | "hostile" | "enemy", filter?: (r: TechnoRules) => boolean): number[];
+}
+
 export declare interface PlayerData {
     name: string;
     country: Country | undefined;
@@ -1193,6 +1237,13 @@ export declare class RadiationRules {
     readIni(ini: IniSection): void;
 }
 
+export declare interface ReachabilityMap {
+    /** Checks if two nodes are connected. */
+    isReachable(from: PathNode, to: PathNode): boolean;
+    /** A number representing the connected region. Undefined if impassable terrain. */
+    getRegionId(node: PathNode): number | undefined;
+}
+
 export declare interface Rectangle {
     x: number;
     y: number;
@@ -1247,12 +1298,17 @@ export declare class RulesApi {
     getIni(): IniFile;
 }
 
-/** Side/faction types (ally/soviet). Relic naming since tiberian sun */
+/**
+ * Side/faction types (ally/soviet). Relic naming since tiberian sun.
+ * Do not change the order. The numerical values are mapped to fields in rules.ini such as AIBasePlanningSide.
+ */
 export declare enum SideType {
     GDI = 0,
     Nod = 1,
-    Civilian = 2,
-    Mutant = 3
+    /** Yuri */
+    ThirdSide = 2,
+    Civilian = 3,
+    Mutant = 4
 }
 
 export declare interface Size {
@@ -1341,6 +1397,7 @@ export declare class TechnoRules extends ObjectRules {
     private forbiddenHouses;
     requiresStolenAlliedTech: boolean;
     requiresStolenSovietTech: boolean;
+    requiresStolenThirdTech: boolean;
     cost: number;
     points: number;
     soylent: number;
@@ -1468,6 +1525,7 @@ export declare class TechnoRules extends ObjectRules {
     immuneToRadiation: boolean;
     immuneToPsionics: boolean;
     typeImmune: boolean;
+    damageSelf: boolean;
     warpable: boolean;
     /** Only for vehicles */
     isTilter: boolean;