@nativewrappers/fivem 0.0.41 → 0.0.44

package/{client/RelationshipGroup.js → RelationshipGroup.js}

@@ -2,6 +2,10 @@
  * 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.
      *

package/{client/Rope.d.ts → Rope.d.ts}

@@ -1,5 +1,5 @@
-import type { BaseEntity } from './models/BaseEntity';
-import { Vector3 } from './utils';
+import type { BaseEntity } from "./models/BaseEntity";
+import { Vector3 } from "./utils";
 /**
  * Class to manage invisible ropes between entities.
  */

package/{client/Rope.js → Rope.js}

@@ -1,8 +1,12 @@
-import { Vector3 } from './utils';
+import { Vector3 } from "./utils";
 /**
  * Class to manage invisible ropes between entities.
  */
 export class Rope {
+    /**
+     * Id of rope entity.
+     */
+    handle;
     /**
      * Create a rope object based on an existing rope in the world.
      *
@@ -71,7 +75,7 @@ export class Rope {
      * @param length The desired length of the rope between the two entities.
      */
     attachEntities(entityOne, positionOne, entityTwo, positionTwo, length) {
-        AttachEntitiesToRope(this.handle, entityOne.Handle, entityTwo.Handle, positionOne.x, positionOne.y, positionOne.z, positionTwo.x, positionTwo.y, positionTwo.z, length, false, false, '', '');
+        AttachEntitiesToRope(this.handle, entityOne.Handle, entityTwo.Handle, positionOne.x, positionOne.y, positionOne.z, positionTwo.x, positionTwo.y, positionTwo.z, length, false, false, "", "");
     }
     /**
      * Detach the rope from an entity.

package/{client/TaskSequence.d.ts → TaskSequence.d.ts}

@@ -1,4 +1,4 @@
-import { Tasks } from './Tasks';
+import { Tasks } from "./Tasks";
 export declare class TaskSequence {
     private static nullTask;
     private handle;

package/{client/TaskSequence.js → TaskSequence.js}

@@ -1,8 +1,11 @@
-import { Tasks } from './Tasks';
+import { Tasks } from "./Tasks";
 // TODO: Figure out why this uses 'null ped'
 export class TaskSequence {
+    static nullTask;
+    handle = 0;
+    isClosed;
+    count;
     constructor(handle) {
-        this.handle = 0;
         handle === undefined ? this.create() : (this.handle = handle);
         if (!TaskSequence.nullTask) {
             TaskSequence.nullTask = new Tasks(null);

package/{client/Tasks.d.ts → Tasks.d.ts}

@@ -1,8 +1,8 @@
-import { AnimationFlags, DrivingStyle, FiringPattern, LeaveVehicleFlags, VehicleSeat } from './enums';
-import { Ped, Vehicle } from './models';
-import { BaseEntity } from './models/BaseEntity';
-import { TaskSequence } from './TaskSequence';
-import { Vector3 } from './utils';
+import { AnimationFlags, DrivingStyle, FiringPattern, LeaveVehicleFlags, VehicleSeat } from "./enums";
+import { Ped, Vehicle } from "./models";
+import { BaseEntity } from "./models/BaseEntity";
+import { TaskSequence } from "./TaskSequence";
+import { Vector3 } from "./utils";
 export declare class Tasks {
     private ped;
     constructor(ped: Ped | null);

package/{client/Tasks.js → Tasks.js}

@@ -1,9 +1,10 @@
-import { DrivingStyle, FiringPattern, VehicleSeat, } from './enums';
-import { Ped } from './models';
-import { BaseEntity } from './models/BaseEntity';
-import { Vector3 } from './utils';
-import { LoadAnimDict } from './utils/Animations';
+import { DrivingStyle, FiringPattern, VehicleSeat, } from "./enums";
+import { Ped } from "./models";
+import { BaseEntity } from "./models/BaseEntity";
+import { Vector3 } from "./utils";
+import { LoadAnimDict } from "./utils/Animations";
 export class Tasks {
+    ped;
     // we take null because sequences have a null ped, if you pass null to this
     // you betterk now what you're doing.
     constructor(ped) {
@@ -88,7 +89,7 @@ export class Tasks {
     }
     followPointRoute(points) {
         TaskFlushRoute();
-        points.forEach(point => TaskExtendRoute(point.x, point.y, point.z));
+        points.forEach((point) => TaskExtendRoute(point.x, point.y, point.z));
         TaskFollowPointRoute(this.ped.Handle, 1, 0);
     }
     followToOffsetFromEntity(target, offset, timeout, stoppingRange, movementSpeed = 1, persistFollowing = true) {

package/{client/World.d.ts → World.d.ts}

@@ -1,13 +1,13 @@
-import { Model, Prop } from './';
-import { Blip } from './Blip';
-import { Camera } from './Camera';
-import { CameraTypes, CloudHat, IntersectFlags, MarkerType, PickupType, RopeType, Weather } from './enums';
-import { Ped, Vehicle } from './models';
-import type { BaseEntity } from './models/BaseEntity';
-import { Pickup } from './Pickup';
-import { AsynchronousRaycastResult, SynchronousRaycastResult } from './Raycast';
-import { Rope } from './Rope';
-import { Color, Vector3 } from './utils';
+import { Model, Prop } from "./";
+import { Blip } from "./Blip";
+import { Camera } from "./Camera";
+import { CameraTypes, CloudHat, IntersectFlags, MarkerType, PickupType, RopeType, Weather } from "./enums";
+import { Ped, Vehicle } from "./models";
+import type { BaseEntity } from "./models/BaseEntity";
+import { Pickup } from "./Pickup";
+import { AsynchronousRaycastResult, SynchronousRaycastResult } from "./Raycast";
+import { Rope } from "./Rope";
+import { Color, Vector3 } from "./utils";
 /**
  * Class with common world manipulations.
  *
@@ -109,11 +109,19 @@ export declare abstract class World {
     /**
      * Doesn't work
      */
-    static get WeatherTransition(): [string | Weather, string | Weather, number];
+    static get WeatherTransition(): [
+        string | Weather,
+        string | Weather,
+        number
+    ];
     /**
      * Doesn't work
      */
-    static set WeatherTransition(transition: [string | Weather, string | Weather, number]);
+    static set WeatherTransition(transition: [
+        string | Weather,
+        string | Weather,
+        number
+    ]);
     /**
      * Transition to different weather type within a certain time.
      *

package/{client/World.js → World.js}

@@ -1,14 +1,14 @@
-import { Model, Prop } from './';
-import { Blip } from './Blip';
-import { Camera } from './Camera';
-import { CameraTypes, CloudHat, IntersectFlags, SHAPE_TEST_DEFAULT, Weather, } from './enums';
-import { GameplayCamera } from './GameplayCamera';
-import { VehicleHash } from './hashes';
-import { Ped, Vehicle } from './models';
-import { Pickup } from './Pickup';
-import { AsynchronousRaycastResult, SynchronousRaycastResult } from './Raycast';
-import { Rope } from './Rope';
-import { Maths, Vector3, Wait } from './utils';
+import { Model, Prop } from "./";
+import { Blip } from "./Blip";
+import { Camera } from "./Camera";
+import { CameraTypes, CloudHat, IntersectFlags, SHAPE_TEST_DEFAULT, Weather, } from "./enums";
+import { GameplayCamera } from "./GameplayCamera";
+import { VehicleHash } from "./hashes";
+import { Ped, Vehicle } from "./models";
+import { Pickup } from "./Pickup";
+import { AsynchronousRaycastResult, SynchronousRaycastResult } from "./Raycast";
+import { Rope } from "./Rope";
+import { Maths, Vector3, Wait } from "./utils";
 /**
  * Class with common world manipulations.
  *
@@ -106,7 +106,7 @@ export class World {
             ClearCloudHat();
             return;
         }
-        SetCloudHatTransition(this.cloudHatDict.get(this.currentCloudHat) ?? '', 3);
+        SetCloudHatTransition(this.cloudHatDict.get(this.currentCloudHat) ?? "", 3);
     }
     /**
      * Get the opacity of current cloud hat. Value is between 0-1.
@@ -234,7 +234,11 @@ export class World {
      */
     static get WeatherTransition() {
         const transition = GetWeatherTypeTransition();
-        return [this.weatherDict[transition[0]], this.weatherDict[transition[1]], transition[2]];
+        return [
+            this.weatherDict[transition[0]],
+            this.weatherDict[transition[1]],
+            transition[2],
+        ];
     }
     /**
      * Doesn't work
@@ -648,9 +652,9 @@ export class World {
      * @returns Array of Props.
      */
     static getAllProps() {
-        const handles = GetGamePool('CObject');
+        const handles = GetGamePool("CObject");
         const props = [];
-        handles.forEach(handle => props.push(new Prop(handle)));
+        handles.forEach((handle) => props.push(new Prop(handle)));
         return props;
     }
     /**
@@ -661,7 +665,7 @@ export class World {
     static getAllRopes() {
         const handles = GetAllRopes();
         const props = [];
-        handles.forEach(handle => props.push(new Rope(handle)));
+        handles.forEach((handle) => props.push(new Rope(handle)));
         return props;
     }
     /**
@@ -670,9 +674,9 @@ export class World {
      * @returns Array of Peds.
      */
     static getAllPeds() {
-        const handles = GetGamePool('CPed');
+        const handles = GetGamePool("CPed");
         const peds = [];
-        handles.forEach(handle => peds.push(new Ped(handle)));
+        handles.forEach((handle) => peds.push(new Ped(handle)));
         return peds;
     }
     /**
@@ -681,9 +685,9 @@ export class World {
      * @returns Array of Vehicles.
      */
     static getAllVehicles() {
-        const handles = GetGamePool('CVehicle');
+        const handles = GetGamePool("CVehicle");
         const vehicles = [];
-        handles.forEach(handle => vehicles.push(new Vehicle(handle)));
+        handles.forEach((handle) => vehicles.push(new Vehicle(handle)));
         return vehicles;
     }
     /**
@@ -713,49 +717,49 @@ export class World {
      * @returns Array of Pickups.
      */
     static getAllPickups() {
-        const handles = GetGamePool('CPickup');
+        const handles = GetGamePool("CPickup");
         const pickups = [];
-        handles.forEach(handle => pickups.push(new Pickup(handle)));
+        handles.forEach((handle) => pickups.push(new Pickup(handle)));
         return pickups;
     }
+    static currentCloudHat = CloudHat.Clear;
+    static cloudHatDict = new Map([
+        [CloudHat.Unknown, "Unknown"],
+        [CloudHat.Altostratus, "altostratus"],
+        [CloudHat.Cirrus, "Cirrus"],
+        [CloudHat.Cirrocumulus, "cirrocumulus"],
+        [CloudHat.Clear, "Clear 01"],
+        [CloudHat.Cloudy, "Cloudy 01"],
+        [CloudHat.Contrails, "Contrails"],
+        [CloudHat.Horizon, "Horizon"],
+        [CloudHat.HorizonBand1, "horizonband1"],
+        [CloudHat.HorizonBand2, "horizonband2"],
+        [CloudHat.HorizonBand3, "horizonband3"],
+        [CloudHat.Horsey, "horsey"],
+        [CloudHat.Nimbus, "Nimbus"],
+        [CloudHat.Puffs, "Puffs"],
+        [CloudHat.Rain, "RAIN"],
+        [CloudHat.Snowy, "Snowy 01"],
+        [CloudHat.Stormy, "Stormy 01"],
+        [CloudHat.Stratoscumulus, "stratoscumulus"],
+        [CloudHat.Stripey, "Stripey"],
+        [CloudHat.Shower, "shower"],
+        [CloudHat.Wispy, "Wispy"],
+    ]);
+    static weatherDict = [
+        "EXTRASUNNY",
+        "CLEAR",
+        "CLOUDS",
+        "SMOG",
+        "FOGGY",
+        "OVERCAST",
+        "RAIN",
+        "THUNDER",
+        "CLEARING",
+        "NEUTRAL",
+        "SNOW",
+        "BLIZZARD",
+        "SNOWLIGHT",
+        "XMAS",
+    ];
 }
