@nativewrappers/redm 0.0.65 → 0.0.72

package/interfaces/Dimensions.d.ts

@@ -1,4 +1,4 @@
-import { Vector3 } from "../../common/utils/Vector3";
+import type { Vector3 } from "../common/utils/Vector3";
 export interface Dimensions {
     min: Vector3;
     max: Vector3;

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@nativewrappers/redm",
   "description": "Native wrappers and utilities for use with RedM.",
+  "contributors": [
+    "Remco Troost <d0p3t>",
+    "Dillon Skaggs <AvarianKnight>",
+    "Linden <thelindat>"
+  ],
   "license": "MIT",
   "type": "module",
-  "version": "0.0.65",
+  "version": "0.0.72",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/nativewrappers.git"
@@ -25,8 +30,5 @@
   ],
   "exports": {
     ".": "./index.js"
-  },
-  "dependencies": {
-    "@nativewrappers/common": "0.0.65"
   }
 }

package/utils/index.d.ts

@@ -1,2 +1,2 @@
 export * from "./Native";
-export { Vector2, Vector3, Vector4, Maths, Color, Quaternion, Delay, enumValues, getStringFromUInt8Array, getUInt32FromUint8Array, } from "../../common/utils/index";
+export { Vector2, Vector3, Vector4, Maths, Color, Quaternion, Delay, enumValues, getStringFromUInt8Array, getUInt32FromUint8Array, } from "../common/utils/index";

package/world/createDraftVehicle.d.ts

@@ -1,6 +1,6 @@
-import { Vector3 } from "../../common/utils";
-import { Vehicle } from "../../redm/entities";
-import { Model } from "../../redm/Model";
+import type { Vector3 } from "../common/utils";
+import { Vehicle } from "redm/entities";
+import type { Model } from "redm/Model";
 /**
  * Creates a vehicle at the specified {@param spawnPos}, you don't need to request the model before this.
  */

package/world/createPed.d.ts

@@ -1,6 +1,6 @@
-import { Vector3 } from "../../common/utils";
-import { Ped } from "../../redm/entities";
-import { Model } from "../../redm/Model";
+import type { Vector3 } from "../common/utils";
+import { Ped } from "redm/entities";
+import type { Model } from "redm/Model";
 /**
  * Creates a ped at the specified {@param spawnPos}, you don't need to request the model before this.
  */

package/world/createProp.d.ts

@@ -1,6 +1,6 @@
-import { Vector3 } from "../../common/utils";
-import { Prop } from "../../redm/entities/Prop";
-import { Model } from "../../redm/Model";
+import type { Vector3 } from "../common/utils";
+import { Prop } from "redm/entities/Prop";
+import type { Model } from "redm/Model";
 /**
  * Creates a ped at the specified {@param spawnPos}, you don't need to request the model before this.
  */

package/world/createVehicle.d.ts

@@ -1,6 +1,6 @@
-import { Vector3 } from "../../common/utils";
-import { Vehicle } from "../../redm/entities";
-import { Model } from "../../redm/Model";
+import type { Vector3 } from "../common/utils";
+import { Vehicle } from "redm/entities";
+import type { Model } from "redm/Model";
 /**
  * Creates a vehicle at the specified {@param spawnPos}, you don't need to request the model before this.
  */

package/Attribute.js

