@falloutmp/types 0.1.0 → 0.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@falloutmp/types",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "TypeScript declarations for the Fallout Multiplayer scripting API: @falloutmp/types/server and @falloutmp/types/client",
   "license": "UNLICENSED",
   "exports": {

package/shared.d.ts

@@ -1,10 +1,13 @@
 /**
  * Structural TypeScript types that are not runtime globals.
  *
- * These describe what the MafiaHub Framework itself provides -- the base entity and player handles
- * FMP's own `Player` extends, and the value types they exchange. The generated declarations import
- * from here; nothing in this file is produced by the exporter, so it is edited by hand when the
- * framework's own surface changes.
+ * These describe what the MafiaHub Framework itself provides and the generated declarations have no
+ * counterpart for: handler signatures, and the base entity handle on the client, whose API declares
+ * no Entity class. The generated declarations import from here; nothing in this file is produced by
+ * the exporter, so it is edited by hand when the framework's own surface changes.
+ *
+ * Value types (Vector2, Vector3, Quaternion, Color) and the server's Entity are generated global
+ * classes. Never redeclare them here: an import of a weaker copy would shadow the real class.
  *
  * A binding may only declare a named type, never an inline `(...) => ...`, so a handler parameter
  * has nowhere else it can be spelled.
@@ -22,47 +25,6 @@ export type MessageReply = (value: unknown) => void;
 /** Handler for a request addressed to a resource, given the payload and a reply callback. */
 export type MessageHandler = (payload: unknown, reply: MessageReply) => void;
 
-/** A two-dimensional vector. */
-export interface Vector2 {
-  x: number;
-  y: number;
-}
-
-/** A normalized RGBA color. */
-export interface Color {
-  r: number;
-  g: number;
-  b: number;
-  a: number;
-}
-
-/** A mutable three-dimensional vector used for world positions and Euler angles. */
-export interface Vector3 {
-  x: number;
-  y: number;
-  z: number;
-  add(other: Vector3): this;
-  sub(other: Vector3): this;
-  mul(scalar: number): this;
-  div(scalar: number): this;
-  normalize(): this;
-  dot(other: Vector3): number;
-  cross(other: Vector3): this;
-  distance(other: Vector3): number;
-  lerp(target: Vector3, t: number): this;
-  set(x: number, y: number, z: number): this;
-  clone(): Vector3;
-}
-
-/** Quaternion used for entity rotations. */
-export interface Quaternion {
-  w: number;
-  x: number;
-  y: number;
-  z: number;
-}
-
-
 /** Handler registered with `Key.bind`, provided by the MafiaHub Framework. */
 export type KeyHandler = (key: string, state: "down" | "up") => void;
 
@@ -72,7 +34,7 @@ export type KeyHandler = (key: string, state: "down" | "up") => void;
  */
 export type WebEventHandler = (payload?: unknown) => void;
 
-/** Base networked entity handle, provided by the MafiaHub Framework. */
+/** Base networked entity handle on the client, provided by the MafiaHub Framework. Vector3 and Quaternion are the generated globals. */
 export interface Entity {
   /** Network id, stable for the entity's lifetime. */
   readonly id: number;