@scm-js/plugin-api 1.71.0 → 1.72.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +10 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -861,6 +861,11 @@ export interface TerrainType extends TerrainName {
861
861
  group: number;
862
862
  height: 0 | 1 | 2;
863
863
  buildable: boolean;
864
+ /**
865
+ * The name in the user's language, where `name` is not a string of the catalogue's: a pair
866
+ * terrain's name is put together ("Mud (mid ground)", "Group 3672"). Shown through `terrainLabel`.
867
+ */
868
+ label?: string;
864
869
  }
865
870
  export type GroupKind = "terrain" | "edge" | "doodad" | "other";
866
871
  export interface TileInfo {
@@ -895,7 +900,11 @@ export interface Rect {
895
900
  x1: number;
896
901
  y1: number;
897
902
  }
898
- /** What Replace Terrain matches or writes: a flat terrain type (by ISOM id) or one exact tile. */
903
+ /**
904
+ * What Replace Terrain matches or writes: a flat terrain type or one exact tile. A terrain's id
905
+ * is its ISOM id (the CV5 `index` of the flat pair), or a pair id (`palette.ts#PAIR_TERRAIN`)
906
+ * for flat ground the tileset does not type — a mod's added pairs.
907
+ */
899
908
  export type TerrainPick = {
900
909
  kind: "terrain";
901
910
  id: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scm-js/plugin-api",
3
- "version": "1.71.0",
3
+ "version": "1.72.0",
4
4
  "description": "Type declarations for the scmJS plugin API",
5
5
  "license": "MIT",
6
6
  "types": "index.d.ts",