@@ -1,143 +0,0 @@
-import { _N } from "./utils/Native";
-export class CoreAttribute {
-    handle;
-    attribute;
-    constructor(ped, attribute) {
-        this.handle = ped.Handle;
-        this.attribute = attribute;
-    }
-    /**
-     * This doesn't seem to actually do anything
-     * @todo maybe remove unless theres a valid use case
-     * @param amount
-     * @param makeSound
-     */
-    enableOverpower(amount, makeSound = false) {
-        // EnableAttributeCoreOverpower
-        _N("0x4AF5A4C7B9157D14", this.handle, this.attribute, amount, makeSound);
-    }
-    get Overpowered() {
-        return _N("0x200373A8DF081F22", this.attribute, Citizen.resultAsInteger());
-    }
-    /**
-     * @returns the amount of overpower time left in seconds
-     */
-    get OverpoweredTimeLeft() {
-        // GetAttributeCoreOverpowerSecondsLeft
-        return _N("0xB429F58803D285B1", this.handle, this.attribute, Citizen.resultAsInteger());
-    }
-    /**
-     * Returns how full the core is
-     */
-    get CoreValue() {
-        return GetAttributeCoreValue(this.handle, this.attribute);
-    }
-    set CoreValue(amount) {
-        // SetAttributeCoreValue
-        _N("0xC6258F41D86676E0", this.handle, this.attribute, amount);
-    }
-}
-export class PedAttribute {
-    handle;
-    attribute;
-    constructor(ped, attribute) {
-        this.handle = ped.Handle;
-        this.attribute = attribute;
-    }
-    /**
-     *
-     * @param amount the amount of points to add to the attribute
-     */
-    addPoints(amount) {
-        AddAttributePoints(this.handle, this.attribute, amount);
-    }
-    /**
-     * Disables the overpower state on this attribute, see {@link enableOverpower} on how to enable
-     */
-    disableOverpower() {
-        DisableAttributeOverpower(this.handle, this.attribute);
-    }
-    /**
-     *
-     * @param amount the amount to overpower this attribute by
-     * @param makeSound if activating the overpower should play sound
-     */
-    enableOverpower(amount, makeSound = false) {
-        // EnableAttributeOverpower
-        _N("0xF6A7C08DF2E28B28", this.handle, this.attribute, amount, makeSound);
-    }
-    /**
-     * Gets the amount of attribute points the ped has
-     */
-    get Points() {
-        return GetAttributePoints(this.handle, this.attribute);
-    }
-    set Points(amount) {
-        SetAttributePoints(this.handle, this.attribute, amount);
-    }
-    get Rank() {
-        return GetAttributeRank(this.handle, this.attribute);
-    }
-    set BaseRank(amount) {
-        SetAttributeBaseRank(this.handle, this.attribute, amount);
-    }
-    get BaseRank() {
-        return GetAttributeBaseRank(this.handle, this.attribute);
-    }
-    set BonusRank(amount) {
-        SetAttributeBonusRank(this.handle, this.attribute, amount);
-    }
-    get BonusRank() {
-        return GetAttributeBonusRank(this.handle, this.attribute);
-    }
-    get MaxRank() {
-        // GetMaxAttributeRank
-        return _N("0x704674A0535A471D", this.attribute, Citizen.resultAsInteger());
-    }
-    get Overpowered() {
-        // IsAttributeOverpowered
-        return _N("0x103C2F885ABEB00B", this.attribute, Citizen.resultAsInteger());
-    }
-}
-// There's probably a better way to do this but this will do for now as it reduces repetition
-export class Attributes {
-    pedAttributes = [];
-    coreAttributes = [];
-    constructor(ped) {
-        for (let i = 0; i <= 21; i++) {
-            this.pedAttributes[i] = new PedAttribute(ped, i);
-        }
-        for (let i = 0; i <= 2; i++) {
-            this.coreAttributes[i] = new CoreAttribute(ped, i);
-        }
-    }
-    getCore(attribute) {
-        if (attribute > 2)
-            throw new RangeError("The max enum for CoreAttribute is 2");
-        if (attribute < 0)
-            throw new RangeError("The minimum enum for CoreAttribute is 0");
-        // This should always be valid
-        return this.coreAttributes[attribute];
-    }
-    get(attribute) {
-        if (attribute > 22)
-            throw new RangeError("The max enum for PedAttribute is 22");
-        if (attribute < 0)
-            throw new RangeError("The minimum enum for PedAttribute is 0");
-        return this.pedAttributes[attribute];
-    }
-    set CoreIcon(status) {
-        if (status > 15)
-            throw new RangeError("The max enum for StatusEffect is 15");
-        if (status < 0)
-            throw new RangeError("The minimum enum for StatusEffect is 0");
-        _N("0xA4D3A1C008F250DF", status);
-    }
-    set PeriodicIcon(status) {
-        if (status > 15)
-            throw new RangeError("The max enum for StatusEffect is 15!");
-        if (status < 0)
-            throw new RangeError("The minimum enum for StatusEffect is 0");
-        _N("0xFB6E111908502871", status);
-    }
-}

package/Controls.js

