From 937a2b97ace89e8c2911a698a02cc743408e7811 Mon Sep 17 00:00:00 2001 From: Psychoshock Date: Mon, 25 Dec 2023 15:33:54 -0500 Subject: [PATCH] update docs description --- PED/GivePedHelmet.md | 18 +++++------------- PED/IsPedTryingToEnterALockedVehicle.md | 3 ++- PED/RemovePedHelmet.md | 5 +++-- PED/SetPedHelmet.md | 8 ++++---- 4 files changed, 14 insertions(+), 20 deletions(-) diff --git a/PED/GivePedHelmet.md b/PED/GivePedHelmet.md index c37d22fe7..ee124382d 100644 --- a/PED/GivePedHelmet.md +++ b/PED/GivePedHelmet.md @@ -8,19 +8,11 @@ ns: PED void GIVE_PED_HELMET(Ped ped, BOOL cannotRemove, int helmetFlag, int textureIndex); ``` -``` -PoliceMotorcycleHelmet 1024 -RegularMotorcycleHelmet 4096 -FiremanHelmet 16384 -PilotHeadset 32768 -PilotHelmet 65536 --- -p2 is generally 4096 or 16384 in the scripts. p1 varies between 1 and 0. -``` +Give the ped a helmet. ## Parameters -* **ped**: -* **cannotRemove**: -* **helmetFlag**: -* **textureIndex**: +* **ped**: Ped index. +* **cannotRemove**: Can remove helmet or not. +* **helmetFlag**: Flag for the helmet. +* **textureIndex**: Texture index. diff --git a/PED/IsPedTryingToEnterALockedVehicle.md b/PED/IsPedTryingToEnterALockedVehicle.md index 8c96dac42..d7829d2f4 100644 --- a/PED/IsPedTryingToEnterALockedVehicle.md +++ b/PED/IsPedTryingToEnterALockedVehicle.md @@ -8,8 +8,9 @@ ns: PED BOOL IS_PED_TRYING_TO_ENTER_A_LOCKED_VEHICLE(Ped ped); ``` +If the ped is attempting to enter a locked vehicle. ## Parameters -* **ped**: +* **ped**: Ped index. ## Return value diff --git a/PED/RemovePedHelmet.md b/PED/RemovePedHelmet.md index 00f674013..e7ac8beed 100644 --- a/PED/RemovePedHelmet.md +++ b/PED/RemovePedHelmet.md @@ -8,8 +8,9 @@ ns: PED void REMOVE_PED_HELMET(Ped ped, BOOL instantly); ``` +Remove a helmet from a ped ## Parameters -* **ped**: -* **instantly**: +* **ped**: Ped index. +* **instantly**: Force to remove. diff --git a/PED/SetPedHelmet.md b/PED/SetPedHelmet.md index 858a96a99..ea51b1dbc 100644 --- a/PED/SetPedHelmet.md +++ b/PED/SetPedHelmet.md @@ -5,11 +5,11 @@ ns: PED ```c // 0x560A43136EB58105 0xED366E53 -void SET_PED_HELMET(Ped ped, BOOL canWearHelmet); +void SET_PED_HELMET(Ped ped, BOOL enable); ``` +Adjusts the preference for a ped to utilize a helmet. ## Parameters -* **ped**: -* **canWearHelmet**: - +* **ped**: Ped index. +* **enable**: If can wear helmet or not. \ No newline at end of file