@nativewrappers/redm-codegen 0.0.4 → 0.0.6

package/src/namespaces/Map.ts

@@ -12,143 +12,230 @@ import { inv, rai, raf, ras, rav, pvi, pvf, pvv, pvii, pvfi, _h, f } from '../ty
 
 export class Map {
   /**
-   * Doesn't actually return anything.
+   * Clear blip data. It must be used before RemoveBlip I'm pretty sure that blips are handled internally with databinding. This function should then allow you to clear blip container and therefore free up memory?.
    *
+   * @param blipid 
    * @returns
    */
-  static forceSonarBlipsThisFrame(): any {
-    return inv<number>('0xEE1C7BA69BB74B08');
+  static clearBlip(blipid: number): any {
+    return inv<number>('0x01B928CA2E198B01', blipid);
   }
 
   /**
-   * @param scale 
-   * @param p1 
+   * hash can be the hash of "guarma" or "world".
+   *
+   * @param zone 
    */
-  static setMinimapFowOverrideRevealScale(scale: number, p1: string | number): void {
-    inv<void>('0xE5A7F70B7C0F3271', f(scale), _h(p1));
+  static setMinimapZone(zone: string | number): void {
+    inv<void>('0xA657EC9DBC6CC900', _h(zone));
   }
 
   /**
-   * @param regionHash 
+   * @param blipHash 
+   * @param pos 
+   * @param radius 
+   * @returns
    */
-  static disableRegionBlip(regionHash: string | number): void {
-    inv<void>('0x6786D7AFAC3162B3', _h(regionHash));
+  static blipAddForRadius(blipHash: string | number, pos: Vector3, radius: number): number {
+    return inv<number>('0x45F13B7E0A15C880', _h(blipHash), f(pos.x), f(pos.y), f(pos.z), f(radius), rai());
   }
 
   /**
-   * in the decompiles this doesnt seem to ever be executed the param needed needs to be above 0 but its always passed as 0
-   * removes the icon from lockon prompt
-   *
-   * @param entity 
-   * @param p1 
+   * @param waypointRecording 
+   * @param point 
+   * @param numPoints 
+   * @param colorNameHash 
+   * @param p4 
+   * @param p5 
    */
-  static removeBlipIconFromEntityLockonPrompt(entity: Entity, p1: number): void {
-    inv<void>('0xBB68D4D3CA3DE402', entity.handle, p1);
+  static startGpsCustomRouteFromWaypointRecordingRoute(waypointRecording: string | null, point: number, numPoints: number, colorNameHash: string | number, p4: boolean, p5: boolean): void {
+    inv<void>('0x6B44F13D888F770D', waypointRecording, point, numPoints, _h(colorNameHash), p4, p5);
   }
 
   /**
-   * @param hash 
+   * @param pos 
+   * @returns outPosition
    */
-  static revealMinimapFow(hash: string | number): void {
-    inv<void>('0xF8096DF9B87246E3', _h(hash));
+  static findClosestGpsPosition(pos: Vector3): [any, Vector3] {
+    const result = inv<[number, number[]]>('0x3FDA2B79AEEE351C', f(pos.x), f(pos.y), f(pos.z), pvv());
+    return [result[0], Vector3.fromArray(result[1])];
+  }
+
+  /**
+   * @returns
+   */
+  static getMainPlayerBlipId(): number {
+    return inv<number>('0x5CD2889B2B381D45', rai());
+  }
+
+  /**
+   * @param blipHash 
+   * @param pos 
+   * @param scale 
+   * @param p7 
+   * @returns
+   */
+  static blipAddForArea(blipHash: string | number, pos: Vector3, scale: Vector3, p7: number): number {
+    return inv<number>('0xEC174ADBCB611ECC', _h(blipHash), f(pos.x), f(pos.y), f(pos.z), f(scale.x), f(scale.y), f(scale.z), p7, rai());
   }
 
   /**
    * @param blip 
+   * @param scale 
+   */
+  static setBlipScale(blip: number, scale: number): void {
+    inv<void>('0xD38744167B2FA257', blip, f(scale));
+  }
+
+  /**
+   * Checks if the GPS route to the waypoint is navigable along a road. If a route exists but there is no valid road path, this function returns false.
+   *
    * @returns
    */
-  static getBlipCoords(blip: number): Vector3 {
-    return Vector3.fromArray(inv<number[]>('0x201C319797BDA603', blip, rav()));
+  static isGpsRouteOnRoad(): any {
+    return inv<number>('0xF47A1EB2A538A3A3');
   }
 
   /**
-   * https://github.com/femga/rdr3_discoveries/blob/master/graphics/minimap/radar/radar_configs.lua
-   * configHash: -1943724816, 347777538, -117986897, -789269373, -547506804, -1986542417, 2080113112
-   * p1: usually 898171178 or 0 in R* scripts (doesn't seems to have any effect)
+   * list of minimap props: https://github.com/femga/rdr3_discoveries/tree/master/graphics/minimap/minimapObjects
+   * variations parameter are the interior locations you see on the map like these bellow
+   * variation 0 https://i.imgur.com/jkLhn3Z.png
+   * variation 2 https://i.imgur.com/eKV0Tcm.png
+   * variation 4 https://i.imgur.com/rjwOgEH.png
+   * there are more and you can find them in the decompiles
    *
-   * @param configHash 
+   * @param minimapProp 
+   * @param pos 
+   * @param rotation 
+   * @param variation 
+   */
+  static addPropToMinimap(minimapProp: string | number, pos: Vector2, rotation: number, variation: number): void {
+    inv<void>('0x1392105DA88BBFFB', _h(minimapProp), f(pos.x), f(pos.y), f(rotation), variation);
+  }
+
+  /**
+   * @param minimapProp 
+   */
+  static removePropFromMinimap(minimapProp: string | number): void {
+    inv<void>('0xE057FEA9A22EB3EE', _h(minimapProp));
+  }
+
+  /**
+   * will remove the blip icon from the entity lockon prompt, use 0 for p1
+   *
+   * @param entity 
    * @param p1 
    */
-  static setRadarConfigType(configHash: string | number, p1: string | number): void {
-    inv<void>('0x9C113883487FD53C', _h(configHash), _h(p1));
+  static clearBlipIconFromLockonEntityPrompt(entity: Entity, p1: number): void {
+    inv<void>('0x44813684F72B563C', entity.handle, p1);
   }
 
   /**
-   * It's unclear what exactly this does, but I assume it marks the blip as "no longer needed"
+   * https://alloc8or.re/rdr3/doc/enums/rage__eGpsFlags.txt
    *
-   * @param blip 
+   * @param p0 
+   * @param p1 
    */
-  static abandonBlip(blip: number): void {
-    inv<void>('0xDEEDE7C41742E011', blip);
+  static setGpsFlags(p0: number, p1: number): void {
+    inv<void>('0x5DE61C90DDECFA2D', p0, f(p1));
   }
 
   /**
    * @param blip 
-   * @param styleHash 
-   * @returns
+   * @param player 
    */
-  static blipAddStyle(blip: number, styleHash: string | number): any {
-    return inv<number>('0xBD62D98799A3DAF0', blip, _h(styleHash));
+  static setBlipNameToPlayerName(blip: number, player: Player): void {
+    inv<void>('0x093DD5A31BC2B459', blip, player.handle);
   }
 
   /**
+   * @param blip 
+   * @param blipType 
    * @param blipHash 
-   * @param volume 
-   * @returns
    */
-  static blipAddForVolume(blipHash: string | number, volume: Volume): number {
-    return inv<number>('0xA6EF0C54A3443E70', _h(blipHash), volume.handle, rai());
+  static setBlipFlashTimer(blip: number, blipType: number, blipHash: string | number): void {
+    inv<void>('0x02FF4CF43B7209D1', blip, blipType, _h(blipHash));
   }
 
   /**
-   * If modifierHash is 0, ALL modifiers will be removed.
-   *
-   * @param blip 
-   * @param modifierHash 
-   * @returns
+   * @param hash 
    */
-  static blipRemoveModifier(blip: number, modifierHash: string | number): any {
-    return inv<number>('0xB059D7BD3D78C16F', blip, _h(modifierHash));
+  static resetMinimapFow(hash: string | number): void {
+    inv<void>('0xEB3CB3386C775D72', _h(hash));
   }
 
-  static unlockMinimapAngle(): void {
-    inv<void>('0x5373DE8E179BC2A0');
+  /**
+   * @param colorNameHash 
+   * @param onFoot 
+   * @param inVehicle 
+   */
+  static startGpsMultiRoute(colorNameHash: string | number, onFoot: boolean, inVehicle: boolean): void {
+    inv<void>('0x3D3D15AF7BCAAF83', _h(colorNameHash), onFoot, inVehicle);
   }
 
   /**
-   * @param blipHash 
+   * will add a blip icon to the entity lockon prompt that you specify
+   *
    * @param entity 
-   * @returns
+   * @param blipIcon 
    */
-  static blipAddForEntity(blipHash: string | number, entity: Entity): number {
-    return inv<number>('0x23F74C2FDA6E7C61', _h(blipHash), entity.handle, rai());
+  static setBlipIconToLockonEntityPrompt(entity: Entity, blipIcon: string | number): void {
+    inv<void>('0x7563CBCA99253D1A', entity.handle, _h(blipIcon));
   }
 
   /**
-   * @param typeHash 
+   * Returns the Blip handle of given Entity.
+   *
    * @param entity 
+   * @returns
    */
-  static triggerSonarBlipOnEntity(typeHash: string | number, entity: Entity): void {
-    inv<void>('0x0C7A2289A5C4D7C9', _h(typeHash), entity.handle);
+  static getBlipFromEntity(entity: Entity): number {
+    return inv<number>('0x6D2C41A8BD6D6FD0', entity.handle, rai());
   }
 
   /**
-   * Not official native name
-   * Removes the blip from an entity and makes it static on the map, try it on GetMainPlayerBlipId() for a demonstration
+   * Clears the previously set coordinates for the pause map view, removing any specified focal point and radius that were set using `SetPausemapCoordsWithRadius - 0xE0884C184728C75B`
+   */
+  static clearPausemapCoords(): void {
+    inv<void>('0x7C9F4CDF402CA82A');
+  }
+
+  /**
+   * Used for GUARMA MODE; Enabled: toggle = false, 0; Disabled: toggle = true, 0
+   * Hash p1 seems to be unused, always 0
    *
+   * @param toggle 
+   * @param p1 
+   */
+  static setFowUpdatePlayerOverride(toggle: boolean, p1: string | number): void {
+    inv<void>('0x63E7279D04160477', toggle, _h(p1));
+  }
+
+  /**
    * @param blip 
+   * @returns
    */
-  static blipDetachFromEntity(blip: number): void {
-    inv<void>('0x250C75EB1728CC0D', blip);
+  static isBlipOnMinimap(blip: number): boolean {
+    return !!inv<boolean>('0x46534526B9CD2D17', blip, rai());
   }
 
   /**
-   * Locks the minimap to the specified angle in integer degrees. angle: The angle in whole degrees. If less than 0 or greater than 360, unlocks the angle.
+   * https://alloc8or.re/rdr3/doc/enums/eBlipModifier.txt
+   * https://github.com/femga/rdr3_discoveries/tree/master/useful_info_from_rpfs/blip_modifiers Old name: _BLIP_SET_MODIFIER
    *
-   * @param angle 
+   * @param blip 
+   * @param modifierHash 
+   * @returns
    */
-  static lockMinimapAngle(angle: number): void {
-    inv<void>('0x0BFD145EF819FB3A', angle);
+  static blipAddModifier(blip: number, modifierHash: string | number): any {
+    return inv<number>('0x662D364ABF16DE2F', blip, _h(modifierHash));
+  }
+
+  /**
+   * Does the same as SET_GPS_MULTI_ROUTE_RENDER(false);
+   */
+  static clearGpsMultiRoute(): void {
+    inv<void>('0x9E0AB9AAEE87CE28');
   }
 
   /**
@@ -208,7 +295,7 @@ export class Map {
    * @returns
    */
   static isWaypointActive(): boolean {
-    return inv<boolean>('0x202B1BBFC6AB5EE4', rai());
+    return !!inv<boolean>('0x202B1BBFC6AB5EE4', rai());
   }
 
   /**
@@ -384,230 +471,143 @@ export class Map {
   }
 
   /**
-   * Clear blip data. It must be used before RemoveBlip I'm pretty sure that blips are handled internally with databinding. This function should then allow you to clear blip container and therefore free up memory?.
-   *
-   * @param blipid 
-   * @returns
-   */
-  static clearBlip(blipid: number): any {
-    return inv<number>('0x01B928CA2E198B01', blipid);
-  }
-
-  /**
-   * hash can be the hash of "guarma" or "world".
+   * Doesn't actually return anything.
    *
-   * @param zone 
-   */
-  static setMinimapZone(zone: string | number): void {
-    inv<void>('0xA657EC9DBC6CC900', _h(zone));
-  }
-
-  /**
-   * @param blipHash 
-   * @param pos 
-   * @param radius 
-   * @returns
-   */
-  static blipAddForRadius(blipHash: string | number, pos: Vector3, radius: number): number {
-    return inv<number>('0x45F13B7E0A15C880', _h(blipHash), f(pos.x), f(pos.y), f(pos.z), f(radius), rai());
-  }
-
-  /**
-   * @param waypointRecording 
-   * @param point 
-   * @param numPoints 
-   * @param colorNameHash 
-   * @param p4 
-   * @param p5 
-   */
-  static startGpsCustomRouteFromWaypointRecordingRoute(waypointRecording: string | null, point: number, numPoints: number, colorNameHash: string | number, p4: boolean, p5: boolean): void {
-    inv<void>('0x6B44F13D888F770D', waypointRecording, point, numPoints, _h(colorNameHash), p4, p5);
-  }
-
-  /**
-   * @param pos 
-   * @returns outPosition
-   */
-  static findClosestGpsPosition(pos: Vector3): [any, Vector3] {
-    const result = inv<[number, number[]]>('0x3FDA2B79AEEE351C', f(pos.x), f(pos.y), f(pos.z), pvv());
-    return [result[0], Vector3.fromArray(result[1])];
-  }
-
-  /**
    * @returns
    */
-  static getMainPlayerBlipId(): number {
-    return inv<number>('0x5CD2889B2B381D45', rai());
+  static forceSonarBlipsThisFrame(): any {
+    return inv<number>('0xEE1C7BA69BB74B08');
   }
 
   /**
-   * @param blipHash 
-   * @param pos 
    * @param scale 
-   * @param p7 
-   * @returns
+   * @param p1 
    */
-  static blipAddForArea(blipHash: string | number, pos: Vector3, scale: Vector3, p7: number): number {
-    return inv<number>('0xEC174ADBCB611ECC', _h(blipHash), f(pos.x), f(pos.y), f(pos.z), f(scale.x), f(scale.y), f(scale.z), p7, rai());
+  static setMinimapFowOverrideRevealScale(scale: number, p1: string | number): void {
+    inv<void>('0xE5A7F70B7C0F3271', f(scale), _h(p1));
   }
 
   /**
-   * @param blip 
-   * @param scale 
+   * @param regionHash 
    */
-  static setBlipScale(blip: number, scale: number): void {
-    inv<void>('0xD38744167B2FA257', blip, f(scale));
+  static disableRegionBlip(regionHash: string | number): void {
+    inv<void>('0x6786D7AFAC3162B3', _h(regionHash));
   }
 
   /**
-   * Checks if the GPS route to the waypoint is navigable along a road. If a route exists but there is no valid road path, this function returns false.
+   * in the decompiles this doesnt seem to ever be executed the param needed needs to be above 0 but its always passed as 0
+   * removes the icon from lockon prompt
    *
-   * @returns
+   * @param entity 
+   * @param p1 
    */
-  static isGpsRouteOnRoad(): any {
-    return inv<number>('0xF47A1EB2A538A3A3');
+  static removeBlipIconFromEntityLockonPrompt(entity: Entity, p1: number): void {
+    inv<void>('0xBB68D4D3CA3DE402', entity.handle, p1);
   }
 
   /**
-   * list of minimap props: https://github.com/femga/rdr3_discoveries/tree/master/graphics/minimap/minimapObjects
-   * variations parameter are the interior locations you see on the map like these bellow
-   * variation 0 https://i.imgur.com/jkLhn3Z.png
-   * variation 2 https://i.imgur.com/eKV0Tcm.png
-   * variation 4 https://i.imgur.com/rjwOgEH.png
-   * there are more and you can find them in the decompiles
-   *
-   * @param minimapProp 
-   * @param pos 
-   * @param rotation 
-   * @param variation 
+   * @param hash 
    */
-  static addPropToMinimap(minimapProp: string | number, pos: Vector2, rotation: number, variation: number): void {
-    inv<void>('0x1392105DA88BBFFB', _h(minimapProp), f(pos.x), f(pos.y), f(rotation), variation);
+  static revealMinimapFow(hash: string | number): void {
+    inv<void>('0xF8096DF9B87246E3', _h(hash));
   }
 
   /**
-   * @param minimapProp 
+   * @param blip 
+   * @returns
    */
-  static removePropFromMinimap(minimapProp: string | number): void {
-    inv<void>('0xE057FEA9A22EB3EE', _h(minimapProp));
+  static getBlipCoords(blip: number): Vector3 {
+    return Vector3.fromArray(inv<number[]>('0x201C319797BDA603', blip, rav()));
   }
 
   /**
-   * will remove the blip icon from the entity lockon prompt, use 0 for p1
+   * https://github.com/femga/rdr3_discoveries/blob/master/graphics/minimap/radar/radar_configs.lua
+   * configHash: -1943724816, 347777538, -117986897, -789269373, -547506804, -1986542417, 2080113112
+   * p1: usually 898171178 or 0 in R* scripts (doesn't seems to have any effect)
    *
-   * @param entity 
+   * @param configHash 
    * @param p1 
    */
-  static clearBlipIconFromLockonEntityPrompt(entity: Entity, p1: number): void {
-    inv<void>('0x44813684F72B563C', entity.handle, p1);
+  static setRadarConfigType(configHash: string | number, p1: string | number): void {
+    inv<void>('0x9C113883487FD53C', _h(configHash), _h(p1));
   }
 
   /**
-   * https://alloc8or.re/rdr3/doc/enums/rage__eGpsFlags.txt
+   * It's unclear what exactly this does, but I assume it marks the blip as "no longer needed"
    *
-   * @param p0 
-   * @param p1 
-   */
-  static setGpsFlags(p0: number, p1: number): void {
-    inv<void>('0x5DE61C90DDECFA2D', p0, f(p1));
-  }
-
-  /**
    * @param blip 
-   * @param player 
    */
-  static setBlipNameToPlayerName(blip: number, player: Player): void {
-    inv<void>('0x093DD5A31BC2B459', blip, player.handle);
+  static abandonBlip(blip: number): void {
+    inv<void>('0xDEEDE7C41742E011', blip);
   }
 
   /**
    * @param blip 
-   * @param blipType 
-   * @param blipHash 
+   * @param styleHash 
+   * @returns
    */
-  static setBlipFlashTimer(blip: number, blipType: number, blipHash: string | number): void {
-    inv<void>('0x02FF4CF43B7209D1', blip, blipType, _h(blipHash));
+  static blipAddStyle(blip: number, styleHash: string | number): any {
+    return inv<number>('0xBD62D98799A3DAF0', blip, _h(styleHash));
   }
 
   /**
-   * @param hash 
+   * @param blipHash 
+   * @param volume 
+   * @returns
    */
-  static resetMinimapFow(hash: string | number): void {
-    inv<void>('0xEB3CB3386C775D72', _h(hash));
+  static blipAddForVolume(blipHash: string | number, volume: Volume): number {
+    return inv<number>('0xA6EF0C54A3443E70', _h(blipHash), volume.handle, rai());
   }
 
   /**
-   * @param colorNameHash 
-   * @param onFoot 
-   * @param inVehicle 
+   * If modifierHash is 0, ALL modifiers will be removed.
+   *
+   * @param blip 
+   * @param modifierHash 
+   * @returns
    */
-  static startGpsMultiRoute(colorNameHash: string | number, onFoot: boolean, inVehicle: boolean): void {
-    inv<void>('0x3D3D15AF7BCAAF83', _h(colorNameHash), onFoot, inVehicle);
+  static blipRemoveModifier(blip: number, modifierHash: string | number): any {
+    return inv<number>('0xB059D7BD3D78C16F', blip, _h(modifierHash));
   }
 
-  /**
-   * will add a blip icon to the entity lockon prompt that you specify
-   *
-   * @param entity 
-   * @param blipIcon 
-   */
-  static setBlipIconToLockonEntityPrompt(entity: Entity, blipIcon: string | number): void {
-    inv<void>('0x7563CBCA99253D1A', entity.handle, _h(blipIcon));
+  static unlockMinimapAngle(): void {
+    inv<void>('0x5373DE8E179BC2A0');
   }
 
   /**
-   * Returns the Blip handle of given Entity.
-   *
+   * @param blipHash 
    * @param entity 
    * @returns
    */
-  static getBlipFromEntity(entity: Entity): number {
-    return inv<number>('0x6D2C41A8BD6D6FD0', entity.handle, rai());
+  static blipAddForEntity(blipHash: string | number, entity: Entity): number {
+    return inv<number>('0x23F74C2FDA6E7C61', _h(blipHash), entity.handle, rai());
   }
 
   /**
-   * Clears the previously set coordinates for the pause map view, removing any specified focal point and radius that were set using `SetPausemapCoordsWithRadius - 0xE0884C184728C75B`
+   * @param typeHash 
+   * @param entity 
    */
-  static clearPausemapCoords(): void {
-    inv<void>('0x7C9F4CDF402CA82A');
+  static triggerSonarBlipOnEntity(typeHash: string | number, entity: Entity): void {
+    inv<void>('0x0C7A2289A5C4D7C9', _h(typeHash), entity.handle);
   }
 
   /**
-   * Used for GUARMA MODE; Enabled: toggle = false, 0; Disabled: toggle = true, 0
-   * Hash p1 seems to be unused, always 0
+   * Not official native name
+   * Removes the blip from an entity and makes it static on the map, try it on GetMainPlayerBlipId() for a demonstration
    *
-   * @param toggle 
-   * @param p1 
-   */
-  static setFowUpdatePlayerOverride(toggle: boolean, p1: string | number): void {
-    inv<void>('0x63E7279D04160477', toggle, _h(p1));
-  }
-
-  /**
    * @param blip 
-   * @returns
    */
-  static isBlipOnMinimap(blip: number): boolean {
-    return inv<boolean>('0x46534526B9CD2D17', blip, rai());
+  static blipDetachFromEntity(blip: number): void {
+    inv<void>('0x250C75EB1728CC0D', blip);
   }
 
   /**
-   * https://alloc8or.re/rdr3/doc/enums/eBlipModifier.txt
-   * https://github.com/femga/rdr3_discoveries/tree/master/useful_info_from_rpfs/blip_modifiers Old name: _BLIP_SET_MODIFIER
+   * Locks the minimap to the specified angle in integer degrees. angle: The angle in whole degrees. If less than 0 or greater than 360, unlocks the angle.
    *
-   * @param blip 
-   * @param modifierHash 
-   * @returns
-   */
-  static blipAddModifier(blip: number, modifierHash: string | number): any {
-    return inv<number>('0x662D364ABF16DE2F', blip, _h(modifierHash));
-  }
-
-  /**
-   * Does the same as SET_GPS_MULTI_ROUTE_RENDER(false);
+   * @param angle 
    */
-  static clearGpsMultiRoute(): void {
-    inv<void>('0x9E0AB9AAEE87CE28');
+  static lockMinimapAngle(angle: number): void {
+    inv<void>('0x0BFD145EF819FB3A', angle);
   }
 
   /**
@@ -615,7 +615,7 @@ export class Map {
    * @returns
    */
   static doesBlipExist(blip: number): boolean {
-    return inv<boolean>('0xCD82FA174080B3B1', blip, rai());
+    return !!inv<boolean>('0xCD82FA174080B3B1', blip, rai());
   }
 
   /**