@scm-js/plugin-api 1.57.0 → 1.59.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;
@@ -3716,8 +3720,9 @@ export interface TriggersApi {
 	}): TriggerRefs[];
 	/**
 	 * The 0-based player slots a player group names on the open map: a slot itself, the
-	 * members of a force, players 1–8 for *All Players*, and for *Current Player* the slots
-	 * of `owners` (the groups a trigger is ticked for). `approximate` when the group is only
+	 * members of a force, players 1–12 for *All Players* (as conditions and the unit actions
+	 * take it; as a trigger's owner it is players 1–8), and for *Current Player* the slots of
+	 * `owners` (the groups a trigger is ticked for). `approximate` when the group is only
 	 * settled while the game runs (*Foes*, *Allies*, *Neutral Players*, *Non Allied Victory
 	 * Players*); `players` is then every slot it could name.
 	 */

package/package.json

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