@killscript/types 0.1.0

package/dist/server.d.ts

@@ -0,0 +1,3 @@
+import "./shared.js";
+import "./generated/server.js";
+export {};

package/dist/shared.d.ts

@@ -0,0 +1,152 @@
+import "./generated/shared.js";
+export {};
+declare global {
+    /** A read-only, one-based array exposed by the game. Use `arrays` from the SDK to iterate it. */
+    interface LuaArray<T> {
+        readonly Length: number;
+        readonly [index: number]: T | undefined;
+    }
+    /** @customConstructor Vector2.new */
+    interface Vector2 {
+        x: number;
+        y: number;
+        readonly magnitude: number;
+        readonly sqrMagnitude: number;
+        readonly normalized: Vector2;
+        Magnitude(): number;
+        Dot(rhs: Vector2): number;
+        Angle(to: Vector2): number;
+        Distance(to: Vector2): number;
+        Normalize(): Vector2;
+    }
+    /** @noSelf */
+    interface Vector2Constructor {
+        new (x: number, y: number): Vector2;
+        readonly zero: Vector2;
+        readonly one: Vector2;
+    }
+    const Vector2: Vector2Constructor;
+    /** @customConstructor Vector3.new */
+    interface Vector3 {
+        x: number;
+        y: number;
+        z: number;
+        readonly magnitude: number;
+        readonly sqrMagnitude: number;
+        readonly normalized: Vector3;
+        Magnitude(): number;
+        Dot(rhs: Vector3): number;
+        Angle(to: Vector3): number;
+        Distance(to: Vector3): number;
+        Cross(rhs: Vector3): Vector3;
+        OnlyXZ(): Vector3;
+        Normalize(): Vector3;
+    }
+    /** @noSelf */
+    interface Vector3Constructor {
+        new (x: number, y: number, z: number): Vector3;
+        readonly back: Vector3;
+        readonly down: Vector3;
+        readonly forward: Vector3;
+        readonly left: Vector3;
+        readonly negativeInfinity: Vector3;
+        readonly zero: Vector3;
+        readonly one: Vector3;
+        readonly positiveInfinity: Vector3;
+        readonly right: Vector3;
+        readonly up: Vector3;
+        fromYawPitchToDirection(yaw: number, pitch: number): Vector3;
+    }
+    const Vector3: Vector3Constructor;
+    /** @customConstructor Quaternion.new */
+    interface Quaternion {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+        readonly normalized: Quaternion;
+        readonly eulerAngles: Vector3;
+        Dot(other: Quaternion): number;
+        Normalize(): Quaternion;
+        Inverse(): Quaternion;
+        Angle(other: Quaternion): number;
+        Lerp(other: Quaternion, amount: number): Quaternion;
+        LerpUnclamped(other: Quaternion, amount: number): Quaternion;
+        Slerp(other: Quaternion, amount: number): Quaternion;
+        SlerpUnclamped(other: Quaternion, amount: number): Quaternion;
+        RotateTowards(to: Quaternion, maxDegreesDelta: number): Quaternion;
+        ToAngleAxis(): LuaMultiReturn<[angle: number, axis: Vector3]>;
+    }
+    type Vector3Like = Vector3 | {
+        readonly x: number;
+        readonly y: number;
+        readonly z: number;
+    };
+    /** @noSelf */
+    interface QuaternionConstructor {
+        new (x: number, y: number, z: number, w: number): Quaternion;
+        euler(x: number, y: number, z: number): Quaternion;
+        lookRotation(forward: Vector3Like, up?: Vector3Like): Quaternion;
+        angleAxis(angle: number, axis: Vector3Like): Quaternion;
+        fromToRotation(from: Vector3Like, to: Vector3Like): Quaternion;
+    }
+    const Quaternion: QuaternionConstructor;
+    /** @customConstructor Color.new */
+    interface Color {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    }
+    /** @noSelf */
+    interface ColorConstructor {
+        new (r: number, g: number, b: number, a?: number): Color;
+    }
+    const Color: ColorConstructor;
+    /** @customConstructor Rect.new */
+    interface Rect {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+        xMin: number;
+        yMin: number;
+        xMax: number;
+        yMax: number;
+        center: Vector2;
+    }
+    /** @noSelf */
+    interface RectConstructor {
+        new (x: number, y: number, width: number, height: number): Rect;
+    }
+    const Rect: RectConstructor;
+    /** Values supported by native Config after the module configuration has loaded. */
+    type ConfigValue = boolean | number | Color;
+    const Config: Record<string, ConfigValue>;
+    /** Serializable persistent module data. Available only in the client entry. */
+    interface StorageTable {
+        [key: string]: LuaValue;
+    }
+    interface TimeApi {
+        /**
+         * Native truncating conversion. Exact durations can undercount (1 second
+         * was verified as 59 ticks); prefer SDK `time.ceilTicks()` for deadlines.
+         */
+        SecondsToTick(seconds: number): number;
+    }
+    interface NetworkApi {
+        /** Native transport keeps only one send made in the same tick. Prefer `defineNetwork()`. */
+        SendTable(table: LuaTableData): void;
+    }
+    interface AgentInputApi {
+        /**
+         * @deprecated In the current game build setter calls succeed but are not
+         * applied to the actually controlled player. The game developer is aware.
+         */
+        SetButtonState(inputButton: EInputButton, down: boolean): void;
+        /** @deprecated See SetButtonState; the current server input setters are not applied. */
+        SetLookRotation(vector: Vector2): void;
+        /** @deprecated See SetButtonState; the current server input setters are not applied. */
+        SetMoveDirection(vector: Vector2): void;
+    }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@killscript/types",
+  "version": "0.1.0",
+  "description": "TypeScript declarations for the native KILLSCRIPT Lua API",
+  "license": "MIT",
+  "keywords": ["killscript", "typescript", "lua", "types"],
+  "homepage": "https://silentbless.github.io/killscript/",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SilentBless/killscript.git",
+    "directory": "packages/types"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/shared.d.ts"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.json && node ../../scripts/rewrite-declaration-imports.mjs dist",
+    "check": "tsc -p tsconfig.json --noEmit",
+    "prepack": "npm run build"
+  },
+  "dependencies": {
+    "@typescript-to-lua/language-extensions": "1.19.0"
+  },
+  "devDependencies": {
+    "typescript": "6.0.2"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}