@armoury/fivem-framework-client 0.0.0-stage → 1.0.7

package/dist/types/client/client-action-points.d.ts

@@ -0,0 +1,30 @@
+import { ClientEntities } from './client-entities';
+import { ActionPoint } from './models/action-point.model';
+import { Marker } from './models/marker.model';
+export declare class ClientActionPoints extends ClientEntities {
+    private chunkRadius;
+    private _actionPoints;
+    protected get actionPoints(): {
+        [posX: number]: {
+            [posY: number]: ActionPoint[];
+        };
+    };
+    private _cachedPlayerPosition;
+    protected get cachedPlayerPosition(): [number, number];
+    private _cachedPlayerRoundedPosition;
+    private _cachedIsPlayerInAnyVehicle;
+    protected createMarkers(markers: Marker[]): void;
+    protected clearMarkers(): void;
+    /** Creates one or multiple Action Points. Action points DO NOT include markers and/or blips.
+     * They only contain the logic executed when a position is met.
+    */
+    protected createActionPoints(...actionPoints: ActionPoint[]): void;
+    protected createActionPoint(actionPoint: ActionPoint): void;
+    protected clearActionPoint(id: string): void;
+    protected clearActionPoints(): void;
+    protected actionPointExistsAtPosition(posX: number, posY: number, posZ: number): boolean;
+    protected removeActionPoint(actionPoint: ActionPoint): void;
+    protected onThreadTriggered(optimizationType: string): void;
+    debug_ActionPoints(): void;
+    private roundToNearest;
+}

package/dist/types/client/client-entities.d.ts

@@ -0,0 +1,43 @@
+import { ClientBase } from './client.base';
+import { Blip } from './models/blip.model';
+import { Marker } from './models/marker.model';
+export declare class ClientEntities extends ClientBase {
+    private _blips;
+    protected get blips(): Blip[];
+    private _markers;
+    protected get markers(): Marker[];
+    private _vehicles;
+    protected get vehicles(): number[];
+    private _peds;
+    protected get peds(): number[];
+    private _waypoints;
+    protected get waypoints(): number[];
+    private _checkpoints;
+    protected get checkpoints(): Map<number, number[]>;
+    constructor();
+    protected createBlips(blips: Blip[]): void;
+    protected createBlip(blip: Blip): number;
+    protected clearBlip(blipId: number): void;
+    protected clearBlips(): void;
+    private refreshBlips;
+    /** Defines a custom, irreplaceable waypoint */
+    protected createWaypoint(pos: number[], title?: string, color?: number, id?: number, routeColor?: number, diameter?: number): number;
+    protected clearWaypoints(): void;
+    protected clearWaypoint(waypoint: number, ignoreSplice?: boolean): void;
+    protected createCheckpoint(type: number, posX1: number, posY1: number, posZ1: number, posX2: number | null, posY2: number | null, posZ2: number | null, diameter: number, red: number, green: number, blue: number, alpha: number, reserved: number): number;
+    protected clearCheckpoint(checkpoint: number): void;
+    protected clearCheckpointByPosition(pos: number[]): void;
+    /** Defines permanent markers. Handles draw-per-tick automatically. */
+    protected createMarkers(markers: Marker[]): void;
+    protected clearMarkers(): void;
+    /** Wrapper of FiveM's native CreateVehicle - includes requesting the model */
+    protected createVehicleAsync(modelHash: string | number, x: number, y: number, z: number, heading: number, isNetwork: boolean, netMissionEntity: boolean, putPlayerInVehicle?: boolean): Promise<number>;
+    protected removeVehicle(vehicle: number): void;
+    protected removePed(ped: number): void;
+    protected createPedInsideVehicleAsync(vehicle: number, pedType: number, modelHash: number | string, seat: number, isNetwork: boolean, bScriptHostPed: boolean): Promise<number>;
+    protected createPedAsync(pedType: number, modelHash: number, x: number, y: number, z: number, heading: number, isNetwork: boolean, bScriptHostPed: boolean): Promise<number>;
+    protected playAnimForPed(ped: number, animationDict: string, animationName: string, duration: number, flag?: number, blendInSpeed?: number, blendOutSpeed?: number): Promise<void>;
+    protected setPedModelAsync(ped: number, modelHash: number): Promise<boolean>;
+    private assignDefaultEntityListeners;
+    protected onRefreshPlayersInVirtualWorld(): void;
+}