@@ -1,14 +0,0 @@
-export class Controls {
-    static IsInputJustPressed(hash) {
-        return IsControlJustPressed(0, hash);
-    }
-    static IsInputPressed(hash) {
-        return IsControlPressed(0, hash);
-    }
-    static IsDisabledInputPressed(hash) {
-        return IsDisabledControlPressed(0, hash);
-    }
-    static DisableControl(hash) {
-        DisableControlAction(0, hash, false);
-    }
-}

package/Game.js

@@ -1,10 +0,0 @@
-import { Ped } from "./entities";
-import { GameConstants } from "./GameConstants";
-export class Game {
-    static get PlayerPed() {
-        return new Ped(PlayerPedId());
-    }
-    static get Player() {
-        return GameConstants.Player;
-    }
-}

package/GameConstants.js

@@ -1,20 +0,0 @@
-import { Player } from "./entities";
-// Constants that will never change throughout the lifetime of the player
-export class GameConstants {
-    // the actual player object that will get initialized on the first call to the `get Player()`
-    static player = null;
-    // The player id of the local client
-    static PlayerId = PlayerId();
-    // The server id of the local client.
-    static ServerId = GetPlayerServerId(GameConstants.PlayerId);
-    // The player class of the local object
-    static get Player() {
-        // Initialize the player on first access, this should prevent any issues where the `Player` class isn't
-        // defined yet since we call this from `Player` too.
-        // return GameConstants.player;
-        if (GameConstants.player === null) {
-            GameConstants.player = new Player(GameConstants.PlayerId);
-        }
-        return GameConstants.player;
-    }
-}

package/Model.js

@@ -1,153 +0,0 @@
-import { Vector3 } from "../common/utils/Vector3";
-import { Delay } from "../common/utils";
-/**
- * Class to create and manage entity models.
- */
-export class Model {
-    /**
-     * Hash of this model.
-     */
-    hash;
-    requestedModel = false;
-    /**
-     * Creates a model object based on the hash key or model string.
-     *
-     * @param hash A number or string of the model's hash. Example: "mp_m_freemode_01"
-     */
-    constructor(hash) {
-        if (typeof hash === "string") {
-            this.hash = GetHashKey(hash);
-        }
-        else {
-            this.hash = hash;
-        }
-    }
-    [Symbol.dispose]() {
-        if (this.requestedModel) {
-            this.markAsNoLongerNeeded();
-        }
-    }
-    /**
-     * Gets the hash of the model.
-     *
-     * @returns The hash key.
-     */
-    get Hash() {
-        return this.hash;
-    }
-    /**
-     * Gets if the model is valid or not.
-     *
-     * @returns Whether this model is valid.
-     */
-    get IsValid() {
-        return IsModelValid(this.hash);
-    }
-    /**
-     * Gets if the model is in cd image or not.
-     *
-     * @returns Whether this model is in cd image.
-     */
-    get IsInCdImage() {
-        return IsModelInCdimage(this.hash);
-    }
-    /**
-     * Gets if the model is loaded or not.
-     *
-     * @returns Whether this model is loaded.
-     */
-    get IsLoaded() {
-        return HasModelLoaded(this.hash);
-    }
-    /**
-     * Gets if the model collision is loaded or not.
-     *
-     * @returns Whether this model collision is loaded.
-     */
-    get IsCollisionLoaded() {
-        return HasCollisionForModelLoaded(this.hash);
-    }
-    /**
-     * Gets if the model is a boat or not.
-     *
-     * @returns Whether this model is a boat.
-     */
-    get IsBoat() {
-        return IsThisModelABoat(this.hash);
-    }
-    /**
-     * Gets if the model is a Ped or not.
-     *
-     * @returns Whether this model is a Ped.
-     */
-    get IsPed() {
-        return IsModelAPed(this.hash);
-    }
-    /**
-     * Gets if the model is a prop or not.
-     *
-     * @returns Whether this model is a prop.
-     */
-    get IsProp() {
-        return (this.IsValid &&
-            !this.IsPed &&
-            !this.IsVehicle &&
-            !IsWeaponValid(this.hash));
-    }
-    /**
-     * Gets if the model is a train or not.
-     *
-     * @returns Whether this model is a train.
-     */
-    get IsTrain() {
-        return IsThisModelATrain(this.hash);
-    }
-    /**
-     * Gets if the model is a Vehicle or not.
-     *
-     * @returns Whether this model is a Vehicle.
-     */
-    get IsVehicle() {
-        return IsModelAVehicle(this.hash);
-    }
-    /**
-     * Gets the model dimensions.
-     *
-     * @returns This model min & max dimensions.
-     */
-    get Dimensions() {
-        const [minArray, maxArray] = GetModelDimensions(this.hash);
-        const min = Vector3.fromArray(minArray);
-        const max = Vector3.fromArray(maxArray);
-        return { min, max };
-    }
-    /**
-     * Request and load the model with a specified timeout. Default timeout is 1000 (recommended).
-     * This function will not automatically set the model as no longer needed when
-     * done.
-     *
-     * @param timeoutMs Maximum allowed time for model to load.
-     */
-    async request(timeoutMs = 1000) {
-        if (!this.IsInCdImage && !this.IsValid && !IsWeaponValid(this.hash)) {
-            return false;
-        }
-        // pre-check so if its already loaded we don't add another ref
-        if (this.IsLoaded) {
-            return true;
-        }
-        RequestModel(this.hash, false);
-        const timeout = GetGameTimer() + timeoutMs;
-        while (!this.IsLoaded && GetGameTimer() < timeout) {
-            await Delay(0);
-        }
-        this.requestedModel = true;
-        return this.IsLoaded;
-    }
-    /**
-     * Sets the model as no longer needed allowing the game engine to free memory.
-     */
-    markAsNoLongerNeeded() {
-        SetModelAsNoLongerNeeded(this.hash);
-    }
-}

