@scm-js/plugin-api 1.22.0 → 1.24.0

package/index.d.ts

@@ -1957,6 +1957,20 @@ export interface PluginManifest {
 	icon?: string;
 	/** The `PLUGIN_API_VERSION` the plugin was written against. */
 	api?: number;
+	/**
+	 * Plugins this one needs running, as the specs Manage Plugins takes
+	 * (`"github:owner/repo"`, `"github:owner/repo@v1.2.0"`, a URL to a `plugin.json`,
+	 * `"builtin:name"`). Adding this plugin installs them first, enabling it enables them,
+	 * and the editor starts them before it; a required plugin cannot be turned off or
+	 * removed while something enabled needs it.
+	 *
+	 * Which *version* of the required plugin is enough is not said here. The two plugins
+	 * meet through `api.services`: the required one provides a service with a `version`
+	 * (`ServiceOptions`), and this one checks `ServiceInfo.version` in its `watch` and says
+	 * so in its own words when it is too old. A version range in the manifest would have
+	 * the editor arbitrate a contract it never reads.
+	 */
+	requires?: string[];
 }
 /** What `activate` may hand back: nothing, a cleanup function, or a Disposable. */
 export type Deactivate = void | (() => void) | Disposable;
@@ -2804,6 +2818,36 @@ export interface TriggersApi {
 	};
 	/** A trigger's `Comment` action text, when it has one. */
 	comment(trigger: TriggerRecord): string | null;
+	/**
+	 * EUD: the player value that reaches a memory address through the deaths table
+	 * (`(address − consts.triggers.deathsTable) / 4`, the address rounded down to a dword)
+	 * — what a Deaths condition or Set Deaths action stores in `player` with `unitId` 0 to
+	 * read or write that dword.
+	 */
+	epd(address: number): number;
+	/** EUD: the address a record's `player` and `unitId` reach through the deaths table — `epd`'s inverse, and a plain death counter's cell as an address. */
+	addressOf(player: number, unitId?: number): number;
+	/**
+	 * A content fingerprint of a trigger: the same wherever it sits in the list and
+	 * whatever the game's bookkeeping bits say. What a plugin that generates triggers
+	 * finds its run by (`TriggerClaimSpec.locate`), and what an editor keeps a selection
+	 * by across a list that changed under it.
+	 */
+	fingerprint(trigger: TriggerRecord): string;
+	/**
+	 * Every death-counter cell (`[player, unit]`) and switch the triggers read or write —
+	 * TRIG when `list` is omitted. A player group counts as every slot it can resolve to
+	 * (`Current Player` as the trigger's owners); a class unit (*Any unit*, *Men*, …)
+	 * counts for nothing, and an EUD player is an address, not a cell. What a plugin that
+	 * allocates counters or switches of its own must keep clear of.
+	 */
+	usage(list?: TriggerRecord[]): {
+		cells: [
+			player: number,
+			unit: number
+		][];
+		switches: number[];
+	};
 	/**
 	 * Tell the editor that a run of the trigger list is generated by this plugin. The
 	 * Trigger Editor badges those rows, locks them and offers the plugin's own editor in
@@ -3382,9 +3426,16 @@ export interface TriggerConsts {
 	readonly triggerFlags: typeof TriggerFlag;
 	/**
 	 * The address of the game's death table, which is the base an EUD player value is
-	 * counted from: `epd = (address - deathsTable) / 4 + 0x2000`.
+	 * counted from: `epd = (address - deathsTable) / 4` (`triggers.epd` does the sum).
 	 */
 	readonly deathsTable: number;
+	/**
+	 * The value of a condition's or action's trailing `mask` word that makes it a *masked*
+	 * record: the game then reads or writes only the bits set in the record's `location`
+	 * field, which is how one byte, one word or one bit of a dword is reached. StarCraft:
+	 * Remastered only; 1.16.1 ignores the word.
+	 */
+	readonly maskedRecord: 17235;
 }
 export interface ActiveBrush {
 	mode: TerrainMode;

package/package.json

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