@altv/types-client - npm Package Compare versions

Comparing version 1.5.0 to 1.5.1

index.d.ts

@@ -202,3 +202,2 @@ declare module "alt-client" {
    *
-   * @beta
    */
@@ -332,3 +331,2 @@ export interface IVehicleHandling {
    *
-   * @beta
    */
@@ -350,78 +348,52 @@ export const branch: string;
 
-    /** @beta */
     public get length(): number;
 
-    /** @beta */
     public toArray(): [number, number, number];
 
-    /** @beta */
     public add(x: number, y: number, z: number): Vector3;
 
-    /** @beta */
     public add(value: number): Vector3;
 
-    /** @beta */
     public add(array: [number, number, number]): Vector3;
 
-    /** @beta */
     public add(vector: IVector3): Vector3;
 
-    /** @beta */
     public sub(x: number, y: number, z: number): Vector3;
 
-    /** @beta */
     public sub(value: number): Vector3;
 
-    /** @beta */
     public sub(array: [number, number, number]): Vector3;
 
-    /** @beta */
     public sub(vector: IVector3): Vector3;
 
-    /** @beta */
     public div(x: number, y: number, z: number): Vector3;
 
-    /** @beta */
     public div(value: number): Vector3;
 
-    /** @beta */
     public div(array: [number, number, number]): Vector3;
 
-    /** @beta */
     public div(vector: IVector3): Vector3;
 
-    /** @beta */
     public mul(x: number, y: number, z: number): Vector3;
 
-    /** @beta */
     public mul(value: number): Vector3;
 
-    /** @beta */
     public mul(array: [number, number, number]): Vector3;
 
-    /** @beta */
     public mul(vector: IVector3): Vector3;
 
-    /** @beta */
     public negative(): Vector3;
 
-    /** @beta */
     public normalize(): Vector3;
 
-    /** @beta */
     public distanceTo(vector: IVector3): number;
 
-    /** @beta */
     public angleTo(vector: IVector3): Vector3;
 
-    /** @beta */
     public angleToDegrees(vector: IVector3): Vector3;
 
-    /** @beta */
     public toRadians(): Vector3;
 
-    /** @beta */
     public toDegrees(): Vector3;
 
-    /** @beta */
     public isInRange(vector: IVector3, range: number): boolean;
@@ -505,5 +477,2 @@ }
 
-  /**
-  * @beta
-  */
   export class Checkpoint extends WorldObject {
@@ -523,3 +492,2 @@ public checkpointType: CheckpointType;
   export class Entity extends WorldObject {
-    /** @beta */
     public static readonly all: Array<Entity>;
@@ -544,3 +512,2 @@
 
-    /** @beta */
     public readonly visible: boolean;
@@ -625,4 +592,5 @@
      *
+     * @alpha
      */
-    public readonly currentWeaponTintIndex: number;
+    //public readonly currentWeaponTintIndex: number;
 
@@ -638,5 +606,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly isJumping: boolean;
+    //public readonly isJumping: boolean;
 
@@ -658,5 +626,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly isShooting: boolean;
+    //public readonly isShooting: boolean;
 
@@ -666,5 +634,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly isReloading: boolean;
+    //public readonly isReloading: boolean;
 
@@ -764,3 +732,2 @@ /**
      *
-     * @beta
      */
@@ -794,5 +761,5 @@ public handling: IVehicleHandling;
      *
-     * @beta
+     * @alpha
      */
-    public readonly destroyed: boolean;
+    //public readonly isDestroyed: boolean;
 
@@ -802,5 +769,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly modKitsCount: number;
+    //public readonly modKitsCount: number;
 
@@ -810,5 +777,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly modKit: number;
+    //public readonly modKit: number;
 
@@ -818,5 +785,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly primaryColor: number;
+    //public readonly primaryColor: number;
 
@@ -826,5 +793,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly customPrimaryColor: RGBA;
+    //public readonly customPrimaryColor: RGBA;
 
@@ -834,5 +801,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly secondaryColor: number;
+    //public readonly secondaryColor: number;
 
@@ -842,5 +809,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly customSecondaryColor: RGBA;
+    //public readonly customSecondaryColor: RGBA;
 
@@ -850,5 +817,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly pearlColor: number;
+    //public readonly pearlColor: number;
 
@@ -858,5 +825,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly wheelColor: number;
+    //public readonly wheelColor: number;
 
@@ -866,5 +833,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly interiorColor: number;
+    //public readonly interiorColor: number;
 
@@ -874,5 +841,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly dashboardColor: number;
+    //public readonly dashboardColor: number;
 
@@ -882,5 +849,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly tireSmokeColor: number;
+    //public readonly tireSmokeColor: number;
 
@@ -890,5 +857,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly wheelType: number;
+    //public readonly wheelType: number;
 
@@ -898,5 +865,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly frontWheels: number;
+    //public readonly frontWheels: number;
 
@@ -906,5 +873,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly rearWheels: number;
+    //public readonly rearWheels: number;
 
@@ -914,5 +881,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly customTires: boolean;
+    //public readonly customTires: boolean;
 
@@ -922,5 +889,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly darkness: number;
+    //public readonly darkness: number;
 
@@ -930,5 +897,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly numberPlateIndex: number;
+    //public readonly numberPlateIndex: number;
 
@@ -938,5 +905,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly numberPlateText: string;
+    //public readonly numberPlateText: string;
 
@@ -946,5 +913,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly windowTint: number;
+    //public readonly windowTint: number;
 
@@ -954,5 +921,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly dirtLevel: number;
+    //public readonly dirtLevel: number;
 
@@ -962,5 +929,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly neon: IVehicleNeon;
+    //public readonly neon: IVehicleNeon;
 
@@ -970,5 +937,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly neonColor: RGBA;
+    //public readonly neonColor: RGBA;
 
@@ -978,5 +945,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly livery: number;
+    //public readonly livery: number;
 
@@ -986,5 +953,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly roofLivery: number;
+    //public readonly roofLivery: number;
 
@@ -994,5 +961,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly engineOn: boolean;
+    //public readonly engineOn: boolean;
 
@@ -1002,5 +969,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly handbrakeActive: boolean;
+    //public readonly handbrakeActive: boolean;
 
@@ -1010,5 +977,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly headlightColor: number;
+    //public readonly headlightColor: number;
 
@@ -1018,5 +985,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly activeRadioStation: number;
+    //public readonly activeRadioStation: number;
 
@@ -1026,5 +993,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly sirenActive: boolean;
+    //public readonly sirenActive: boolean;
 
@@ -1034,5 +1001,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly lockState: number;
+    //public readonly lockState: number;
 
@@ -1042,5 +1009,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly daylightOn: boolean;
+    //public readonly daylightOn: boolean;
 
@@ -1050,5 +1017,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly nightlightOn: boolean;
+    //public readonly nightlightOn: boolean;
 
@@ -1058,5 +1025,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly roofState: number;
+    //public readonly roofState: number;
 
@@ -1066,5 +1033,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly flamethrowerActive: boolean;
+    //public readonly flamethrowerActive: boolean;
 
@@ -1074,5 +1041,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly lightsMultiplier: number;
+    //public readonly lightsMultiplier: number;
 
@@ -1082,5 +1049,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly engineHealth: number;
+    //public readonly engineHealth: number;
 
@@ -1090,5 +1057,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly petrolTankHealth: number;
+    //public readonly petrolTankHealth: number;
 
@@ -1098,5 +1065,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly repairsCount: number;
+    //public readonly repairsCount: number;
 
@@ -1106,5 +1073,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly bodyHealth: number;
+    //public readonly bodyHealth: number;
 
@@ -1114,5 +1081,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly bodyAdditionalHealth: number;
+    //public readonly bodyAdditionalHealth: number;
 
@@ -1122,5 +1089,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly hasArmoredWindows: boolean;
+    //public readonly hasArmoredWindows: boolean;
 
@@ -1130,5 +1097,5 @@ /**
      *
-     * @beta
+     * @alpha
      */
-    public readonly manualEngineControl: boolean;
+    //public readonly manualEngineControl: boolean;
 
@@ -1161,3 +1128,3 @@ /**
      *
-     * @param url URL.
+     * @param url URL of the html file.
      * @param isOverlay true to render as overlay, false to render on game's GUI stage
@@ -1168,5 +1135,32 @@ */
     /**
+     * Creates a WebView.
+     *
+     * @param url URL of the html file.
+     * @param pos x, y coordinates of the position
+     */
+    constructor(url: string, pos: IVector2);
+
+    /**
+     * Creates a custom size WebView and specific pos.
+     *
+     * @param url URL of the html file.
+     * @param pos x, y coordinates of the position
+     * @param size x, y to define the size
+     */
+    constructor(url: string, pos: IVector2, size: IVector2);
+
+    /**
+     * Creates a custom size WebView and specific pos.
+     *
+     * @param url URL of the html file.
+     * @param isOverlay true to render as overlay, false to render on game's GUI stage
+     * @param pos x, y coordinates of the position
+     * @param size x, y to define the size
+     */
+    constructor(url: string, isOverlay: boolean, pos: IVector2, size: IVector2);
+
+    /**
      * Creates a WebView rendered on game object.
      *
-     * @param url URL.
+     * @param url URL of the html file.
      * @param propHash Hash of object to render on.
@@ -1216,3 +1210,2 @@ * @param targetTexture Name of object's texture to replace.
   export class Blip extends WorldObject {
-    /** @beta */
     public static routeColor: RGBA;
@@ -1232,3 +1225,2 @@
 
-    /** @beta */
     public display: number;
@@ -1289,3 +1281,2 @@
 
-    /** @beta */
     public size: number;
@@ -1389,3 +1380,2 @@
      *
-     * @beta
      */
@@ -1408,3 +1398,5 @@ public static getForHandlingName(handlingHash: number): HandlingData;
     public vTilesY: number;
-
+    
+    constructor(zoomDataId: number);
+    
     public static get(zoomData: string): MapZoomData;
@@ -1506,2 +1498,16 @@
     static muteInput: boolean;
+    
+    /**
+     * Determines if the voice activation is enabled.
+     * 
+     * @alpha
+     */
+    static activityInputEnabled: boolean;
+
+    /**
+     * Returns the keycode of the voice activation key.
+     * 
+     * @alpha
+     */
+    static activationKey: number;
   }
@@ -1673,3 +1679,2 @@
    *
-   * @beta
    */
@@ -1742,3 +1747,3 @@ export function isInStreamerMode(): boolean;
   /**
-   * Unsubscribes from client event handler with specified listener.
+   * Unsubscribes from client event with specified listener.
    *
@@ -1752,3 +1757,3 @@ * @remarks Listener should be of the same reference as when event was subscribed.
   /**
-   * Unsubscribes from server event handler with specified listener.
+   * Unsubscribes from server event with specified listener.
    *
@@ -1762,3 +1767,3 @@ * @remarks Listener should be of the same reference as when event was subscribed.
   /**
-   * Subscribes to client event handler with specified listener.
+   * Subscribes to client event with specified listener.
    *
@@ -1770,7 +1775,12 @@ * @param eventName Name of the event.
 
-  /** @beta */
+  /**
+   * Subscribes to client event with specified listener, which only triggers once.
+   *
+   * @param eventName Name of the event.
+   * @param listener Listener that should be added.
+   */
   export function once<K extends keyof IClientEvent>(eventName: K, listener: IClientEvent[K]): void;
 
   /**
-   * Subscribes to client event handler with specified listener.
+   * Subscribes to client event with specified listener.
    *
@@ -1782,7 +1792,12 @@ * @param eventName Name of the event.
 
-  /** @beta */
+  /**
+   * Subscribes to client event with specified listener, which only triggers once.
+   *
+   * @param eventName Name of the event.
+   * @param listener Listener that should be added.
+   */
   export function once<S extends string>(event: Exclude<S, keyof IClientEvent>, listener: (...args: any[]) => void | Promise<void>): void;
 
   /**
-   * Subscribes to client event handler with specified listener.
+   * Subscribes to server event with specified listener.
    *
@@ -1794,3 +1809,8 @@ * @param eventName Name of the event.
 
-  /** @beta */
+  /**
+   * Subscribes to server event with specified listener, which only triggers once.
+   *
+   * @param eventName Name of the event.
+   * @param listener Listener that should be added.
+   */
   export function onceServer(eventName: string, listener: (...args: any[]) => void): void;
@@ -1805,7 +1825,6 @@
   /**
-   * The output is returned as a string.
+   * The output is returned as a base64 string.
    *
    * @return Return is dependent on the success of the operation.
    *
-   * @beta
    */
@@ -1815,3 +1834,3 @@ export function takeScreenshot(): Promise<string>;
   /**
-   * The output is returned as a string.
+   * The output is returned as a base64 string.
    *
@@ -1821,3 +1840,2 @@ * @return Return is dependent on the success of the operation.
    *
-   * @beta
    */
@@ -1884,3 +1902,2 @@ export function takeScreenshotGameOnly(): Promise<string>;
    *
-   * @beta
    */
@@ -1922,3 +1939,14 @@ export function setRotationVelocity(scriptID: number, x: number, y: number, z: number): void;
 
+  /** @alpha */
   export class WebSocketClient extends BaseObject {
+    public autoReconnect: boolean;
+
+    public perMessageDeflate: boolean;
+
+    public pingInterval: number;
+
+    public url: string;
+
+    public readonly readyState: WebSocketReadyState;
+
     constructor(url: string);
@@ -1943,17 +1971,27 @@
     public addSubProtocol(protocol: string): void;
-
+    
     public getSubProtocols(): string[];
-
+    
     public setExtraHeader(header: string, value: string): void;
+  }
 
-    public autoReconnect: boolean;
+  /**
+   * Load a specific ytyp file.
+   *
+   * @param path Relative path to the game folder.
+   * @remarks Example: alt.loadYtyp("x64u.rpf/levels/gta5/_hills/country_06/country_06_metadata.rpf/cs6_08_interior_cs6_08_mine_int.ytyp")
+   *
+   * @alpha
+   */
+  export function loadYtyp(path: string): boolean;
 
-    public perMessageDeflate: boolean;
-
-    public pingInterval: number;
-
-    public url: string;
-
-    public readonly readyState: WebSocketReadyState;
-  }
+  /**
+   * Unload a specific ytyp file.
+   *
+   * @param path Relative path to the game folder.
+   * @remarks Example: alt.unloadYtyp("x64u.rpf/levels/gta5/_hills/country_06/country_06_metadata.rpf/cs6_08_interior_cs6_08_mine_int.ytyp")
+   *
+   * @alpha
+   */
+   export function unloadYtyp(path: string): boolean;
 }

package.json

 {
   "name": "@altv/types-client",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "This package contains types definitions for alt:V client-side module.",
@@ -5,0 +5,0 @@ "types": "index.d.ts",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

49373

increased by3.91%

Lines of code

1586

increased by1.93%

No dependency changes