package/dist/types/client/client-hud.controller.d.ts

@@ -0,0 +1,4 @@
+import { ClientActionPoints } from './client-action-points';
+export declare class ClientHudController extends ClientActionPoints {
+    protected addToFeed(feedItemLength?: number, ...texts: string[]): void;
+}

package/dist/types/client/client-ui.controller.d.ts

@@ -0,0 +1,19 @@
+import EventEmitter from 'events';
+import { ClientController } from './client.controller';
+import { IClientWithUIController } from './interfaces/client-ui.interface';
+export declare class ClientWithUIController extends ClientController implements IClientWithUIController {
+    private uiDisplay;
+    private uiDisplayCooldownTimestamp;
+    constructor();
+    protected onIncomingUIMessageEvent: EventEmitter;
+    protected isUIShowing(): boolean;
+    protected isUIOnCooldown(): boolean;
+    protected showUI(ignoreCursorMode?: boolean, ignoreFocus?: boolean): void;
+    protected hideUI(): void;
+    protected addUIListener(name: string): void;
+    /** Remember that you NEED to use addUIListener in order to be able to listen for events */
+    protected onIncomingUIMessage(eventName: string, eventData: any): void;
+    onForceShowUI(data: any, ignoreCursorMode?: boolean, ignoreFocus?: boolean): void;
+    onForceHideUI(): void;
+    private addDefaultListeners;
+}

package/dist/types/client/client.base.d.ts

@@ -0,0 +1,22 @@
+export declare class ClientBase {
+    private tickInstance;
+    private tickFunctions;
+    protected routingBucket: number;
+    constructor();
+    /** ATTENTION! The ID of a tick function needs to be UNIQUE! */
+    protected addToTick(...functions: {
+        id: string;
+        function: Function;
+    }[]): void;
+    protected addToTickUnique(...functions: {
+        id: string;
+        function: Function;
+    }[]): void;
+    /** Removes tick function with the provided id. */
+    protected removeFromTick(id: string): void;
+    private refreshTicks;
+    private removeTickDuplicates;
+    private assignBaseListeners;
+    protected setEntityRoutingBucket(routingBucket: number): void;
+    protected getPlayerInfo(stat: string, playerId?: number): string | number | number[] | string[] | Object;
+}

package/dist/types/client/client.controller.d.ts

@@ -0,0 +1,12 @@
+import { ClientHudController } from './client-hud.controller';
+export declare class ClientController extends ClientHudController {
+    protected translationFile?: {
+        [key: string]: string;
+    };
+    private _translationLanguage;
+    protected get translationLanguage(): string;
+    protected translate(key: string, params?: {
+        [key: string]: string;
+    }): string;
+    protected setTranslationLanguage(language: string): void;
+}

package/dist/types/client/constants/color.mappings.d.ts

@@ -0,0 +1,3 @@
+export declare const COLOR_MAPPINGS: {
+    [key: number]: number[];
+};

package/dist/types/client/index.d.ts

