@sagl/server 0.0.0-stage → 0.1.0-next.49

package/dist/paint.js

@@ -0,0 +1,84 @@
+// Paint finishes (`vehicle.paintFinish`): a car's paint drawn with a shader
+// instead of the game's plain paint. Built in, or your own (an HLSL client
+// file): see docs/server-api/paint.md.
+const SLOTS = { both: 3, primary: 1, secondary: 2, all: 15 };
+const NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
+const rgb = (c) => [((c >> 16) & 255) / 255, ((c >> 8) & 255) / 255, (c & 255) / 255];
+/** @internal A finish and livery as sent (null: neither, the game's paint). */
+export function encodePaintAndLivery(f, l) {
+    if (!f && !l)
+        return null;
+    const sent = f ? encodePaint(f) : { type: "", shader: "", params: "", values: [], slots: SLOTS[l?.on ?? "both"] ?? 3 };
+    if (l) {
+        sent.livery = l.texture;
+        sent.liveryMapping = l.mapping === "uv" ? 1 : 2;
+        sent.liveryScale = Math.max(0.05, l.scale ?? 4);
+        sent.liveryOpacity = Math.max(0, Math.min(1, l.opacity ?? 1));
+        sent.liveryMultiply = l.blend === "multiply";
+        if (!f)
+            sent.slots = SLOTS[l.on ?? "both"] ?? 3;
+    }
+    return sent;
+}
+/** @internal As sent: its type or shader, parameters ("name:size,...") and values (4 each). */
+export function encodePaint(f) {
+    let type = "", shader = "";
+    let params = [];
+    if ("type" in f) {
+        switch (f.type) {
+            case "metallic":
+                type = "metallic";
+                params = [
+                    ["flakes", [f.flakes ?? 0.7]],
+                    ["flakeSize", [f.flakeSize ?? 1]],
+                    ["flakeColor", rgb(f.flakeColor ?? 0xffffff)],
+                    ["gloss", [f.gloss ?? 0.85]],
+                ];
+                break;
+            case "pearl":
+                type = "pearl";
+                params = [
+                    ["pearlColor", rgb(f.pearlColor ?? 0xffffff)],
+                    ["flakes", [f.flakes ?? 0.35]],
+                    ["flakeSize", [f.flakeSize ?? 1]],
+                    ["gloss", [f.gloss ?? 0.9]],
+                ];
+                break;
+            case "satin":
+            case "matte":
+                type = "satin";
+                params = [["sheen", [f.sheen ?? (f.type === "matte" ? 0.1 : 0.5)]]];
+                break;
+            case "colorShift":
+                type = "colorShift";
+                params = [
+                    ["hueShift", [f.hueShift ?? 30]],
+                    ["shift", [f.shift ?? 1]],
+                    ["flakes", [f.flakes ?? 0.35]],
+                    ["flakeSize", [f.flakeSize ?? 1]],
+                    ["gloss", [f.gloss ?? 0.9]],
+                ];
+                break;
+            default:
+                throw new RangeError(`not a paint finish: ${String(f.type)}`);
+        }
+    }
+    else {
+        shader = f.shader;
+        params = Object.entries(f.params ?? {}).map(([n, v]) => [n, Array.isArray(v) ? v : [v]]);
+        if (params.length > 8)
+            throw new RangeError(`at most 8 paint parameters (${params.length})`);
+        for (const [n, v] of params) {
+            if (!NAME.test(n))
+                throw new RangeError(`not a parameter name: "${n}"`);
+            if (v.length < 1 || v.length > 4)
+                throw new RangeError(`parameter ${n}: 1 to 4 numbers`);
+        }
+    }
+    const values = params.flatMap(([, v]) => [0, 1, 2, 3].map((i) => Number(v[i] ?? 0)));
+    const slots = SLOTS[f.on ?? "both"];
+    if (slots === undefined)
+        throw new RangeError(`not paint slots: ${f.on}`);
+    return { type, shader, params: params.map(([n, v]) => `${n}:${v.length}`).join(","), values, slots };
+}
+//# sourceMappingURL=paint.js.map