-World.currentCloudHat = CloudHat.Clear;
-World.cloudHatDict = new Map([
-    [CloudHat.Unknown, 'Unknown'],
-    [CloudHat.Altostratus, 'altostratus'],
-    [CloudHat.Cirrus, 'Cirrus'],
-    [CloudHat.Cirrocumulus, 'cirrocumulus'],
-    [CloudHat.Clear, 'Clear 01'],
-    [CloudHat.Cloudy, 'Cloudy 01'],
-    [CloudHat.Contrails, 'Contrails'],
-    [CloudHat.Horizon, 'Horizon'],
-    [CloudHat.HorizonBand1, 'horizonband1'],
-    [CloudHat.HorizonBand2, 'horizonband2'],
-    [CloudHat.HorizonBand3, 'horizonband3'],
-    [CloudHat.Horsey, 'horsey'],
-    [CloudHat.Nimbus, 'Nimbus'],
-    [CloudHat.Puffs, 'Puffs'],
-    [CloudHat.Rain, 'RAIN'],
-    [CloudHat.Snowy, 'Snowy 01'],
-    [CloudHat.Stormy, 'Stormy 01'],
-    [CloudHat.Stratoscumulus, 'stratoscumulus'],
-    [CloudHat.Stripey, 'Stripey'],
-    [CloudHat.Shower, 'shower'],
-    [CloudHat.Wispy, 'Wispy'],
-]);
-World.weatherDict = [
-    'EXTRASUNNY',
-    'CLEAR',
-    'CLOUDS',
-    'SMOG',
-    'FOGGY',
-    'OVERCAST',
-    'RAIN',
-    'THUNDER',
-    'CLEARING',
-    'NEUTRAL',
-    'SNOW',
-    'BLIZZARD',
-    'SNOWLIGHT',
-    'XMAS',
-];

