@nativewrappers/fivem 0.0.1 → 0.0.4

package/lib/client/utils/Animations.d.ts

@@ -11,7 +11,10 @@ export declare const LoadAnimDict: (animDict: string, waitTime?: number) => Prom
  * @param waitTime how long to wait for the dictionary to load
  * @returns if the animation successfully loaded, if the animation failed to load it will return an array of animations that failed to load
  */
-export declare const LoadAnimDictArray: (animDict: string[], waitTime?: number) => Promise<[boolean, string[] | null]>;
+export declare const LoadAnimDictArray: (animDict: string[], waitTime?: number) => Promise<[
+    boolean,
+    string[] | null
+]>;
 /**
  * A utility to unload multiple animation dictionary
  * @param animDict the animation dictionaries to unload

package/lib/server/Events.d.ts

@@ -1,35 +1,15 @@
 import { Player } from './entities/Player';
-/** @typedef {(player: Player, ...args: any[]) => void} NetEvent */
 export type NetEvent = (player: Player, ...args: any[]) => void;
 export declare class Events {
-    /**
-     * @public
-     * @static
-     * @returns {void}
-     */
     static cancel(): void;
-    /**
-     * @public
-     * @static
-     * @returns {boolean}
-     */
     static wasCanceled(): boolean;
-    /**
-     * @public
-     * @static
-     */
     static get InvokingResource(): string;
     /**
      * An onNet wrapper that properly converts the type into the correct type
-     * @public
-     * @default (eventName: string, event: import("/home/skaggs/projects/fivem/server/src/Events").NetEvent) => void
      */
     onNet: (eventName: string, event: NetEvent) => void;
     /**
      * An on wrapper that properly converts the classes
-     * @public
-     * @default (eventName: string, event: import("/home/skaggs/projects/fivem/server/src/Events").NetEvent) => void
      */
     on: (eventName: string, event: NetEvent) => void;
 }
-/** @typedef {(player: Player, ...args: any[]) => void} NetEvent */

package/lib/server/Events.js

@@ -3,10 +3,6 @@ import { Ped, Prop, Vehicle, Entity } from './entities';
 import { Player } from './entities/Player';
 import { ClassTypes } from './enum/ClassTypes';
 import { Vector2, Vector3, Vector4 } from './utils';