package/RawControls.js

@@ -1,14 +0,0 @@
-export class RawControls {
-    static IsKeyDown(rawKey) {
-        return IsRawKeyDown(rawKey);
-    }
-    static IsKeyPressed(rawKey) {
-        return IsRawKeyPressed(rawKey);
-    }
-    static IsKeyReleased(rawKey) {
-        return IsRawKeyReleased(rawKey);
-    }
-    static IsKeyUp(rawKey) {
-        return IsRawKeyUp(rawKey);
-    }
-}

package/RelationshipGroup.js

@@ -1,67 +0,0 @@
-/**
- * Class to create and manage a relationship group. Useful to manage behavior between Peds.
- */
-export class RelationshipGroup {
-    /**
-     * The hash of the relationship group
-     */
-    hash;
-    /**
-     * Create a relationship group. Optionally pass a group hash.
-     *
-     * @param name Name of the relationship group.
-     */
-    constructor(name) {
-        const [, groupHash] = AddRelationshipGroup(name);
-        this.hash = groupHash;
-    }
-    /**
-     * Gets the hash of the relationship group.
-     *
-     * @returns The hash of this object.
-     */
-    get Hash() {
-        return this.hash;
-    }
-    /**
-     * Get the relationship between two relationship groups.
-     *
-     * @param targetGroup The other relationship group.
-     * @returns The relationship
-     */
-    getRelationshipBetweenGroups(targetGroup) {
-        return GetRelationshipBetweenGroups(this.Hash, targetGroup.Hash);
-    }
-    /**
-     * Set the relationship group between this relationship group and another one.
-     *
-     * @param targetGroup The other relationship group.
-     * @param relationship The desired relationship.
-     * @param biDirectionally If target group should have same relationship towards this.
-     */
-    setRelationshipBetweenGroups(targetGroup, relationship, biDirectionally = false) {
-        SetRelationshipBetweenGroups(Number(relationship), this.Hash, targetGroup.Hash);
-        if (biDirectionally) {
-            SetRelationshipBetweenGroups(Number(relationship), targetGroup.Hash, this.Hash);
-        }
-    }
-    /**
-     * Clear the relationship between this relationship group and another.
-     *
-     * @param targetGroup The other relationship group.
-     * @param relationship The desired relationship to clear.
-     * @param biDirectionally Whether the target group should also clear the relationship.
-     */
-    clearRelationshipBetweenGroups(targetGroup, relationship, biDirectionally = false) {
-        ClearRelationshipBetweenGroups(Number(relationship), this.Hash, targetGroup.Hash);
-        if (biDirectionally) {
-            ClearRelationshipBetweenGroups(Number(relationship), targetGroup.Hash, this.Hash);
-        }
-    }
-    /**
-     * Remove this relationship group from the game. This will not delete this object.
-     */
-    remove() {
-        RemoveRelationshipGroup(this.Hash);
-    }
-}