package/dist/paint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paint.js","sourceRoot":"","sources":["../src/paint.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,2EAA2E;AAC3E,uCAAuC;AAgHvC,MAAM,KAAK,GAA+B,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;AACzF,MAAM,IAAI,GAAG,0BAA0B,CAAC;AAExC,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;AAE9F,+EAA+E;AAC/E,MAAM,UAAU,oBAAoB,CAAC,CAAqB,EAAE,CAAgB;IAC1E,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC1B,MAAM,IAAI,GAGR,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IAC5G,IAAI,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,OAAO,CAAC;QACxB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QAChD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,KAAK,KAAK,UAAU,CAAC;QAC7C,IAAI,CAAC,CAAC;YAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,WAAW,CAAC,CAAc;IACxC,IAAI,IAAI,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,CAAC;IAC3B,IAAI,MAAM,GAAyB,EAAE,CAAC;IACtC,IAAI,MAAM,IAAI,CAAC,EAAE,CAAC;QAChB,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;YACf,KAAK,UAAU;gBACb,IAAI,GAAG,UAAU,CAAC;gBAClB,MAAM,GAAG;oBACP,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC;oBAC7B,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC;oBACjC,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,UAAU,IAAI,QAAQ,CAAC,CAAC;oBAC7C,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;iBAC7B,CAAC;gBACF,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,GAAG,OAAO,CAAC;gBACf,MAAM,GAAG;oBACP,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC,UAAU,IAAI,QAAQ,CAAC,CAAC;oBAC7C,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC;oBAC9B,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC;oBACjC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC;iBAC5B,CAAC;gBACF,MAAM;YACR,KAAK,OAAO,CAAC;YACb,KAAK,OAAO;gBACV,IAAI,GAAG,OAAO,CAAC;gBACf,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,MAAM;YACR,KAAK,YAAY;gBACf,IAAI,GAAG,YAAY,CAAC;gBACpB,MAAM,GAAG;oBACP,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC;oBAChC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;oBACzB,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC;oBAC9B,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC;oBACjC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC;iBAC5B,CAAC;gBACF,MAAM;YACR;gBACE,MAAM,IAAI,UAAU,CAAC,uBAAuB,MAAM,CAAE,CAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QAClB,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACzF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,+BAA+B,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QAC7F,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBAAE,MAAM,IAAI,UAAU,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC;YACxE,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC;gBAAE,MAAM,IAAI,UAAU,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;QAC3F,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,EAAE,IAAI,MAAM,CAAC,CAAC;IACpC,IAAI,KAAK,KAAK,SAAS;QAAE,MAAM,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC1E,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AACvG,CAAC"}

package/dist/paynspray.d.ts

@@ -0,0 +1,44 @@
+import type { Player } from "./player.js";
+import type { Server } from "./server.js";
+import type { Vehicle } from "./vehicle.js";
+import { type Garage } from "./zone.js";
+export interface PayNSprayOptions {
+    /** What a respray costs. Default 100 (the game's). */
+    price?: number;
+    /** Their wanted level cleared (on parole, as the game's: the stars flash, and a crime brings them back). Default true. */
+    clearWanted?: boolean;
+    /** The car repaired. Default true. */
+    repair?: boolean;
+    /** New colours (never the one it had; a modded car, `vehicle.modded`, keeps its own). Default true. */
+    respray?: boolean;
+    /** A cloud of dust in the new colour rolling out of the door. Default true. */
+    dust?: boolean;
+    /** Its blip (the game's spray can) on everyone's radar, near it. Default true. */
+    blips?: boolean;
+    /** Models turned away as too hot. Default: the game's law enforcement vehicles. */
+    hotModels?: number[];
+    /**
+     * Asked as they drive in, after the game's own checks: return false to
+     * turn them away (say why yourself), or a text to turn them away with it
+     * (as the game's notices), or a number for the price this time.
+     */
+    onEnter?: (player: Player, vehicle: Vehicle, garage: Garage) => boolean | string | number | void;
+}
+/**
+ * The game's Pay 'n' Sprays (`server.payNSpray`), on by default: drive in,
+ * the door shuts, the car is repaired and resprayed and the wanted level
+ * cleared, for $100. Turn it off to build your own from `garage.zone`'s
+ * events, or change how it works with `configure`. Fires `vehicleRespray`.
+ */
+export declare class PayNSpray {
+    #private;
+    /** @internal */
+    constructor(server: Server, emit: (player: Player, vehicle: Vehicle, colors: [number, number]) => void);
+    /** Whether they work (default true). Off, their doors stay as they are: open them as you need. */
+    get enabled(): boolean;
+    set enabled(on: boolean);
+    /** Changes how they work (only the options given). */
+    configure(options: PayNSprayOptions): this;
+    /** The game's Pay 'n' Spray garages. */
+    get garages(): Garage[];
+}

package/dist/paynspray.js