package/{client/cfx → cfx}/index.d.ts

@@ -1,4 +1,4 @@
-export { StateBagChangeHandler } from './StateBagChangeHandler';
+export { StateBagChangeHandler } from "./StateBagChangeHandler";
 declare const _default: {
     Entity: typeof Entity;
     Player: typeof Player;

package/{client/enums → enums}/RaycastEnums.js

@@ -27,4 +27,6 @@ export var ShapeTestStatus;
     ShapeTestStatus[ShapeTestStatus["NotReady"] = 1] = "NotReady";
     ShapeTestStatus[ShapeTestStatus["Ready"] = 2] = "Ready";
 })(ShapeTestStatus || (ShapeTestStatus = {}));
-export const SHAPE_TEST_DEFAULT = ShapeTestOptions.IgnoreGlass | ShapeTestOptions.IgnoreSeeThrough | ShapeTestOptions.IgnoreNoCollision;
+export const SHAPE_TEST_DEFAULT = ShapeTestOptions.IgnoreGlass |
+    ShapeTestOptions.IgnoreSeeThrough |
+    ShapeTestOptions.IgnoreNoCollision;

package/enums/index.d.ts

@@ -0,0 +1,42 @@
+export { Alignment } from "./Alignment";
+export { AnimationFlags } from "./AnimationFlags";
+export { AudioFlag } from "./AudioFlag";
+export { BadgeStyle } from "./BadgeStyle";
+export { BlipColor, BlipSprite } from "./Blip";
+export { Bone } from "./Bone";
+export { CameraShake } from "./CameraShake";
+export { CheckboxStyle } from "./CheckboxStyle";
+export { CheckpointCustomIconStyle, CheckpointIcon } from "./Checkpoint";
+export { CloudHat } from "./CloudHat";
+export { Control } from "./Control";
+export { CursorSprite } from "./CursorSprite";
+export { DrivingStyle, VehicleDrivingFlags } from "./Driving";
+export { ExplosionType } from "./ExplosionType";
+export { FiringPattern } from "./FiringPattern";
+export { Font } from "./Font";
+export { ForceType } from "./ForceType";
+export { Gender } from "./Gender";
+export { HelmetType } from "./HelmetType";
+export { HudColor } from "./HudColor";
+export { HudComponent } from "./HudComponent";
+export { InputMode } from "./InputMode";
+export { IntersectFlags, ShapeTestOptions, SHAPE_TEST_DEFAULT, } from "./RaycastEnums";
+export { InvertAxis, InvertAxisFlags } from "./InvertAxis";
+export { Language } from "./Language";
+export { LeaveVehicleFlags } from "./LeaveVehicleFlags";
+export { LoadingSpinnerType } from "./LoadingSpinnerType";
+export { MarkerType } from "./MarkerType";
+export { MenuAlignment } from "./MenuAlignment";
+export { NotificationType } from "./NotificationType";
+export { ParachuteLandingType, ParachuteState } from "./Parachute";
+export { RadioStation } from "./RadioStation";
+export { RagdollType } from "./RagdollType";
+export { Relationship } from "./Relationship";
+export { RopeType } from "./RopeType";
+export { ScreenEffect } from "./ScreenEffect";
+export { SpeechModifier } from "./SpeechModifier";
+export * from "./Vehicle";
+export { Weather } from "./Weather";
+export { ZoneID } from "./ZoneID";
+export { PickupType } from "./PickupType";
+export { CameraTypes } from "./CameraTypes";

