@kcds/types 1.0.6 → 1.0.7

package/README.md

@@ -3,10 +3,10 @@
 TypeScript declarations of the KCDS SDK, for the server and client scripts of KCDS resources. KCDS is a
 multiplayer mod for Kingdom Come: Deliverance II.
 
-This version declares the SDK of KCDS 1.0.6. Install the version your server runs:
+This version declares the SDK of KCDS 1.0.7. Install the version your server runs:
 
 ```text
-npm install --save-dev @kcds/types@1.0.6
+npm install --save-dev @kcds/types@1.0.7
 ```
 
 A KCDS hotfix x.y.z.w is the package version x.y.z-hotfix.w.

package/client-api.d.ts

@@ -1,4 +1,4 @@
-// KCDS SDK 1.0.6: generated from the SDK's own API, as https://kcdsynced.com/docs shows it.
+// KCDS SDK 1.0.7: generated from the SDK's own API, as https://kcdsynced.com/docs shows it.
 // Do not edit: regenerate it from the release instead.
 
 /// <reference path="./shared.d.ts" />
@@ -2602,7 +2602,9 @@ declare namespace KcdsTypes {
    * though others still do. Yaw is in degrees from +Y, rising to the left, and pitch is in degrees,
    * positive up. The server decides who can fly with Player.noclipAllowed, and for others, enable()
    * returns 'notAllowed'. Events are noclipChanged(active, reason), with the reason 'script',
-   * 'sessionOver', 'viewLost' or 'notAllowed', and noclipAllowedChanged(allowed).
+   * 'sessionOver', 'viewLost', 'notAllowed' or 'mounted', and noclipAllowedChanged(allowed). A
+   * 'body' flight does not start, and one that runs ends with 'mounted', while the player rides a
+   * horse: the body stays in the saddle. A 'camera' flight works on horseback.
    */
   class NoClip {
     constructor(...args: any[]);

package/client.d.ts

@@ -1,3 +1,3 @@
-// KCDS SDK 1.0.6: the declarations client scripts have.
+// KCDS SDK 1.0.7: the declarations client scripts have.
 /// <reference path="./shared.d.ts" />
 /// <reference path="./client-api.d.ts" />

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kcds/types",
-  "version": "1.0.6",
-  "description": "TypeScript declarations of the KCDS 1.0.6 SDK, for the server and client scripts of KCDS resources.",
+  "version": "1.0.7",
+  "description": "TypeScript declarations of the KCDS 1.0.7 SDK, for the server and client scripts of KCDS resources.",
   "keywords": [
     "kcds",
     "kingdom-come-deliverance-2",

package/server-api.d.ts

@@ -1,4 +1,4 @@
-// KCDS SDK 1.0.6: generated from the SDK's own API, as https://kcdsynced.com/docs shows it.
+// KCDS SDK 1.0.7: generated from the SDK's own API, as https://kcdsynced.com/docs shows it.
 // Do not edit: regenerate it from the release instead.
 
 /// <reference path="./shared.d.ts" />
@@ -362,8 +362,13 @@ declare namespace KcdsTypes {
      * level, and they stand at `position`, or where the level puts a new player. From then on nobody
      * on the map they left sees them. playerMapChanged fires once they stand there. On their current
      * map it only places them at `position`. Throws a TypeError for a map the server does not run or a
-     * position that is not finite. Returns true when the trip was ordered. @param map The map's name,
-     * such as 'kutnohorsko'. @param position Where they stand on that map, { x, y, z }; optional.
+     * position that is not finite. Returns true when the trip was ordered, and false for the Kingdom
+     * Come: Deliverance map ('kcd1_rataje') when the KCDS Master did not check that the player owns
+     * that game (their game loads that map from their own copy of it), and for 'klaster' (the Sedlec
+     * monastery) when the player's licence does not list its DLC, Mysteria Ecclesiae (entitlements):
+     * no script can send anyone else there. A server whose first map is one of them admits only
+     * players who own it. @param map The map's name, such as 'kutnohorsko'. @param position Where they
+     * stand on that map, { x, y, z }; optional.
      */
     setMap(map: any, position: any): boolean;
     /**
@@ -570,6 +575,17 @@ declare namespace KcdsTypes {
      * Whether they see the combat marker now: their own setting, or else the server's.
      */
     readonly combatMarker: any;
+    /**
+     * Moves the KCDS watermark to a corner of this player's screen alone. Overrides
+     * Watermark.setCorner for them until null gives them the server's corner again. The watermark
+     * cannot be turned off. Throws a TypeError for any other value. @param corner 'bottomLeft',
+     * 'bottomRight', 'topRight', 'topLeft', or null for the server's corner.
+     */
+    setWatermarkCorner(corner: any): void;
+    /**
+     * The corner their watermark stands in now: their own corner, or else the server's.
+     */
+    readonly watermarkCorner: string;
     /**
      * Whistles for their horse like the game's companion key, so it comes and nearby players hear it,
      * firing playerWhistle. Returns true when the order goes out, and false if they are not yet in the
@@ -811,17 +827,18 @@ declare namespace KcdsTypes {
      * its own. It takes the same as Horse.equip. What they wear in the same place on the body comes
      * off and stays in the inventory. A weapon becomes the weapon of their selected weapon set, a bow
      * or crossbow with the arrows or bolts they have on, and arrows or bolts go into the set of their
-     * bow, as the game's own Equip does; the weapon that was there stays in the inventory. One
-     * playerInventoryChanged follows, with the reason 'equip'. Throws a TypeError for an item a person
-     * does not wear or hold, or metadata Inventory.add refuses. Returns { ok, code, revision, items }
-     * as Inventory.add does. The code is alreadyWorn if they wear the same piece already, itemLimit or
-     * inventoryCapacity if there is no room, and inventoryUnavailable if they have no inventory. It is
-     * invalidEquipment if the piece cannot go on with what stays on; then `conflicts` says why. For
-     * example, { rule: 'needsFilled', slot: 'head_helmet', needs: 'head_coif_padded' } means a helmet
-     * needs a mail coif under it, and plate needs a padded piece. 'needsEmpty' names a slot that must
-     * be empty first. @param item The item class's name or GUID, or { item, metadata } with metadata
-     * as Inventory.add takes it: quality, health or condition, onEquipBuffs, custom { name,
-     * description, data } and transient.
+     * bow, as the game's own Equip does; the weapon that was there stays in the inventory. A torch
+     * ('torch_weapon') goes into its own slot, ready for the torch key. One playerInventoryChanged
+     * follows, with the reason 'equip'. Throws a TypeError for an item a person does not wear or hold,
+     * or metadata Inventory.add refuses. Returns { ok, code, revision, items } as Inventory.add does.
+     * The code is alreadyWorn if they wear the same piece already, itemLimit or inventoryCapacity if
+     * there is no room, and inventoryUnavailable if they have no inventory. It is invalidEquipment if
+     * the piece cannot go on with what stays on; then `conflicts` says why. For example, { rule:
+     * 'needsFilled', slot: 'head_helmet', needs: 'head_coif_padded' } means a helmet needs a mail coif
+     * under it, and plate needs a padded piece. 'needsEmpty' names a slot that must be empty first.
+     * @param item The item class's name or GUID, or { item, metadata } with metadata as Inventory.add
+     * takes it: quality, health or condition, onEquipBuffs, custom { name, description, data } and
+     * transient.
      */
     equip(item: any): { ok: any; code: any; revision: any; items: any; conflicts?: any };
     /**
@@ -1351,6 +1368,7 @@ declare namespace KcdsTypes {
      * accounts on one connection. Several players behind a shared NAT have the same address.
      */
     readonly ip: any;
+    readonly apps: any;
     /**
      * Server only. Their round-trip time in milliseconds, smoothed by the transport and refreshed
      * every 2 seconds, or 0 before the first measurement.
@@ -1382,6 +1400,22 @@ declare namespace KcdsTypes {
      * 'steam', 'epic', 'xbox', 'gog', 'discord', 'hardware' or 'ip'.
      */
     getIdentifier(kind: any): string;
+    /**
+     * Server only. What the player owns beyond the game, read-only, from the KCDS Master's licence
+     * pass: { kcd2Dlc }, the Kingdom Come: Deliverance II DLCs their store account owns:
+     * 'quest_for_valor', 'huntsman', 'season_pass_shields', 'bandit_camps', 'forge_tycoon' and
+     * 'mysteria_ecclesiae' (the Sedlec monastery map, klaster). Today only a Steam licence lists DLCs;
+     * other stores give an empty list. No script can grant one. A resource decides what a player
+     * without a DLC gets; the server itself only keeps klaster for owners of Mysteria Ecclesiae
+     * (setMap).
+     */
+    readonly entitlements: { kcd2Dlc: string[] };
+    /**
+     * Server only. Whether the player owns `name`, from the KCDS Master's licence pass (see
+     * entitlements). Throws a TypeError when `name` is not a string. @param name 'kcd2_dlc:<dlc>',
+     * such as 'kcd2_dlc:mysteria_ecclesiae'.
+     */
+    hasEntitlement(name: any): boolean;
     /**
      * Their body's look, as their game last published it.
      */
@@ -4665,7 +4699,9 @@ declare namespace KcdsTypes {
      * level's designers named it, which tells apart chests that share a model), and lockLevel is the
      * level's, 0 to 1, or null where the game makes one up on reset. They belong to the game, with
      * each player's game filling them as the level says, until Stash.adopt hands one to the server.
-     * @param position Optional: where to look from. @param radius Optional: metres, default 20.
+     * The KCD1 map's (kcd1_rataje) are listed once the owner writes them from their own KCD1 into the
+     * resources folder with Dev/tools/stash/build_kcd1_chests.py (level-chests.json). @param position
+     * Optional: where to look from. @param radius Optional: metres, default 20.
      */
     static levelChests(position?: any, radius?: any): { placedGuid: any; sourceName: any; position: any; model: any; lockedAtBoot: any; canBePicked: any; lockLevel: any }[];
     /**
@@ -4949,11 +4985,12 @@ declare namespace KcdsTypes {
     /**
      * Applies an edit and returns it. @param definition `kind`, 'brush' by default, 'entity' or
      * 'layer'; `name`, a brush's mesh path, objects/...cgf, or a layer's full name as World
-     * Architect's story_layers lists it; `guid`, an entity's 16 hex digits, dashes allowed; `at`,
-     * where the level placed it; `hidden`; `model`, a props catalogue mesh to stand in its place, as
-     * for LevelEdit.model; and to move it, `position`, `rotation` (a Quaternion, [x, y, z, w] or Euler
-     * degrees { x, y, z }) and `scale` (a number or Vector3, 0.01 to 100). @param dimension Optional:
-     * limits it to this dimension. By default it applies in all.
+     * Architect's story_layers lists it (on the Kingdom Come: Deliverance map, kcd1_rataje, as that
+     * game's level names it, its GUID in braces); `guid`, an entity's 16 hex digits, dashes allowed;
+     * `at`, where the level placed it; `hidden`; `model`, a props catalogue mesh to stand in its
+     * place, as for LevelEdit.model; and to move it, `position`, `rotation` (a Quaternion, [x, y, z,
+     * w] or Euler degrees { x, y, z }) and `scale` (a number or Vector3, 0.01 to 100). @param
+     * dimension Optional: limits it to this dimension. By default it applies in all.
      */
     static apply(definition?: LevelEditDefinition, dimension?: any): LevelEdit;
     /**
@@ -4982,7 +5019,11 @@ declare namespace KcdsTypes {
      * 'brush', 'entity' or 'layer'. A layer edit switches one of the level's story layers, the state a
      * place is in (a yard before or after a siege, a forge broken or rebuilt): `hidden` turns it off,
      * otherwise it is on. It needs no `at`, moves nothing and takes no `model`; restoring it gives the
-     * layer back as the level has it.
+     * layer back as the level has it. On the Kingdom Come: Deliverance map the layers start as a new
+     * game of that game has them (farms not burnt, Talmberk's fort as it was, the Vranik camp in its
+     * first state, Pribyslavitz in ruins); a farm burnt is its layer state1 on and state0 off. There a
+     * layer edit switches all of the layer: its buildings and plants (with their collision) and its
+     * doors, chests, beds, lights and fires.
      */
     readonly kind: string;
     /**
@@ -6446,12 +6487,12 @@ declare namespace KcdsTypes {
   class Dice {
     constructor(...args: any[]);
     /**
-     * The tables in the server's level, each { id, behavior, level, position, seats, chairs, placed },
-     * where `placed` is false for the level's own. `chairs` gives each chair's { position, player,
-     * sitFrom }. `player` is the holder's id or null. `sitFrom`, { position, yaw in degrees }, is
-     * where the game's sit-down begins, so a script can walk an NPC there and have it sit without a
-     * jump. A table placed by a script has an empty list. Tables SmartObject.remove took from all
-     * dimensions are not listed.
+     * The tables on the server's maps (World.maps; `level` says which), each { id, behavior, level,
+     * position, seats, chairs, placed }, where `placed` is false for the level's own. `chairs` gives
+     * each chair's { position, player, sitFrom }. `player` is the holder's id or null. `sitFrom`, {
+     * position, yaw in degrees }, is where the game's sit-down begins, so a script can walk an NPC
+     * there and have it sit without a jump. A table placed by a script has an empty list. Tables
+     * SmartObject.remove took from all dimensions are not listed.
      */
     static tables(): any[];
     /**
@@ -7209,6 +7250,26 @@ declare namespace KcdsTypes {
     static setEnabled(enabled: any): void;
   }
 
+  /**
+   * Moves the KCDS watermark, the mark and server line every player sees in a corner of the screen
+   * while in the world, to another corner. The watermark itself cannot be turned off or hidden. The
+   * voice chat indicator always stands beside it, toward the middle of the screen.
+   */
+  class Watermark {
+    constructor(...args: any[]);
+    /**
+     * The corner every player's watermark stands in: 'bottomLeft' (the default), 'bottomRight',
+     * 'topRight' or 'topLeft'.
+     */
+    static readonly corner: string;
+    /**
+     * Moves the watermark to a corner for all players. A player with their own corner
+     * (player.setWatermarkCorner) keeps it. Throws a TypeError for any other value. @param corner
+     * 'bottomLeft', 'bottomRight', 'topRight' or 'topLeft'.
+     */
+    static setCorner(corner: any): void;
+  }
+
   /**
    * Scripted camera shots. The server puts one player's camera at a point, aimed by a rotation or at
    * a point, with a field of view, moving there over some seconds. Ending a shot returns the
@@ -7498,7 +7559,8 @@ declare namespace KcdsTypes {
      */
     diceMatchStarting: (first: any, second: any, table: any, options?: any) => any;
     /**
-     * A player held dice and continued or passed.
+     * A player held dice and continued or passed. A pass may hold no dice of the last throw (heldMask
+     * 0, points 0): the turn ends with its points so far, none on its first throw.
      */
     diceMove: (event: any) => any;
     /**
@@ -8515,6 +8577,7 @@ declare const kcds: {
     readonly TabletopPiece: typeof KcdsTypes.TabletopPiece;
     readonly Trees: typeof KcdsTypes.Trees;
     readonly Vfx: typeof KcdsTypes.Vfx;
+    readonly Watermark: typeof KcdsTypes.Watermark;
     readonly World: typeof KcdsTypes.World;
     readonly WorldResource: typeof KcdsTypes.WorldResource;
   };
@@ -8607,6 +8670,7 @@ declare namespace kcds {
     type TabletopPiece = KcdsTypes.TabletopPiece;
     type Trees = KcdsTypes.Trees;
     type Vfx = KcdsTypes.Vfx;
+    type Watermark = KcdsTypes.Watermark;
     type World = KcdsTypes.World;
     type WorldResource = KcdsTypes.WorldResource;
   }

package/server.d.ts

@@ -1,3 +1,3 @@
-// KCDS SDK 1.0.6: the declarations server scripts have.
+// KCDS SDK 1.0.7: the declarations server scripts have.
 /// <reference path="./shared.d.ts" />
 /// <reference path="./server-api.d.ts" />

package/shared.d.ts

@@ -1,4 +1,4 @@
-// KCDS SDK 1.0.6: generated from the SDK's own API, as https://kcdsynced.com/docs shows it.
+// KCDS SDK 1.0.7: generated from the SDK's own API, as https://kcdsynced.com/docs shows it.
 // Do not edit: regenerate it from the release instead.
 
 /** The resource's log (the server's console, the client's log), one line per call. */