@nativewrappers/fivem 0.0.1

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

@@ -0,0 +1,87 @@
+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.
+     */
+    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;
+}

package/lib/server/entities/Ped.js

@@ -0,0 +1,122 @@
+import { ClassTypes } from '../enum/ClassTypes';
+import { BaseEntity } from './BaseEntity';
+/** @extends BaseEntity */
+export class Ped extends BaseEntity {
+    constructor(handle) {
+        super(handle);
+        /**
+         * @protected
+         * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Ped
+         */
+        this.type = ClassTypes.Ped;
+    }
+    /**
+     * Get an interable list of peds currently on the server
+     * @public
+     * @static
+     * @returns {IterableIterator<Ped>} Iterable list of Peds.
+     */
+    static *AllPeds() {
+        for (const pedId of GetAllPeds()) {
+            yield new Ped(pedId);
+        }
+    }
+    /**
+     * @public
+     * @static
+     * @param {number} netId
+     * @returns {Ped}
+     */
+    static fromNetworkId(netId) {
+        return new Ped(NetworkGetEntityFromNetworkId(netId));
+    }
+    /**
+     * @public
+     * @static
+     * @param {number} handle
+     * @returns {Ped}
+     */
+    static fromHandle(handle) {
+        return new Ped(handle);
+    }
+    /**
+     * @public
+     */
+    get Armour() {
+        return GetPedArmour(this.handle);
+    }
+    /**
+     * @public
+     */
+    get CauseOfDeath() {
+        return GetPedCauseOfDeath(this.handle);
+    }
+    /**
+     * @public
+     */
+    get DesiredHeading() {
+        return GetPedDesiredHeading(this.handle);
+    }
+    /**
+     * @public
+     */
+    get MaxHealth() {
+        return GetPedMaxHealth(this.handle);
+    }
+    /**
+     * @public
+     */
+    get TaskCommand() {
+        return GetPedScriptTaskCommand(this.handle);
+    }
+    /**
+     * @public
+     */
+    get TaskStage() {
+        return GetPedScriptTaskStage(this.handle);
+    }
+    /**
+     * @public
+     */
+    get LastSourceOfDamage() {
+        return GetPedSourceOfDamage(this.handle);
+    }
+    /**
+     * @public
+     */
+    get DeathCause() {
+        return GetPedCauseOfDeath(this.handle);
+    }
+    /**
+     * @public
+     */
+    get Weapon() {
+        return GetSelectedPedWeapon(this.handle);
+    }
+    /**
+     * @public
+     */
+    get Vehicle() {
+        return GetVehiclePedIsIn(this.handle, false);
+    }
+    /**
+     * @public
+     */
+    get LastVehicle() {
+        return GetVehiclePedIsIn(this.handle, true);
+    }
+    /**
+     * @public
+     */
+    get IsPlayer() {
+        return IsPedAPlayer(this.handle);
+    }
+    /**
+     * @public
+     * @param {number} index
+     * @returns {number}
+     */
+    specificTaskType(index) {
+        return GetPedSpecificTaskType(this.handle, index);
+    }
+}

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

