@sandustry-modding/types 0.3.1 → 0.4.0

package/src/shared/api/terrains.d.ts

@@ -15,7 +15,7 @@ export namespace terrains {
   /**
    * Terrain definition shape for {@link register} and {@link getDefinitionByType}.
    *
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.register`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export interface TerrainDefinition {
     /** Unique mod-scoped terrain id. */
@@ -45,7 +45,7 @@ export namespace terrains {
   /**
    * Terrain cell data returned by {@link getDataAtCell}.
    *
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.getDataAtCell`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export interface TerrainDataAtCell {
     /** Numeric terrain cell type. */
@@ -53,12 +53,13 @@ export namespace terrains {
     /**
      * Current hit points, or null when the terrain has no hp.
      *
-     * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.getDataAtCell`
+     * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
      */
     hitPoints: number | null;
     /**
      * @deprecated Use {@link hitPoints} instead.
-     * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `result.hitPoints`
+     *
+     * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
      */
     hp?: number | null;
   }
@@ -67,7 +68,8 @@ export namespace terrains {
    * Return the mod string id for a numeric terrain type.
    *
    * @param terrainType - Numeric terrain cell type.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.getIdByType`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function getIdByType(terrainType: TerrainType): TerrainId;
 
@@ -75,13 +77,15 @@ export namespace terrains {
    * Resolve a terrain string id to a numeric cell type.
    *
    * @param terrainId - Mod-registered or built-in terrain id.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.getTypeById`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function getTypeById(terrainId: TerrainId): TerrainType;
 
   /**
    * @deprecated Use {@link getTypeById} instead.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.terrains.getTypeById`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function getTypeFromId(terrainId: TerrainId): TerrainType;
 
@@ -89,7 +93,8 @@ export namespace terrains {
    * Look up the definition for a terrain type.
    *
    * @param terrainType - Numeric terrain cell type.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.getDefinitionByType`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function getDefinitionByType(terrainType: TerrainType): TerrainDefinition | undefined;
 
@@ -98,7 +103,8 @@ export namespace terrains {
    *
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.getTypeAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function getTypeAtCell(...args: CellCoordinates): TerrainType | null;
 
@@ -108,7 +114,8 @@ export namespace terrains {
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
    * @returns Cell type and hit points, or null when the cell is not terrain.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.getDataAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function getDataAtCell(...args: CellCoordinates): TerrainDataAtCell | null;
 
@@ -117,7 +124,8 @@ export namespace terrains {
    *
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.isAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function isAtCell(...args: CellCoordinates): boolean;
 
@@ -127,7 +135,8 @@ export namespace terrains {
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
    * @param terrainId - Terrain string id to compare.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.isTypeAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function isTypeAtCell(...args: [...CellCoordinates, terrainId: TerrainId]): boolean;
 
@@ -135,7 +144,8 @@ export namespace terrains {
    * Return true when a packed cell id refers to terrain.
    *
    * @param cellId - Packed cell id from {@link world.getCellIdAtCell}.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.isCellIdTerrain`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function isCellIdTerrain(cellId: CellId): boolean;
 
@@ -145,7 +155,8 @@ export namespace terrains {
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
    * @param damage - Damage amount to apply.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.damageAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function damageAtCell(...args: [...CellCoordinates, damage: number]): void;
 
@@ -156,7 +167,8 @@ export namespace terrains {
    * @param cellY - Grid row of the target cell.
    * @param terrainTypeOrId - Numeric cell type or terrain string id.
    * @param options - Optional mutation flags.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.terrains.createAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function createAtCell(...args: [...CellCoordinates, terrainTypeOrId: TerrainRef, options?: TerrainMutationOptions]): void;
 
@@ -167,7 +179,8 @@ export namespace terrains {
    * @param cellY - Grid row of the target cell.
    * @param terrainTypeOrId - Numeric cell type or terrain string id.
    * @param options - Optional mutation flags.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.terrains.replaceAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function replaceAtCell(...args: [...CellCoordinates, terrainTypeOrId: TerrainRef, options?: TerrainMutationOptions]): void;
 
@@ -177,7 +190,8 @@ export namespace terrains {
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
    * @param options - Optional mutation flags.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.terrains.removeAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function removeAtCell(...args: [...CellCoordinates, options?: TerrainMutationOptions]): void;
 
@@ -188,20 +202,22 @@ export namespace terrains {
    * @param cellY - Grid row of the target cell.
    * @param hitPoints - New hit point value.
    * @returns True when hit points changed or the terrain was removed.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.terrains.setHitPointsAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function setHitPointsAtCell(...args: [...CellCoordinates, hitPoints: number]): boolean;
 
   /**
    * @deprecated Use {@link setHitPointsAtCell} instead.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.terrains.setHitPointsAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function setHpAtCell(...args: [...CellCoordinates, hitPoints: number]): boolean;
 
   /**
    * Options for terrain create, replace, or remove calls.
    *
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains.createAtCell`
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export interface TerrainMutationOptions {
     /** Skip shadow updates around the changed cell. */
@@ -211,21 +227,21 @@ export namespace terrains {
   /**
    * Numeric terrain / {@link CellTypeEnum} handle.
    *
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export type TerrainType = CellTypeEnum | TaggedNumber<"terrainType">;
 
   /**
    * Mod or built-in terrain string id.
    *
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export type TerrainId = LooseString<never>;
 
   /**
    * Type handle or string id accepted by mutation helpers.
    *
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.terrains`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export type TerrainRef = TerrainType | TerrainId;
 }

package/src/shared/api/ui.d.ts

@@ -10,6 +10,11 @@ export namespace ui {
    * Show a short on-screen toast message.
    * @param message - Plain text, translation key, or translatable value.
    * @param options - Cooldown, style, and auto-dismiss options.
+   *
+   * @example Worker entry
+   * ```ts
+   * api.ui.toast({ key: "mods|example|workerToast" });
+   * ```
    */
   export function toast(message: LocalizedText, options?: ToastOptions): void;
 

package/src/shared/api/world.d.ts

@@ -11,33 +11,33 @@ import { grid as gridNs } from "./grid";
  */
 export namespace world {
   /**
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.getCellIdAtCell`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export import getCellIdAtCell = gridNs.getCellIdAtCell;
   /**
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.isCellEmptyAtCell`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export import isCellEmptyAtCell = gridNs.isCellEmptyAtCell;
   /**
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.isTerrainAtCell`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export import isTerrainAtCell = gridNs.isTerrainAtCell;
   /**
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.reportActivityAtCell`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export import reportActivityAtCell = gridNs.reportActivityAtCell;
   /**
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.excavateAtCell`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export import excavateAtCell = gridNs.excavateAtCell;
   /**
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.getDimensions`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export import getDimensions = gridNs.getDimensions;
-  /** @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.ExcavateOptions` */
+  /** @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading) */
   export import ExcavateOptions = gridNs.ExcavateOptions;
-  /** @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.CellId` */
+  /** @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading) */
   export import CellId = gridNs.CellId;
-  /** @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid.GridDimensions` */
+  /** @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading) */
   export import GridDimensions = gridNs.GridDimensions;
 }

package/src/worker/api/effects.d.ts

@@ -20,7 +20,8 @@ export namespace effects {
    * @param worldX - World x position in pixels.
    * @param worldY - World y position in pixels.
    * @param options - Duration, radius, and intensity settings.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.effects.createAtWorld`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function createAtWorld(
     effectId: string,
@@ -31,7 +32,8 @@ export namespace effects {
 
   /**
    * @deprecated Use {@link createAtWorld} instead.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.effects.createAtWorld`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function createEffectAtWorld(
     effectId: string,
@@ -46,7 +48,13 @@ export namespace effects {
    * @param worldX - World x position in pixels.
    * @param worldY - World y position in pixels.
    * @param options - Count, velocity, colour, and lifetime settings.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.effects.createParticlesAtWorld`
+   *
+   * @example Worker entry
+   * ```ts
+   * api.effects.createParticlesAtWorld(worldX, worldY, { count: 8 });
+   * ```
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export import createParticlesAtWorld = shared.api.effects.createParticlesAtWorld;
 }

package/src/worker/api/elements.d.ts

@@ -10,7 +10,7 @@ import { shared } from "../../shared";
  * @internal Worker extension; not interchangeable with main-thread
  * `sandkit.api.elements`.
  *
- * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements`
+ * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
  */
 export namespace elements {
   /** Numeric id for a registered element type. */
@@ -34,7 +34,8 @@ export namespace elements {
   export import getTypeById = shared.api.elements.getTypeById;
   /**
    * @deprecated Use {@link getTypeById} instead.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.elements.getTypeById`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export import getTypeFromId = shared.api.elements.getTypeFromId;
   /** Returns the definition for an element type. */
@@ -65,7 +66,15 @@ export namespace elements {
    * @param cellY - Grid row of the target cell.
    * @param elementTypeOrId - Numeric type or string id.
    * @param options - Optional spawn overrides.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.createAtCell`
+   *
+   * @example Worker entry
+   * ```ts
+   * api.elements.createAtCell(cellX, cellY, "water", {
+   *   durationTicks: 60,
+   * });
+   * ```
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function createAtCell(
     ...args: [...CellCoordinates, elementTypeOrId: ElementRef, options?: ElementCreateOptions]
@@ -78,7 +87,8 @@ export namespace elements {
    * @param cellY - Grid row of the target cell.
    * @param elementTypeOrId - Numeric type or string id.
    * @param options - Optional spawn overrides.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.replaceAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function replaceAtCell(
     ...args: [...CellCoordinates, elementTypeOrId: ElementRef, options?: ElementCreateOptions]
@@ -90,7 +100,8 @@ export namespace elements {
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
    * @param options - Optional removal flags.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.removeAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function removeAtCell(
     ...args: [...CellCoordinates, options?: ElementRemovalOptions]
@@ -104,7 +115,8 @@ export namespace elements {
    * @param toCellX - Destination cell column.
    * @param toCellY - Destination cell row.
    * @returns True when the move succeeded.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.moveBetweenCells`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function moveBetweenCells(
     fromCellX: number,
@@ -120,7 +132,8 @@ export namespace elements {
    * @param fromCellY - Source cell row.
    * @param toCellX - Destination cell column.
    * @param toCellY - Destination cell row.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.teleportBetweenCells`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function teleportBetweenCells(
     fromCellX: number,
@@ -137,7 +150,8 @@ export namespace elements {
    * @param secondCellX - Second cell column.
    * @param secondCellY - Second cell row.
    * @returns True when the swap succeeded.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.swapBetweenCells`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function swapBetweenCells(
     firstCellX: number,
@@ -148,7 +162,8 @@ export namespace elements {
 
   /**
    * @deprecated Use {@link swapBetweenCells} instead.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.elements.swapBetweenCells`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function swapCells(
     firstCellX: number,
@@ -161,13 +176,15 @@ export namespace elements {
    * Mark an element index as movement-blocked for this tick.
    *
    * @param elementIndex - Element index from {@link getInfoAtCell}.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.elements.markMovementBlockedByIndex`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function markMovementBlockedByIndex(elementIndex: number): void;
 
   /**
    * @deprecated Use {@link markMovementBlockedByIndex} instead.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.elements.markMovementBlockedByIndex`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function markMovementBlockedByElementIndex(elementIndex: number): void;
 
@@ -178,7 +195,8 @@ export namespace elements {
    * @param cellY - Grid row of the target cell.
    * @param velocity - New velocity vector.
    * @returns True when velocity was set.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.setVelocityAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function setVelocityAtCell(...args: [...CellCoordinates, velocity: Vector2]): boolean;
 
@@ -190,7 +208,8 @@ export namespace elements {
    * @param velocity - Velocity delta to add.
    * @param maxSpeedCellsPerSecond - Optional speed cap after the addition.
    * @returns True when velocity was updated.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.addParticleVelocityAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function addParticleVelocityAtCell(
     ...args: [...CellCoordinates, velocity: Vector2, maxSpeedCellsPerSecond?: number]
@@ -203,7 +222,8 @@ export namespace elements {
    * @param cellY - Grid row of the target cell.
    * @param velocity - Initial particle velocity.
    * @returns True when conversion succeeded.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.convertToParticleAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function convertToParticleAtCell(...args: [...CellCoordinates, velocity: Vector2]): boolean;
 
@@ -213,7 +233,8 @@ export namespace elements {
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
    * @returns True when conversion succeeded.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.convertFromParticleAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function convertFromParticleAtCell(...args: CellCoordinates): boolean;
 
@@ -225,7 +246,8 @@ export namespace elements {
    * @param fieldNumber - Data field index (1–4).
    * @param value - New field value.
    * @returns True when the field was set.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.setDataFieldAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function setDataFieldAtCell(
     ...args: [...CellCoordinates, fieldNumber: 1 | 2 | 3 | 4, value: number]
@@ -236,7 +258,8 @@ export namespace elements {
    *
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.refreshColorAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function refreshColorAtCell(...args: CellCoordinates): void;
 
@@ -246,7 +269,8 @@ export namespace elements {
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
    * @param physicsState - Physics skip flags for the element.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.setPhysicsAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function setPhysicsAtCell(...args: [...CellCoordinates, physicsState: number]): void;
 
@@ -258,7 +282,18 @@ export namespace elements {
    * @param durationTicks - Duration in simulation ticks.
    * @param options - When `updateMax` is true, also update max duration.
    * @returns True when duration was updated.
-   * @see https://sandustry.com/sandkit.html#mutations-heading Official Sandkit API — Worker entry `api.elements.setDurationAtCell`
+   *
+   * @example Worker entry
+   * ```ts
+   * const updated = api.elements.setDurationAtCell(
+   *   cellX,
+   *   cellY,
+   *   120,
+   *   { updateMax: true },
+   * );
+   * ```
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function setDurationAtCell(
     ...args: [...CellCoordinates, durationTicks: number, options?: { updateMax?: boolean; }]

package/src/worker/api/events.d.ts

@@ -13,7 +13,35 @@ export namespace events {
    * @param eventId - Registered event name.
    * @param callback - Called when the event is emitted.
    * @param options - Required guard for filtered events.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.events.on`
+   *
+   * @example element:moved
+   * ```ts
+   * api.events.on(
+   *   "element:moved",
+   *   (payload) => handleElementMoved(payload),
+   *   { guard: { elementType } },
+   * );
+   * ```
+   *
+   * @example terrain:updated
+   * ```ts
+   * api.events.on(
+   *   "terrain:updated",
+   *   (payload) => {
+   *     handleTerrainUpdate(payload);
+   *   },
+   *   { guard: { terrainType } },
+   * );
+   * ```
+   *
+   * @example worker:update:post
+   * ```ts
+   * api.events.on("worker:update:post", (payload) => {
+   *   runPostUpdate(payload);
+   * });
+   * ```
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function on<K extends EventId>(
     eventId: K,
@@ -27,7 +55,8 @@ export namespace events {
    * @param eventId - Registered event name.
    * @param payload - Serializable payload passed to listeners.
    * @param options - Optional guard forwarded to filtered listeners.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.events.emit`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function emit<K extends EventId>(
     eventId: K,

package/src/worker/api/fire.d.ts

@@ -13,7 +13,8 @@ export namespace fire {
    *
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.fire.canBurnElementAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function canBurnElementAtCell(...args: CellCoordinates): boolean;
 
@@ -23,7 +24,8 @@ export namespace fire {
    * @param cellX - Grid column of the target cell.
    * @param cellY - Grid row of the target cell.
    * @returns True when the burn succeeded.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Worker entry `api.fire.burnElementAtCell`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#mutations-heading)
    */
   export function burnElementAtCell(...args: CellCoordinates): boolean;
 }

package/src/worker/api/grid.d.ts

@@ -18,7 +18,14 @@ export namespace grid {
   export import reportActivityAtCell = sharedGrid.reportActivityAtCell;
   /** Apply excavation damage and eject velocity at a cell. */
   export import excavateAtCell = sharedGrid.excavateAtCell;
-  /** Return the world grid size in cells. */
+  /**
+   * Return the world grid size in cells.
+   *
+   * @example Worker entry
+   * ```ts
+   * const { widthCells, heightCells } = api.grid.getDimensions();
+   * ```
+   */
   export import getDimensions = sharedGrid.getDimensions;
   /** Options for {@link excavateAtCell}. */
   export import ExcavateOptions = sharedGrid.ExcavateOptions;
@@ -30,7 +37,8 @@ export namespace grid {
 
 /**
  * @deprecated Use {@link grid} instead.
- * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.grid`
+ *
+ * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
  */
 export namespace world {
   export import getCellIdAtCell = grid.getCellIdAtCell;