package/enums/index.js

@@ -0,0 +1,42 @@
+export { Alignment } from "./Alignment";
+export { AnimationFlags } from "./AnimationFlags";
+export { AudioFlag } from "./AudioFlag";
+export { BadgeStyle } from "./BadgeStyle";
+export { BlipColor, BlipSprite } from "./Blip";
+export { Bone } from "./Bone";
+export { CameraShake } from "./CameraShake";
+export { CheckboxStyle } from "./CheckboxStyle";
+export { CheckpointCustomIconStyle, CheckpointIcon } from "./Checkpoint";
+export { CloudHat } from "./CloudHat";
+export { Control } from "./Control";
+export { CursorSprite } from "./CursorSprite";
+export { DrivingStyle, VehicleDrivingFlags } from "./Driving";
+export { ExplosionType } from "./ExplosionType";
+export { FiringPattern } from "./FiringPattern";
+export { Font } from "./Font";
+export { ForceType } from "./ForceType";
+export { Gender } from "./Gender";
+export { HelmetType } from "./HelmetType";
+export { HudColor } from "./HudColor";
+export { HudComponent } from "./HudComponent";
+export { InputMode } from "./InputMode";
+export { IntersectFlags, ShapeTestOptions, SHAPE_TEST_DEFAULT, } from "./RaycastEnums";
+export { InvertAxisFlags } from "./InvertAxis";
+export { Language } from "./Language";
+export { LeaveVehicleFlags } from "./LeaveVehicleFlags";
+export { LoadingSpinnerType } from "./LoadingSpinnerType";
+export { MarkerType } from "./MarkerType";
+export { MenuAlignment } from "./MenuAlignment";
+export { NotificationType } from "./NotificationType";
+export { ParachuteLandingType, ParachuteState } from "./Parachute";
+export { RadioStation } from "./RadioStation";
+export { RagdollType } from "./RagdollType";
+export { Relationship } from "./Relationship";
+export { RopeType } from "./RopeType";
+export { ScreenEffect } from "./ScreenEffect";
+export { SpeechModifier } from "./SpeechModifier";
+export * from "./Vehicle";
+export { Weather } from "./Weather";
+export { ZoneID } from "./ZoneID";
+export { PickupType } from "./PickupType";
+export { CameraTypes } from "./CameraTypes";