package/Volume.js

@@ -1,13 +0,0 @@
-export class Volume {
-    handle;
-    constructor(coord, rot, scale, customName) {
-        if (customName) {
-            this.handle = CreateVolumeCylinderWithCustomName(coord.x, coord.y, coord.z, rot.x, rot.y, rot.z, scale.x, scale.y, scale.z, customName);
-            return;
-        }
-        this.handle = CreateVolumeCylinder(coord.x, coord.y, coord.z, rot.x, rot.y, rot.z, scale.x, scale.y, scale.z);
-    }
-    get Handle() {
-        return this.handle;
-    }
-}

package/entities/BaseEntity.js

@@ -1,91 +0,0 @@
-import { Vector3 } from "../../common/utils";
-export class BaseEntity {
-    handle;
-    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
-      * })
-      ```
-      */
-    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/Entity.js

@@ -1,59 +0,0 @@
-import { EntityType, ForceType } from "../enums/Entity";
-import { _N } from "../utils";
-import { BaseEntity } from "./BaseEntity";
-export class Entity extends BaseEntity {
-    // NOTE: There is nothing stopping you from using creating an invalid entity, you should do your own due-diligence
-    constructor(handle) {
-        super(handle);
-    }
-    addTrackingTrails() {
-        // _ADD_ENTITY_TRACKING_TRAILS
-        _N("0x1AD922AB5038DEF3", this.Handle);
-    }
-    get EntityType() {
-        return GetEntityType(this.Handle);
-    }
-    /**
-     * @param direction - the direction to apply the force towards
-     * @param offset - the offset to apply the force to
-     * @param forceType - the force type to apply
-     * @param boneIndex - the boneIndex to apply the force to, or 0
-     * @param isDirectional - whether the direction is relational?
-     * @param ignoreUpVec - ?
-     * @param isForceRel - whether to multiply the force by the object mass & acceleration
-     */
-    applyForce(direction, offset, forceType = ForceType.MinForce, boneIndex = 0, isDirectional = false, ignoreUpVec = true, isForceRel = true) {
-        const d = direction;
-        const o = offset;
-        ApplyForceToEntity(this.Handle, forceType, d.x, d.y, d.z, o.x, o.y, o.z, boneIndex, isDirectional, ignoreUpVec, isForceRel, false, true);
-    }
-    /**
-     * @param direction - the direction to apply the force towards
-     * @param forceType - the force type to use
-     * @param isDirectional - whether the direction is local?
-     * @param isForceRel - whether to multiply the force by the object mass & acceleration
-     */
-    applyForceToCenter(direction, forceType = ForceType.MinForce, isDirectional = false, isForceRel = true) {
-        const d = direction;
-        ApplyForceToEntityCenterOfMass(this.Handle, forceType, d.x, d.y, d.z, false, isDirectional, isForceRel, false);
-    }
-    /**
-     * @param tgtEntity - the entity to attach to the {@Entity}
-     * @param pos - the position offset
-     * @param rot - the rotation to apply to the entity
-     * @param boneIndex - the bone to attach the entity to, or 0 for the center of the entity
-     * @param enableCollision - whether the entity should have collision enabled
-     * @param useSoftPinning - when false the entity will not detach from the {@Entity}
-     * @param vertexIndex -  ?
-     * @param fixedRot - ?
-     * @throws Error if tgtEntity and {@Entity} are the same entity
-     */
-    attachTo(tgtEntity, pos, rot, boneIndex = 0, enableCollision = true, useSoftPinning = false, vertexIndex = 0, fixedRot = true) {
-        if (tgtEntity.Handle === this.Handle) {
-            throw new Error("tgtEntity had the same handle as the current entity, attaching an entity to itself will crash");
-        }
-        const p = pos;
-        const r = rot;
-        AttachEntityToEntity(tgtEntity.Handle, this.Handle, boneIndex, p.x, p.y, p.z, r.x, r.y, r.z, false, useSoftPinning, enableCollision, (this.EntityType === EntityType.Ped), vertexIndex, fixedRot, false, false);
-    }
-}