@@ -0,0 +1,10 @@
+/// <reference path="../ambient.declarations.d.ts" />
+import 'reflect-metadata';
+import { Provider } from 'injection-js';
+import { ClientActionPointsService, ClientBlipsService, ClientCheckpointsService, ClientMarkersService, ClientPedsService, ClientSessionService, ClientTicksService, ClientUIService, ClientVehiclesService, ClientWaypointsService, ClientHudService } from './services';
+export declare const CLIENT_PROVIDERS: (typeof ClientTicksService | typeof ClientActionPointsService | typeof ClientBlipsService | typeof ClientCheckpointsService | typeof ClientHudService | typeof ClientMarkersService | typeof ClientPedsService | typeof ClientSessionService | typeof ClientVehiclesService | typeof ClientUIService | typeof ClientWaypointsService)[];
+export declare function Client_Init<T extends {
+    new (...args: any[]): any;
+} & Provider>(_class: T, ...providers: Provider[]): T;
+export * from './services';
+export * from '@armoury/fivem-framework-common';

package/dist/types/client/interfaces/client-ui.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IClientWithUIController {
+    onForceShowUI(data: any): void;
+    onForceHideUI(): void;
+}

package/dist/types/client/models/action-point.model.d.ts

@@ -0,0 +1,10 @@
+export interface ActionPoint {
+    pos: number[];
+    action: Function;
+    id?: string;
+    once?: boolean;
+    range?: number;
+    onfootOnly?: boolean;
+    inVehicleOnly?: boolean;
+    onceIf?: Function;
+}

package/dist/types/client/models/blip.model.d.ts

@@ -0,0 +1,14 @@
+export interface Blip {
+    id: number;
+    color: number;
+    title: string;
+    pos: number[];
+    scale?: number;
+    alpha?: number;
+    entityId?: number;
+    type?: 'coords' | 'range' | 'entity';
+    longRange?: boolean;
+}
+export interface BlipMonitored extends Blip {
+    instance?: number | null;
+}

package/dist/types/client/models/index.d.ts

@@ -0,0 +1,5 @@
+export * from './action-point.model';
+export * from './blip.model';
+export * from './marker.model';
+export * from './ui-button.model';
+export * from './ui-dialog.model';

package/dist/types/client/models/marker.model.d.ts

@@ -0,0 +1,22 @@
+import { Blip } from "./blip.model";
+export interface Marker {
+    marker: number;
+    pos: number[];
+    scale: number;
+    rgba: number[];
+    renderDistance: number;
+    underlyingCircle?: MarkerCircle;
+    blip?: Blip;
+    rotation?: number[];
+    textureDict?: string;
+    textureName?: string;
+    fadeInDisabled?: boolean;
+}
+export interface MarkerMonitored extends Marker {
+    instance?: number | null;
+}
+export interface MarkerCircle {
+    marker: number;
+    scale: number;
+    rgba?: number[];
+}

package/dist/types/client/models/ui-button.model.d.ts

@@ -0,0 +1,8 @@
+export interface UIButton {
+    disabled?: boolean;
+    tooltip?: string;
+    title: string;
+    subtitle?: string;
+    icon?: string;
+    unlocked?: boolean;
+}

package/dist/types/client/models/ui-dialog.model.d.ts

@@ -0,0 +1,9 @@
+export interface UIDialog {
+    buttons: UIDialogButton[];
+    content: string;
+    dialogId: string;
+    title: string;
+}
+export interface UIDialogButton {
+    title: string;
+}

package/dist/types/client/services/client-action-points.service.d.ts

@@ -0,0 +1,29 @@
+import { ClientTicksService } from './client-ticks.service';
+import { ActionPoint } from '../models';
+export declare class ClientActionPointsService {
+    private _ticksService;
+    private chunkRadius;
+    private _actionPoints;
+    get actionPoints(): {
+        [posX: number]: {
+            [posY: number]: ActionPoint[];
+        };
+    };
+    private _cachedPlayerPosition;
+    get cachedPlayerPosition(): [number, number];
+    private _cachedPlayerRoundedPosition;
+    private _cachedIsPlayerInAnyVehicle;
+    constructor(_ticksService: ClientTicksService);
+    /** Creates one or multiple Action Points. Action points DO NOT include markers and/or blips.
+     * They only contain the logic executed when a position is met.
+    */
+    create(...actionPoints: ActionPoint[]): void;
+    protected createActionPoint(actionPoint: ActionPoint): void;
+    remove(actionPoint: ActionPoint): void;
+    removeById(id: string): void;
+    removeAll(): void;
+    existsAtPosition(posX: number, posY: number, posZ: number): boolean;
+    protected onThreadTriggered(optimizationType: string): void;
+    debug_ActionPoints(): void;
+    private roundToNearest;
+}