@@ -0,0 +1,163 @@
+/// <reference types="@citizenfx/server" />
+import { ClassTypes } from '../enum/ClassTypes';
+import { Vector3 } from '../utils';
+import { Ped } from './Ped';
+export declare class Player {
+    private readonly source;
+    /**
+     * @protected
+     * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Player
+     */
+    protected type: ClassTypes;
+    constructor(source: number);
+    /**
+     * Get an interable list of players currently on the server
+     * @public
+     * @static
+     * @returns {IterableIterator<Player>} Iterable list of Players.
+     */
+    static AllPlayers(): IterableIterator<Player>;
+    /**
+     * @public
+     */
+    get Exists(): boolean;
+    /**
+     * @public
+     */
+    get Source(): number;
+    /**
+     * @public
+     */
+    get State(): StateBagInterface;
+    /**
+     * Returns the player source casted as a string
+     * @public
+     */
+    get Src(): string;
+    /**
+     * @public
+     */
+    get Ped(): Ped;
+    /**
+     * @public
+     */
+    get Tokens(): string[];
+    /**
+     * @public
+     */
+    get Identifiers(): string[];
+    /**
+     * @public
+     */
+    get Endpoint(): string;
+    /**
+     * @public
+     */
+    get CamerRotation(): Vector3;
+    /**
+     * Returns the time since the last player UDP message
+     * @public
+     */
+    get LastMessage(): number;
+    /**
+     * @public
+     */
+    get MaxArmour(): number;
+    /**
+     * @public
+     */
+    get MaxHealth(): number;
+    /**
+     * @public
+     */
+    get MeleeModifier(): number;
+    /**
+     * @returns the players name
+     * @public
+     */
+    get Name(): string;
+    /**
+     * @public
+     * @returns {string} the players name with any color code unicode, etc removed, this can lead to there being no name at all
+     */
+    filteredName(): string;
+    /**
+     * @returns the players round trip ping
+     * @public
+     */
+    get Ping(): number;
+    /**
+     * @returns the current routhing bucket the player is in, default is 0
+     * @public
+     */
+    get RoutingBucket(): number;
+    /**
+     * @public
+     */
+    get Team(): number;
+    /**
+     * @public
+     */
+    get WantedPosition(): Vector3;
+    /**
+     * @public
+     */
+    get WantedLevel(): number;
+    /**
+     * @public
+     */
+    get IsEvadingWanted(): boolean;
+    /**
+     * @public
+     */
+    get WeaponDamageModifier(): number;
+    /**
+     * @public
+     */
+    get WeaponDefenseModifier(): number;
+    /**
+     * @public
+     */
+    get WeaponDefenseModifier2(): number;
+    /**
+     * @public
+     */
+    get AirDragMultiplier(): number;
+    /**
+     * @public
+     */
+    get IsUsingSuperJump(): boolean;
+    /**
+     * @public
+     */
+    get IsMuted(): boolean;
+    /**
+     * @public
+     */
+    set IsMuted(isMuted: boolean);
+    /**
+     * @public
+     * @param {string} object
+     * @returns {boolean}
+     */
+    isAceAllowed(object: string): boolean;
+    /**
+     * @public
+     * @param {boolean} [lastPursuit=false]
+     * @returns {number}
+     */
+    timeInPersuit(lastPursuit?: boolean): number;
+    /**
+     * @public
+     * @param {string} [reason='No reason specified']
+     * @returns {void}
+     */
+    drop(reason?: string): void;
+    /**
+     * @public
+     * @param {string} eventName
+     * @param {...any} [args]
+     * @returns {void}
+     */
+    emit(eventName: string, ...args: any[]): void;
+}

package/lib/server/entities/Player.js

