@sandustry-modding/types 0.3.1 → 0.4.0

package/src/sandkit/api/sound.d.ts

@@ -11,7 +11,8 @@ export namespace sound {
    *
    * @param soundId - Registered sound identifier.
    * @param options - Volume, position, playback rate, and rate-limit options.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.sound.play`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function play(soundId: string, options?: SoundOptions): SoundHandle;
 
@@ -20,7 +21,8 @@ export namespace sound {
    *
    * @param soundId - Registered sound identifier.
    * @param options - Volume, position, playback rate, and rate-limit options.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.sound.playActive`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function playActive(soundId: string, options?: SoundOptions): SoundHandle;
 
@@ -29,7 +31,8 @@ export namespace sound {
    *
    * @param layers - Layer definitions (sound id, volume, delay, and per-layer options).
    * @param options - Shared position, volume, and rate-limit options for all layers.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.sound.playLayers`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function playLayers(layers: SoundLayer[], options?: SoundLayersOptions): SoundHandle[];
 
@@ -39,7 +42,8 @@ export namespace sound {
    * @param worldX - World X coordinate in pixels.
    * @param worldY - World Y coordinate in pixels.
    * @param baseVolume - Base volume before distance attenuation.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.sound.calculateDistanceOptionsAtWorld`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function calculateDistanceOptionsAtWorld(worldX: number, worldY: number, baseVolume?: number): SoundOptions;
 
@@ -47,27 +51,29 @@ export namespace sound {
    * Stop a sound by id.
    *
    * @param soundId - Registered sound identifier to stop.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.sound.stopBySoundId`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function stopBySoundId(soundId: string): void;
 
   /**
    * @deprecated Use {@link stopBySoundId} instead.
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — deprecated alias of `api.sound.stopBySoundId`
+   *
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function stopById(soundId: string): void;
 
   /**
    * Stop the active sound channel.
    *
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.sound.stopActive`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function stopActive(): void;
 
   /**
    * Stop all playing sounds.
    *
-   * @see https://sandustry.com/sandkit.html Official Sandkit API — Main entry `api.sound.stopAll`
+   * @see [Official docs](https://sandustry.com/sandkit.html#api-access-heading)
    */
   export function stopAll(): void;
 

package/src/sandkit/api/structureBehaviors.d.ts

@@ -12,6 +12,14 @@ export namespace structureBehaviors {
    * Register conveyor behavior for a structure type.
    * @param structureId - Structure type id string.
    * @param options - Transport offset, velocity, distance, and run direction.
+   *
+   * @example
+   * ```ts
+   * api.structureBehaviors.registerConveyorType(
+   *   "exampleConveyor",
+   *   { runWith: "right" },
+   * );
+   * ```
    */
   export function registerConveyorType(structureId: string, options?: { transportOffset?: Vector2; velocity?: Vector2; maxTransportDistance?: number; transportHeight?: number; runWith?: 'left' | 'right'; skipQueued?: boolean; }): void;
   /**