@nativewrappers/redm 0.0.63 → 0.0.65

package/entities/BaseEntity.d.ts

@@ -2,16 +2,66 @@ import { Vector3 } from "../../common/utils";
 export declare class BaseEntity {
     private handle;
     constructor(entHandle: number);
+    /**
+      * Replaces the current handle for the entity used on, this hsould be used sparringly, mainly
+      * in situations where you're going to reuse an entity over and over and don't want to make a
+      * new entity every time.
+      *
+      *  **WARNING**: This does no checks, if you provide it an invalid entity it will use it
+      *
+      * ```ts
+      * const REUSABLE_ENTITY = new Entity(entityHandle);
+      *
+      * onNet("entityHandler", (entNetId: number) => {
+      *  // if no net entity we should ignore
+      *  if (!NetworkDoesEntityExistWithNetworkId(entNetId)) return;
+      *
+      *  // Reuse our entity so we don't have to initialize a new one
+      *  REUSABLE_ENTITY.replaceHandle(NetworkGetEntityFromNetworkId(entNetId));
+      *  // Do something with REUSABLE_ENTITY entity
+      * })
+      ```
+      */
     replaceHandle(newHandle: number): void;
+    /**
+     * @returns the network for the specified entity, this doesn't check if the entity is networked, you should use {@link BaseEntity.IsNetworked}
+     */
+    get NetworkId(): number;
+    /**
+     * @returns `true` if the current entity is networked, false otherwise
+     */
+    get IsNetworked(): boolean;
     /**
      * @returns Returns true if the entity handle is not 0 and exists in the game engine
      */
     get Exists(): boolean;
+    /**
+     * @returns The entitys current handle.
+     */
     get Handle(): number;
+    /**
+     * @param amount the health to set the health to, setting to `0` will kill the entity, if using on a {@link Ped} you should check the MaxHealth before setting.
+     */
     set Health(amount: number);
+    /**
+     * @returns the amount of health the current {@link BaseEntity} has
+     */
     get Health(): number;
+    /**
+     * @returns the heading of the current {@link BaseEntity}
+     */
     get Heading(): number;
+    /**
+     * @param heading sets the entitys heading to the specified heading, this can be in the range of 0..360
+     */
     set Heading(heading: number);
+    /**
+     * @returns the position of the current Entity
+     */
     get Position(): Vector3;
+    /**
+     * You should (almost) always try to load the collisions before setting the entitys position if going a long distance.
+     * @param pos sets the position for the current ped
+     */
     set Position(pos: Vector3);
 }

package/entities/BaseEntity.js

