@chronodivide/game-api 0.50.0 → 0.50.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# 0.50.1
+
+- Add "enemy" type argument to `gameApi.getVisibleUnits`
+
 # 0.50.0
 
 - Update game engine version to 0.56

package/dist/index.d.ts

@@ -323,8 +323,16 @@ export declare class GameApi {
      * Gets a list of units which are visible to the given player (not under the shroud), based on hostility
      *
      * An additional filter predicate can be passed to further narrow down results
+     *
+     * @param playerName -
+     * @param type - filters units based on their owner
+     *  - `self` returns units owned by playerName
+     *  - `allied` return all units owned by playerName or allies
+     *  - `hostile` returns all units not owned by playerName or allies, including neutral units
+     *  - `enemy` returns all units owned by enemy players, not including neutral units
+     * @param filter - an optional predicate for futher filtering units based on their rules
      */
-    getVisibleUnits(playerName: string, type: "self" | "allied" | "hostile", filter?: (r: TechnoRules) => boolean): number[];
+    getVisibleUnits(playerName: string, type: "self" | "allied" | "hostile" | "enemy", filter?: (r: TechnoRules) => boolean): number[];
     getGameObjectData(objId: number): GameObjectData | undefined;
     getUnitData(unitId: number): UnitData | undefined;
     getAllSuperWeaponData(): SuperWeaponData[];