package/dist/types/client/services/client-blips.service.d.ts

@@ -0,0 +1,10 @@
+import { Blip, BlipMonitored } from "../models";
+export declare class ClientBlipsService {
+    protected _blips: BlipMonitored[];
+    get blips(): Blip[];
+    createMultiple(...blips: Blip[]): void;
+    create(blip: Blip): number;
+    clear(blipId: number): void;
+    clearAll(): void;
+    private refresh;
+}

package/dist/types/client/services/client-checkpoints.service.d.ts

@@ -0,0 +1,7 @@
+export declare class ClientCheckpointsService {
+    private _checkpoints;
+    get checkpoints(): Map<number, number[]>;
+    create(type: number, posX1: number, posY1: number, posZ1: number, posX2: number | null, posY2: number | null, posZ2: number | null, diameter: number, red: number, green: number, blue: number, alpha: number, reserved: number): number;
+    clear(checkpoint: number): void;
+    clearByPosition(pos: number[]): void;
+}

package/dist/types/client/services/client-hud.service.d.ts

@@ -0,0 +1,3 @@
+export declare class ClientHudService {
+    addToFeed(feedItemLength?: number, ...texts: string[]): void;
+}

package/dist/types/client/services/client-markers.service.d.ts

@@ -0,0 +1,11 @@
+import { Marker } from "../models";
+import { ClientActionPointsService } from "./client-action-points.service";
+export declare class ClientMarkersService {
+    private _actionPoints;
+    private _markers;
+    get markers(): Marker[];
+    constructor(_actionPoints: ClientActionPointsService);
+    /** Defines permanent markers. Handles draw-per-tick automatically. */
+    create(...markers: Marker[]): void;
+    clearAll(): void;
+}

package/dist/types/client/services/client-peds.service.d.ts

@@ -0,0 +1,10 @@
+export declare class ClientPedsService {
+    private _peds;
+    get peds(): number[];
+    constructor();
+    remove(ped: number): void;
+    createInsideVehicleAsync(vehicle: number, pedType: number, modelHash: number | string, seat: number, isNetwork: boolean, bScriptHostPed: boolean): Promise<number>;
+    createAsync(pedType: number, modelHash: number, x: number, y: number, z: number, heading: number, isNetwork: boolean, bScriptHostPed: boolean): Promise<number>;
+    playAnim(ped: number, animationDict: string, animationName: string, duration: number, flag?: number, blendInSpeed?: number, blendOutSpeed?: number): Promise<void>;
+    setModelAsync(ped: number, modelHash: number): Promise<boolean>;
+}

package/dist/types/client/services/client-session.service.d.ts

@@ -0,0 +1,3 @@
+export declare class ClientSessionService {
+    getPlayerInfo(stat: string, playerId?: number): string | number | number[] | string[] | Object;
+}

package/dist/types/client/services/client-ticks.service.d.ts

@@ -0,0 +1,21 @@
+export declare class ClientTicksService {
+    private tickInstance;
+    private tickFunctions;
+    protected routingBucket: number;
+    constructor();
+    /** ATTENTION! The ID of a tick function needs to be UNIQUE! */
+    add(...functions: {
+        id: string;
+        function: Function;
+    }[]): void;
+    addUnique(...functions: {
+        id: string;
+        function: Function;
+    }[]): void;
+    /** Removes tick function with the provided id. */
+    remove(id: string): void;
+    private refreshTicks;
+    private removeTickDuplicates;
+    private assignBaseListeners;
+    protected setEntityRoutingBucket(routingBucket: number): void;
+}

