@scm-js/plugin-api 1.56.0 → 1.58.0

package/index.d.ts

@@ -167,7 +167,7 @@ export interface UnitSettings {
 	hitPoints: Uint32Array;
 	shields: Uint16Array;
 	armor: Uint8Array;
-	/** Game frames (15 per second at Fastest). */
+	/** Game frames (about 24 per second at Fastest, 15 at Normal). */
 	buildTime: Uint16Array;
 	mineralCost: Uint16Array;
 	gasCost: Uint16Array;
@@ -516,7 +516,11 @@ declare const ActionFlag: {
 declare const TriggerFlag: {
 	/** Game bookkeeping: every condition was met this cycle. */
 	readonly ConditionsMet: 1;
-	/** Ignore Defeat / Draw for this trigger. */
+	/**
+	 * Not what the name says: each time the trigger's actions run, the player counts as won
+	 * without winning, so every other player in the game with no result is defeated, and a
+	 * Defeat or Draw of this trigger stalls (docs/triggers.md). The name stays for plugins.
+	 */
 	readonly IgnoreGameEnd: 2;
 	/** Same as a Preserve Trigger action. */
 	readonly Preserve: 4;
@@ -605,7 +609,12 @@ export interface Scenario {
 	/** SWNM: string index per switch (0 = unnamed); null when the file has no section. */
 	switchNames: number[] | null;
 }
-export type MapVersion = "original" | "hybrid" | "broodwar" | "remastered";
+/**
+ * The revisions. `remasteredHybrid` is Remastered's VER 64: read like a hybrid 63 file, with
+ * no Brood War needed, and allowed STRx. The editor keeps it but does not offer it for a map
+ * that is not already one.
+ */
+export type MapVersion = "original" | "hybrid" | "broodwar" | "remastered" | "remasteredHybrid";
 export interface Cv5Group {
 	/** Doodad groups store 1 here; terrain groups store a group type. */
 	index: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scm-js/plugin-api",
-  "version": "1.56.0",
+  "version": "1.58.0",
   "description": "Type declarations for the scmJS plugin API",
   "license": "MIT",
   "types": "index.d.ts",