@@ -0,0 +1,177 @@
+// Pay 'n' Spray, as the game's. Players' games run no garage logic (it was
+// the game's own code, for one player), so the server does it, the way the
+// game did:
+//
+// - Drive in. A police car (or the like) is turned away ("Whoa! I don't
+//   touch nothing THAT hot!"), an RC toy too ("I don't do toys!"), and so is
+//   anyone without the price ("No more freebies!"), each with the game's
+//   sound for it.
+// - Otherwise, once the car is wholly inside, the door shuts, holding them
+//   still, and the spray hisses (the game's sound, as long as the game plays
+//   it). Then the car is repaired and resprayed (another colour), their
+//   wanted level cleared on parole (the old stars flash for 20 s, and a
+//   crime brings them back) and the price taken, and the door opens, with
+//   the game's notice.
+//
+// Not the game's, an extra: a cloud of dust in the new paint's colour rolls
+// out of the door as it opens.
+import { GameSound } from "./constants.js";
+import { gxt } from "./text.js";
+import { GarageType } from "./zone.js";
+import { ShopBlips } from "./shopblips.js";
+const DOOR_MS = 1500; // the door shutting
+const SPRAY_MS = 1900; // the spray's hiss: as long as the game plays it
+const NOTICE_MS = 4000;
+const DUST_AFTER_MS = 700; // the door part open
+const INSIDE_BY = 2.6; // m from the walls: a car, wholly inside
+// The game's law enforcement vehicles (the cops would know them anywhere),
+// and its RC toys.
+const HOT = [427, 430, 432, 433, 490, 497, 523, 528, 596, 597, 598, 599, 601];
+const TOYS = new Set([441, 464, 465, 501, 564, 594]);
+// Wheel Arch Angels is a Pay 'n' Spray in the map files (the game's script
+// makes it a mod shop).
+const NOT_SPRAYS = new Set(["mds1SFS"]);
+const SPRAY_SPRITE = 63; // RADAR_SPRITE_SPRAY
+/**
+ * The game's Pay 'n' Sprays (`server.payNSpray`), on by default: drive in,
+ * the door shuts, the car is repaired and resprayed and the wanted level
+ * cleared, for $100. Turn it off to build your own from `garage.zone`'s
+ * events, or change how it works with `configure`. Fires `vehicleRespray`.
+ */
+export class PayNSpray {
+    #server;
+    #emit;
+    #enabled = true;
+    #o = {};
+    #busy = new Set();
+    // "player:garage": turned away, or just resprayed, until they drive out.
+    #untilTheyLeave = new Set();
+    // The price agreed as they drove in.
+    #price = new Map();
+    #blips;
+    /** @internal */
+    constructor(server, emit) {
+        this.#server = server;
+        this.#emit = emit;
+        server.on("zoneEnter", (p, z) => this.#enter(p, z.garage));
+        server.on("zoneLeave", (p, z) => {
+            if (z.garage) {
+                this.#untilTheyLeave.delete(this.#key(p, z.garage));
+                this.#price.delete(this.#key(p, z.garage));
+            }
+        });
+        server.on("zoneMove", (p, z) => this.#move(p, z.garage));
+        this.#blips = new ShopBlips(server, SPRAY_SPRITE, () => this.#enabled && (this.#o.blips ?? true) ? this.garages.map((g) => g.center) : []);
+    }
+    /** Whether they work (default true). Off, their doors stay as they are: open them as you need. */
+    get enabled() {
+        return this.#enabled;
+    }
+    set enabled(on) {
+        this.#enabled = on;
+        this.#blips.refresh();
+    }
+    /** Changes how they work (only the options given). */
+    configure(options) {
+        Object.assign(this.#o, options);
+        this.#blips.refresh();
+        return this;
+    }
+    /** The game's Pay 'n' Spray garages. */
+    get garages() {
+        return this.#server.garages.filter((g) => this.#isSpray(g));
+    }
+    #isSpray(g) {
+        return g !== null && g.type === GarageType.PayNSpray && !NOT_SPRAYS.has(g.name);
+    }
+    #key(player, garage) {
+        return `${player.id}:${garage.id}`;
+    }
+    #sprayable(g) {
+        return this.#enabled && this.#isSpray(g) && !this.#busy.has(g);
+    }
+    #enter(player, garage) {
+        const vehicle = player.vehicle;
+        if (!this.#sprayable(garage) || !vehicle || vehicle.driver !== player)
+            return;
+        const key = this.#key(player, garage);
+        const away = (text, sound) => {
+            player.hud.notice(text, NOTICE_MS);
+            this.#server.audio.playGame(sound, { to: [player] });
+            this.#untilTheyLeave.add(key);
+        };
+        const hot = (this.#o.hotModels ?? HOT).includes(vehicle.model);
+        if (hot || TOYS.has(vehicle.model))
+            return away(gxt(TOYS.has(vehicle.model) ? "GA_1B" : "GA_1"), GameSound.CarIsHot);
+        let price = this.#o.price ?? 100;
+        const said = this.#o.onEnter?.(player, vehicle, garage);
+        if (said === false)
+            return void this.#untilTheyLeave.add(key);
+        if (typeof said === "string")
+            return away(said, GameSound.CarIsHot);
+        if (typeof said === "number")
+            price = Math.max(0, said);
+        this.#price.set(key, price);
+        if (player.money < price) {
+            away(price === 100 ? gxt("GA_3") : `No more freebies~n~$${price} to respray!`, GameSound.CarNoCash);
+        }
+    }
+    #move(player, garage) {
+        const vehicle = player.vehicle;
+        if (!this.#sprayable(garage) || !vehicle || vehicle.driver !== player)
+            return;
+        const key = this.#key(player, garage);
+        if (this.#untilTheyLeave.has(key))
+            return;
+        const price = this.#price.get(key) ?? this.#o.price ?? 100;
+        if (!garage.contains(vehicle.position, INSIDE_BY) || player.money < price)
+            return;
+        this.#busy.add(garage);
+        garage.close();
+        player.frozen = true;
+        // Shut: the spray.
+        setTimeout(() => {
+            if (player.connected)
+                this.#server.audio.playGame(GameSound.CarRespray, { to: [player] });
+        }, DOOR_MS);
+        setTimeout(() => {
+            let colors = vehicle.exists ? vehicle.colors : [0, 0];
+            if (vehicle.exists) {
+                // A modified car (a mod shop's) keeps its paint: only repaired.
+                if ((this.#o.respray ?? true) && !vehicle.modded) {
+                    // Another colour: never the one it had.
+                    const [old] = vehicle.colors;
+                    let paint = old;
+                    while (paint === old)
+                        paint = Math.floor(Math.random() * 127);
+                    colors = [paint, Math.floor(Math.random() * 127)];
+                    vehicle.colors = colors;
+                }
+                if (this.#o.repair ?? true)
+                    vehicle.repair();
+                vehicle.dirt = 0; // fresh paint: clean
+                if (this.#o.dust ?? true) {
+                    // The dust: a cloud in the new colour, rolling out of the door as it opens.
+                    const paint = colors[0];
+                    setTimeout(() => {
+                        if (vehicle.exists)
+                            this.#server.effects.dust(vehicle, { carColor: paint, count: 30, spread: 2.5, size: 2, rise: 0.3 });
+                    }, DUST_AFTER_MS);
+                }
+            }
+            if (player.connected) {
+                player.giveMoney(-price);
+                if (this.#o.clearWanted ?? true)
+                    player.clearWantedLevel({ parole: true });
+                player.frozen = false;
+                player.hud.notice(price === 100 ? gxt("GA_2") : `New engine and paint job: $${price}~n~Cops won't recognize you!`, NOTICE_MS);
+                if (vehicle.exists)
+                    this.#emit(player, vehicle, colors);
+            }
+            garage.open();
+            this.#busy.delete(garage);
+            this.#untilTheyLeave.add(key);
+        }, DOOR_MS + SPRAY_MS);
+    }
+}
+//# sourceMappingURL=paynspray.js.map

package/dist/paynspray.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paynspray.js","sourceRoot":"","sources":["../src/paynspray.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,2EAA2E;AAC3E,YAAY;AACZ,EAAE;AACF,wEAAwE;AACxE,6EAA6E;AAC7E,yEAAyE;AACzE,kBAAkB;AAClB,2EAA2E;AAC3E,6EAA6E;AAC7E,wEAAwE;AACxE,wEAAwE;AACxE,0EAA0E;AAC1E,uBAAuB;AACvB,EAAE;AACF,4EAA4E;AAC5E,+BAA+B;AAE/B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAEhC,OAAO,EAAE,UAAU,EAAe,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAyB3C,MAAM,OAAO,GAAG,IAAI,CAAC,CAAM,oBAAoB;AAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAK,iDAAiD;AAC5E,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,aAAa,GAAG,GAAG,CAAC,CAAC,qBAAqB;AAChD,MAAM,SAAS,GAAG,GAAG,CAAC,CAAK,yCAAyC;AAEpE,2EAA2E;AAC3E,mBAAmB;AACnB,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;AAC9E,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAErD,2EAA2E;AAC3E,wBAAwB;AACxB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AACxC,MAAM,YAAY,GAAG,EAAE,CAAC,CAAE,qBAAqB;AAE/C;;;;;GAKG;AACH,MAAM,OAAO,SAAS;IACpB,OAAO,CAAS;IAChB,KAAK,CAAuE;IAC5E,QAAQ,GAAG,IAAI,CAAC;IAChB,EAAE,GAAqB,EAAE,CAAC;IAC1B,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAC1B,yEAAyE;IACzE,eAAe,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,qCAAqC;IACrC,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;IACnC,MAAM,CAAY;IAElB,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAA0E;QACpG,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC9B,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;gBACb,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;gBACpD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,CACrD,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACvF,CAAC;IAED,kGAAkG;IAClG,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IACD,IAAI,OAAO,CAAC,EAAW;QACrB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED,sDAAsD;IACtD,SAAS,CAAC,OAAyB;QACjC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wCAAwC;IACxC,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,QAAQ,CAAC,CAAgB;QACvB,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,SAAS,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAClF,CAAC;IAED,IAAI,CAAC,MAAsB,EAAE,MAAc;QACzC,OAAO,GAAG,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;IACrC,CAAC;IAED,UAAU,CAAC,CAAgB;QACzB,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,MAAqB;QAC1C,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM;YAAE,OAAO;QAC9E,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;YAC3C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACnC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACrD,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC,CAAC;QACF,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,IAAI,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC/D,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;QACrH,IAAI,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,CAAC;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;QACxD,IAAI,IAAI,KAAK,KAAK;YAAE,OAAO,KAAK,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC;QACpE,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC5B,IAAI,MAAM,CAAC,KAAK,GAAG,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,uBAAuB,KAAK,cAAc,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC;QACtG,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAc,EAAE,MAAqB;QACzC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM;YAAE,OAAO;QAC9E,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,CAAC;QAC3D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,KAAK,GAAG,KAAK;YAAE,OAAO;QAClF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACvB,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC;QACrB,mBAAmB;QACnB,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,MAAM,CAAC,SAAS;gBAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC5F,CAAC,EAAE,OAAO,CAAC,CAAC;QACZ,UAAU,CAAC,GAAG,EAAE;YACd,IAAI,MAAM,GAAqB,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACxE,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;gBACnB,gEAAgE;gBAChE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;oBACjD,wCAAwC;oBACxC,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;oBAC7B,IAAI,KAAK,GAAG,GAAG,CAAC;oBAChB,OAAO,KAAK,KAAK,GAAG;wBAAE,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC;oBAC9D,MAAM,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;oBAClD,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;gBAC1B,CAAC;gBACD,IAAI,IAAI,CAAC,EAAE,CAAC,MAAM,IAAI,IAAI;oBAAE,OAAO,CAAC,MAAM,EAAE,CAAC;gBAC7C,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,CAAE,qBAAqB;gBACxC,IAAI,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACzB,4EAA4E;oBAC5E,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;oBACxB,UAAU,CAAC,GAAG,EAAE;wBACd,IAAI,OAAO,CAAC,MAAM;4BAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;oBAC1H,CAAC,EAAE,aAAa,CAAC,CAAC;gBACpB,CAAC;YACH,CAAC;YACD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;gBACrB,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC;gBACzB,IAAI,IAAI,CAAC,EAAE,CAAC,WAAW,IAAI,IAAI;oBAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC3E,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,8BAA8B,KAAK,8BAA8B,EAAE,SAAS,CAAC,CAAC;gBAC9H,IAAI,OAAO,CAAC,MAAM;oBAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;YAC1D,CAAC;YACD,MAAM,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC1B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,CAAC;IACzB,CAAC;CACF"}

package/dist/ped.d.ts

@@ -0,0 +1,335 @@
+import { type AudioEffects } from "./audio_effects.js";
+import type { NativePedStep, NativeServer } from "./native.js";
+import type { Player, Vector3 } from "./player.js";
+import type { Vehicle } from "./vehicle.js";
+import type { Hit } from "./server.js";
+import type { SpeakOptions, Speech } from "./audio.js";
+/** @internal */
+export declare function setPedSpeaker(fn: (file: string, options: SpeakOptions) => Speech): void;
+/** Who a ped's order is about: a player or another ped. */
+export type PedTarget = Player | Ped;
+/** How fast it goes. */
+export type Pace = "walk" | "run" | "sprint";
+/**
+ * One step of an order (`ped.sequence()`): a game task its owner's game
+ * runs with the ped's own AI. Exactly one of the keys below.
+ */
+export type PedStep = {
+    walkTo: Vector3;
+    pace?: Pace;
+    straight?: boolean;
+    radius?: number;
+} | {
+    follow: PedTarget;
+    distance?: number;
+    ms?: number;
+} | {
+    fleeFrom: PedTarget;
+    distance?: number;
+    ms?: number;
+} | {
+    face: PedTarget | Vector3;
+} | {
+    lookAt: PedTarget;
+    ms: number;
+} | {
+    standStill: number | true;
+} | {
+    handsUp: number | true;
+} | {
+    cower: number | true;
+} | {
+    attack: PedTarget;
+} | {
+    wander: true;
+} | {
+    playAnim: [block: string, name: string];
+    loop?: boolean;
+    ms?: number;
+} | {
+    enterVehicle: Vehicle;
+    seat?: number;
+} | {
+    leaveVehicle: true;
+} | {
+    driveTo: Vector3;
+    speed?: number;
+    hurry?: boolean;
+    radius?: number;
+};
+/**
+ * How an order ended. `"cancelled"`: replaced by another order, or
+ * `ped.stop()` (`reason` says which). `"failed"`: `reason` says why
+ * (`"died"`, `"removed"`, `"unreachable"`, `"target lost"`, `"animation"`,
+ * `"in a vehicle"`, `"refused"`).
+ */
+export interface OrderResult {
+    status: "done" | "failed" | "cancelled";
+    reason?: string;
+    /** The step it ended at (the last, if done). */
+    step: number;
+}
+/**
+ * How a ped behaves beyond its orders: mission characters' settings
+ * (`createPed(..., { mission })`, `ped.set()`).
+ */
+export interface PedSettings {
+    /**
+     * `"normal"`: as the game's peds of its kind (flees gunfire, ...).
+     * `"none"`: ignores everything. `"self-defence"`: ignores everything but
+     * fights whoever hits it (unless busy with an order and `keepTask`).
+     */
+    reactions?: "normal" | "none" | "self-defence";
+    /** Being hurt or bumped doesn't stop its order. */
+    keepTask?: boolean;
+    /** Takes no damage at all (all of `proofs`). */
+    invincible?: boolean;
+    /** Takes no damage of these kinds (enforced by the server too). */
+    proofs?: {
+        bullet?: boolean;
+        fire?: boolean;
+        explosion?: boolean;
+        collision?: boolean;
+        melee?: boolean;
+    };
+    /** False: players can't drag it out of a vehicle. Default true. */
+    draggable?: boolean;
+    /** Aim, 1-100; left out: its own. */
+    accuracy?: number;
+    /** Attacks these players on sight (when not busy with an order). */
+    hostileTo?: readonly Player[];
+    /** How near "on sight" is, metres. Default 40. */
+    hostileRange?: number;
+}
+/** A ped's own events: `ped.on(...)`. */
+export interface PedEvents {
+    /** An order's step finished; the next starts. */
+    stepDone: (step: number, orderId: number) => void;
+    /** An order finished. */
+    orderDone: (orderId: number) => void;
+    /** An order failed. */
+    orderFailed: (reason: string, step: number, orderId: number) => void;
+}
+/** @internal A step, as the native server takes it. */
+export declare function encodeStep(step: PedStep): NativePedStep;
+/** @internal What a `say()` sends, and how long it lasts. */
+export declare function speechOf(native: NativeServer, line: {
+    subtitle?: string;
+    dialogue?: string;
+    table?: string;
+    ms?: number;
+}): {
+    subtitle: string;
+    dialogue: string;
+    ms: number;
+};
+/**
+ * A ped (NPC) created with `server.createPed()`. The nearest player's game
+ * simulates it, running its own AI as for any ped in single-player (it
+ * flees gunfire, falls over when hit, dies), and everyone sees the same ped.
+ * The server checks what that game reports.
+ */
+export declare class Ped {
+    #private;
+    readonly id: number;
+    /** Ped model (skin). */
+    readonly model: number;
+    /** The story character it is ("ryder"), or null: then `model` is 0. */
+    readonly character: string | null;
+    /** Free-form per-ped storage for gamemode data. */
+    readonly data: Record<string, unknown>;
+    /** @internal Created by Server. */
+    constructor(nativeServer: NativeServer, id: number, player: (id: number) => Player | undefined, vehicle: (id: number) => Vehicle | undefined, destroy: (ped: Ped) => void);
+    /** False once destroyed. */
+    get exists(): boolean;
+    /** @internal */
+    markDestroyed(): void;
+    /** Walks (or runs, sprints) to `position`, along the paths (or `straight`). Done within `radius` (1 m). */
+    walkTo(position: Vector3, options?: {
+        pace?: Pace;
+        straight?: boolean;
+        radius?: number;
+    }): Promise<OrderResult>;
+    /** Keeps within `distance` (2 m) of `target`, for `ms` (until the next order if left out). */
+    follow(target: PedTarget, options?: {
+        distance?: number;
+        ms?: number;
+    }): Promise<OrderResult>;
+    /** Runs from `target` until `distance` (50 m) away, or `ms` is up. */
+    fleeFrom(target: PedTarget, options?: {
+        distance?: number;
+        ms?: number;
+    }): Promise<OrderResult>;
+    /** Turns to face a player, a ped or a position. */
+    face(target: PedTarget | Vector3): Promise<OrderResult>;
+    /** Looks at `target` for `ms`. */
+    lookAt(target: PedTarget, ms: number): Promise<OrderResult>;
+    /** Stands still for `ms` (until the next order if left out). */
+    standStill(ms?: number): Promise<OrderResult>;
+    /** Puts its hands up for `ms` (until the next order if left out). */
+    handsUp(ms?: number): Promise<OrderResult>;
+    /** Cowers for `ms` (until the next order if left out). */
+    cower(ms?: number): Promise<OrderResult>;
+    /** Attacks `target` with what it holds, until one of them is dead. */
+    attack(target: PedTarget): Promise<OrderResult>;
+    /** Wanders around (until the next order). */
+    wander(): Promise<OrderResult>;
+    /**
+     * Walks to `vehicle` and gets in: its driver's seat (`seat` 0, the
+     * default) or a passenger's (1-8). Done once it's sitting there.
+     */
+    enterVehicle(vehicle: Vehicle, seat?: number): Promise<OrderResult>;
+    /** Gets out of the vehicle it's in (done at once if it's on foot). */
+    leaveVehicle(): Promise<OrderResult>;
+    /**
+     * Drives the vehicle it's driving to `position` along the roads, at
+     * `speed` m/s (default 12), by the rules (stopping for traffic and
+     * lights) or, with `hurry`, weaving round traffic and through lights.
+     * Done within `radius` (8 m).
+     */
+    driveTo(position: Vector3, options?: {
+        speed?: number;
+        hurry?: boolean;
+        radius?: number;
+    }): Promise<OrderResult>;
+    /** Plays one of the game's animations (`block`, `name`), once or `loop`ing, for `ms`. */
+    playAnim(block: string, name: string, options?: {
+        loop?: boolean;
+        ms?: number;
+    }): Promise<OrderResult>;
+    /**
+     * Several steps, run one after another by its owner's game with no pause
+     * between them (up to 16). Resolves when the last is done, or one fails.
+     */
+    sequence(steps: PedStep[]): Promise<OrderResult>;
+    /** Stops what it's been ordered to do: back to standing (or wandering). */
+    stop(): void;
+    /**
+     * Who sees it: `"world"` (the default), everyone its virtual world shows
+     * it to (its world, and worlds viewing it); or only these players (while
+     * they're in its world or one viewing it). Players who can't see it can't
+     * hit it, nor it them. Players who leave drop off the list.
+     */
+    get visibleTo(): readonly Player[] | "world";
+    set visibleTo(players: readonly Player[] | "world");
+    /**
+     * The player whose game always runs it, at any distance, while they can
+     * see it (a mission's player, so a chase or a follow plays out on their
+     * screen); null, the nearest player's (the default). If they can't have
+     * it (left, another world), the nearest takes over meanwhile.
+     */
+    get controller(): Player | null;
+    set controller(player: Player | null);
+    /** Its settings (see `PedSettings`). */
+    get settings(): Readonly<PedSettings>;
+    /**
+     * Changes its settings; fields left out keep their value. For mission
+     * characters: `{ reactions: "self-defence", keepTask: true }` is what
+     * `createPed`'s `mission` option starts from.
+     */
+    set(settings: PedSettings): this;
+    /** @internal Set at creation (the server has them already). */
+    initVisibility(visibleTo: readonly Player[] | "world", controller: Player | null): void;
+    /** @internal A player left: off its hostile and visibility lists (the server drops them too). */
+    forgetPlayer(player: Player): void;
+    /**
+     * Says something: one of the game's voice lines in its own voice
+     * (`context`, a `VoiceContext`), and/or a `subtitle` shown to the players
+     * who hear it (those who have subtitles on in their pause menu). Or a line
+     * of the game's mission dialogue (`dialogue`, its GXT key such as
+     * "RYD2_AA", from mission table `table`): its recording, from this ped,
+     * with its own text as the subtitle. Heard by `to`, or everyone within
+     * 40 m who sees it. Resolves when it's done (after `ms`, the recording,
+     * or about as long as reading the subtitle takes). `effects` puts the
+     * recording through audio effects (`"phone"`...; then its lips don't move).
+     */
+    say(line: {
+        context?: number;
+        subtitle?: string;
+        dialogue?: string;
+        table?: string;
+        ms?: number;
+        to?: readonly Player[];
+        effects?: AudioEffects;
+        /** A recording of your own instead (a client file): from this ped, `subtitle` in step with it. */
+        file?: string;
+        /** With `file`: from inside this vehicle, muffled through the glass. */
+        inside?: Vehicle;
+    }): Promise<void>;
+    /**
+     * What happens to it when hurt, for this ped alone (as
+     * `server.on("pedDamage")` for all): return `false` to refuse it, or a
+     * number for the damage instead. Called before the server's listeners.
+     * **Returns** a function that removes it.
+     *
+     * ```ts
+     * witness.onDamage((by, hit) => (hit.weapon <= 15 ? 0 : undefined));  // fists and bats don't hurt him
+     * ```
+     */
+    onDamage(fn: (attacker: Player | Ped, hit: Hit) => boolean | number | void): () => void;
+    /** @internal Hurt: to its own listeners first. */
+    damagedBy(attacker: Player | Ped, hit: Hit): boolean | number | undefined;
+    /**
+     * A player threatening it: aiming a gun at it within `range` m (default
+     * 8), or (unless `melee: false`) hitting it with fists or a melee weapon.
+     * For a ped that gives up, as in a holdup or an arrest. Called each time
+     * it happens (aiming: at most once a second per player). **Returns** a
+     * function that removes it.
+     *
+     * ```ts
+     * clerk.onThreatened((player) => { void clerk.handsUp(5000); });
+     * ```
+     */
+    onThreatened(fn: (player: Player, how: "aim" | "melee") => void, options?: {
+        range?: number;
+        melee?: boolean;
+    }): () => void;
+    /** @internal Whether anything listens for threats (the server checks aims only then). */
+    get watchesThreats(): boolean;
+    /** @internal Checks whether `player` is aiming at it (the server, a few times a second). */
+    checkAim(player: Player): void;
+    /** @internal */
+    threatenedBy(player: Player, how: "aim" | "melee"): void;
+    /** Whether it's carrying out an order. */
+    get busy(): boolean;
+    on<E extends keyof PedEvents>(event: E, listener: PedEvents[E]): this;
+    off<E extends keyof PedEvents>(event: E, listener: PedEvents[E]): this;
+    /** @internal The server's word on an order. */
+    handleOrder(orderId: number, step: number, state: "stepDone" | "done" | "failed", reason: string): void;
+    /** Where it is, as its owner last reported. */
+    get position(): Vector3;
+    /** Facing, degrees. */
+    get heading(): number;
+    get health(): number;
+    get armour(): number;
+    /** The weapon it holds (`Weapon`), 0 unarmed. */
+    get weapon(): number;
+    get dead(): boolean;
+    get world(): number;
+    /** The player whose game simulates it, or null (nobody near). */
+    get owner(): Player | null;
+    /** Part of the ambient population (the server removes it when nobody is near). */
+    get ambient(): boolean;
+    /** The vehicle it's in, or null on foot. */
+    get vehicle(): Vehicle | null;
+    /** Its seat in `vehicle` (0 driver, 1-8 passenger), or null on foot. */
+    get seat(): number | null;
+    /**
+     * Puts it in a vehicle seat (0 driver, the default) for everyone. A driver
+     * whose behaviour is "wander" drives around; it still reacts as any
+     * driver would (it gets out and runs, fights back...). Throws if the seat
+     * is taken or the vehicle is in another world.
+     */
+    putInVehicle(vehicle: Vehicle, seat?: number): void;
+    /** Takes it out of its vehicle (beside it). */
+    removeFromVehicle(): void;
+    /**
+     * Hands it back to the game, like `MARK_CHAR_AS_NO_LONGER_NEEDED`: its
+     * order stops, everyone sees it, and the server removes it as it does the
+     * ambient population, once nobody is near (a body after it has lain a
+     * while). The Ped object stays usable until then.
+     */
+    release(): void;
+    /** Removes it for everyone. */
+    destroy(): void;
+}