@@ -4,51 +4,87 @@ export class BaseEntity {
     constructor(entHandle) {
         this.handle = entHandle;
     }
-    // Replaces the current handle for the entity used on, this hsould be used sparringly, mainly
-    // in situations where you're going to reuse an entity over and over and don't want to make a
-    // new entity every time.
-    //
-    // **WARNING**: This does no checks, if you provide it an invalid entity it will use it
-    //
-    // ```ts
-    // const REUSABLE_ENTITY = new Entity(entityHandle);
-    //
-    // onNet("entityHandler", (entNetId: number) => {
-    //  // if no net entity we should ignore
-    //  if (!NetworkDoesEntityExistWithNetworkId(entNetId)) return;
-    //
-    //  // Reuse our entity so we don't have to initialize a new one
-    //  REUSABLE_ENTITY.replaceHandle(NetworkGetEntityFromNetworkId(entNetId));
-    //  // Do something with REUSABLE_ENTITY entity
-    // })
-    // ```
+    /**
+      * Replaces the current handle for the entity used on, this hsould be used sparringly, mainly
+      * in situations where you're going to reuse an entity over and over and don't want to make a
+      * new entity every time.
+      *
+      *  **WARNING**: This does no checks, if you provide it an invalid entity it will use it
+      *
+      * ```ts
+      * const REUSABLE_ENTITY = new Entity(entityHandle);
+      *
+      * onNet("entityHandler", (entNetId: number) => {
+      *  // if no net entity we should ignore
+      *  if (!NetworkDoesEntityExistWithNetworkId(entNetId)) return;
+      *
+      *  // Reuse our entity so we don't have to initialize a new one
+      *  REUSABLE_ENTITY.replaceHandle(NetworkGetEntityFromNetworkId(entNetId));
+      *  // Do something with REUSABLE_ENTITY entity
+      * })
+      ```
+      */
     replaceHandle(newHandle) {
         this.handle = newHandle;
     }
+    /**
+     * @returns the network for the specified entity, this doesn't check if the entity is networked, you should use {@link BaseEntity.IsNetworked}
+     */
+    get NetworkId() {
+        return NetworkGetNetworkIdFromEntity(this.Handle);
+    }
+    /**
+     * @returns `true` if the current entity is networked, false otherwise
+     */
+    get IsNetworked() {
+        return NetworkGetEntityIsNetworked(this.Handle);
+    }
     /**
      * @returns Returns true if the entity handle is not 0 and exists in the game engine
      */
     get Exists() {
         return this.handle !== 0 && DoesEntityExist(this.Handle);
     }
+    /**
+     * @returns The entitys current handle.
+     */
     get Handle() {
         return this.handle;
     }
+    /**
+     * @param amount the health to set the health to, setting to `0` will kill the entity, if using on a {@link Ped} you should check the MaxHealth before setting.
+     */
     set Health(amount) {
         SetEntityHealth(this.Handle, amount, 0);
     }
+    /**
+     * @returns the amount of health the current {@link BaseEntity} has
+     */
     get Health() {
         return GetEntityHealth(this.Handle);
     }
+    /**
+     * @returns the heading of the current {@link BaseEntity}
+     */
     get Heading() {
         return GetEntityHeading(this.Handle);
     }
+    /**
+     * @param heading sets the entitys heading to the specified heading, this can be in the range of 0..360
+     */
     set Heading(heading) {
         SetEntityHeading(this.Handle, heading);
     }
+    /**
+     * @returns the position of the current Entity
+     */
     get Position() {
         return Vector3.fromArray(GetEntityCoords(this.handle, true, true));
     }
+    /**
+     * You should (almost) always try to load the collisions before setting the entitys position if going a long distance.
+     * @param pos sets the position for the current ped
+     */
     set Position(pos) {
         SetEntityCoords(this.handle, pos.x, pos.y, pos.z, false, false, false, false);
     }

package/entities/Ped.d.ts

@@ -5,7 +5,6 @@ import { Vector3 } from "../utils";
 import { BaseEntity } from "./BaseEntity";
 import { Vehicle } from "./Vehicle";
 import { Player } from "./Player";
-export type OptionalPed = Ped | null;
 export declare class Ped extends BaseEntity {
     private attributes;
     constructor(handle: number);
@@ -50,15 +49,15 @@ export declare class Ped extends BaseEntity {
     /**
      * @returns the last mount that this ped was on, or null if it doesn't exist
      */
-    get Mount(): OptionalPed;
+    get Mount(): Ped | null;
     /**
      * returns the horse that this ped is leading
      */
-    get LeadingHorse(): OptionalPed;
+    get LeadingHorse(): Ped | null;
     /**
      * returns the owner of the current animal
      */
-    get Owner(): OptionalPed;
+    get Owner(): Ped | null;
     get TamingState(): TamingState;
     get IsInteractingWithAnimal(): boolean;
     get IsSittingInAnyVehicle(): boolean;
@@ -149,7 +148,7 @@ export declare class Ped extends BaseEntity {
      * @param amount - the amount of armour to add to the ped
      */
     addArmour(amount: number): void;
-    applyDamage(damageAmount: number, boneId?: number, pedKiller?: OptionalPed): void;
+    applyDamage(damageAmount: number, boneId?: number, pedKiller?: Ped | null): void;
     /**
      * @param damagePack - the damage decal to apply see [here](https://github.com/femga/rdr3_discoveries/blob/master/peds_customization/ped_decals.lua) for more documentation
      * @param damage - the damage to apply

package/index.d.ts

@@ -8,3 +8,4 @@ export * from "./world";
 export * from "./GameConstants";
 export * from "./RelationshipGroup";
 export * from "./Attribute";
+export { Convar, Kvp, Resource, Command } from "../common/index";

package/index.js

@@ -8,3 +8,4 @@ export * from "./world";
 export * from "./GameConstants";
 export * from "./RelationshipGroup";
 export * from "./Attribute";
+export { Convar, Kvp, Resource, Command } from "../common/index";

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@nativewrappers/redm",
   "description": "Native wrappers and utilities for use with RedM.",
-  "author": "Remco Troost <d0p3t>",
   "license": "MIT",
   "type": "module",
-  "version": "0.0.63",
+  "version": "0.0.65",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/nativewrappers.git"
@@ -28,6 +27,6 @@
     ".": "./index.js"
   },
   "dependencies": {
-    "@nativewrappers/common": "0.0.63"
+    "@nativewrappers/common": "0.0.65"
   }
 }