@chronodivide/game-api 0.65.0 → 0.67.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+# 0.67.0
+
+- Update game engine version to 0.72
+- Allow observers when creating games in online mode
+- Add `CreateOnlineOpts.nonInteractive` option when creating games in online mode
+- Add `CreateOnlineOpts.onGameStart` callback when creating games in online mode
+
+# 0.66.0
+
+- Update game engine version to 0.71
+
 # 0.65.0
 
 - Update game engine version to 0.70

package/dist/index.d.ts

@@ -50,8 +50,8 @@ export declare class ActionsApi {
 
 export declare interface Agent {
     name: string;
-    /** Country name as found in rules.ini [Countries] */
-    country: string;
+    /** Country name as found in rules.ini [Countries]. Omit for observers. */
+    country?: string;
 }
 
 export declare class AiRules {
@@ -250,6 +250,14 @@ export declare interface CreateOnlineOpts extends CreateBaseOpts {
     clientUrl: string;
     botPassword: string;
     agents: [Bot, ...Agent[]];
+    /** If specified, process will not wait for player input before creating the game. */
+    nonInteractive?: boolean;
+    /**
+     * Called when the game is created.
+     *
+     * @param joinUrls - The URLs that each player agent can use to join the game.
+     */
+    onGameCreate?(joinUrls: Map<Agent, string>): unknown;
 }
 
 export declare type CreateOpts = CreateOfflineOpts | CreateOnlineOpts;
@@ -377,7 +385,11 @@ export declare class GameInstanceApi {
     getCurrentTick(): number;
     getTickRate(): number;
     getPlayerStats(): PlayerStats[];
-    saveReplay(targetDir?: string): void;
+    /**
+     * @param targetDir - Where to save the replay file.
+     * @returns - The path where the replay file was saved to.
+     */
+    saveReplay(targetDir?: string): string;
     dispose(): void;
 }
 
@@ -521,23 +533,24 @@ export declare enum InfDeathType {
 export declare class IniFile {
     private sections;
     fromString(data: string): this;
-    fromJson(data: Record<string, unknown>): void;
+    fromJson(data: Record<string, unknown>): this;
     toString(): string;
     clone(): IniFile;
     getOrCreateSection(name: string): IniSection;
     getSection(name: string): IniSection | undefined;
     getOrderedSections(): IniSection[];
-    private isValueArray;
     mergeWith(ini: IniFile): this;
 }
 
 export declare class IniSection {
     name: string;
-    entries: Map<string, string>;
+    entries: Map<string, string | string[]>;
+    private sections;
     constructor(name: string);
+    fromJson(data: Record<string, unknown>): this;
     clone(): IniSection;
-    set(name: string, value: string): void;
-    get(name: string): string | undefined;
+    set(name: string, value: string | string[]): void;
+    get(name: string): string | string[] | undefined;
     has(name: string): boolean;
     getString(name: string, defaultValue?: string): string;
     getNumber(key: string, defaultValue?: number): number;
@@ -556,6 +569,7 @@ export declare class IniSection {
     /** Emulates fixed-point precision given a floating-point number */
     private toFixedPointPrecision;
     getBool(key: string, defaultValue?: boolean): boolean;
+    getKeyArray(key: string, defaultValue?: string[]): string[];
     getArray(key: string, sep?: RegExp, defaultValue?: string[]): string[];
     getNumberArray(key: string, sep?: RegExp, defaultValue?: number[]): number[];
     getFixedArray(key: string, sep?: RegExp, defaultValue?: number[]): number[];
@@ -563,8 +577,13 @@ export declare class IniSection {
     getEnumNumeric<T>(key: string, enumType: any, defaultValue: T): T;
     getEnumArray<T>(key: string, enumType: any, sep?: RegExp, defaultValue?: T[], caseInsensitive?: boolean): T[];
     getHighestNumericIndex(): number;
+    isNumericIndexArray(): boolean;
     getConcatenatedValues(): string;
-    toString(): string;
+    toString(namePrefix?: string): string;
+    mergeWith(other: IniSection): void;
+    getOrCreateSection(name: string): IniSection;
+    getSection(name: string): IniSection | undefined;
+    getOrderedSections(): IniSection[];
 }
 
 export declare interface IsoTile {