@citizenfx/server 2.0.13686-1 → 2.0.13759-1

package/natives_server.d.ts

@@ -177,35 +177,31 @@ declare function SetPedDecoration(ped: number, collection: string | number, over
 declare function AddStateBagChangeHandler(keyFilter: string, bagFilter: string, handler: Function): number;
 
 /**
- * Applies a force to the specified entity.
- * ```cpp
- * enum eForceType
- * {
- * MinForce = 0,
- * MaxForceRot = 1,
- * MinForce2 = 2,
- * MaxForceRot2 = 3,
- * ForceNoRot = 4,
- * ForceRotPlusForce = 5
+ * cpp
+ * enum eApplyForceTypes {
+ * APPLY_TYPE_FORCE = 0,
+ * APPLY_TYPE_IMPULSE = 1,
+ * APPLY_TYPE_EXTERNAL_FORCE = 2,
+ * APPLY_TYPE_EXTERNAL_IMPULSE = 3,
+ * APPLY_TYPE_TORQUE = 4,
+ * APPLY_TYPE_ANGULAR_IMPULSE = 5
  * }
- * ```
- * Research/documentation on the gtaforums can be found [here](https://gtaforums.com/topic/885669-precisely-define-object-physics/) and [here](https://gtaforums.com/topic/887362-apply-forces-and-momentums-to-entityobject/).
- * @param entity The entity you want to apply a force on
- * @param forceType Refer to `eForceType`
- * @param x Force amount (X)
- * @param y Force amount (Y)
- * @param z Force amount (Z)
- * @param offX Rotation/offset force (X)
- * @param offY Rotation/offset force (Y)
- * @param offZ Rotation/offset force (Z)
- * @param boneIndex (Often 0) Entity bone index
- * @param isDirectionRel (Usually false) Vector defined in local (body-fixed) coordinate frame
- * @param ignoreUpVec (Usually true)
- * @param isForceRel (Usually true) When true, force gets multiplied with the objects mass and different objects will have the same acceleration
- * @param p12 (Usually false)
- * @param p13 (Usually true)
- */
-declare function ApplyForceToEntity(entity: number, forceType: number, x: number, y: number, z: number, offX: number, offY: number, offZ: number, boneIndex: number, isDirectionRel: boolean, ignoreUpVec: boolean, isForceRel: boolean, p12: boolean, p13: boolean): void;
+ * @param entity The entity handle
+ * @param forceType The force type
+ * @param x The x component of the force to apply
+ * @param y The y component of the force to apply
+ * @param z The z component of the force to apply
+ * @param offX Offset from center of entity (X)
+ * @param offY Offset from center of entity (Y)
+ * @param offZ Offset from center of entity (Z)
+ * @param nComponent Component of the entity to apply the force too. Only matters for breakable or articulated (ragdoll) physics. 0 means the root or parent component
+ * @param bLocalForce Specifies whether the force vector passed in is in local or world coordinates. `true` means the force will get automatically transformed into world space before being applied
+ * @param bLocalOffset Specifies whether the offset passed in is in local or world coordinates
+ * @param bScaleByMass Specifies whether to scale the force by mass
+ * @param bPlayAudio Specifies whether to play audio events related to the force being applied. The audio will depend on the entity type. Currently vehicles are the only entity types supported, and will play a suspension squeal depending on the magnitude of the force
+ * @param bScaleByTimeWarp Specifies whether to scale the force by time warp. Default is `true`
+ */
+declare function ApplyForceToEntity(entity: number, forceType: number, x: number, y: number, z: number, offX: number, offY: number, offZ: number, nComponent: number, bLocalForce: boolean, bLocalOffset: boolean, bScaleByMass: boolean, bPlayAudio: boolean, bScaleByTimeWarp: boolean): void;
 
 /**
  * Returns whether or not the specified player has enough information to start a commerce session for.
@@ -2953,11 +2949,26 @@ declare function SetPedResetFlag(ped: number, flagId: number, doReset: boolean):
  * **0**: CTaskNMRelax
  * **1**: CTaskNMScriptControl: Hardcoded not to work in networked environments.
  * **Else**: CTaskNMBalance
- * @param time1 Time(ms) Ped is in ragdoll mode; only applies to ragdoll types 0 and not 1.
+ * @param ped The ped to ragdoll.
+ * @param minTime Time(ms) Ped is in ragdoll mode; only applies to ragdoll types 0 and not 1.
+ * @param bAbortIfInjured unused
+ * @param bAbortIfDead unused
  */
-declare function SetPedToRagdoll(ped: number, time1: number, time2: number, ragdollType: number, p4: boolean, p5: boolean, p6: boolean): void;
+declare function SetPedToRagdoll(ped: number, minTime: number, maxTime: number, ragdollType: number, bAbortIfInjured: boolean, bAbortIfDead: boolean, bForceScriptControl: boolean): void;
 
 /**
+ * cpp
+ * enum eNMFallType {
+ * TYPE_FROM_HIGH = 0,
+ * TYPE_OVER_WALL = 1,
+ * TYPE_DOWN_STAIRS = 2,
+ * TYPE_DIE_TYPES = 3,
+ * TYPE_DIE_FROM_HIGH = 4,
+ * TYPE_DIE_OVER_WALL = 5,
+ * TYPE_DIE_DOWN_STAIRS = 6
+ * }
+ * ```
+ * ```
  * Return variable is never used in R*'s scripts.
  * Not sure what p2 does. It seems like it would be a time judging by it's usage in R*'s scripts, but didn't seem to affect anything in my testings.
  * x, y, and z are coordinates, most likely to where the ped will fall.
@@ -2965,8 +2976,20 @@ declare function SetPedToRagdoll(ped: number, time1: number, time2: number, ragd
  * p8 to p13 are always 0f in R*'s scripts.
  * (Simplified) Example of the usage of the function from R*'s scripts:
  * ped::set_ped_to_ragdoll_with_fall(ped, 1500, 2000, 1, -entity::get_entity_forward_vector(ped), 1f, 0f, 0f, 0f, 0f, 0f, 0f);
- */
-declare function SetPedToRagdollWithFall(ped: number, time: number, p2: number, ragdollType: number, x: number, y: number, z: number, p7: number, p8: number, p9: number, p10: number, p11: number, p12: number, p13: number): void;
+ * @param ped The ped to ragdoll.
+ * @param nFallType The type of fall.
+ * @param dirX The x direction of the fall.
+ * @param dirY The y direction of the fall.
+ * @param dirZ The z direction of the fall.
+ * @param fGroundHeight The ground height (z).
+ * @param grab1X unused
+ * @param grab1Y unused
+ * @param grab1Z unused
+ * @param grab2X unused
+ * @param grab2Y unused
+ * @param grab2Z unused
+ */
+declare function SetPedToRagdollWithFall(ped: number, minTime: number, maxTime: number, nFallType: number, dirX: number, dirY: number, dirZ: number, fGroundHeight: number, grab1X: number, grab1Y: number, grab1Z: number, grab2X: number, grab2Y: number, grab2Z: number): void;
 
 /**
  * Flags:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citizenfx/server",
-  "version": "2.0.13686-1",
+  "version": "2.0.13759-1",
   "description": "Typings for the CitizenFX server JS API.",
   "main": "index.js",
   "scripts": {