package/hashes/index.d.ts

@@ -0,0 +1,5 @@
+export { MaterialHash } from "./MaterialHash";
+export { PedHash } from "./PedHash";
+export { VehicleHash } from "./VehicleHash";
+export { AmmoType, WeaponHash, VehicleWeaponHash } from "./WeaponHash";
+export { WeatherTypeHash } from "./WeatherTypeHash";

package/hashes/index.js

@@ -0,0 +1,5 @@
+export { MaterialHash } from "./MaterialHash";
+export { PedHash } from "./PedHash";
+export { VehicleHash } from "./VehicleHash";
+export { AmmoType, WeaponHash, VehicleWeaponHash } from "./WeaponHash";
+export { WeatherTypeHash } from "./WeatherTypeHash";

package/index.d.ts

@@ -0,0 +1,24 @@
+export * from "./utils";
+export { Game } from "./Game";
+export { World } from "./World";
+export { Model } from "./Model";
+export { Audio } from "./Audio";
+export { Blip } from "./Blip";
+export { Camera } from "./Camera";
+export { Checkpoint } from "./Checkpoint";
+export { GameplayCamera } from "./GameplayCamera";
+export { ParticleEffect } from "./ParticleEffect";
+export { ParticleEffectAsset } from "./ParticleEffectAsset";
+export { Pickup } from "./Pickup";
+export { AsynchronousRaycastResult, SynchronousRaycastResult } from "./Raycast";
+export { RelationshipGroup } from "./RelationshipGroup";
+export { Tasks } from "./Tasks";
+export { TaskSequence } from "./TaskSequence";
+export { NetworkedScene } from "./NetworkedScene";
+export { Rope } from "./Rope";
+export * from "./models";
+export * from "./enums";
+export * from "./hashes";
+export * from "./ui";
+export * from "./weapon";
+export * from "./weaponComponent";

package/index.js