-/**
- * @param {...any} [args]
- * @returns {any[]}
- */
 const getClassFromArguments = (...args) => {
     const newArgs = [];
     for (const arg of args) {
@@ -54,8 +50,6 @@ export class Events {
     constructor() {
         /**
          * An onNet wrapper that properly converts the type into the correct type
-         * @public
-         * @default (eventName: string, event: import("/home/skaggs/projects/fivem/server/src/Events").NetEvent) => void
          */
         this.onNet = (eventName, event) => {
             onNet(eventName, (...args) => {
@@ -65,8 +59,6 @@ export class Events {
         };
         /**
          * An on wrapper that properly converts the classes
-         * @public
-         * @default (eventName: string, event: import("/home/skaggs/projects/fivem/server/src/Events").NetEvent) => void
          */
         this.on = (eventName, event) => {
             on(eventName, (...args) => {
@@ -75,28 +67,13 @@ export class Events {
             });
         };
     }
-    /**
-     * @public
-     * @static
-     * @returns {void}
-     */
     static cancel() {
         CancelEvent();
     }
-    /**
-     * @public
-     * @static
-     * @returns {boolean}
-     */
     static wasCanceled() {
         return WasEventCanceled();
     }
-    /**
-     * @public
-     * @static
-     */
     static get InvokingResource() {
         return GetInvokingResource();
     }
 }
-/** @typedef {(player: Player, ...args: any[]) => void} NetEvent */

package/lib/server/Game.d.ts

@@ -1,56 +1,25 @@
 import { Player } from './entities/Player';
 export declare abstract class Game {
-    /**
-     * @public
-     * @static
-     * @default Map<any, any>
-     */
     static hashCache: Map<string, number>;
     /**
      * Calculate the Jenkins One At A Time (joaat) has from the given string.
-     * @public
-     * @static
-     * @param {string} input The input string to calculate the hash
-     * @returns {number}
+     *
+     * @param input The input string to calculate the hash
      */
     static generateHash(input: string): number;
     /**
      * Gets how many milliseconds the game has been open this session
-     * @public
-     * @static
      */
     static get GameTime(): number;
-    /**
-     * @public
-     * @static
-     */
     static get GameBuild(): number;
-    /**
-     * @public
-     * @static
-     */
     static get GameName(): string;
-    /**
-     * @public
-     * @static
-     * @param {string} name
-     * @param {(player: Player, args: any[]) => void} handler
-     * @param {boolean} [restricted=false]
-     * @returns {void}
-     */
     static registerCommand(name: string, handler: (player: Player, args: any[]) => void, restricted?: boolean): void;
-    /**
-     * @public
-     * @static
-     */
     static get RegisteredCommands(): [{
         name: string;
     }];
     /**
      * Get an iterable list of players currently on the server.
-     * @public
-     * @static
-     * @returns {IterableIterator<Player>} Iterable list of Player objects.
+     * @returns Iterable list of Player objects.
      */
     static PlayerList(): IterableIterator<Player>;
 }

package/lib/server/Game.js

@@ -2,10 +2,8 @@ import { Player } from './entities/Player';
 export class Game {
     /**
      * Calculate the Jenkins One At A Time (joaat) has from the given string.
-     * @public
-     * @static
-     * @param {string} input The input string to calculate the hash
-     * @returns {number}
+     *
+     * @param input The input string to calculate the hash
      */
     static generateHash(input) {
         if (typeof input === 'undefined') {
@@ -20,34 +18,16 @@ export class Game {
     }
     /**
      * Gets how many milliseconds the game has been open this session
-     * @public
-     * @static
      */
     static get GameTime() {
         return GetGameTimer();
     }
-    /**
-     * @public
-     * @static
-     */
     static get GameBuild() {
         return GetGameBuildNumber();
     }
-    /**
-     * @public
-     * @static
-     */
     static get GameName() {
         return GetGameName();
     }
-    /**
-     * @public
-     * @static
-     * @param {string} name
-     * @param {(player: Player, args: any[]) => void} handler
-     * @param {boolean} [restricted=false]
-     * @returns {void}
-     */
     static registerCommand(name, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     handler, restricted = false) {
@@ -58,18 +38,12 @@ export class Game {
             handler(player, args);
         }, restricted);
     }
-    /**
-     * @public
-     * @static
-     */
     static get RegisteredCommands() {
         return GetRegisteredCommands();
     }
     /**
      * Get an iterable list of players currently on the server.
-     * @public
-     * @static
-     * @returns {IterableIterator<Player>} Iterable list of Player objects.
+     * @returns Iterable list of Player objects.
      */
     static *PlayerList() {
         for (const id of getPlayers()) {
@@ -78,9 +52,4 @@ export class Game {
     }
 }
 // A map containing generated hashes.
-/**
- * @public
- * @static
- * @default Map<any, any>
- */
 Game.hashCache = new Map();

package/lib/server/cfx/StateBagChangeHandler.d.ts

@@ -1,9 +1,3 @@
-/**
- * @typedef {Object} StateBagChangeHandler
- */
 export interface StateBagChangeHandler<T> {
     (bagName: string, key: string, value: T, reserved: number, replicated: boolean): void;
 }
-/**
- * @typedef {Object} StateBagChangeHandler
- */

package/lib/server/cfx/StateBagChangeHandler.js

@@ -1,4 +1 @@
 export {};
-/**
- * @typedef {Object} StateBagChangeHandler
- */

package/lib/server/entities/BaseEntity.d.ts

@@ -7,109 +7,36 @@ import { Vector4 } from '../utils';
 import { Vector3 } from '../utils';
 export declare class BaseEntity {
     protected handle: number;
-    /**
-     * @protected
-     * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Entity
-     */
     protected type: ClassTypes;
     constructor(handle: number);
-    /**
-     * @public
-     */
     get State(): StateBagInterface;
-    /**
-     * @public
-     */
     get Handle(): number;
-    /**
-     * @public
-     */
     get Owner(): number;
-    /**
-     * @public
-     */
     get FirstOwner(): number;
-    /**
-     * @public
-     */
     get Exists(): boolean;
-    /**
-     * @public
-     */
     get AttachedTo(): number;
-    /**
-     * @public
-     */
     get Position(): Vector3;
-    /**
-     * @public
-     */
     get Heading(): number;
-    /**
-     * @public
-     */
     get PositionAndHeading(): Vector4;
-    /**
-     * @public
-     */
     get Health(): number;
-    /**
-     * @public
-     */
     get MaxHealth(): number;
-    /**
-     * @public
-     */
     get Model(): Hash;
-    /**
-     * @public
-     */
     get PopulationType(): PopulationType;
-    /**
-     * @public
-     */
     get Rotation(): Vector3;
-    /**
-     * @public
-     */
     get RotationVelocity(): Vector3;
-    /**
-     * @public
-     */
     get RoutingBucket(): number;
     /**
      * @returns The script that made the entity
-     * @public
      */
     get Script(): string;
-    /**
-     * @public
-     */
     get Speed(): number;
-    /**
-     * @public
-     */
     get Type(): eEntityType;
     /**
      * @returns the entitys velocity, if the entity is a ped it will return Vector3(0, 0, 0)
-     * @public
      */
     get Velocity(): Vector3;
-    /**
-     * @public
-     */
     get IsVisible(): boolean;
-    /**
-     * @public
-     */
     get NetworkId(): number;
-    /**
-     * @public
-     */
     get IsNoLongerNeeded(): boolean;
-    /**
-     * @public
-     * @returns {void}
-     */
     delete(): void;
 }

package/lib/server/entities/BaseEntity.js

@@ -5,156 +5,83 @@ import { Vector3 } from '../utils';
 export class BaseEntity {
     constructor(handle) {
         this.handle = handle;
-        /**
-         * @protected
-         * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Entity
-         */
         this.type = ClassTypes.Entity;
     }
-    /**
-     * @public
-     */
     get State() {
         return cfx.Entity(this.handle).state;
     }
-    /**
-     * @public
-     */
     get Handle() {
         return this.handle;
     }
-    /**
-     * @public
-     */
     get Owner() {
         return NetworkGetEntityOwner(this.handle);
     }
-    /**
-     * @public
-     */
     get FirstOwner() {
         return NetworkGetFirstEntityOwner(this.handle);
     }
-    /**
-     * @public
-     */
     get Exists() {
         return this.handle !== 0 && DoesEntityExist(this.handle);
     }
-    /**
-     * @public
-     */
     get AttachedTo() {
         return GetEntityAttachedTo(this.handle);
     }
-    /**
-     * @public
-     */
     get Position() {
         return Vector3.fromArray(GetEntityCoords(this.handle));
     }
-    /**
-     * @public
-     */
     get Heading() {
         return GetEntityHeading(this.handle);
     }
-    /**
-     * @public
-     */
     get PositionAndHeading() {
         return Vector4.fromArray([...GetEntityCoords(this.handle), GetEntityHeading(this.handle)]);
     }
-    /**
-     * @public
-     */
     get Health() {
         return GetEntityHealth(this.handle);
     }
-    /**
-     * @public
-     */
     get MaxHealth() {
         return GetEntityMaxHealth(this.handle);
     }
-    /**
-     * @public
-     */
     get Model() {
         return GetEntityModel(this.handle);
     }
-    /**
-     * @public
-     */
     get PopulationType() {
         return GetEntityPopulationType(this.handle);
     }
-    /**
-     * @public
-     */
     get Rotation() {
         return Vector3.fromArray(GetEntityRotation(this.handle));
     }
-    /**
-     * @public
-     */
     get RotationVelocity() {
         return Vector3.fromArray(GetEntityRotationVelocity(this.handle));
     }
-    /**
-     * @public
-     */
     get RoutingBucket() {
         return GetEntityRoutingBucket(this.handle);
     }
     /**
      * @returns The script that made the entity
-     * @public
      */
     get Script() {
         return GetEntityScript(this.handle);
     }
-    /**
-     * @public
-     */
     get Speed() {
         return GetEntitySpeed(this.handle);
     }
-    /**
-     * @public
-     */
     get Type() {
         return GetEntityType(this.handle);
     }
     /**
      * @returns the entitys velocity, if the entity is a ped it will return Vector3(0, 0, 0)
-     * @public
      */
     get Velocity() {
         return Vector3.fromArray(GetEntityVelocity(this.handle));
     }
-    /**
-     * @public
-     */
     get IsVisible() {
         return IsEntityVisible(this.handle);
     }
-    /**
-     * @public
-     */
     get NetworkId() {
         return NetworkGetNetworkIdFromEntity(this.handle);
     }
-    /**
-     * @public
-     */
     get IsNoLongerNeeded() {
         return HasEntityBeenMarkedAsNoLongerNeeded(this.handle);
     }
-    /**
-     * @public
-     * @returns {void}
-     */
     delete() {
         DeleteEntity(this.handle);
     }

package/lib/server/entities/Entity.d.ts

@@ -1,18 +1,5 @@
 import { BaseEntity } from './BaseEntity';
-/** @extends BaseEntity */
 export declare class Entity extends BaseEntity {
-    /**
-     * @public
-     * @static
-     * @param {number} netId
-     * @returns {Entity}
-     */
     static fromNetworkId(netId: number): Entity;
-    /**
-     * @public
-     * @static
-     * @param {number} handle
-     * @returns {Entity}
-     */
     static fromHandle(handle: number): Entity;
 }

package/lib/server/entities/Entity.js

@@ -1,21 +1,8 @@
 import { BaseEntity } from './BaseEntity';
-/** @extends BaseEntity */
 export class Entity extends BaseEntity {
-    /**
-     * @public
-     * @static
-     * @param {number} netId
-     * @returns {Entity}
-     */
     static fromNetworkId(netId) {
         return new Entity(NetworkGetEntityFromNetworkId(netId));
     }
-    /**
-     * @public
-     * @static
-     * @param {number} handle
-     * @returns {Entity}
-     */
     static fromHandle(handle) {
         return new Entity(handle);
     }

package/lib/server/entities/Ped.d.ts

@@ -1,87 +1,27 @@
 import { ClassTypes } from '../enum/ClassTypes';
 import { Hash } from '../type/Hash';
 import { BaseEntity } from './BaseEntity';
-/** @extends BaseEntity */
 export declare class Ped extends BaseEntity {
-    /**
-     * @protected
-     * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Ped
-     */
     protected type: ClassTypes;
     constructor(handle: number);
     /**
      * Get an interable list of peds currently on the server
-     * @public
-     * @static
-     * @returns {IterableIterator<Ped>} Iterable list of Peds.
+     * @returns Iterable list of Peds.
      */
     static AllPeds(): IterableIterator<Ped>;
-    /**
-     * @public
-     * @static
-     * @param {number} netId
-     * @returns {Ped}
-     */
     static fromNetworkId(netId: number): Ped;
-    /**
-     * @public
-     * @static
-     * @param {number} handle
-     * @returns {Ped}
-     */
     static fromHandle(handle: number): Ped;
-    /**
-     * @public
-     */
     get Armour(): number;
-    /**
-     * @public
-     */
     get CauseOfDeath(): Hash;
-    /**
-     * @public
-     */
     get DesiredHeading(): number;
-    /**
-     * @public
-     */
     get MaxHealth(): number;
-    /**
-     * @public
-     */
     get TaskCommand(): Hash;
-    /**
-     * @public
-     */
     get TaskStage(): number;
-    /**
-     * @public
-     */
     get LastSourceOfDamage(): number;
-    /**
-     * @public
-     */
     get DeathCause(): number;
-    /**
-     * @public
-     */
     get Weapon(): Hash;
-    /**
-     * @public
-     */
     get Vehicle(): number;
-    /**
-     * @public
-     */
     get LastVehicle(): number;
-    /**
-     * @public
-     */
     get IsPlayer(): boolean;
-    /**
-     * @public
-     * @param {number} index
-     * @returns {number}
-     */
     specificTaskType(index: number): number;
 }