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

package/dist/native.d.ts

@@ -0,0 +1,809 @@
+import type { EncodedEffect } from "./audio_effects.js";
+export interface NativePlayerState {
+    id: number;
+    name: string;
+    skin: number;
+    ip: string;
+    viaProxy: boolean;
+    connectHost: string;
+    connectPort: number;
+    ping: number;
+    alive: boolean;
+    paused: boolean;
+    focused: boolean;
+    money: number;
+    wantedLevel: number;
+    maxWantedLevel: number;
+    radioNameHidden: boolean;
+    world: number;
+    interior: number;
+    weapon: number;
+    weapons: {
+        slot: number;
+        weapon: number;
+        ammo: number;
+    }[];
+    infiniteSprint: boolean;
+    fightingStyle: number;
+    skinAnimations: boolean;
+    stats: Record<string, number>;
+    /** The vehicle they are in, if any, and their seat (0 driver). */
+    vehicleId: number | null;
+    seat: number | null;
+    /** The vehicle they remote-control, if any. */
+    remoteVehicleId: number | null;
+    /** The vehicle they last drove, while it exists. */
+    lastVehicleId: number | null;
+    /** False until the player's first sync packet; position/health are 0 until then. */
+    hasState: boolean;
+    /** The buttons held (Key bits), as their last sync. */
+    keys: number;
+    /** m/s (a passenger: their vehicle's). */
+    velocity: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    /** Their camera: where it looks (a unit vector) and where it is; null for passengers. */
+    cameraFront: {
+        x: number;
+        y: number;
+        z: number;
+    } | null;
+    cameraPosition: {
+        x: number;
+        y: number;
+        z: number;
+    } | null;
+    health: number;
+    armour: number;
+    x: number;
+    y: number;
+    z: number;
+    heading: number;
+}
+export type WeaponViolationReason = "notOwned" | "noAmmo" | "fireRate" | "position";
+export interface NativeVehicleHit {
+    cause: "collision" | "weapon";
+    with: "world" | "ground" | "vehicle" | "ped" | "object" | null;
+    weapon: number;
+    otherVehicleId: number | null;
+    playerId: number | null;
+    pedId: number | null;
+    healthBefore: number;
+    health: number;
+    loss: number;
+    intensity: number;
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+}
+export interface NativePedStep {
+    kind: number;
+    x?: number;
+    y?: number;
+    z?: number;
+    pace?: number;
+    targetPlayer?: number;
+    targetPed?: number;
+    distance?: number;
+    ms?: number;
+    animBlock?: string;
+    animName?: string;
+    loop?: boolean;
+    vehicleId?: number;
+    seat?: number;
+    speed?: number;
+    driveStyle?: number;
+}
+export interface NativeDraw {
+    id: number;
+    remove?: boolean;
+    kind?: number;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+    text?: string;
+    font?: string;
+    size?: number;
+    color?: number;
+    outline?: number;
+    shadow?: number;
+    outlineColor?: number;
+    boxColor?: number;
+    boxPadding?: number;
+    align?: number;
+    layer?: number;
+    anchor?: number;
+}
+export interface NativeShot {
+    weapon: number;
+    origin: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    target: {
+        x: number;
+        y: number;
+        z: number;
+    };
+}
+export interface NativeExplosion {
+    type: number;
+    weapon: number;
+    vehicleId: number;
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+}
+export interface NativeHit {
+    weapon: number;
+    bodyPart: number;
+    damage: number;
+    direction: number;
+}
+export interface NativeHooks {
+    join?(id: number): void;
+    quit?(id: number, reason: "quit" | "timeout" | "kicked"): void;
+    /** false vetoes; a number replaces the damage; anything else allows. */
+    /** attackerId null and attackerPedId set: a server ped hit them. */
+    damage?(victimId: number, attackerId: number | null, hit: NativeHit, attackerPedId?: number): boolean | number | void;
+    death?(id: number, killerId: number | null, weapon: number, killerPedId: number | null): void;
+    spawn?(id: number): void;
+    pause?(id: number, paused: boolean, focused: boolean): void;
+    enterVehicle?(playerId: number, vehicleId: number): void;
+    exitVehicle?(playerId: number, vehicleId: number): void;
+    zoneEnter?(playerId: number, zoneId: number): void;
+    zoneLeave?(playerId: number, zoneId: number): void;
+    zoneMove?(playerId: number, zoneId: number): void;
+    /** false refuses; a number replaces the station; anything else allows. */
+    radio?(playerId: number, vehicleId: number, station: number): boolean | number | void;
+    shoot?(playerId: number, shot: NativeShot): boolean | void;
+    weaponViolation?(playerId: number, reason: WeaponViolationReason, weapon: number): void;
+    explosion?(playerId: number, explosion: NativeExplosion): boolean | void;
+    vehicleDeath?(vehicleId: number, killerId: number | null): boolean | void;
+    vehicleHit?(vehicleId: number, hit: NativeVehicleHit): boolean | number | void;
+    vehicleRespawn?(vehicleId: number): void;
+    /** false keeps the old level; a number replaces the new one. */
+    wantedLevel?(playerId: number, level: number, old: number): boolean | number | void;
+    scriptMessage?(playerId: number, channel: string, data: string): void;
+    uiEvent?(playerId: number, event: NativeUiEvent): void;
+    objectHit?(playerId: number, id: number, damage: number, weapon: number): void;
+    pickupTouch?(playerId: number, id: number): void;
+    /** Their client script put an object in their hands (or took one away). */
+    playerAttach?(playerId: number, spec: Parameters<NativeServer["playerAttachment"]>[1]): void;
+    carjack?(jackerId: number, victimId: number, vehicleId: number): void;
+    playerInterior?(playerId: number, interior: number, old: number): void;
+    playerKeys?(playerId: number, keys: number, old: number): void;
+    playerAction?(playerId: number, id: string): void;
+    chat?(playerId: number, text: string): void;
+    dialogResponse?(playerId: number, id: number, response: boolean, listItem: number, input: string): void;
+    /** kind: 0 moved to `row`, 1 selected it, 2 backed out. */
+    gameMenuEvent?(playerId: number, id: number, kind: number, row: number): void;
+    cameraEvent?(playerId: number, id: number, step: number, kind: number): void;
+    documentResult?(playerId: number, id: number, button: number): void;
+    suggestRequest?(playerId: number, id: number, text: string): void;
+    interactionUse?(playerId: number, id: number, where: {
+        event: "use" | "reach" | "leave";
+        model: number;
+        x: number;
+        y: number;
+        z: number;
+        heading: number;
+    }): void;
+    cutsceneState?(playerId: number, id: number, state: "loaded" | "finished" | "failed" | "skipVote", skipped: boolean): void;
+    /** false vetoes; a number replaces the damage; anything else allows. */
+    pedDamage?(pedId: number, attackerId: number | null, hit: NativeHit, attackerPedId?: number): boolean | number | void;
+    pedDeath?(pedId: number, killerId: number | null, weapon: number, killerPedId: number | null): void;
+    pedOrder?(pedId: number, orderId: number, step: number, state: "stepDone" | "done" | "failed", reason: string): void;
+    pedViolation?(playerId: number, pedId: number, reason: string): void;
+    populationSpawn?(playerId: number, spawn: NativeAmbientSpawn): boolean | void;
+}
+export interface NativeUiEvent {
+    doc: number;
+    /** A UiEventType, or "error" (the document didn't open). */
+    type: string;
+    id: string;
+    value: string;
+    checked: boolean;
+    enter: boolean;
+    key: number;
+    fields: Record<string, string>;
+}
+export interface NativePedState {
+    id: number;
+    model: number;
+    /** A story character's name, or "". */
+    special: string;
+    world: number;
+    x: number;
+    y: number;
+    z: number;
+    heading: number;
+    health: number;
+    armour: number;
+    weapon: number;
+    dead: boolean;
+    ownerId: number | null;
+    behaviour: number;
+    vehicleId: number | null;
+    seat: number | null;
+    ambient: boolean;
+}
+export interface NativePopulation {
+    peds: boolean;
+    traffic: boolean;
+    density: number;
+    gangs: boolean;
+    police: boolean;
+    ambulance: boolean;
+    fire: boolean;
+    wanted: boolean;
+    evadeSeconds: number;
+    evadeDistance: number;
+    indicators: boolean;
+}
+export interface NativeAmbientSpawn {
+    vehicle: boolean;
+    vehicleModel: number;
+    position: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    heading: number;
+    peds: {
+        model: number;
+        pedType: number;
+        weapon: number;
+        seat: number;
+    }[];
+}
+export interface NativeVehicleState {
+    id: number;
+    /** Tuning parts on it. */
+    components: number[];
+    /** -1: none. */
+    paintjob: number;
+    doorsLocked: boolean;
+    /** 0 the game's, 1 off, 2 on. */
+    engine: number;
+    lights: number;
+    searchlight: number;
+    smoke: number;
+    /** Held dirt: 0 each game's own, else 1 + tenths. */
+    dirt: number;
+    searchlightOn: boolean;
+    smokeOn: boolean;
+    indicators: number;
+    indicatorsOn: number;
+    /** Degrees. */
+    heading: number;
+    model: number;
+    x: number;
+    y: number;
+    z: number;
+    health: number;
+    wrecked: boolean;
+    ambient: boolean;
+    /** CDamageManager bytes (24), or [] when undamaged. */
+    damage: number[];
+    /** ms; 0: never respawns by itself. */
+    respawnDelay: number;
+    /** m/s, as last synced (0 once nobody has for a second). */
+    velocity: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    /** What it tows. */
+    trailerId: number | null;
+    plate: string;
+    color1: number;
+    color2: number;
+    /** Radio station, -1 until chosen. */
+    radio: number;
+    world: number;
+    interior: number;
+    driverId: number | null;
+    /** Seat number -> player id. */
+    occupants: Record<string, number>;
+    /** Seat number -> server ped id. */
+    pedSeats: Record<string, number>;
+}
+export interface NativeGarageState {
+    id: number;
+    name: string;
+    type: number;
+    x: number;
+    y: number;
+    z: number;
+    /** The box: from (x, y) to (frontX, frontY) one way, to (sideX, sideY) the other; z to topZ. */
+    frontX: number;
+    frontY: number;
+    sideX: number;
+    sideY: number;
+    topZ: number;
+    open: boolean;
+    zoneId: number;
+}
+export interface NativeCullZone {
+    world?: number;
+    min: [number, number, number];
+    max: [number, number, number];
+    audio?: number;
+    attributes?: number;
+    mirror?: {
+        axis: number;
+        sign: number;
+        coord: number;
+    };
+}
+export interface NativeServerConfig {
+    port?: number;
+    name?: string;
+    maxPlayers?: number;
+    timeHour?: number;
+    timeMinute?: number;
+    timeFrozen?: boolean;
+    trustedProxies?: string[];
+    startMoney?: number;
+    weather?: number;
+    skinAnimations?: boolean;
+    gameEntrances?: boolean;
+    splash?: boolean;
+    carjacking?: boolean;
+    indicatorKeys?: boolean;
+    indicatorCancel?: boolean;
+    indicatorSound?: string;
+    clientFiles?: string;
+}
+export interface NativeServer {
+    start(): boolean;
+    service(timeoutMs?: number): void;
+    shutdown(): void;
+    setHooks(hooks: NativeHooks): void;
+    playerIds(): number[];
+    player(id: number): NativePlayerState | null;
+    setSkin(id: number, model: number): void;
+    setPosition(id: number, x: number, y: number, z: number, heading?: number): void;
+    setHealth(id: number, health: number, armour: number): void;
+    setMoney(id: number, money: number): void;
+    setWantedLevel(id: number, level: number): void;
+    paroleWantedLevel(id: number): void;
+    setMaxWantedLevel(id: number, level: number): void;
+    setRemoteControl(id: number, vehicleId: number, detonate: boolean): boolean;
+    /** id -1: everyone. */
+    sendMessage(id: number, text: string, color?: number, markdown?: boolean): void;
+    kick(id: number, reason?: string): void;
+    getTime(world?: number): {
+        hour: number;
+        minute: number;
+        frozen: boolean;
+    };
+    setTime(hour: number, minute: number, world?: number): void;
+    freezeTime(frozen: boolean, world?: number): void;
+    getWeather(world?: number): number;
+    setWeather(weather: number, world?: number): void;
+    worldSynced(world: number): boolean;
+    trafficLights(world: number): {
+        northSouth: number;
+        eastWest: number;
+        pedestrians: number;
+        fixed: boolean;
+        timing: {
+            green: number;
+            yellow: number;
+            walk: number;
+            flashing: number;
+        };
+    };
+    setTrafficLights(northSouth: number, eastWest: number, pedestrians: number, world: number): void;
+    holdTrafficLights(world: number): void;
+    defineAction(id: string, label: string, key: string): void;
+    removeAction(id: string): void;
+    resumeTrafficLights(world: number): void;
+    setTrafficTiming(green: number, yellow: number, walk: number, flashing: number, world: number): void;
+    setWorldSynced(world: number, synced: boolean): void;
+    createCullZone(zone: NativeCullZone): number;
+    destroyCullZone(id: number): boolean;
+    randomSkin(): number;
+    /** Heading in radians; colours < 0 are random. Returns the id, or 0. */
+    createVehicle(model: number, x: number, y: number, z: number, heading: number, color1: number, color2: number, radio: number, world: number, ambient: boolean, respawnDelayMs: number, plate?: string): number;
+    setPlayerWorld(id: number, world: number): void;
+    giveWeapon(id: number, weapon: number, ammo: number): boolean;
+    setStat(id: number, stat: number, value: number): boolean;
+    clearStat(id: number, stat: number): void;
+    setInfiniteSprint(id: number, infinite: boolean): void;
+    setFightingStyle(id: number, style: number): void;
+    setDrunkLevel(id: number, level: number): void;
+    renamePlayer(playerId: number, name: string): boolean;
+    setScore(playerId: number, score: number): void;
+    towVehicle(vehicleId: number, trailerId: number): boolean;
+    setStuntBonus(playerId: number, on: boolean): void;
+    crimeReport(playerId: number, crime: number, x: number, y: number, z: number): void;
+    gangZone(playerId: number, z: {
+        id: number;
+        remove: boolean;
+        minX: number;
+        minY: number;
+        maxX: number;
+        maxY: number;
+        color: number;
+        flashing: boolean;
+        flashColor: number;
+    }): void;
+    spectate(playerId: number, kind: number, targetId: number): void;
+    setVisibleFor(playerId: number, viewerId: number, visible: boolean): void;
+    setPlayerWeather(playerId: number, weather: number | null): void;
+    worldBounds(playerId: number, on: boolean, minX: number, maxX: number, minY: number, maxY: number): void;
+    nameTag(viewerId: number, playerId: number, hidden: boolean, text: string, color: number | null): void;
+    nameTagOptions(viewerId: number, distance: number, lineOfSight: boolean, ids: boolean, bars: boolean): void;
+    putInVehicle(id: number, vehicleId: number, seat: number): void;
+    setSkinAnimations(id: number, skin: boolean): void;
+    setWeaponAmmo(id: number, weapon: number, ammo: number): boolean;
+    removeWeapon(id: number, weapon: number): void;
+    resetWeapons(id: number): void;
+    setCurrentWeapon(id: number, weapon: number): void;
+    removeFromVehicle(id: number, jump?: boolean): void;
+    setVehicleWorld(id: number, world: number): void;
+    placeVehicle(id: number, x: number, y: number, z: number, heading: number): void;
+    vehicleComponent(id: number, part: number, add: boolean): boolean;
+    vehicleLocked(id: number, locked: boolean, playerId?: number, clear?: boolean): void;
+    vehicleParams(id: number, engine: number, lights: number, searchlight: number, smoke: number, indicators: number, dirt?: number): void;
+    vehiclePaintjob(id: number, paintjob: number): boolean;
+    setPlayerInterior(id: number, interior: number): void;
+    commandTree(playerId: number, tree: string): void;
+    clearChat(playerId: number): void;
+    explosion(playerId: number, x: number, y: number, z: number, type: number): void;
+    playerAttachment(toPlayerId: number, spec: {
+        playerId: number;
+        slot: number;
+        remove?: boolean;
+        model?: number;
+        bone?: number;
+        ox?: number;
+        oy?: number;
+        oz?: number;
+        rx?: number;
+        ry?: number;
+        rz?: number;
+        sx?: number;
+        sy?: number;
+        sz?: number;
+    }): void;
+    dialog(playerId: number, spec: {
+        id: number;
+        hide?: boolean;
+        style?: number;
+        title?: string;
+        body?: string;
+        button1?: string;
+        button2?: string;
+        markdown?: boolean;
+    }): void;
+    documentView(playerId: number, spec: {
+        id: number;
+        close?: boolean;
+        title?: string;
+        file?: string;
+        buttons?: string;
+        requireEnd?: boolean;
+        closable?: boolean;
+    }): void;
+    vehiclePalette(playerId: number, colors: number[]): void;
+    vehiclePaint(id: number, spec: {
+        type?: string;
+        shader?: string;
+        params?: string;
+        values?: number[];
+        slots?: number;
+        livery?: string;
+        liveryMapping?: number;
+        liveryScale?: number;
+        liveryOpacity?: number;
+        liveryMultiply?: boolean;
+    } | null): void;
+    screenEffect(playerId: number, spec: {
+        id: number;
+        remove?: boolean;
+        file?: string;
+        params?: string;
+        values?: number[];
+        order?: number;
+        fadeMs?: number;
+    }): void;
+    gameMenu(playerId: number, spec: {
+        id: number;
+        hide?: boolean;
+        title?: string;
+        rows?: string;
+        row?: number;
+        footer?: string;
+        hints?: string;
+        columns?: number;
+        image?: string;
+    }): void;
+    checkpoint(playerId: number, spec: {
+        race: boolean;
+        enabled: boolean;
+        x?: number;
+        y?: number;
+        z?: number;
+        size?: number;
+        type?: number;
+        nextX?: number;
+        nextY?: number;
+        nextZ?: number;
+    }): void;
+    suggestions(playerId: number, id: number, start: number, list: string[]): void;
+    setVehicleInterior(id: number, interior: number): void;
+    setWorldView(viewer: number, target: number, visible: boolean): void;
+    worldSees(viewer: number, target: number): boolean;
+    setRadioNameHidden(id: number, hidden: boolean): void;
+    destroyVehicle(id: number): boolean;
+    vehicle(id: number): NativeVehicleState | null;
+    vehicleIds(): number[];
+    setVehicleColors(id: number, color1: number, color2: number): void;
+    repairVehicle(id: number): void;
+    setVehicleHealth(id: number, health: number): boolean;
+    /** The CDamageManager bytes (24), or [] for none. */
+    setVehicleDamage(id: number, damage: number[]): boolean;
+    respawnVehicle(id: number): void;
+    setVehiclePlate(id: number, plate: string): boolean;
+    setClientScript(name: string, code: string): void;
+    setClientScriptFile(path: string): boolean;
+    setBranding(logo: string, primary: number, secondary: number, background: string, showName: boolean): string;
+    rescanClientFiles(): number;
+    clientFiles(): {
+        path: string;
+        size: number;
+        sha256: string;
+    }[];
+    /** player: their id, or -1 for everyone. */
+    setMapMarker(player: number, id: string, x: number, y: number, icon: number, color: number, label: string): void;
+    removeMapMarker(player: number, id: string): void;
+    setMapOverlay(player: number, id: string, x1: number, y1: number, x2: number, y2: number, image: Buffer, opacity: number, layer: number): void;
+    setMapOverlayFile(player: number, id: string, x1: number, y1: number, x2: number, y2: number, file: string, opacity: number, layer: number): boolean;
+    removeMapOverlay(player: number, id: string): void;
+    setMapWorld(player: number, visible: boolean, background: number): void;
+    removeClientScript(name: string): boolean;
+    sendScriptMessage(id: number, channel: string, data: string): void;
+    broadcastScriptMessage(channel: string, data: string): void;
+    setVehicleRespawnDelay(id: number, ms: number): void;
+    createPed(model: number | string, x: number, y: number, z: number, heading: number, world: number, weapon: number, health: number, behaviour: number, visibleTo?: number[] | null, controller?: number | null): number;
+    destroyPed(id: number): boolean;
+    releasePed(id: number): boolean;
+    releaseVehicle(id: number): boolean;
+    population(world: number): NativePopulation;
+    pedIds(): number[];
+    setPopulation(world: number, settings: Partial<NativePopulation>): void;
+    ped(id: number): NativePedState | null;
+    orderPed(pedId: number, steps: NativePedStep[]): number;
+    cancelPedOrder(pedId: number): void;
+    pedSay(pedId: number, context: number, subtitle: string, ms: number, to: number[] | null, dialogue?: string, effects?: EncodedEffect[]): void;
+    playerSay(playerId: number, dialogue: string, subtitle: string, ms: number, to: number[] | null, effects?: EncodedEffect[]): void;
+    dialogueMs(key: string): number;
+    subtitle(playerId: number, text: string, ms: number): void;
+    setBlip(playerId: number, id: number, spec: {
+        kind: number;
+        x?: number;
+        y?: number;
+        z?: number;
+        target?: number;
+        color: number;
+        sprite?: number;
+        display?: number;
+        scale?: number;
+        pulse?: boolean;
+        shortRange?: boolean;
+    } | null): void;
+    hudText(playerId: number, kind: number, text: string, ms: number, style?: number): void;
+    draw(playerId: number, spec: NativeDraw): void;
+    screenFade(playerId: number, fadeIn: boolean, ms: number, color: number): void;
+    cutscene(playerId: number, id: number, action: number, name?: string): void;
+    playerAnim(playerId: number, block: string, name: string, loop: boolean, ms: number, stop: boolean, hold?: boolean, upperBody?: boolean): void;
+    playerLoop(playerId: number, block: string, name: string, upperBody: boolean, jetpack: boolean, hold?: boolean, noAttack?: boolean): void;
+    freezePlayer(playerId: number, frozen: boolean): void;
+    slidePlayer(playerId: number, x: number, y: number, z: number, heading: number): void;
+    animationSet(playerId: number, name: string, file: string): void;
+    customModel(playerId: number, spec: {
+        id: number;
+        base: number;
+        dff: string;
+        txd: string;
+    }): void;
+    splash(playerId: number, show: boolean, fadeMs: number, text: string): void;
+    hudToggles(playerId: number, hidden: number): void;
+    objectMaterial(playerId: number, spec: {
+        objectId: number;
+        index: number;
+        remove?: boolean;
+        model?: number;
+        txd?: string;
+        texture?: string;
+        color?: number;
+        file?: string;
+        isText?: boolean;
+        text?: string;
+        size?: number;
+        font?: string;
+        fontSize?: number;
+        bold?: boolean;
+        fontColor?: number;
+        backColor?: number;
+        align?: number;
+    }): void;
+    serverObject(playerId: number, spec: {
+        id: number;
+        remove?: boolean;
+        shatter?: boolean;
+        model?: number;
+        x?: number;
+        y?: number;
+        z?: number;
+        rx?: number;
+        ry?: number;
+        rz?: number;
+        noCollision?: boolean;
+        breakable?: boolean;
+        moveMs?: number;
+        streamDistance?: number;
+        interior?: number;
+    }): void;
+    pickup(playerId: number, spec: {
+        id: number;
+        remove?: boolean;
+        model?: number;
+        weapon?: number;
+        x?: number;
+        y?: number;
+        z?: number;
+        inVehicle?: boolean;
+        hidden?: boolean;
+        interior?: number;
+    }): void;
+    label(playerId: number, spec: {
+        id: number;
+        remove?: boolean;
+        text?: string;
+        x?: number;
+        y?: number;
+        z?: number;
+        on?: number;
+        target?: number;
+        color?: number;
+        distance?: number;
+        throughWalls?: boolean;
+        interior?: number;
+    }): void;
+    effect(playerId: number, spec: {
+        id: number;
+        stop?: boolean;
+        name?: string;
+        x?: number;
+        y?: number;
+        z?: number;
+        on?: number;
+        target?: number;
+        loop?: boolean;
+        color?: number;
+        size?: number;
+        count?: number;
+        spread?: number;
+        rise?: number;
+        life?: number;
+        carColor?: number;
+    }): void;
+    gameSound(playerId: number, spec: {
+        sound: number;
+        atSpot?: boolean;
+        x?: number;
+        y?: number;
+        z?: number;
+        mission?: boolean;
+        on?: number;
+        target?: number;
+        range?: number;
+        effects?: EncodedEffect[];
+        realism?: boolean;
+    }): void;
+    audioEnvironment(playerId: number, effects: EncodedEffect[]): void;
+    camera(playerId: number, spec: {
+        behind?: boolean;
+        id?: number;
+        steps?: number[];
+        points?: number[];
+        loop?: boolean;
+        widescreen?: boolean;
+        stop?: boolean;
+        freecam?: boolean;
+        freecamSpeed?: number;
+    }): void;
+    /** How long a sound file plays (ms), or -1. */
+    audioDuration(path: string): number;
+    notice(playerId: number, text: string, ms: number): void;
+    sound(playerId: number, spec: {
+        id: number;
+        stop?: boolean;
+        file?: string;
+        x?: number;
+        y?: number;
+        z?: number;
+        on?: number;
+        target?: number;
+        loop?: boolean;
+        volume?: number;
+        range?: number;
+        effects?: EncodedEffect[];
+        realism?: boolean;
+        speech?: boolean;
+    }): void;
+    interaction(playerId: number, id: number, spec: {
+        models: number[];
+        x: number;
+        y: number;
+        z: number;
+        radius: number;
+        prompt: string;
+        notify: boolean;
+    } | null): void;
+    ui(playerId: number, spec: {
+        doc: number;
+        action: number;
+        file?: string;
+        flags?: number;
+        events?: number;
+        change?: number;
+        element?: string;
+        name?: string;
+        value?: string;
+    }): void;
+    hudCounter(playerId: number, id: number, spec: {
+        label: string;
+        timer?: boolean;
+        countUp?: boolean;
+        value?: number;
+        max?: number;
+        bar?: boolean;
+        color?: number;
+        paused?: boolean;
+    } | null): void;
+    missionResult(playerId: number, kind: string, title: string, text: string, sound: boolean, ms: number): void;
+    setPedVisibility(pedId: number, playerIds: number[] | null): void;
+    setPedController(pedId: number, playerId: number | null): void;
+    setPedSettings(pedId: number, settings: {
+        reactions: number;
+        keepTask: boolean;
+        proofs: number;
+        notDraggable: boolean;
+        accuracy: number;
+        hostilePlayers: number[];
+        hostileRange: number;
+    }): void;
+    putPedInVehicle(id: number, vehicleId: number, seat: number): boolean;
+    removePedFromVehicle(id: number): void;
+    wreckVehicle(id: number, killerId?: number): void;
+    setVehicleRadio(id: number, station: number): boolean;
+    createSphereZone(x: number, y: number, z: number, radius: number, world?: number): number;
+    createBoxZone(x1: number, y1: number, z1: number, x2: number, y2: number, z2: number, world?: number): number;
+    destroyZone(id: number): boolean;
+    garages(): NativeGarageState[];
+    setGarageOpen(id: number, open: boolean): void;
+}
+interface NativeModule {
+    NativeServer: new (config: NativeServerConfig) => NativeServer;
+    isValidSkin(model: number): boolean;
+    componentSlot(part: number): number;
+    componentFits(model: number, part: number): boolean;
+    protocolVersion: number;
+    version: string;
+}
+export declare const native: NativeModule;
+export {};