@@ -0,0 +1,25 @@
+export * from "./utils";
+export { Game } from "./Game";
+export { World } from "./World";
+export { Model } from "./Model";
+export { Audio } from "./Audio";
+export { Blip } from "./Blip";
+export { Camera } from "./Camera";
+export { Checkpoint } from "./Checkpoint";
+export { GameplayCamera } from "./GameplayCamera";
+export { ParticleEffect } from "./ParticleEffect";
+export { ParticleEffectAsset } from "./ParticleEffectAsset";
+export { Pickup } from "./Pickup";
+export { AsynchronousRaycastResult, SynchronousRaycastResult } from "./Raycast";
+export { RelationshipGroup } from "./RelationshipGroup";
+export { Tasks } from "./Tasks";
+export { TaskSequence } from "./TaskSequence";
+export { NetworkedScene } from "./NetworkedScene";
+export { Rope } from "./Rope";
+// Lets export all from folders
+export * from "./models";
+export * from "./enums";
+export * from "./hashes";
+export * from "./ui";
+export * from "./weapon";
+export * from "./weaponComponent";

package/{client/interfaces → interfaces}/Dimensions.d.ts

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

package/{client/models → models}/BaseEntity.d.ts

@@ -1,12 +1,12 @@
-import { Blip } from '../Blip';
-import { ForceType } from '../enums';
-import { MaterialHash, WeaponHash } from '../hashes';
-import { Model } from '../Model';
-import { Quaternion, Vector3 } from '../utils';
-import { EntityBoneCollection } from './';
-import { EntityBone } from './EntityBone';
-import { StateBagChangeHandler } from '../cfx';
-import { ClassTypes } from '../../common/utils/ClassTypes';
+import { Blip } from "../Blip";
+import { ForceType } from "../enums";
+import { MaterialHash, WeaponHash } from "../hashes";
+import { Model } from "../Model";
+import { Quaternion, Vector3 } from "../utils";
+import { EntityBoneCollection } from "./";
+import { EntityBone } from "./EntityBone";
+import { StateBagChangeHandler } from "../cfx";
+import { ClassTypes } from "../../common/utils/ClassTypes";
 export declare class BaseEntity {
     static fromNetworkId(networkId: number): BaseEntity | null;
     static fromStateBagName(stateBagName: string): BaseEntity | null;
@@ -138,29 +138,29 @@ export declare class BaseEntity {
      */
     getOffsetInRelativeCoords(worldCoords: Vector3): Vector3;
     /**
-      * @example
-      * ```typescript
-      * const ply = Game.PlayerPed;
-      * const plyPos = ply.Position;
-      * const bag = await World.createProp(new Model('ba_prop_battle_bag_01b'), plyPos, true, true, true);
-      * bag.attachToBone(
-      *     ply.Bones.getBone(64113),
-      *     new Vector3(0.12, -0.25, 0.0),
-      *     new Vector3(105.0, 50.0, 190.0)
-      * )
-      * const offset = bag.getRelativePositionOffset(plyPos);
-      * ```
-      * @param worldCoords: the offset given the world coords
-      * @returns the offset position from the entity in relative coords
-      */
+     * @example
+     * ```typescript
+     * const ply = Game.PlayerPed;
+     * const plyPos = ply.Position;
+     * const bag = await World.createProp(new Model('ba_prop_battle_bag_01b'), plyPos, true, true, true);
+     * bag.attachToBone(
+     *     ply.Bones.getBone(64113),
+     *     new Vector3(0.12, -0.25, 0.0),
+     *     new Vector3(105.0, 50.0, 190.0)
+     * )
+     * const offset = bag.getRelativePositionOffset(plyPos);
+     * ```
+     * @param worldCoords: the offset given the world coords
+     * @returns the offset position from the entity in relative coords
+     */
     getOffsetInWorldCoords(offset: Vector3): Vector3;
     /**
      * @deprecated use [[getOffsetInRelativeCoords]] instead
      */
     getPositionOffset(worldCoords: Vector3): Vector3;
     /**
-      * @deprecated use [[getOffsetInWorldCoords]]
-      */
+     * @deprecated use [[getOffsetInWorldCoords]]
+     */
     getOffsetPosition(offset: Vector3): Vector3;
     attachTo(entity: BaseEntity, position: Vector3, rotation: Vector3, collisions?: boolean, unk9?: boolean, useSoftPinning?: boolean, rotationOrder?: number): void;
     attachToBone(entityBone: EntityBone, position: Vector3, rotation: Vector3, collisions?: boolean, unk9?: boolean, useSoftPinning?: boolean, rotationOrder?: number): void;