@scm-js/plugin-api 1.70.0 → 1.72.0

package/index.d.ts

@@ -861,6 +861,11 @@ export interface TerrainType extends TerrainName {
 	group: number;
 	height: 0 | 1 | 2;
 	buildable: boolean;
+	/**
+	 * The name in the user's language, where `name` is not a string of the catalogue's: a pair
+	 * terrain's name is put together ("Mud (mid ground)", "Group 3672"). Shown through `terrainLabel`.
+	 */
+	label?: string;
 }
 export type GroupKind = "terrain" | "edge" | "doodad" | "other";
 export interface TileInfo {
@@ -895,7 +900,11 @@ export interface Rect {
 	x1: number;
 	y1: number;
 }
-/** What Replace Terrain matches or writes: a flat terrain type (by ISOM id) or one exact tile. */
+/**
+ * What Replace Terrain matches or writes: a flat terrain type or one exact tile. A terrain's id
+ * is its ISOM id (the CV5 `index` of the flat pair), or a pair id (`palette.ts#PAIR_TERRAIN`)
+ * for flat ground the tileset does not type — a mod's added pairs.
+ */
 export type TerrainPick = {
 	kind: "terrain";
 	id: number;
@@ -5928,9 +5937,14 @@ export interface PickFilesOptions {
 	accept?: string;
 	multiple?: boolean;
 	/**
-	 * Pick a folder rather than files: `pickFiles` then resolves with every file in it and
+	 * Pick a folder rather than files: `pickFiles` then resolves with the files in it and
 	 * its subfolders as `FolderFile`s, with their paths. The browser's folder picker where it
 	 * has one, else the file input's folder mode; an empty list when the user cancels.
+	 *
+	 * The folder picker leaves out, without saying so, the files the browser keeps back from
+	 * a page: `desktop.ini`, shortcuts, names Windows keeps for devices and, on Windows, whole
+	 * file types such as `.ini` and `.dll`. A folder dropped on the editor
+	 * (`FileTypeSpec.openFolder`) comes with every file.
 	 */
 	directory?: boolean;
 }

package/package.json

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