@@ -0,0 +1,235 @@
+import cfx from '../cfx';
+import { ClassTypes } from '../enum/ClassTypes';
+import { cleanPlayerName } from '../utils';
+import { Vector3 } from '../utils';
+import { Ped } from './Ped';
+export class Player {
+    constructor(source) {
+        this.source = source;
+        /**
+         * @protected
+         * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Player
+         */
+        this.type = ClassTypes.Player;
+    }
+    /**
+     * Get an interable list of players currently on the server
+     * @public
+     * @static
+     * @returns {IterableIterator<Player>} Iterable list of Players.
+     */
+    static *AllPlayers() {
+        const num = GetNumPlayerIndices();
+        for (let i = 0; i < num; i++) {
+            yield new Player(parseInt(GetPlayerFromIndex(i)));
+        }
+    }
+    /**
+     * @public
+     */
+    get Exists() {
+        return this.source !== 0;
+    }
+    /**
+     * @public
+     */
+    get Source() {
+        return this.source;
+    }
+    /**
+     * @public
+     */
+    get State() {
+        return cfx.Player(this.source).state;
+    }
+    /**
+     * Returns the player source casted as a string
+     * @public
+     */
+    get Src() {
+        return this.source;
+    }
+    /**
+     * @public
+     */
+    get Ped() {
+        return new Ped(GetPlayerPed(this.Src));
+    }
+    /**
+     * @public
+     */
+    get Tokens() {
+        return getPlayerTokens(this.source);
+    }
+    /**
+     * @public
+     */
+    get Identifiers() {
+        return getPlayerIdentifiers(this.source);
+    }
+    /**
+     * @public
+     */
+    get Endpoint() {
+        return GetPlayerEndpoint(this.Src);
+    }
+    /**
+     * @public
+     */
+    get CamerRotation() {
+        return Vector3.fromArray(GetPlayerCameraRotation(this.Src));
+    }
+    /**
+     * Returns the time since the last player UDP message
+     * @public
+     */
+    get LastMessage() {
+        return GetPlayerLastMsg(this.Src);
+    }
+    /**
+     * @public
+     */
+    get MaxArmour() {
+        return GetPlayerMaxArmour(this.Src);
+    }
+    /**
+     * @public
+     */
+    get MaxHealth() {
+        return GetPlayerMaxHealth(this.Src);
+    }
+    /**
+     * @public
+     */
+    get MeleeModifier() {
+        return GetPlayerMeleeWeaponDamageModifier(this.Src);
+    }
+    /**
+     * @returns the players name
+     * @public
+     */
+    get Name() {
+        return GetPlayerName(this.Src);
+    }
+    /**
+     * @public
+     * @returns {string} the players name with any color code unicode, etc removed, this can lead to there being no name at all
+     */
+    filteredName() {
+        return cleanPlayerName(this.Name);
+    }
+    /**
+     * @returns the players round trip ping
+     * @public
+     */
+    get Ping() {
+        return GetPlayerPing(this.Src);
+    }
+    /**
+     * @returns the current routhing bucket the player is in, default is 0
+     * @public
+     */
+    get RoutingBucket() {
+        return GetPlayerRoutingBucket(this.Src);
+    }
+    /**
+     * @public
+     */
+    get Team() {
+        return GetPlayerTeam(this.Src);
+    }
+    /**
+     * @public
+     */
+    get WantedPosition() {
+        return Vector3.fromArray(GetPlayerWantedCentrePosition(this.Src));
+    }
+    /**
+     * @public
+     */
+    get WantedLevel() {
+        return GetPlayerWantedLevel(this.Src);
+    }
+    /**
+     * @public
+     */
+    get IsEvadingWanted() {
+        return IsPlayerEvadingWantedLevel(this.Src);
+    }
+    /**
+     * @public
+     */
+    get WeaponDamageModifier() {
+        return GetPlayerWeaponDamageModifier(this.Src);
+    }
+    /**
+     * @public
+     */
+    get WeaponDefenseModifier() {
+        return GetPlayerWeaponDefenseModifier(this.Src);
+    }
+    /**
+     * @public
+     */
+    get WeaponDefenseModifier2() {
+        return GetPlayerWeaponDefenseModifier_2(this.Src);
+    }
+    /**
+     * @public
+     */
+    get AirDragMultiplier() {
+        return GetAirDragMultiplierForPlayersVehicle(this.Src);
+    }
+    /**
+     * @public
+     */
+    get IsUsingSuperJump() {
+        return IsPlayerUsingSuperJump(this.Src);
+    }
+    /**
+     * @public
+     */
+    get IsMuted() {
+        return MumbleIsPlayerMuted(this.source);
+    }
+    /**
+     * @public
+     */
+    set IsMuted(isMuted) {
+        MumbleSetPlayerMuted(this.source, isMuted);
+    }
+    /**
+     * @public
+     * @param {string} object
+     * @returns {boolean}
+     */
+    isAceAllowed(object) {
+        return IsPlayerAceAllowed(this.Src, object);
+    }
+    /**
+     * @public
+     * @param {boolean} [lastPursuit=false]
+     * @returns {number}
+     */
+    timeInPersuit(lastPursuit = false) {
+        return GetPlayerTimeInPursuit(this.Src, lastPursuit);
+    }
+    /**
+     * @public
+     * @param {string} [reason='No reason specified']
+     * @returns {void}
+     */
+    drop(reason = 'No reason specified') {
+        DropPlayer(this.Src, reason);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    /**
+     * @public
+     * @param {string} eventName
+     * @param {...any} [args]
+     * @returns {void}
+     */
+    emit(eventName, ...args) {
+        TriggerClientEvent(eventName, this.source, ...args);
+    }
+}

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

@@ -0,0 +1,32 @@
+import { ClassTypes } from '../enum/ClassTypes';
+import { BaseEntity } from './BaseEntity';
+/** @extends BaseEntity */
+export declare class Prop extends BaseEntity {
+    /**
+     * @protected
+     * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Prop
+     */
+    protected type: ClassTypes;
+    constructor(handle: number);
+    /**
+     * Get an interable list of props currently on the server
+     * @public
+     * @static
+     * @returns {IterableIterator<Prop>} Iterable list of Props.
+     */
+    static AllProps(): IterableIterator<Prop>;
+    /**
+     * @public
+     * @static
+     * @param {number} netId
+     * @returns {Prop}
+     */
+    static fromNetworkId(netId: number): Prop;
+    /**
+     * @public
+     * @static
+     * @param {number} handle
+     * @returns {Prop}
+     */
+    static fromHandle(handle: number): Prop;
+}

package/lib/server/entities/Prop.js

@@ -0,0 +1,42 @@
+import { ClassTypes } from '../enum/ClassTypes';
+import { BaseEntity } from './BaseEntity';
+/** @extends BaseEntity */
+export class Prop extends BaseEntity {
+    constructor(handle) {
+        super(handle);
+        /**
+         * @protected
+         * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Prop
+         */
+        this.type = ClassTypes.Prop;
+    }
+    /**
+     * Get an interable list of props currently on the server
+     * @public
+     * @static
+     * @returns {IterableIterator<Prop>} Iterable list of Props.
+     */
+    static *AllProps() {
+        for (const prop of GetAllObjects()) {
+            yield new Prop(prop);
+        }
+    }
+    /**
+     * @public
+     * @static
+     * @param {number} netId
+     * @returns {Prop}
+     */
+    static fromNetworkId(netId) {
+        return new Prop(NetworkGetEntityFromNetworkId(netId));
+    }
+    /**
+     * @public
+     * @static
+     * @param {number} handle
+     * @returns {Prop}
+     */
+    static fromHandle(handle) {
+        return new Prop(handle);
+    }
+}