package/dist/types/client/services/client-translate.service.d.ts

@@ -0,0 +1,13 @@
+import { ClientSessionService } from "./client-session.service";
+export declare class ClientTranslateService {
+    private readonly _translations;
+    private readonly _session;
+    private _language;
+    get language(): string;
+    constructor(_translations: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    }, _session: ClientSessionService);
+    instant(key: string): string;
+}

package/dist/types/client/services/client-ui.service.d.ts

@@ -0,0 +1,19 @@
+import { ClientTicksService } from "./client-ticks.service";
+import { Observable } from "rxjs";
+export declare class ClientUIService {
+    private _ticksService;
+    private _onShow$;
+    get onShow$(): Observable<any>;
+    private _onHide$;
+    get onHide$(): Observable<any>;
+    private _visible;
+    get visible(): boolean;
+    private cooldownTimestamp;
+    constructor(_ticksService: ClientTicksService);
+    show(ignoreCursorMode?: boolean, ignoreFocus?: boolean): void;
+    hide(): void;
+    protected onForceShowUI(data: any): void;
+    protected onForceHideUI(data: any): void;
+    dismiss(): void;
+    isOnCooldown(): boolean;
+}

package/dist/types/client/services/client-vehicles.service.d.ts

@@ -0,0 +1,8 @@
+export declare class ClientVehiclesService {
+    private _vehicles;
+    get vehicles(): number[];
+    constructor();
+    /** Wrapper of FiveM's native CreateVehicle - includes requesting the model */
+    createAsync(modelHash: string | number, x: number, y: number, z: number, heading: number, isNetwork: boolean, netMissionEntity: boolean, putPlayerInVehicle?: boolean): Promise<number>;
+    remove(vehicle: number): void;
+}

package/dist/types/client/services/client-waypoints.service.d.ts

@@ -0,0 +1,13 @@
+import { ClientBlipsService } from "./client-blips.service";
+import { ClientCheckpointsService } from "./client-checkpoints.service";
+export declare class ClientWaypointsService {
+    private _blipsService;
+    private _checkpointsService;
+    private _waypoints;
+    get waypoints(): number[];
+    constructor(_blipsService: ClientBlipsService, _checkpointsService: ClientCheckpointsService);
+    /** Defines a custom, irreplaceable waypoint */
+    protected createWaypoint(pos: number[], title?: string, color?: number, id?: number, routeColor?: number, diameter?: number): number;
+    protected clearWaypoints(): void;
+    protected clearWaypoint(waypoint: number, ignoreSplice?: boolean): void;
+}

package/dist/types/client/services/index.d.ts

@@ -0,0 +1,12 @@
+export * from './client-action-points.service';
+export * from './client-blips.service';
+export * from './client-checkpoints.service';
+export * from './client-hud.service';
+export * from './client-markers.service';
+export * from './client-peds.service';
+export * from './client-session.service';
+export * from './client-ticks.service';
+export * from './client-translate.service';
+export * from './client-vehicles.service';
+export * from './client-ui.service';
+export * from './client-waypoints.service';

package/package.json

@@ -1,6 +1,31 @@
-{
-  "name": "@armoury/fivem-framework-client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+{
+  "name": "@armoury/fivem-framework-client",
+  "version": "1.0.7",
+  "description": "Client APIs for the Armoury FiveM framework",
+  "main": "dist/cjs/client/index.js",
+  "module": "dist/esm/client/index.js",
+  "types": "dist/types/client/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/client/index.d.ts",
+      "import": "./dist/esm/client/index.js",
+      "require": "./dist/cjs/client/index.js"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "npm run build:cjs && npm run build:esm && npm run build:types",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json && node ../../tools/move_ambientdeclaration.js client"
+  },
+  "dependencies": {
+    "@armoury/fivem-framework-common": "1.0.7",
+    "injection-js": "^2.4.0",
+    "reflect-metadata": "^0.2.1",
+    "rxjs": "^7.8.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.