@scm-js/plugin-api 1.55.0 → 1.57.0

package/index.d.ts

@@ -151,7 +151,7 @@ export interface Forces {
 	flags: number[];
 }
 export interface PlayerRgb {
-	/** `[r, g, b]` for each of the 8 playable slots; only read when `mode` is `Custom`. */
+	/** `[r, g, b]` for each of the 8 playable slots: the colour when `mode` is `Custom`; the editor writes `[0, 0, COLR]` for `Palette`. */
 	rgb: [
 		number,
 		number,
@@ -605,7 +605,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;
@@ -1781,7 +1786,7 @@ export interface PlayerSlotView {
 export interface PlayerPatch {
 	type?: number;
 	race?: number;
-	/** COLR index 0–15 (playable slots). */
+	/** COLR index 0–11 (playable slots). Older versions show a wrong colour past 11, and Remastered skips it. */
 	color?: number;
 	/** A CRGB custom colour, or null to go back to the palette colour (playable slots). */
 	rgb?: [

package/package.json

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