diff --git a/AUDIO/EnableVehicleExhaustPops.md b/AUDIO/EnableVehicleExhaustPops.md index b6adb5589..2bce45ef5 100644 --- a/AUDIO/EnableVehicleExhaustPops.md +++ b/AUDIO/EnableVehicleExhaustPops.md @@ -9,8 +9,9 @@ aliases: ["0x2BE4BC731D039D5A"] void ENABLE_VEHICLE_EXHAUST_POPS(Vehicle vehicle, BOOL toggle); ``` +Sets whether the vehicle passed has exhaust pops. ## Parameters -* **vehicle**: -* **toggle**: +* **vehicle**: +* **toggle**: Enables or disables exaust pops. diff --git a/AUDIO/GetSoundIdFromNetworkId.md b/AUDIO/GetSoundIdFromNetworkId.md index b7a123e15..93bab59a4 100644 --- a/AUDIO/GetSoundIdFromNetworkId.md +++ b/AUDIO/GetSoundIdFromNetworkId.md @@ -9,8 +9,10 @@ aliases: ["0x75262FD12D0A1C84"] int GET_SOUND_ID_FROM_NETWORK_ID(int netId); ``` +Counterpart: [`GET_NETWORK_ID_FROM_SOUND_ID`](#_0x2DE3F0A134FFBC0D). ## Parameters -* **netId**: +* **netId**: Network ID of sound. ## Return value +Integer representing a sound id, -1 (0xFFFFFFFF) on failure. diff --git a/AUDIO/IsVehicleRadioEnabled.md b/AUDIO/IsVehicleRadioEnabled.md new file mode 100644 index 000000000..6bb64f114 --- /dev/null +++ b/AUDIO/IsVehicleRadioEnabled.md @@ -0,0 +1,30 @@ +--- +ns: AUDIO +aliases: ["0x0BE4BE946463F917"] +--- +## _IS_VEHICLE_RADIO_ENABLED + +```c +// 0x0BE4BE946463F917 +BOOL _IS_VEHICLE_RADIO_ENABLED(Vehicle vehicle); +``` + +``` +IS_VEHICLE_* +``` + +## Parameters +* **vehicle**: The vehicle to check + +## Return value +Is the given vehicle's radio enabled + +## Examples +```lua +local radioEnabled = IsVehicleRadioEnabled(GetVehiclePedIsIn(PlayerPedId(), false)) +print(radioEnabled) +``` +```cs +bool radioEnabled = API.IsVehicleRadioEnabled(API.GetVehiclePedIsIn(Game.PlayerPed.Handle, false)); +Debug.WriteLine(radioEnabled.ToString()); +``` diff --git a/AUDIO/N_0x0be4be946463f917.md b/AUDIO/N_0x0be4be946463f917.md deleted file mode 100644 index bab701c3c..000000000 --- a/AUDIO/N_0x0be4be946463f917.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -ns: AUDIO ---- -## _0x0BE4BE946463F917 - -```c -// 0x0BE4BE946463F917 -BOOL _0x0BE4BE946463F917(Vehicle vehicle); -``` - -``` -IS_VEHICLE_* -``` - -## Parameters -* **vehicle**: - -## Return value diff --git a/AUDIO/N_0xa5f377b175a699c5.md b/AUDIO/N_0xa5f377b175a699c5.md deleted file mode 100644 index b6b4c156b..000000000 --- a/AUDIO/N_0xa5f377b175a699c5.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -ns: AUDIO ---- -## _0xA5F377B175A699C5 - -```c -// 0xA5F377B175A699C5 0xE812925D -void _0xA5F377B175A699C5(int p0); -``` - -``` -SET_AUDIO_S* -``` - -## Parameters -* **p0**: - diff --git a/AUDIO/PlayPedAmbientSpeechAndCloneNative.md b/AUDIO/PlayPedAmbientSpeechAndCloneNative.md index 3a783deb0..d7808f9f7 100644 --- a/AUDIO/PlayPedAmbientSpeechAndCloneNative.md +++ b/AUDIO/PlayPedAmbientSpeechAndCloneNative.md @@ -9,10 +9,7 @@ aliases: ["_PLAY_AMBIENT_SPEECH2"] void PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE(Ped ped, char* speechName, char* speechParam); ``` -``` -Plays ambient speech. See also _0x5C57B85D. -See PLAY_PED_AMBIENT_SPEECH_NATIVE for parameter specifications. -``` +See [`PLAY_PED_AMBIENT_SPEECH_NATIVE`](#_0x8E04FEDD28D42462) for parameter specifications. ``` NativeDB Added Parameter 4: Any p3 diff --git a/AUDIO/PlayPedAmbientSpeechNative.md b/AUDIO/PlayPedAmbientSpeechNative.md index 32d7b1dc8..6a1e7cad0 100644 --- a/AUDIO/PlayPedAmbientSpeechNative.md +++ b/AUDIO/PlayPedAmbientSpeechNative.md @@ -9,10 +9,9 @@ aliases: ["_PLAY_AMBIENT_SPEECH1"] void PLAY_PED_AMBIENT_SPEECH_NATIVE(Ped ped, char* speechName, char* speechParam); ``` +Plays ambient speech; see also [`PLAY_PED_AMBIENT_SPEECH_AND_CLONE_NATIVE`](#_0xC6941B4A3A8FBBB9). + ``` -Plays ambient speech. See also _0x444180DB. -ped: The ped to play the ambient speech. -speechName: Name of the speech to play, eg. "GENERIC_HI". speechParam: Can be one of the following: SPEECH_PARAMS_STANDARD SPEECH_PARAMS_ALLOW_REPEAT @@ -52,7 +51,6 @@ SPEECH_PARAMS_SHOUTED SPEECH_PARAMS_SHOUTED_CLEAR SPEECH_PARAMS_SHOUTED_CRITICAL Note: A list of Name and Parameters can be found here pastebin.com/1GZS5dCL -Old name: _PLAY_AMBIENT_SPEECH1 ``` ``` @@ -60,7 +58,7 @@ NativeDB Added Parameter 4: Any p3 ``` ## Parameters -* **ped**: -* **speechName**: +* **ped**: The ped to play the ambient speech. +* **speechName**: Name of the speech to play, eg. "GENERIC_HI". * **speechParam**: diff --git a/AUDIO/SetAudioScriptCleanupTime.md b/AUDIO/SetAudioScriptCleanupTime.md new file mode 100644 index 000000000..15414993f --- /dev/null +++ b/AUDIO/SetAudioScriptCleanupTime.md @@ -0,0 +1,14 @@ +--- +ns: AUDIO +aliases: ["0xA5F377B175A699C5"] +--- +## SET_AUDIO_SCRIPT_CLEANUP_TIME + +```c +// 0xA5F377B175A699C5 0xE812925D +void SET_AUDIO_SCRIPT_CLEANUP_TIME(int time); +``` + +## Parameters +* **time**: + diff --git a/AUDIO/SetVehicleAudioBodyDamageFactor.md b/AUDIO/SetVehicleAudioBodyDamageFactor.md index 497666ba5..089027e52 100644 --- a/AUDIO/SetVehicleAudioBodyDamageFactor.md +++ b/AUDIO/SetVehicleAudioBodyDamageFactor.md @@ -6,10 +6,11 @@ aliases: ["0x01BB4D577D38BD9E"] ```c // 0x01BB4D577D38BD9E 0xE81FAC68 -void SET_VEHICLE_AUDIO_BODY_DAMAGE_FACTOR(Vehicle vehicle, float p1); +void SET_VEHICLE_AUDIO_BODY_DAMAGE_FACTOR(Vehicle vehicle, float intensity); ``` -## Parameters -* **vehicle**: -* **p1**: +Vehicle will make a 'rattling' noise when decelerating +## Parameters +* **vehicle**: Vehicle to modify +* **intensity**: A value 0.0 - 1.0. Higher the value, the more likely the vehicle is to make the sound while decelerating diff --git a/AUDIO/UnlockMissionNewsStory.md b/AUDIO/UnlockMissionNewsStory.md index 4e215d9b1..6e63dfd14 100644 --- a/AUDIO/UnlockMissionNewsStory.md +++ b/AUDIO/UnlockMissionNewsStory.md @@ -8,10 +8,6 @@ ns: AUDIO void UNLOCK_MISSION_NEWS_STORY(int newsStory); ``` -``` -I see this as a native that would of been used back in GTA III when you finally unlocked the bridge to the next island and such. -``` - ## Parameters * **newsStory**: diff --git a/CAM/GetCamActiveViewModeContext.md b/CAM/GetCamActiveViewModeContext.md new file mode 100644 index 000000000..8849345bf --- /dev/null +++ b/CAM/GetCamActiveViewModeContext.md @@ -0,0 +1,29 @@ +--- +ns: CAM +aliases: ["0x19CAFA3C87F7C2FF"] +--- +## _GET_CAM_ACTIVE_VIEW_MODE_CONTEXT + +```c +// 0x19CAFA3C87F7C2FF +int _GET_CAM_ACTIVE_VIEW_MODE_CONTEXT(); +``` + +Enumerated type defined in camControlHelperMetadataViewModes: + +```c +enum Context { + ON_FOOT = 0, // [G|S]ET_FOLLOW_PED_CAM_* + IN_VEHICLE = 1, // [G|S]ET_FOLLOW_VEHICLE_CAM_* + ON_BIKE = 2, + IN_BOAT = 3, + IN_AIRCRAFT = 4, + IN_SUBMARINE = 5, + IN_HELI = 6, + IN_TURRET = 7, +} +``` + +## Return value +The active view mode context. + diff --git a/CAM/GetCamViewModeForContext.md b/CAM/GetCamViewModeForContext.md new file mode 100644 index 000000000..80587ee5e --- /dev/null +++ b/CAM/GetCamViewModeForContext.md @@ -0,0 +1,17 @@ +--- +ns: CAM +aliases: ["0xEE778F8C7E1142E2"] +--- +## GET_CAM_VIEW_MODE_FOR_CONTEXT + +```c +// 0xEE778F8C7E1142E2 0xF3B148A6 +int GET_CAM_VIEW_MODE_FOR_CONTEXT(int context); +``` + +See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#_0x8D4D46230B2C353A) for the view mode enum. + +## Parameters +* **context**: See [`_GET_CAM_ACTIVE_VIEW_MODE_CONTEXT`](#_0x19CAFA3C87F7C2FF). + +## Return value diff --git a/CAM/GetFollowPedCamViewMode.md b/CAM/GetFollowPedCamViewMode.md index d42d9ac5e..0322b9e25 100644 --- a/CAM/GetFollowPedCamViewMode.md +++ b/CAM/GetFollowPedCamViewMode.md @@ -8,12 +8,17 @@ ns: CAM int GET_FOLLOW_PED_CAM_VIEW_MODE(); ``` -``` -Returns -0 - Third Person Close -1 - Third Person Mid -2 - Third Person Far -4 - First Person +```c +// view mode enumeration +enum _0xA11D7CA8 +{ + THIRD_PERSON_NEAR = 0, + THIRD_PERSON_MEDIUM = 1, + THIRD_PERSON_FAR = 2, + CINEMATIC = 3, + FIRST_PERSON = 4, +}; ``` ## Return value +Returns a value from the view mode enumeration diff --git a/CAM/GetFollowPedCamZoomLevel.md b/CAM/GetFollowPedCamZoomLevel.md index fba53b54e..3f3adfbd9 100644 --- a/CAM/GetFollowPedCamZoomLevel.md +++ b/CAM/GetFollowPedCamZoomLevel.md @@ -8,5 +8,6 @@ ns: CAM int GET_FOLLOW_PED_CAM_ZOOM_LEVEL(); ``` +See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#_0x8D4D46230B2C353A) for the follow mode enum. ## Return value diff --git a/CAM/GetFollowVehicleCamViewMode.md b/CAM/GetFollowVehicleCamViewMode.md index 3c7123adb..138336903 100644 --- a/CAM/GetFollowVehicleCamViewMode.md +++ b/CAM/GetFollowVehicleCamViewMode.md @@ -8,12 +8,6 @@ ns: CAM int GET_FOLLOW_VEHICLE_CAM_VIEW_MODE(); ``` -``` -Returns the type of camera: -0 - Third Person Close -1 - Third Person Mid -2 - Third Person Far -4 - First Person -``` +See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#_0x8D4D46230B2C353A) for the follow mode enum. ## Return value diff --git a/CAM/GetFollowVehicleCamZoomLevel.md b/CAM/GetFollowVehicleCamZoomLevel.md index dadb70ccd..8c319e044 100644 --- a/CAM/GetFollowVehicleCamZoomLevel.md +++ b/CAM/GetFollowVehicleCamZoomLevel.md @@ -8,5 +8,6 @@ ns: CAM int GET_FOLLOW_VEHICLE_CAM_ZOOM_LEVEL(); ``` +See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#_0x8D4D46230B2C353A) for the follow mode enum. ## Return value diff --git a/CAM/GetGameplayCamRelativePitch.md b/CAM/GetGameplayCamRelativePitch.md index 8795bd81a..7ae122515 100644 --- a/CAM/GetGameplayCamRelativePitch.md +++ b/CAM/GetGameplayCamRelativePitch.md @@ -10,3 +10,10 @@ float GET_GAMEPLAY_CAM_RELATIVE_PITCH(); ## Return value +Returns the relative pitch of the gameplay camera + +## Examples +```lua +local pitch = GetGameplayCamRelativePitch() +print("LocalPlayer pitch: " .. pitch) +``` diff --git a/CAM/N_0x19cafa3c87f7c2ff.md b/CAM/N_0x19cafa3c87f7c2ff.md deleted file mode 100644 index 82c40d507..000000000 --- a/CAM/N_0x19cafa3c87f7c2ff.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -ns: CAM ---- -## _0x19CAFA3C87F7C2FF - -```c -// 0x19CAFA3C87F7C2FF -Any _0x19CAFA3C87F7C2FF(); -``` - -``` -Seems to return the current type of view -example: // checks if you're currently in first person -if ((CAM::_EE778F8C7E1142E2(CAM::_19CAFA3C87F7C2FF()) == 4) && (!__463_$28ED382849B17AFC())) { - HUD::_FDEC055AB549E328(); - HUD::_SET_NOTIFICATION_TEXT_ENTRY("REC_FEED_WAR"); - l_CE[0/*1*/] = HUD::_DRAW_NOTIFICATION(0, 1); -} -``` - -## Return value diff --git a/CAM/N_0xee778f8c7e1142e2.md b/CAM/N_0xee778f8c7e1142e2.md deleted file mode 100644 index 6db0411a6..000000000 --- a/CAM/N_0xee778f8c7e1142e2.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -ns: CAM ---- -## _0xEE778F8C7E1142E2 - -```c -// 0xEE778F8C7E1142E2 0xF3B148A6 -Any _0xEE778F8C7E1142E2(Any p0); -``` - -``` -interprets the result of CAM::_0x19CAFA3C87F7C2FF() -example: // checks if you're currently in first person -if ((CAM::_EE778F8C7E1142E2(CAM::_19CAFA3C87F7C2FF()) == 4) && (!__463_$28ED382849B17AFC())) { -HUD::_FDEC055AB549E328(); -HUD::_SET_NOTIFICATION_TEXT_ENTRY("REC_FEED_WAR"); -l_CE[0/*1*/] = HUD::_DRAW_NOTIFICATION(0, 1); -} -``` - -## Parameters -* **p0**: - -## Return value diff --git a/CAM/PointCamAtCoord.md b/CAM/PointCamAtCoord.md index 726403b81..56afbdc19 100644 --- a/CAM/PointCamAtCoord.md +++ b/CAM/PointCamAtCoord.md @@ -10,8 +10,14 @@ void POINT_CAM_AT_COORD(Cam cam, float x, float y, float z); ## Parameters -* **cam**: +* **cam**: * **x**: * **y**: * **z**: +## Examples +```lua +local coords = vector3(402.99, -998.02, -99.00) +local cam = CreateCamWithParams("DEFAULT_SCRIPTED_CAMERA", coords.x, coords.y, coords.z, 0.00, 0.00, 0.00, 50.00, false, 0) +PointCamAtCoord(cam, coords.x, coords.y, coords.z) +``` diff --git a/CAM/SetFollowPedCamViewMode.md b/CAM/SetFollowPedCamViewMode.md index b3c72e9f8..b27bb4a1d 100644 --- a/CAM/SetFollowPedCamViewMode.md +++ b/CAM/SetFollowPedCamViewMode.md @@ -8,13 +8,7 @@ ns: CAM void SET_FOLLOW_PED_CAM_VIEW_MODE(int viewMode); ``` -``` -Sets the type of Player camera: -0 - Third Person Close -1 - Third Person Mid -2 - Third Person Far -4 - First Person -``` +See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#_0x8D4D46230B2C353A) for the follow mode enum. ## Parameters * **viewMode**: diff --git a/CAM/SetFollowVehicleCamViewMode.md b/CAM/SetFollowVehicleCamViewMode.md index f12cbf6e1..49e427b5d 100644 --- a/CAM/SetFollowVehicleCamViewMode.md +++ b/CAM/SetFollowVehicleCamViewMode.md @@ -8,13 +8,7 @@ ns: CAM void SET_FOLLOW_VEHICLE_CAM_VIEW_MODE(int viewMode); ``` -``` -Sets the type of Player camera in vehicles: -0 - Third Person Close -1 - Third Person Mid -2 - Third Person Far -4 - First Person -``` +See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#_0x8D4D46230B2C353A) for the follow mode enum. ## Parameters * **viewMode**: diff --git a/CAM/SetFollowVehicleCamZoomLevel.md b/CAM/SetFollowVehicleCamZoomLevel.md index 54884d1be..364575228 100644 --- a/CAM/SetFollowVehicleCamZoomLevel.md +++ b/CAM/SetFollowVehicleCamZoomLevel.md @@ -8,6 +8,7 @@ ns: CAM void SET_FOLLOW_VEHICLE_CAM_ZOOM_LEVEL(int zoomLevel); ``` +See [`GET_FOLLOW_PED_CAM_VIEW_MODE`](#_0x8D4D46230B2C353A) for the follow mode enum. ## Parameters * **zoomLevel**: diff --git a/DECORATOR/DecorIsRegisteredAsType.md b/DECORATOR/DecorIsRegisteredAsType.md index 6bffee926..fdf08d828 100644 --- a/DECORATOR/DecorIsRegisteredAsType.md +++ b/DECORATOR/DecorIsRegisteredAsType.md @@ -8,12 +8,8 @@ ns: DECORATOR BOOL DECOR_IS_REGISTERED_AS_TYPE(char* propertyName, int type); ``` -``` -type: see DECOR_REGISTER -``` - ## Parameters * **propertyName**: -* **type**: +* **type**: See [`DECOR_REGISTER`](#_0x9FD90732F56403CE). ## Return value diff --git a/ENTITY/HasEntityClearLosToEntity_2.md b/ENTITY/HasEntityClearLosToEntity_2.md new file mode 100644 index 000000000..79c947579 --- /dev/null +++ b/ENTITY/HasEntityClearLosToEntity_2.md @@ -0,0 +1,19 @@ +--- +ns: ENTITY +aliases: ["0x394BDE2A7BBA031E"] +--- +## _HAS_ENTITY_CLEAR_LOS_TO_ENTITY_2 + +```c +// 0x394BDE2A7BBA031E +Any _HAS_ENTITY_CLEAR_LOS_TO_ENTITY_2(Entity entity1, Entity entity2, int traceType); +``` + +``` +NativeDB Introduced: v1868 +``` + +## Parameters +* **entity1**: +* **entity2**: +* **traceType**: diff --git a/ENTITY/IsEntityInAngledArea.md b/ENTITY/IsEntityInAngledArea.md index 72e30ecc2..596151dad 100644 --- a/ENTITY/IsEntityInAngledArea.md +++ b/ENTITY/IsEntityInAngledArea.md @@ -8,9 +8,9 @@ ns: ENTITY BOOL IS_ENTITY_IN_ANGLED_AREA(Entity entity, float x1, float y1, float z1, float x2, float y2, float z2, float width, BOOL debug, BOOL includez, Any p10); ``` -p10 is some entity flag check, also used in ``IS_ENTITY_AT_ENTITY``, ``IS_ENTITY_IN_AREA``, and ``IS_ENTITY_AT_COORD``. +p10 is some entity flag check, also used in [`IS_ENTITY_AT_ENTITY`](#_0x751B70C3D034E187), [`IS_ENTITY_IN_AREA`](#_0x54736AA40E271165) and [`IS_ENTITY_AT_COORD`](#_0x20B60995556D004F). -See [IS_POINT_IN_ANGLED_AREA](#_0x2A70BAE8883E4C81) for the definition of an angled area. +See [`IS_POINT_IN_ANGLED_AREA`](#_0x2A70BAE8883E4C81) for the definition of an angled area. ## Parameters * **entity**: diff --git a/ENTITY/IsEntityPlayingAnim.md b/ENTITY/IsEntityPlayingAnim.md index 9f3779a6d..92fee449d 100644 --- a/ENTITY/IsEntityPlayingAnim.md +++ b/ENTITY/IsEntityPlayingAnim.md @@ -8,8 +8,9 @@ ns: ENTITY BOOL IS_ENTITY_PLAYING_ANIM(Entity entity, char* animDict, char* animName, int taskFlag); ``` +See also [`IS_SCRIPTED_SCENARIO_PED_USING_CONDITIONAL_ANIM`](#_0x6EC47A344923E1ED) + ``` -See also PED::IS_SCRIPTED_SCENARIO_PED_USING_CONDITIONAL_ANIM 0x6EC47A344923E1ED 0x3C30B447 Taken from ENTITY::IS_ENTITY_PLAYING_ANIM(PLAYER::PLAYER_PED_ID(), "creatures@shark@move", "attack_player", 3) p4 is always 3 in the scripts. taskFlag: diff --git a/ENTITY/N_0x394bde2a7bba031e.md b/ENTITY/N_0x394bde2a7bba031e.md deleted file mode 100644 index e63184002..000000000 --- a/ENTITY/N_0x394bde2a7bba031e.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -ns: ENTITY ---- -## _0x394BDE2A7BBA031E - -```c -// 0x394BDE2A7BBA031E -Any _0x394BDE2A7BBA031E(Any p0, Any p1, Any p2); -``` - -``` -NativeDB Introduced: v1868 -``` - -## Parameters -* **p0**: -* **p1**: -* **p2**: diff --git a/ENTITY/RemoveModelHide.md b/ENTITY/RemoveModelHide.md index 4c216d443..77784e083 100644 --- a/ENTITY/RemoveModelHide.md +++ b/ENTITY/RemoveModelHide.md @@ -5,15 +5,40 @@ ns: ENTITY ```c // 0xD9E3006FB3CBD765 0x993DBC10 -void REMOVE_MODEL_HIDE(Any p0, Any p1, Any p2, Any p3, Any p4, Any p5); +void REMOVE_MODEL_HIDE(Any x, Any y, Any z, Any radius, Any model, Any p5); ``` +p5 requires more research. See also [`CREATE_MODEL_HIDE`](#_0x8A97BCA30A0CE478) and [`CREATE_MODEL_SWAP`](#_0x92C47782FDA8B2A3). + +Network players do not see changes done with this. + +``` +NativeDB Parameter 0: float x +NativeDB Parameter 1: float y +NativeDB Parameter 2: float z +NativeDB Parameter 3: float radius +NativeDB Parameter 4: Hash model +NativeDB Parameter 5: BOOL p5 +``` ## Parameters -* **p0**: -* **p1**: -* **p2**: -* **p3**: -* **p4**: -* **p5**: +* **x**: +* **y**: +* **z**: +* **radius**: The radius specified in gta units +* **model**: The model that you want to make visible +* **p5**: +## Examples +```lua +-- This could be any coordinates, in this example I am using the players ped coordinates +local playerPedCoords = GetEntityCoords(PlayerPedId()) + +-- Hides all entities with the hash "1437508529" within 1.0 gta units. +CreateModelHide(playerPedCoords, 1.0, 1437508529, true) + +Citizen.Wait(2500) + +-- This will make all hidden entities with the hash "1437508529" within 1.0 gta units visible. +RemoveModelHide(playerPedCoords, 1.0, 1437508529, false) +``` diff --git a/ENTITY/SetEntityRotation.md b/ENTITY/SetEntityRotation.md index 8b41aa3bf..b60143253 100644 --- a/ENTITY/SetEntityRotation.md +++ b/ENTITY/SetEntityRotation.md @@ -8,17 +8,11 @@ ns: ENTITY void SET_ENTITY_ROTATION(Entity entity, float pitch, float roll, float yaw, int rotationOrder, BOOL p5); ``` -``` -rotationOrder refers to the order yaw pitch roll is applied, see [GET_ENTITY_ROTATION](#_0xAFBD61CC738D9EB9) - -p5 is usually set as true -``` - ## Parameters * **entity**: * **pitch**: * **roll**: * **yaw**: -* **rotationOrder**: +* **rotationOrder**: The order yaw pitch roll are applied, see [`GET_ENTITY_ROTATION`](#_0xAFBD61CC738D9EB9). * **p5**: diff --git a/FILES/GetShopPedOutfitComponentVariant.md b/FILES/GetShopPedOutfitComponentVariant.md index cd074f350..9f42f1852 100644 --- a/FILES/GetShopPedOutfitComponentVariant.md +++ b/FILES/GetShopPedOutfitComponentVariant.md @@ -10,14 +10,12 @@ BOOL GET_SHOP_PED_OUTFIT_COMPONENT_VARIANT(Any outfit, int slot, Any* item); ``` ``` -outfit = a structure passing though it - see GET_SHOP_PED_QUERY_OUTFIT -slot - outfit slot item - hold 3 ints in a struct, you can use Vector3 structure ``` ## Parameters -* **outfit**: -* **slot**: +* **outfit**: A structure, see [`GET_SHOP_PED_QUERY_OUTFIT`](#_0x6D793F03A631FE56). +* **slot**: outfit slot. * **item**: ## Return value diff --git a/FIRE/AddExplosion.md b/FIRE/AddExplosion.md index b618f5198..7014a1113 100644 --- a/FIRE/AddExplosion.md +++ b/FIRE/AddExplosion.md @@ -8,11 +8,14 @@ ns: FIRE void ADD_EXPLOSION(float x, float y, float z, int explosionType, float damageScale, BOOL isAudible, BOOL isInvisible, float cameraShake); ``` +``` +NativeDB Added Parameter 9: BOOL noDamage +``` + ``` BOOL isAudible = If explosion makes a sound. -BOOL isInvisible = If the explosion is invisible or not. -this native is missing a new argument: noDamage -nodamage = false: damage || nodamage = true: no damage +BOOL isInvisible = If the explosion is invisible or not. +BOOL noDamage = false: damage || nodamage = true: no damage enum ExplosionTypes { EXPLOSION_GRENADE, @@ -50,14 +53,13 @@ enum ExplosionTypes EXPLOSION_PLANE_ROCKET, EXPLOSION_VEHICLE_BULLET, EXPLOSION_GAS_TANK, - EXPLOSION_BIRD_CRAP + EXPLOSION_BIRD_CRAP, + EXPLOSION_FIREWORK = 38, + EXPLOSION_PROXIMINE = 40, + EXPLOSION_PIPEBOMB = 43 }; ``` -``` -NativeDB Added Parameter 9: BOOL noDamage -``` - ## Parameters * **x**: * **y**: diff --git a/FIRE/AddExplosionWithUserVfx.md b/FIRE/AddExplosionWithUserVfx.md index da4d764ae..6cb46d9a3 100644 --- a/FIRE/AddExplosionWithUserVfx.md +++ b/FIRE/AddExplosionWithUserVfx.md @@ -9,20 +9,14 @@ aliases: ["_ADD_SPECFX_EXPLOSION"] void ADD_EXPLOSION_WITH_USER_VFX(float x, float y, float z, int explosionType, Hash explosionFx, float damageScale, BOOL isAudible, BOOL isInvisible, float cameraShake); ``` -``` -isAudible: If explosion makes a sound. -isInvisible: If the explosion is invisible or not. -explosionType: See ADD_EXPLOSION. -``` - ## Parameters * **x**: * **y**: * **z**: -* **explosionType**: +* **explosionType**: See [`ADD_EXPLOSION`](#_0xE3AD2BDBAEE269AC). * **explosionFx**: * **damageScale**: -* **isAudible**: -* **isInvisible**: +* **isAudible**: If explosion makes a sound. +* **isInvisible**: If the explosion is invisible or not. * **cameraShake**: diff --git a/FIRE/AddOwnedExplosion.md b/FIRE/AddOwnedExplosion.md index d3a8b40cf..2bb185504 100644 --- a/FIRE/AddOwnedExplosion.md +++ b/FIRE/AddOwnedExplosion.md @@ -13,7 +13,7 @@ void ADD_OWNED_EXPLOSION(Ped ped, float x, float y, float z, int explosionType, * **x**: * **y**: * **z**: -* **explosionType**: See ADD_EXPLOSION. +* **explosionType**: See [`ADD_EXPLOSION`](#_0xE3AD2BDBAEE269AC). * **damageScale**: * **isAudible**: If explosion makes a sound. * **isInvisible**: If the explosion is invisible or not. diff --git a/FIRE/GetEntityInsideExplosionArea.md b/FIRE/GetEntityInsideExplosionArea.md index 5ce448038..21fba2d6f 100644 --- a/FIRE/GetEntityInsideExplosionArea.md +++ b/FIRE/GetEntityInsideExplosionArea.md @@ -14,7 +14,7 @@ Returns a handle to the first entity within the a circle spawned inside the 2 po ``` ## Parameters -* **explosionType**: See ADD_EXPLOSION. +* **explosionType**: See [`ADD_EXPLOSION`](#_0xE3AD2BDBAEE269AC). * **x1**: * **y1**: * **z1**: diff --git a/FIRE/IsExplosionActiveInArea.md b/FIRE/IsExplosionActiveInArea.md index 2235a8d87..05b2f89cc 100644 --- a/FIRE/IsExplosionActiveInArea.md +++ b/FIRE/IsExplosionActiveInArea.md @@ -11,7 +11,7 @@ BOOL IS_EXPLOSION_ACTIVE_IN_AREA(int explosionType, float x1, float y1, float z1 ## Parameters -* **explosionType**: See ADD_EXPLOSION. +* **explosionType**: See [`ADD_EXPLOSION`](#_0xE3AD2BDBAEE269AC). * **x1**: * **y1**: * **z1**: diff --git a/FIRE/IsExplosionInAngledArea.md b/FIRE/IsExplosionInAngledArea.md index 2e7d677f3..fd2277a22 100644 --- a/FIRE/IsExplosionInAngledArea.md +++ b/FIRE/IsExplosionInAngledArea.md @@ -8,10 +8,10 @@ ns: FIRE BOOL IS_EXPLOSION_IN_ANGLED_AREA(int explosionType, float x1, float y1, float z1, float x2, float y2, float z2, float width); ``` -See [IS_POINT_IN_ANGLED_AREA](#_0x2A70BAE8883E4C81) for the definition of an angled area. +See [`IS_POINT_IN_ANGLED_AREA`](#_0x2A70BAE8883E4C81) for the definition of an angled area. ## Parameters -* **explosionType**: explosion enum, -1 for any explosion type +* **explosionType**: explosion enum, -1 for any explosion type. See [ADD_EXPLOSION](#_0xE3AD2BDBAEE269AC). * **x1**: X dimension of the angled area 'origin' * **y1**: Y dimension of the angled area 'origin' * **z1**: Z dimension of the angled area 'origin' diff --git a/FIRE/IsExplosionInArea.md b/FIRE/IsExplosionInArea.md index 796bb23da..4b49ea2a6 100644 --- a/FIRE/IsExplosionInArea.md +++ b/FIRE/IsExplosionInArea.md @@ -10,7 +10,7 @@ BOOL IS_EXPLOSION_IN_AREA(int explosionType, float x1, float y1, float z1, float ## Parameters -* **explosionType**: See ADD_EXPLOSION. +* **explosionType**: See [`ADD_EXPLOSION`](#_0xE3AD2BDBAEE269AC). * **x1**: * **y1**: * **z1**: diff --git a/FIRE/IsExplosionInSphere.md b/FIRE/IsExplosionInSphere.md index 13f2bfbce..e831854a4 100644 --- a/FIRE/IsExplosionInSphere.md +++ b/FIRE/IsExplosionInSphere.md @@ -10,7 +10,7 @@ BOOL IS_EXPLOSION_IN_SPHERE(int explosionType, float x, float y, float z, float ## Parameters -* **explosionType**: See ADD_EXPLOSION. +* **explosionType**: See [`ADD_EXPLOSION`](#_0xE3AD2BDBAEE269AC). * **x**: * **y**: * **z**: diff --git a/GRAPHICS/AnimpostfxGetUnk.md b/GRAPHICS/AnimpostfxGetUnk.md index 9da1e3cfe..886e1e8e7 100644 --- a/GRAPHICS/AnimpostfxGetUnk.md +++ b/GRAPHICS/AnimpostfxGetUnk.md @@ -9,9 +9,7 @@ aliases: ["0xE35B38A27E8E7179"] float _ANIMPOSTFX_GET_UNK(char* effectName); ``` -``` -See ANIMPOSTFX_PLAY -``` +See [`ANIMPOSTFX_PLAY`](#_0x2206BF9A37B7F724) ## Parameters * **effectName**: diff --git a/GRAPHICS/AnimpostfxIsRunning.md b/GRAPHICS/AnimpostfxIsRunning.md index 78fa7af8b..67018f0f1 100644 --- a/GRAPHICS/AnimpostfxIsRunning.md +++ b/GRAPHICS/AnimpostfxIsRunning.md @@ -9,12 +9,10 @@ aliases: ["_GET_SCREEN_EFFECT_IS_ACTIVE"] BOOL ANIMPOSTFX_IS_RUNNING(char* effectName); ``` -``` -Returns whether the specified effect is active. -See ANIMPOSTFX_PLAY -``` +See [`ANIMPOSTFX_PLAY`](#_0x2206BF9A37B7F724). ## Parameters * **effectName**: ## Return value +Whether the specified effect is active \ No newline at end of file diff --git a/GRAPHICS/AnimpostfxStop.md b/GRAPHICS/AnimpostfxStop.md index 003ad0ad2..928b30a06 100644 --- a/GRAPHICS/AnimpostfxStop.md +++ b/GRAPHICS/AnimpostfxStop.md @@ -9,9 +9,7 @@ aliases: ["_STOP_SCREEN_EFFECT"] void ANIMPOSTFX_STOP(char* effectName); ``` -``` -See ANIMPOSTFX_PLAY -``` +See [`ANIMPOSTFX_PLAY`](#_0x2206BF9A37B7F724). ## Parameters * **effectName**: diff --git a/GRAPHICS/AnimpostfxStopAndDoUnk.md b/GRAPHICS/AnimpostfxStopAndDoUnk.md index b932e25d0..7b57abe19 100644 --- a/GRAPHICS/AnimpostfxStopAndDoUnk.md +++ b/GRAPHICS/AnimpostfxStopAndDoUnk.md @@ -9,10 +9,7 @@ aliases: ["0xD2209BE128B5418C"] void _ANIMPOSTFX_STOP_AND_DO_UNK(char* effectName); ``` -``` -Stops the effect and sets a value (bool) in its data (+0x199) to false. -See ANIMPOSTFX_PLAY -``` +Stops the effect and sets a value (bool) in its data (+0x199) to false; See [`ANIMPOSTFX_PLAY`](#_0x2206BF9A37B7F724). ## Parameters * **effectName**: diff --git a/GRAPHICS/ClearDrawOrigin.md b/GRAPHICS/ClearDrawOrigin.md index 7ec93681d..6859c2518 100644 --- a/GRAPHICS/ClearDrawOrigin.md +++ b/GRAPHICS/ClearDrawOrigin.md @@ -8,8 +8,4 @@ ns: GRAPHICS void CLEAR_DRAW_ORIGIN(); ``` -``` -Resets the screen's draw-origin which was changed by the function GRAPHICS::SET_DRAW_ORIGIN(...) back to x=0,y=0. -See GRAPHICS::SET_DRAW_ORIGIN(...) for further information. -``` - +Resets the screen's draw-origin which was changed by the function [`SET_DRAW_ORIGIN`](#_0xAA0008F3BBB8F416) back to `x=0, y=0`. See [`SET_DRAW_ORIGIN`](#_0xAA0008F3BBB8F416) for further information. diff --git a/GRAPHICS/DrawSpritePoly.md b/GRAPHICS/DrawSpritePoly.md index 4021d40b0..a83de37d8 100644 --- a/GRAPHICS/DrawSpritePoly.md +++ b/GRAPHICS/DrawSpritePoly.md @@ -9,11 +9,9 @@ aliases: ["0x29280002282F1928"] void _DRAW_SPRITE_POLY(float x1, float y1, float z1, float x2, float y2, float z2, float x3, float y3, float z3, int red, int green, int blue, int alpha, char* textureDict, char* textureName, float u1, float v1, float w1, float u2, float v2, float w2, float u3, float v3, float w3); ``` -``` Used for drawling Deadline trailing lights, see deadline.ytd For UVW mapping (u,v,w parameters), reference your favourite internet resource for more details. -``` ## Parameters * **x1**: diff --git a/GRAPHICS/DrawSpritePoly_2.md b/GRAPHICS/DrawSpritePoly_2.md index 4822cca2e..a513e6067 100644 --- a/GRAPHICS/DrawSpritePoly_2.md +++ b/GRAPHICS/DrawSpritePoly_2.md @@ -9,13 +9,11 @@ aliases: ["0x736D7AA1B750856B"] void _DRAW_SPRITE_POLY_2(float x1, float y1, float z1, float x2, float y2, float z2, float x3, float y3, float z3, float red1, float green1, float blue1, int alpha1, float red2, float green2, float blue2, int alpha2, float red3, float green3, float blue3, int alpha3, char* textureDict, char* textureName, float u1, float v1, float w1, float u2, float v2, float w2, float u3, float v3, float w3); ``` -``` Used for drawling Deadline trailing lights, see deadline.ytd Each vertex has its own colour that is blended/illuminated on the texture. Additionally, the R, G, and B components are floats that are int-casted internally. For UVW mapping (u,v,w parameters), reference your favourite internet resource for more details. -``` ## Parameters * **x1**: diff --git a/GRAPHICS/FadeDecalsInRange.md b/GRAPHICS/FadeDecalsInRange.md index 5ebd46e72..88a16c941 100644 --- a/GRAPHICS/FadeDecalsInRange.md +++ b/GRAPHICS/FadeDecalsInRange.md @@ -5,17 +5,23 @@ ns: GRAPHICS ```c // 0xD77EDADB0420E6E0 0xF81E884A -void FADE_DECALS_IN_RANGE(Any p0, Any p1, Any p2, Any p3, Any p4); +void FADE_DECALS_IN_RANGE(Any x, Any y, Any z, Any radius, Any duration); ``` +Fades nearby decals within the range specified. + ``` -Fades nearby decals within the range specified +NativeDB Parameter 0: float x +NativeDB Parameter 1: float y +NativeDB Parameter 2: float z +NativeDB Parameter 3: float radius +NativeDB Parameter 4: float duration ``` ## Parameters -* **p0**: -* **p1**: -* **p2**: -* **p3**: -* **p4**: +* **x**: +* **y**: +* **z**: +* **radius**: +* **duration**: A duration in seconds. diff --git a/GRAPHICS/GetExtraTimecycleModifierIndex.md b/GRAPHICS/GetExtraTimecycleModifierIndex.md index 9363e89ac..af1f685db 100644 --- a/GRAPHICS/GetExtraTimecycleModifierIndex.md +++ b/GRAPHICS/GetExtraTimecycleModifierIndex.md @@ -9,7 +9,7 @@ aliases: ["0xBB0527EC6341496D"] int _GET_EXTRA_TIMECYCLE_MODIFIER_INDEX(); ``` -See [`GetTimecycleModifierIndex`](#_0xFDF3D97C674AFB66) for use, works the same just for the secondary timecycle modifier. +See [`GET_TIMECYCLE_MODIFIER_INDEX`](#_0xFDF3D97C674AFB66) for use, works the same just for the secondary timecycle modifier. ## Return value An integer representing the Timecycle modifier diff --git a/GRAPHICS/N_0x2d3b147afad49de0.md b/GRAPHICS/N_0x2d3b147afad49de0.md index b02635d23..865d64046 100644 --- a/GRAPHICS/N_0x2d3b147afad49de0.md +++ b/GRAPHICS/N_0x2d3b147afad49de0.md @@ -5,41 +5,39 @@ ns: GRAPHICS ```c // 0x2D3B147AFAD49DE0 -void _0x2D3B147AFAD49DE0(char* textureDict, char* textureName, float p2, float p3, float p4, float p5, float p6, float p7, int red, int green, int blue, int alpha); +void _0x2D3B147AFAD49DE0(char* textureDict, char* textureName, float x, float y, float width, float height, float p6, int red, int green, int blue, int alpha, int p11); ``` +``` +Used in arcade games and Beam hack minigame in Doomsday Heist. For example, [Penetrator Arcade Game](https://streamable.com/8igrzw) -Used in arcade games and Beam hack minigame in Doomsday Heist. I will most certainly dive into this to try replicate arcade games. - -It has 12 paramaters not 11. - -_NativeD B Introduced: v1290_ - +NativeDB Introduced: v1290 +``` ## Parameters * **textureDict**: inside script_txds.rpf, browse it with OpenIV * **textureName**: textureName -* **p2**: float seems to be always returning 0.0 but not quite sure -* **p3**: mostly -1 float -* **p4**: something related to aspect ratio and looks like integer but can be float too ? -* **p5**: float -* **p6**: float -* **p7**: float +* **x**: x position must be between 0.0 and 1.0 (1.0 being the most right side of the screen) +* **y**: y position must be between 0.0 and 1.0 (1.0 being the most bottom side of the screen) +* **width**: width 0.0 - 1.0 is the reasonable amount generally +* **height**: height 0.0 - 1.0 is the reasonable amount generally +* **p6**: almost always 0.0 * **red**: red color * **green**: green color * **blue**: blue color * **alpha**: alpha +* **p11**: ## Examples ```lua --- _0x2D3B147AFAD49DE0("MPBeamHack", "Beam_Glow_Tapered", func_11081(Var11), Var11.f_1, (0.064f / fLocal_564), fVar12, (fVar13 + 90f), iVar0, iVar1, iVar2, iVar7, 0) - -N_0x2d3b147afad49de0("MPInvPersMessages", "facade", MathStuff(0.5), 0.0, 0.0, 1.0, 0.0, arg1, arg2, arg3, arg4, 0) - -function MathStuff(number) - number = (((number * 1920) - ((1920 - 1080) / 2)) / 1080) - number = (0.5 - ((0.5 - number) / 0)) - return number -end +-- drawing the game area for penetrator arcade game +Citizen.CreateThread(function() + RequestStreamedTextureDict("MPArcadeDegenatron", false) + while not HasStreamedTextureDictLoaded("MPArcadeDegenatron") do Citizen.Wait(1) end + while true do + N_0x2d3b147afad49de0("MPArcadeDegenatron", "penetrator_scene_frame", 0.5, 0.5, 0.4, 0.6, 0.0, 255, 0, 0, 255, 0) + Citizen.Wait(1) + end +end) ``` diff --git a/GRAPHICS/N_0x44621483ff966526.md b/GRAPHICS/N_0x44621483ff966526.md deleted file mode 100644 index 91fcf6042..000000000 --- a/GRAPHICS/N_0x44621483ff966526.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: GRAPHICS ---- -## _0x44621483FF966526 - -```c -// 0x44621483FF966526 -void _0x44621483FF966526(Any p0, Any p1); -``` - - -## Parameters -* **p0**: -* **p1**: - diff --git a/GRAPHICS/SetCheckpointIconScale.md b/GRAPHICS/SetCheckpointIconScale.md new file mode 100644 index 000000000..78ba8a0d4 --- /dev/null +++ b/GRAPHICS/SetCheckpointIconScale.md @@ -0,0 +1,15 @@ +--- +ns: GRAPHICS +aliases: ["0x44621483FF966526"] +--- +## _SET_CHECKPOINT_ICON_SCALE + +```c +// 0x44621483FF966526 +void _SET_CHECKPOINT_ICON_SCALE(int checkpoint, float scale); +``` + +## Parameters +* **checkpoint**: +* **scale**: + diff --git a/HUD/EndTextCommandDisplayText.md b/HUD/EndTextCommandDisplayText.md index 76ee0f1b7..7dd64a53c 100644 --- a/HUD/EndTextCommandDisplayText.md +++ b/HUD/EndTextCommandDisplayText.md @@ -11,7 +11,6 @@ void END_TEXT_COMMAND_DISPLAY_TEXT(float x, float y); ``` After applying the properties to the text (See UI::SET_TEXT_), this will draw the text in the applied position. Also 0.0f < x, y < 1.0f, percentage of the axis. -Used to be known as _DRAW_TEXT ``` ``` diff --git a/HUD/GetGlobalActionscriptFlag.md b/HUD/GetGlobalActionscriptFlag.md new file mode 100644 index 000000000..e1a3462b6 --- /dev/null +++ b/HUD/GetGlobalActionscriptFlag.md @@ -0,0 +1,26 @@ +--- +ns: HUD +aliases: ["0xE3B05614DCE1D014"] +--- +## GET_GLOBAL_ACTIONSCRIPT_FLAG + +```c +// 0xE3B05614DCE1D014 0xD217EE7E +int GET_GLOBAL_ACTIONSCRIPT_FLAG(int flagIndex); +``` + +``` +Returns the ActionScript flagValue. +ActionScript flags are global flags that scaleforms use +Flags found during testing +0: Returns 1 if the web_browser keyboard is open, otherwise 0 +1: Returns 1 if the player has clicked back twice on the opening page, otherwise 0 (web_browser) +2: Returns how many links the player has clicked in the web_browser scaleform, returns 0 when the browser gets closed +9: Returns the current selection on the mobile phone scaleform +There are 20 flags in total. +``` + +## Parameters +* **flagIndex**: + +## Return value diff --git a/HUD/GetPauseMenuCursorPosition.md b/HUD/GetPauseMenuCursorPosition.md new file mode 100644 index 000000000..7372f48db --- /dev/null +++ b/HUD/GetPauseMenuCursorPosition.md @@ -0,0 +1,17 @@ +--- +ns: HUD +aliases: ['0x5BFF36D6ED83E0AE'] +--- +## _GET_PAUSE_MENU_CURSOR_POSITION + +```c +// 0x5BFF36D6ED83E0AE +Vector3 _GET_PAUSE_MENU_CURSOR_POSITION(); +``` + +Name between `GET_ONSCREEN_KEYBOARD_RESULT` and `GET_PAUSE_MENU_STATE`. Likely, `GET_PAUSE_MENU_*`. + + +## Return value +If the pause menu is open, it will return a Vector3, Z is always 0. +If the pause menu is closed, it will return Vector3.Zero diff --git a/HUD/GetRenderedCharacterHeight.md b/HUD/GetRenderedCharacterHeight.md new file mode 100644 index 000000000..e1124611a --- /dev/null +++ b/HUD/GetRenderedCharacterHeight.md @@ -0,0 +1,21 @@ +--- +ns: HUD +aliases: ["0xDB88A37483346780","_GET_TEXT_SCALE_HEIGHT"] +--- +## GET_RENDERED_CHARACTER_HEIGHT + +```c +// 0xDB88A37483346780 0x3330175B +float GET_RENDERED_CHARACTER_HEIGHT(float size, int font); +``` + +``` +This gets the height of the FONT and not the total text. You need to get the number of lines your text uses, and get the height of a newline (I'm using a smaller value) to get the total text height. +Old name: _GET_TEXT_SCALE_HEIGHT +``` + +## Parameters +* **size**: +* **font**: + +## Return value diff --git a/HUD/GetStreetNameFromHashKey.md b/HUD/GetStreetNameFromHashKey.md index c601f7907..1ba58fc49 100644 --- a/HUD/GetStreetNameFromHashKey.md +++ b/HUD/GetStreetNameFromHashKey.md @@ -8,10 +8,7 @@ ns: HUD char* GET_STREET_NAME_FROM_HASH_KEY(Hash hash); ``` -``` -This functions converts the hash of a street name into a readable string. -For how to get the hashes, see PATHFIND::GET_STREET_NAME_AT_COORD. -``` +Converts the hash of a street name into a readable string. To retrieve a hash for a given (street) coordinate, see [`GET_STREET_NAME_AT_COORD`](#_0x2EB41072B4C1E4C0). ## Parameters * **hash**: diff --git a/HUD/GetTextScaleHeight.md b/HUD/GetTextScaleHeight.md deleted file mode 100644 index 3868d4d4f..000000000 --- a/HUD/GetTextScaleHeight.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -ns: HUD -aliases: ["0xDB88A37483346780"] ---- -## _GET_TEXT_SCALE_HEIGHT - -```c -// 0xDB88A37483346780 0x3330175B -float _GET_TEXT_SCALE_HEIGHT(float size, int font); -``` - -``` -This get's the height of the FONT and not the total text. You need to get the number of lines your text uses, and get the height of a newline (I'm using a smaller value) to get the total text height. -``` - -## Parameters -* **size**: -* **font**: - -## Return value diff --git a/HUD/N_0x5bff36d6ed83e0ae.md b/HUD/N_0x5bff36d6ed83e0ae.md deleted file mode 100644 index 1d1d43369..000000000 --- a/HUD/N_0x5bff36d6ed83e0ae.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: HUD ---- -## _0x5BFF36D6ED83E0AE - -```c -// 0x5BFF36D6ED83E0AE -Vector3 _0x5BFF36D6ED83E0AE(); -``` - -``` -GET_PAUSE_MENU_* -``` - -## Return value diff --git a/HUD/N_0xb99c4e4d9499df29.md b/HUD/N_0xb99c4e4d9499df29.md deleted file mode 100644 index 64ce4b06a..000000000 --- a/HUD/N_0xb99c4e4d9499df29.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -ns: HUD ---- -## _0xB99C4E4D9499DF29 - -```c -// 0xB99C4E4D9499DF29 -void _0xB99C4E4D9499DF29(int p0); -``` - -``` -RESET_* -``` - -## Parameters -* **p0**: - diff --git a/HUD/N_0xe3b05614dce1d014.md b/HUD/N_0xe3b05614dce1d014.md deleted file mode 100644 index 427e38a82..000000000 --- a/HUD/N_0xe3b05614dce1d014.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -ns: HUD ---- -## _0xE3B05614DCE1D014 - -```c -// 0xE3B05614DCE1D014 0xD217EE7E -Any _0xE3B05614DCE1D014(Any p0); -``` - -``` -GET_G* -``` - -## Parameters -* **p0**: - -## Return value diff --git a/HUD/ResetGlobalActionscriptFlag.md b/HUD/ResetGlobalActionscriptFlag.md new file mode 100644 index 000000000..1fe0f0cbb --- /dev/null +++ b/HUD/ResetGlobalActionscriptFlag.md @@ -0,0 +1,14 @@ +--- +ns: HUD +aliases: ["0xB99C4E4D9499DF29"] +--- +## RESET_GLOBAL_ACTIONSCRIPT_FLAG + +```c +// 0xB99C4E4D9499DF29 0x4C4C10CF +void RESET_GLOBAL_ACTIONSCRIPT_FLAG(int flagIndex); +``` + +## Parameters +* **flagIndex**: + diff --git a/HUD/SetMpGamerTagColour.md b/HUD/SetMpGamerTagColour.md index 7936495e6..db80beb1b 100644 --- a/HUD/SetMpGamerTagColour.md +++ b/HUD/SetMpGamerTagColour.md @@ -9,14 +9,23 @@ aliases: ["0x613ED644950626AE"] void SET_MP_GAMER_TAG_COLOUR(int gamerTagId, int component, int hudColorIndex); ``` -``` Sets a gamer tag's component colour -gamerTagId is obtained using for example CREATE_FAKE_MP_GAMER_TAG -Ranges from 0 to 255. 0 is grey health bar, ~50 yellow, 200 purple. -``` ## Parameters -* **gamerTagId**: -* **component**: -* **hudColorIndex**: +* **gamerTagId**: a gamerTagId obtained using for example: [`CREATE_FAKE_MP_GAMER_TAG`](#_0xBFEFE3321A3F5015). +* **component**: a component id, see the full list here: [link](https://docs.fivem.net/docs/game-references/gamer-tags/#components-list) +* **hudColorIndex**: a hud color index, see the full list here: [link](https://pastebin.com/d9aHPbXN) +## Examples +```lua +local playerPed = PlayerPedId() --get our players ped +local playerName = GetPlayerName(PlayerId()) --get our players name +local gamerTagId = CreateFakeMpGamerTag(playerPed, playerName, 0, 0, "", 0) --create a gamer tag +SetMpGamerTagColour(gamerTagId, 0, 129) --set component 0(GAMER_NAME) color to 129(HUD_COLOUR_YOGA) +``` + +```cs +Player player = Game.Player; //get our player +int gamerTagId = CreateFakeMpGamerTag(player.Character.Handle, player.Name, false, false, null, 0); //create a gamer tag +SetMpGamerTagColour(gamerTagId, 0, 129); //set component 0(GAMER_NAME) color to 129(HUD_COLOUR_YOGA) +``` diff --git a/HUD/SetMpGamerTagHealthBarColour.md b/HUD/SetMpGamerTagHealthBarColour.md index 32882b7b6..e284315d3 100644 --- a/HUD/SetMpGamerTagHealthBarColour.md +++ b/HUD/SetMpGamerTagHealthBarColour.md @@ -6,16 +6,29 @@ aliases: ["0x3158C77A7E888AB4","_SET_MP_GAMER_TAG_HEALTH_BAR_COLOR"] ```c // 0x3158C77A7E888AB4 0x5777EC77 -void SET_MP_GAMER_TAG_HEALTH_BAR_COLOUR(int headDisplayId, int color); +void SET_MP_GAMER_TAG_HEALTH_BAR_COLOUR(int gamerTagId, int hudColorIndex); ``` -``` -Ranges from 0 to 255. 0 is grey health bar, ~50 yellow, 200 purple. -Should be enabled as flag (2). Has 0 opacity by default. -- This was _SET_MP_GAMER_TAG_HEALTH_BAR_COLOR, -``` +Should be enabled as component (2). Has 0 alpha by default. ## Parameters -* **headDisplayId**: -* **color**: +* **gamerTagId**: a gamerTagId obtained using for example: [CREATE_FAKE_MP_GAMER_TAG](https://runtime.fivem.net/doc/natives/?_0xBFEFE3321A3F5015) +* **hudColorIndex**: a hud color index, see the full list here: [link](pastebin.com/d9aHPbXN) +## Examples +```lua +local playerPed = PlayerPedId() --get our players ped +local playerName = GetPlayerName(PlayerId()) --get our players name +local gamerTagId = CreateFakeMpGamerTag(playerPed, playerName, 0, 0, "", 0) --create a gamer tag +SetMpGamerTagVisibility(gamerTagId, 2, 1) --set the visibility of component 2(healthArmour) to true +SetMpGamerTagAlpha(gamerTagId, 2, 255) --set the alpha of component 2(healthArmour) to 255 +SetMpGamerTagHealthBarColor(gamerTagId, 129) --set component 2(healthArmour) color to 129(HUD_COLOUR_YOGA) +``` + +```cs +Player player = Game.Player; //get our player +int gamerTagId = CreateFakeMpGamerTag(player.Character.Handle, player.Name, false, false, null, 0); //create a gamer tag +SetMpGamerTagVisibility(gamerTagId, 2, true); //set the visibility of component 2(healthArmour) to true +SetMpGamerTagAlpha(gamerTagId, 2, 255); //set the alpha of component 2(healthArmour) to 255 +SetMpGamerTagHealthBarColor(gamerTagId, 129); //set component 2(healthArmour) color to 129(HUD_COLOUR_YOGA) +``` diff --git a/HUD/SetMultiplayerBankCash.md b/HUD/SetMultiplayerBankCash.md index c244d9578..832ce97b6 100644 --- a/HUD/SetMultiplayerBankCash.md +++ b/HUD/SetMultiplayerBankCash.md @@ -8,4 +8,25 @@ ns: HUD void SET_MULTIPLAYER_BANK_CASH(); ``` +Preview image: +![](https://i.imgur.com/1BTmdyv.png) + +To change the bank balance use [`STAT_SET_INT`](#_0xB3271D7AB655B441) with "BANK_BALANCE" to whatever value you need to. + +## Examples + +```cs +// Code to show both Money and Bank HUD +N_0x170f541e1cadd1de(true); +SetMultiplayerWalletCash(); +SetMultiplayerBankCash(); +N_0x170f541e1cadd1de(false); + +// Add a delay to let the player read his money +await Delay(5000); + +// Hide both Bank and Money HUD +RemoveMultiplayerWalletCash(); +RemoveMultiplayerBankCash(); +``` diff --git a/HUD/SetMultiplayerWalletCash.md b/HUD/SetMultiplayerWalletCash.md index bb2349456..93206cf86 100644 --- a/HUD/SetMultiplayerWalletCash.md +++ b/HUD/SetMultiplayerWalletCash.md @@ -9,4 +9,25 @@ aliases: ["0xC2D15BEF167E27BC"] void SET_MULTIPLAYER_WALLET_CASH(); ``` +Preview image: +![](https://i.imgur.com/1BTmdyv.png) + +To change money value use [`STAT_SET_INT`](#_0xB3271D7AB655B441) with "MP0_WALLET_BALANCE" to whatever value you need to. + +## Examples + +```cs +// Code to show both Money and Bank HUD +N_0x170f541e1cadd1de(true); +SetMultiplayerWalletCash(); +SetMultiplayerBankCash(); +N_0x170f541e1cadd1de(false); + +// Add a delay to let the player read his money +await Delay(5000); + +// Hide both Bank and Money HUD +RemoveMultiplayerWalletCash(); +RemoveMultiplayerBankCash(); +``` diff --git a/HUD/SetPedHasAiBlipWithColor.md b/HUD/SetPedHasAiBlipWithColor.md index 8538f3cc8..48eea7cfd 100644 --- a/HUD/SetPedHasAiBlipWithColor.md +++ b/HUD/SetPedHasAiBlipWithColor.md @@ -9,12 +9,8 @@ aliases: ["0xB13DCB4C6FAAD238"] void _SET_PED_HAS_AI_BLIP_WITH_COLOR(Ped ped, BOOL hasCone, int color); ``` -``` -color: see SET_BLIP_COLOUR -``` - ## Parameters * **ped**: * **hasCone**: -* **color**: +* **color**: See [`SET_BLIP_COLOUR`](#_0x03D7FB09E75D6B7E). diff --git a/HUD/ShowOutlineIndicatorOnBlip.md b/HUD/ShowOutlineIndicatorOnBlip.md index 82f9cfda5..e889ec804 100644 --- a/HUD/ShowOutlineIndicatorOnBlip.md +++ b/HUD/ShowOutlineIndicatorOnBlip.md @@ -11,12 +11,7 @@ void SHOW_OUTLINE_INDICATOR_ON_BLIP(Blip blip, BOOL toggle); Toggles a cyan outline around the blip. -Color can be changed with `SET_BLIP_SECONDARY_COLOUR`. Enabling this circle will override the "crew" and "friend" half-circles (see [`SHOW_CREW_INDICATOR_ON_BLIP`](#_0xDCFB5D4DB8BF367E) and [`SHOW_FRIEND_INDICATOR_ON_BLIP`](#_0x23C3EB807312F01A)). - -~~Oddly enough, this native is called `_SET_BLIP_FRIENDLY`, but the color of the circle is only changable for the 'crew' half-circle (using `SET_BLIP_SECONDARY_COLOUR`), the 'friendly' side can NOT be changed and will always stay cyan/blue. This makes it seem more likely that this should be called `_SET_BLIP_CREW_CIRCLE` or something similar?~~ - -Real name is `SHOW_OUTLINE_INDICATOR_ON_BLIP`, discovered by Blattersturm. - +Color can be changed with [`SET_BLIP_SECONDARY_COLOUR`](#_0x14892474891E09EB). Enabling this circle will override the "crew" and "friend" half-circles (see [`SHOW_CREW_INDICATOR_ON_BLIP`](#_0xDCFB5D4DB8BF367E) and [`SHOW_FRIEND_INDICATOR_ON_BLIP`](#_0x23C3EB807312F01A)). ## Parameters * **blip**: The blip to toggle the outline on. diff --git a/MISC/AddDispatchSpawnBlockingAngledArea.md b/MISC/AddDispatchSpawnBlockingAngledArea.md index 310534c78..f7292c169 100644 --- a/MISC/AddDispatchSpawnBlockingAngledArea.md +++ b/MISC/AddDispatchSpawnBlockingAngledArea.md @@ -9,9 +9,9 @@ aliases: ["0x918C7B2D2FF3928B"] Any _ADD_DISPATCH_SPAWN_BLOCKING_ANGLED_AREA(float x1, float y1, float z1, float x2, float y2, float z2, float width); ``` -To remove, see: [REMOVE_DISPATCH_SPAWN_BLOCKING_AREA](#_0x264AC28B01B353A5). +To remove, see: [`REMOVE_DISPATCH_SPAWN_BLOCKING_AREA`](#_0x264AC28B01B353A5). -See [IS_POINT_IN_ANGLED_AREA](#_0x2A70BAE8883E4C81) for the definition of an angled area. +See [`IS_POINT_IN_ANGLED_AREA`](#_0x2A70BAE8883E4C81) for the definition of an angled area. ## Parameters * **x1**: X dimension of the angled area 'origin' diff --git a/MISC/GetStatusOfMissionRepeatSave.md b/MISC/GetStatusOfMissionRepeatSave.md new file mode 100644 index 000000000..a0840546e --- /dev/null +++ b/MISC/GetStatusOfMissionRepeatSave.md @@ -0,0 +1,13 @@ +--- +ns: MISC +aliases: ["0x2B5E102E4A42F2BF"] +--- +## GET_STATUS_OF_MISSION_REPEAT_SAVE + +```c +// 0x2B5E102E4A42F2BF 0x144AAF22 +Any GET_STATUS_OF_MISSION_REPEAT_SAVE(); +``` + + +## Return value diff --git a/MISC/IsBulletInAngledArea.md b/MISC/IsBulletInAngledArea.md index eab1bb220..bf7ba6443 100644 --- a/MISC/IsBulletInAngledArea.md +++ b/MISC/IsBulletInAngledArea.md @@ -8,9 +8,9 @@ ns: MISC BOOL IS_BULLET_IN_ANGLED_AREA(float x1, float y1, float z1, float x2, float y2, float z2, float width, BOOL ownedByPlayer); ``` -See [IS_POINT_IN_ANGLED_AREA](#_0x2A70BAE8883E4C81) for the definition of an angled area. +See [`IS_POINT_IN_ANGLED_AREA`](#_0x2A70BAE8883E4C81) for the definition of an angled area. -For projectiles, see: [IS_PROJECTILE_TYPE_IN_ANGLED_AREA](#_0xF0BC12401061DEA0) +For projectiles, see: [`IS_PROJECTILE_TYPE_IN_ANGLED_AREA`](#_0xF0BC12401061DEA0) ## Parameters * **x1**: X dimension of the angled area 'origin' diff --git a/MISC/IsProjectileTypeInAngledArea.md b/MISC/IsProjectileTypeInAngledArea.md index 68dcacdc2..998dd59d5 100644 --- a/MISC/IsProjectileTypeInAngledArea.md +++ b/MISC/IsProjectileTypeInAngledArea.md @@ -8,7 +8,7 @@ ns: MISC BOOL IS_PROJECTILE_TYPE_IN_ANGLED_AREA(float x1, float y1, float z1, float x2, float y2, float z2, float width, float p6, Any p7, BOOL ownedByPlayer); ``` -See [IS_POINT_IN_ANGLED_AREA](#_0x2A70BAE8883E4C81) for the definition of an angled area. +See [`IS_POINT_IN_ANGLED_AREA`](#_0x2A70BAE8883E4C81) for the definition of an angled area. ``` NativeDB Parameter 7: Hash weaponHash diff --git a/MISC/N_0x19bfed045c647c49.md b/MISC/N_0x19bfed045c647c49.md index 6b2584413..85b2c60a9 100644 --- a/MISC/N_0x19bfed045c647c49.md +++ b/MISC/N_0x19bfed045c647c49.md @@ -9,9 +9,7 @@ BOOL _0x19BFED045C647C49(Ped ped); ``` ``` -Related to tennis mode. - -GET_TENNIS_* +GET_TENNIS_*; references 0xFBFEC0E9 = interruptswing ``` ## Parameters diff --git a/MISC/N_0x2b5e102e4a42f2bf.md b/MISC/N_0x2b5e102e4a42f2bf.md deleted file mode 100644 index 03bc7adec..000000000 --- a/MISC/N_0x2b5e102e4a42f2bf.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -ns: MISC ---- -## _0x2B5E102E4A42F2BF - -```c -// 0x2B5E102E4A42F2BF 0x144AAF22 -Any _0x2B5E102E4A42F2BF(); -``` - - -## Return value diff --git a/MISC/N_0x72de52178c291cb5.md b/MISC/N_0x72de52178c291cb5.md deleted file mode 100644 index f358c67b0..000000000 --- a/MISC/N_0x72de52178c291cb5.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -ns: MISC ---- -## _0x72DE52178C291CB5 - -```c -// 0x72DE52178C291CB5 0xF62B3C48 -Any _0x72DE52178C291CB5(); -``` - - -## Return value diff --git a/MISC/N_0xe95b0c7d5ba3b96b.md b/MISC/N_0xe95b0c7d5ba3b96b.md index cbf19081a..d49139217 100644 --- a/MISC/N_0xe95b0c7d5ba3b96b.md +++ b/MISC/N_0xe95b0c7d5ba3b96b.md @@ -8,11 +8,7 @@ ns: MISC BOOL _0xE95B0C7D5BA3B96B(Ped ped); ``` -``` -Related to tennis mode. - -GET_TENNIS_* -``` +Related to tennis mode. Checks for `0x0FCED5ADF = swung` ## Parameters * **ped**: diff --git a/MISC/QueueMissionRepeatLoad.md b/MISC/QueueMissionRepeatLoad.md new file mode 100644 index 000000000..72d681a3e --- /dev/null +++ b/MISC/QueueMissionRepeatLoad.md @@ -0,0 +1,13 @@ +--- +ns: MISC +aliases: ["0x72DE52178C291CB5"] +--- +## QUEUE_MISSION_REPEAT_LOAD + +```c +// 0x72DE52178C291CB5 0xF62B3C48 +Any QUEUE_MISSION_REPEAT_LOAD(); +``` + + +## Return value diff --git a/MISC/N_0x44a0bdc559b35f6e.md b/MISC/QueueMissionRepeatSave.md similarity index 60% rename from MISC/N_0x44a0bdc559b35f6e.md rename to MISC/QueueMissionRepeatSave.md index 3f03ea1be..9547e26ae 100644 --- a/MISC/N_0x44a0bdc559b35f6e.md +++ b/MISC/QueueMissionRepeatSave.md @@ -1,16 +1,15 @@ --- ns: MISC +aliases: ["0x44A0BDC559B35F6E"] --- -## _0x44A0BDC559B35F6E +## QUEUE_MISSION_REPEAT_SAVE ```c // 0x44A0BDC559B35F6E 0x3589452B -BOOL _0x44A0BDC559B35F6E(); +BOOL QUEUE_MISSION_REPEAT_SAVE(); ``` -``` Shows the screen which is visible before you redo a mission? The game will make a restoration point where you will cameback when the mission is over. -Returns 1 if the message isn't currently on screen -``` ## Return value +Returns 1 if the message isn't currently on screen. \ No newline at end of file diff --git a/MISC/SetWindDirection.md b/MISC/SetWindDirection.md index db238d8ed..f2fb457f5 100644 --- a/MISC/SetWindDirection.md +++ b/MISC/SetWindDirection.md @@ -8,11 +8,18 @@ ns: MISC void SET_WIND_DIRECTION(float direction); ``` -``` -The wind direction in radians -180 degrees, wind will blow from the south -``` +Sets the wind direction. ## Parameters -* **direction**: +* **direction**: the [wind direction](https://en.wikipedia.org/wiki/Wind_direction) in radians +## Examples +```lua +-- 180 degrees, wind will blow from the south +SetWindDirection(math.rad(180.0)) +``` + +```cs +// 180 degrees, wind will blow from the south +SetWindDirection(3.1415f); +``` diff --git a/NETWORK/IsEntityAGhost.md b/NETWORK/IsEntityAGhost.md deleted file mode 100644 index 150ed557b..000000000 --- a/NETWORK/IsEntityAGhost.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -ns: NETWORK -aliases: ["0x21D04D7BC538C146"] ---- -## _IS_ENTITY_A_GHOST - -```c -// 0x21D04D7BC538C146 -BOOL _IS_ENTITY_A_GHOST(Entity entity); -``` - -Getter for _SET_LOCAL_PLAYER_AS_GHOST and SET_NETWORK_VEHICLE_AS_GHOST. - -## Parameters -* **entity**: - -## Return value diff --git a/NETWORK/IsEntityGhostedToLocalPlayer.md b/NETWORK/IsEntityGhostedToLocalPlayer.md index e07b05620..2ac0621a4 100644 --- a/NETWORK/IsEntityGhostedToLocalPlayer.md +++ b/NETWORK/IsEntityGhostedToLocalPlayer.md @@ -1,6 +1,6 @@ --- ns: NETWORK -aliases: ["0x21D04D7BC538C146"] +aliases: ["0x21D04D7BC538C146","_IS_ENTITY_A_GHOST"] --- ## _IS_ENTITY_GHOSTED_TO_LOCAL_PLAYER diff --git a/NETWORK/N_0x0e3a041ed6ac2b45.md b/NETWORK/N_0x0e3a041ed6ac2b45.md deleted file mode 100644 index 0a0ca17db..000000000 --- a/NETWORK/N_0x0e3a041ed6ac2b45.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -ns: NETWORK ---- -## _0x0E3A041ED6AC2B45 - -```c -// 0x0E3A041ED6AC2B45 -float _0x0E3A041ED6AC2B45(Player player); -``` - -``` -NativeDB Introduced: v323 -``` - -## Parameters -* **player**: diff --git a/NETWORK/N_0x16d3d49902f697bb.md b/NETWORK/N_0x16d3d49902f697bb.md deleted file mode 100644 index 48c90f46f..000000000 --- a/NETWORK/N_0x16d3d49902f697bb.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -ns: NETWORK ---- -## _0x16D3D49902F697BB - -```c -// 0x16D3D49902F697BB -BOOL _0x16D3D49902F697BB(Player player); -``` - -``` -NETWORK_IS_* - -NativeDB Introduced: v323 -``` - -## Parameters -* **player**: diff --git a/NETWORK/N_0x17330ebf2f2124a8.md b/NETWORK/N_0x17330ebf2f2124a8.md deleted file mode 100644 index 18072273a..000000000 --- a/NETWORK/N_0x17330ebf2f2124a8.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -ns: NETWORK ---- -## _0x17330EBF2F2124A8 - -```c -// 0x17330EBF2F2124A8 -void _0x17330EBF2F2124A8(); -``` - - diff --git a/NETWORK/N_0x2cc848a861d01493.md b/NETWORK/N_0x2cc848a861d01493.md deleted file mode 100644 index 66f21584e..000000000 --- a/NETWORK/N_0x2cc848a861d01493.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -ns: NETWORK ---- -## _0x2CC848A861D01493 - -```c -// 0x2CC848A861D01493 0xBEB98840 -Any _0x2CC848A861D01493(); -``` - - -## Return value diff --git a/NETWORK/N_0x4ba166079d658ed4.md b/NETWORK/N_0x4ba166079d658ed4.md deleted file mode 100644 index 49fdd773a..000000000 --- a/NETWORK/N_0x4ba166079d658ed4.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: NETWORK ---- -## _0x4BA166079D658ED4 - -```c -// 0x4BA166079D658ED4 -void _0x4BA166079D658ED4(Any p0, Any p1); -``` - - -## Parameters -* **p0**: -* **p1**: - diff --git a/NETWORK/N_0x5ae17c6b0134b7f1.md b/NETWORK/N_0x5ae17c6b0134b7f1.md deleted file mode 100644 index c3e4695c3..000000000 --- a/NETWORK/N_0x5ae17c6b0134b7f1.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -ns: NETWORK ---- -## _0x5AE17C6B0134B7F1 - -```c -// 0x5AE17C6B0134B7F1 0xC871E745 -Any _0x5AE17C6B0134B7F1(); -``` - - -## Return value diff --git a/NETWORK/N_0x658500ae6d723a7e.md b/NETWORK/N_0x658500ae6d723a7e.md deleted file mode 100644 index cb0872e54..000000000 --- a/NETWORK/N_0x658500ae6d723a7e.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -ns: NETWORK ---- -## _0x658500AE6D723A7E - -```c -// 0x658500AE6D723A7E -void _0x658500AE6D723A7E(Any p0); -``` - - -## Parameters -* **p0**: - diff --git a/NETWORK/N_0x94a8394d150b013a.md b/NETWORK/N_0x94a8394d150b013a.md deleted file mode 100644 index 05a2ce851..000000000 --- a/NETWORK/N_0x94a8394d150b013a.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: NETWORK ---- -## _0x94A8394D150B013A - -```c -// 0x94A8394D150B013A 0x08029970 -Any _0x94A8394D150B013A(); -``` - -``` -NETWORK_IS_* -``` - -## Return value diff --git a/NETWORK/N_0xa7c511fa1c5bda38.md b/NETWORK/N_0xa7c511fa1c5bda38.md deleted file mode 100644 index 39d400a7c..000000000 --- a/NETWORK/N_0xa7c511fa1c5bda38.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: NETWORK ---- -## _0xA7C511FA1C5BDA38 - -```c -// 0xA7C511FA1C5BDA38 -void _0xA7C511FA1C5BDA38(Any p0, Any p1); -``` - - -## Parameters -* **p0**: -* **p1**: - diff --git a/NETWORK/N_0xd414be129bb81b32.md b/NETWORK/N_0xd414be129bb81b32.md deleted file mode 100644 index 43ff7c7f1..000000000 --- a/NETWORK/N_0xd414be129bb81b32.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -ns: NETWORK ---- -## _0xD414BE129BB81B32 - -```c -// 0xD414BE129BB81B32 -float _0xD414BE129BB81B32(Player player); -``` - -``` -NativeDB Introduced: v323 -``` - -## Parameters -* **player**: diff --git a/NETWORK/N_0xf1b84178f8674195.md b/NETWORK/N_0xf1b84178f8674195.md deleted file mode 100644 index ae97f3c8a..000000000 --- a/NETWORK/N_0xf1b84178f8674195.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -ns: NETWORK ---- -## _0xF1B84178F8674195 - -```c -// 0xF1B84178F8674195 0x41702C8A -void _0xF1B84178F8674195(Any p0); -``` - - -## Parameters -* **p0**: - diff --git a/NETWORK/N_0xf9b83b77929d8863.md b/NETWORK/N_0xf9b83b77929d8863.md deleted file mode 100644 index f3599401b..000000000 --- a/NETWORK/N_0xf9b83b77929d8863.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -ns: NETWORK ---- -## _0xF9B83B77929D8863 - -```c -// 0xF9B83B77929D8863 0xBEDC4503 -Any _0xF9B83B77929D8863(); -``` - - -## Return value diff --git a/NETWORK/NetworkAddEntityAngledArea.md b/NETWORK/NetworkAddEntityAngledArea.md index 99363e44b..d48111260 100644 --- a/NETWORK/NetworkAddEntityAngledArea.md +++ b/NETWORK/NetworkAddEntityAngledArea.md @@ -9,9 +9,9 @@ aliases: ["0x376C6375BA60293A","_NETWORK_ADD_ENTITY_ANGLED_AREA"] Any NETWORK_ADD_ENTITY_ANGLED_AREA(float x1, float y1, float z1, float x2, float y2, float z2, float width); ``` -To remove, see: [NETWORK_REMOVE_ENTITY_AREA](#_0x93CF869BAA0C4874). +To remove, see: [`NETWORK_REMOVE_ENTITY_AREA`](#_0x93CF869BAA0C4874). -See [IS_POINT_IN_ANGLED_AREA](#_0x2A70BAE8883E4C81) for the definition of an angled area. +See [`IS_POINT_IN_ANGLED_AREA`](#_0x2A70BAE8883E4C81) for the definition of an angled area. ## Parameters * **x1**: X dimension of the angled area 'origin' diff --git a/NETWORK/NetworkCreateSynchronisedScene.md b/NETWORK/NetworkCreateSynchronisedScene.md index 262380896..99fd47618 100644 --- a/NETWORK/NetworkCreateSynchronisedScene.md +++ b/NETWORK/NetworkCreateSynchronisedScene.md @@ -5,7 +5,7 @@ ns: NETWORK ```c // 0x7CD6BC4C2BBDD526 0xB06FE3FE -int NETWORK_CREATE_SYNCHRONISED_SCENE(float x, float y, float z, float xRot, float yRot, float zRot, int rotationOrder, BOOL useOcclusionPortal, BOOL looped, float p9, float animTime, float p11); +int NETWORK_CREATE_SYNCHRONISED_SCENE(float x, float y, float z, float xRot, float yRot, float zRot, int rotationOrder, BOOL holdLastFrame, BOOL looped, float p9, float animTime, float p11); ``` ## Parameters @@ -16,7 +16,7 @@ int NETWORK_CREATE_SYNCHRONISED_SCENE(float x, float y, float z, float xRot, flo * **yRot**: * **zRot**: * **rotationOrder**: -* **useOcclusionPortal**: +* **holdLastFrame**: * **looped**: * **p9**: * **animTime**: diff --git a/NETWORK/NetworkDidFindGamersSucceed.md b/NETWORK/NetworkDidFindGamersSucceed.md new file mode 100644 index 000000000..025534313 --- /dev/null +++ b/NETWORK/NetworkDidFindGamersSucceed.md @@ -0,0 +1,13 @@ +--- +ns: NETWORK +aliases: ["0xF9B83B77929D8863"] +--- +## NETWORK_DID_FIND_GAMERS_SUCCEED + +```c +// 0xF9B83B77929D8863 0xBEDC4503 +BOOL NETWORK_DID_FIND_GAMERS_SUCCEED(); +``` + + +## Return value diff --git a/NETWORK/NetworkDidGetGamerStatusSucceed.md b/NETWORK/NetworkDidGetGamerStatusSucceed.md new file mode 100644 index 000000000..d157b364d --- /dev/null +++ b/NETWORK/NetworkDidGetGamerStatusSucceed.md @@ -0,0 +1,13 @@ +--- +ns: NETWORK +aliases: ["0x5AE17C6B0134B7F1"] +--- +## NETWORK_DID_GET_GAMER_STATUS_SUCCEED + +```c +// 0x5AE17C6B0134B7F1 0xC871E745 +BOOL NETWORK_DID_GET_GAMER_STATUS_SUCCEED(); +``` + + +## Return value diff --git a/NETWORK/NetworkGetAverageLatencyForPlayer.md b/NETWORK/NetworkGetAverageLatencyForPlayer.md new file mode 100644 index 000000000..3f9527177 --- /dev/null +++ b/NETWORK/NetworkGetAverageLatencyForPlayer.md @@ -0,0 +1,17 @@ +--- +ns: NETWORK +aliases: ["0xD414BE129BB81B32"] +--- +## _NETWORK_GET_AVERAGE_LATENCY_FOR_PLAYER + +```c +// 0xD414BE129BB81B32 +float _NETWORK_GET_AVERAGE_LATENCY_FOR_PLAYER(Player player); +``` + +``` +NativeDB Introduced: v323 +``` + +## Parameters +* **player**: diff --git a/NETWORK/NetworkGetAverageLatencyForPlayer_2.md b/NETWORK/NetworkGetAverageLatencyForPlayer_2.md new file mode 100644 index 000000000..0a0b100b9 --- /dev/null +++ b/NETWORK/NetworkGetAverageLatencyForPlayer_2.md @@ -0,0 +1,21 @@ +--- +ns: NETWORK +aliases: ["0x0E3A041ED6AC2B45"] +--- +## _NETWORK_GET_AVERAGE_LATENCY_FOR_PLAYER_2 + +```c +// 0x0E3A041ED6AC2B45 +float _NETWORK_GET_AVERAGE_LATENCY_FOR_PLAYER_2(Player player); +``` + +``` +Same as _NETWORK_GET_AVERAGE_LATENCY_FOR_PLAYER (0xD414BE129BB81B32) +``` + +``` +NativeDB Introduced: v323 +``` + +## Parameters +* **player**: diff --git a/NETWORK/NetworkGetGamerStatus.md b/NETWORK/NetworkGetGamerStatus.md deleted file mode 100644 index 1bc75c6ae..000000000 --- a/NETWORK/NetworkGetGamerStatus.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -ns: NETWORK -aliases: ["0x85A0EF54A500882C"] ---- -## _NETWORK_GET_GAMER_STATUS - -```c -// 0x85A0EF54A500882C 0x42BD0780 -BOOL _NETWORK_GET_GAMER_STATUS(Any* p0); -``` - - -## Parameters -* **p0**: - -## Return value diff --git a/NETWORK/NetworkGetGamerStatusFromQueue.md b/NETWORK/NetworkGetGamerStatusFromQueue.md new file mode 100644 index 000000000..9ab5b2ed2 --- /dev/null +++ b/NETWORK/NetworkGetGamerStatusFromQueue.md @@ -0,0 +1,13 @@ +--- +ns: NETWORK +aliases: ["0x2CC848A861D01493"] +--- +## NETWORK_GET_GAMER_STATUS_FROM_QUEUE + +```c +// 0x2CC848A861D01493 0xBEB98840 +Any NETWORK_GET_GAMER_STATUS_FROM_QUEUE(); +``` + + +## Return value diff --git a/NETWORK/NetworkIsConnectionEndpointRelayServer.md b/NETWORK/NetworkIsConnectionEndpointRelayServer.md new file mode 100644 index 000000000..cef8f6a12 --- /dev/null +++ b/NETWORK/NetworkIsConnectionEndpointRelayServer.md @@ -0,0 +1,19 @@ +--- +ns: NETWORK +aliases: ["0x16D3D49902F697BB"] +--- +## _NETWORK_IS_CONNECTION_ENDPOINT_RELAY_SERVER + +```c +// 0x16D3D49902F697BB +BOOL _NETWORK_IS_CONNECTION_ENDPOINT_RELAY_SERVER(Player player); +``` + +``` +NETWORK_IS_* + +NativeDB Introduced: v323 +``` + +## Parameters +* **player**: diff --git a/NETWORK/NetworkIsGettingGamerStatus.md b/NETWORK/NetworkIsGettingGamerStatus.md new file mode 100644 index 000000000..28ca15300 --- /dev/null +++ b/NETWORK/NetworkIsGettingGamerStatus.md @@ -0,0 +1,12 @@ +--- +ns: NETWORK +aliases: ["0x94A8394D150B013A"] +--- +## NETWORK_IS_GETTING_GAMER_STATUS + +```c +// 0x94A8394D150B013A 0x08029970 +BOOL NETWORK_IS_GETTING_GAMER_STATUS(); +``` + +## Return value diff --git a/NETWORK/NetworkQueueGamerForStatus.md b/NETWORK/NetworkQueueGamerForStatus.md new file mode 100644 index 000000000..62699797f --- /dev/null +++ b/NETWORK/NetworkQueueGamerForStatus.md @@ -0,0 +1,16 @@ +--- +ns: NETWORK +aliases: ["0x85A0EF54A500882C","_NETWORK_GET_GAMER_STATUS"] +--- +## NETWORK_QUEUE_GAMER_FOR_STATUS + +```c +// 0x85A0EF54A500882C 0x42BD0780 +BOOL NETWORK_QUEUE_GAMER_FOR_STATUS(Any* p0); +``` + + +## Parameters +* **p0**: + +## Return value diff --git a/NETWORK/NetworkSeedRandomNumberGenerator.md b/NETWORK/NetworkSeedRandomNumberGenerator.md new file mode 100644 index 000000000..096b79532 --- /dev/null +++ b/NETWORK/NetworkSeedRandomNumberGenerator.md @@ -0,0 +1,14 @@ +--- +ns: NETWORK +aliases: ["0xF1B84178F8674195"] +--- +## NETWORK_SEED_RANDOM_NUMBER_GENERATOR + +```c +// 0xF1B84178F8674195 0x41702C8A +void NETWORK_SEED_RANDOM_NUMBER_GENERATOR(int seed); +``` + +## Parameters +* **seed**: + diff --git a/NETWORK/NetworkSessionEnter.md b/NETWORK/NetworkSessionEnter.md index a56e2a089..6110cf75d 100644 --- a/NETWORK/NetworkSessionEnter.md +++ b/NETWORK/NetworkSessionEnter.md @@ -20,6 +20,10 @@ p5 is reset to 0 if, Global_1315318 = 0 or Global_1315323 = 9 or 12 or (Global_1312629 = 0 && Global_1312631 = true/1) those are passed. ``` +``` +NativeDB Return Type: BOOL +``` + ## Parameters * **p0**: * **p1**: diff --git a/NETWORK/NetworkSetEntityGhostedWithOwner.md b/NETWORK/NetworkSetEntityGhostedWithOwner.md new file mode 100644 index 000000000..f7cdfe534 --- /dev/null +++ b/NETWORK/NetworkSetEntityGhostedWithOwner.md @@ -0,0 +1,15 @@ +--- +ns: NETWORK +aliases: ["0x4BA166079D658ED4"] +--- +## _NETWORK_SET_ENTITY_GHOSTED_WITH_OWNER + +```c +// 0x4BA166079D658ED4 +void _NETWORK_SET_ENTITY_GHOSTED_WITH_OWNER(Entity entity, BOOL p1); +``` + +## Parameters +* **entity**: +* **p1**: + diff --git a/NETWORK/ResetGhostedEntityAlpha.md b/NETWORK/ResetGhostedEntityAlpha.md new file mode 100644 index 000000000..586835e6c --- /dev/null +++ b/NETWORK/ResetGhostedEntityAlpha.md @@ -0,0 +1,13 @@ +--- +ns: NETWORK +aliases: ["0x17330EBF2F2124A8"] +--- +## _RESET_GHOSTED_ENTITY_ALPHA + +```c +// 0x17330EBF2F2124A8 +void _RESET_GHOSTED_ENTITY_ALPHA(); +``` + +Sets the alpha value used by [`_SET_LOCAL_PLAYER_AS_GHOST`](#_0x5FFE9B4144F9712F), [`SET_NETWORK_VEHICLE_AS_GHOST`](#_0x6274C4712850841E), and [`_NETWORK_SET_ENTITY_GHOSTED_WITH_OWNER`](#_0x4BA166079D658ED4). + diff --git a/NETWORK/SetEntityLocallyInvisible.md b/NETWORK/SetEntityLocallyInvisible.md index 6cfbd7d85..d889568b8 100644 --- a/NETWORK/SetEntityLocallyInvisible.md +++ b/NETWORK/SetEntityLocallyInvisible.md @@ -8,21 +8,19 @@ ns: NETWORK void SET_ENTITY_LOCALLY_INVISIBLE(Entity entity); ``` -Makes the provided entity visible for yourself for the current frame. +Sets the provided entity not visible for yourself for the current frame. ## Parameters -* **entity**: +* **entity**: ## Examples ```lua --- Any random entity should work -local entity = PlayerPedId() - --- Make the entity visible for all players -SetEntityVisible(entity, true) - CreateThread(function() + -- Any random entity should work + local entity = PlayerPedId() + -- Make the entity visible for all players + SetEntityVisible(entity, true) while true do Wait(0) -- Make the entity invisible for the current player only. diff --git a/NETWORK/SetEntityLocallyVisible.md b/NETWORK/SetEntityLocallyVisible.md index 3e9279001..9c67946ba 100644 --- a/NETWORK/SetEntityLocallyVisible.md +++ b/NETWORK/SetEntityLocallyVisible.md @@ -8,6 +8,23 @@ ns: NETWORK void SET_ENTITY_LOCALLY_VISIBLE(Entity entity); ``` +Sets the provided entity visible for yourself for the current frame. + ## Parameters -* **entity**: +* **entity**: The entity to set locally visible. + +## Examples +```lua +CreateThread(function() + -- Any random entity should work + local entity = GetVehiclePedIsIn(PlayerPedId(), false) + while true do + Wait(0) + -- Sets the entity not visible to other players + SetEntityVisible(entity, false, false) + -- Sets the entity as visible for yourself + SetEntityLocallyVisible(entity) + end +end) +``` diff --git a/NETWORK/SetGhostedEntityAlpha.md b/NETWORK/SetGhostedEntityAlpha.md new file mode 100644 index 000000000..933bebff8 --- /dev/null +++ b/NETWORK/SetGhostedEntityAlpha.md @@ -0,0 +1,17 @@ +--- +ns: NETWORK +aliases: ["0x658500AE6D723A7E"] +--- +## _SET_GHOSTED_ENTITY_ALPHA + +```c +// 0x658500AE6D723A7E +void _SET_GHOSTED_ENTITY_ALPHA(int alpha); +``` + +Sets the alpha value used by [`_SET_LOCAL_PLAYER_AS_GHOST`](#_0x5FFE9B4144F9712F), [`SET_NETWORK_VEHICLE_AS_GHOST`](#_0x6274C4712850841E), and [`_NETWORK_SET_ENTITY_GHOSTED_WITH_OWNER`](#_0x4BA166079D658ED4). + +'Solidness' cannot be achieved using 255 - this will have the opposite effect of it defaulting to 128 it seems (or just having no effect at all). + +## Parameters +* **alpha**: A value between 1 and 254. Default: 128 diff --git a/NETWORK/SetRelationshipToPlayer.md b/NETWORK/SetRelationshipToPlayer.md new file mode 100644 index 000000000..fc538527f --- /dev/null +++ b/NETWORK/SetRelationshipToPlayer.md @@ -0,0 +1,17 @@ +--- +ns: NETWORK +aliases: ["0xA7C511FA1C5BDA38"] +--- +## _SET_RELATIONSHIP_TO_PLAYER + +```c +// 0xA7C511FA1C5BDA38 +void _SET_RELATIONSHIP_TO_PLAYER(Player player, BOOL p1); +``` + +Enables ghosting between specific players. Name is between `_SET_RELATIONSHIP_GROUP_DONT_AFFECT_WANTED_LEVEL` and `SET_ROADS_BACK_TO_ORIGINAL`. + +## Parameters +* **player**: +* **p1**: + diff --git a/OBJECT/N_0x190428512b240692.md b/OBJECT/ClearObjectsInsideGarage.md similarity index 55% rename from OBJECT/N_0x190428512b240692.md rename to OBJECT/ClearObjectsInsideGarage.md index b76ce69e5..b60a1f8fb 100644 --- a/OBJECT/N_0x190428512b240692.md +++ b/OBJECT/ClearObjectsInsideGarage.md @@ -1,11 +1,12 @@ --- ns: OBJECT +aliases: ["0x190428512B240692"] --- -## _0x190428512B240692 +## CLEAR_OBJECTS_INSIDE_GARAGE ```c // 0x190428512B240692 0xA565E27E -void _0x190428512B240692(Any garageHash, BOOL vehicles, BOOL peds, BOOL objects, BOOL isNetwork); +void CLEAR_OBJECTS_INSIDE_GARAGE(Any garageHash, BOOL vehicles, BOOL peds, BOOL objects, BOOL isNetwork); ``` ``` diff --git a/OBJECT/GetStateOfRayfireMapObject.md b/OBJECT/GetStateOfRayfireMapObject.md index 555fae0b0..0df27fd66 100644 --- a/OBJECT/GetStateOfRayfireMapObject.md +++ b/OBJECT/GetStateOfRayfireMapObject.md @@ -9,12 +9,9 @@ aliases: ["0x899BA936634A322E", "_GET_DES_OBJECT_STATE"] int GET_STATE_OF_RAYFIRE_MAP_OBJECT(Object object); ``` -``` -Get a destructible object's state. -Substract 1 to get the real state. -See SET_STATE_OF_RAYFIRE_MAP_OBJECT to see the different states -For example, if the object just spawned (state 2), the native will return 3. -``` +See [`SET_STATE_OF_RAYFIRE_MAP_OBJECT`](#_0x5C29F698D404C5E1) to see the different states + +Get a destructible object's state. Substract 1 to get the real state. For example, if the object just spawned (state 2), the native will return 3. ## Parameters * **object**: diff --git a/OBJECT/N_0xc7f29ca00f46350e.md b/OBJECT/N_0xc7f29ca00f46350e.md index e9221345d..96c330371 100644 --- a/OBJECT/N_0xc7f29ca00f46350e.md +++ b/OBJECT/N_0xc7f29ca00f46350e.md @@ -8,8 +8,7 @@ ns: OBJECT void _0xC7F29CA00F46350E(BOOL p0); ``` - -See [N_0x701fda1e82076ba4](#_0x701FDA1E82076BA4). +See [`N_0x701fda1e82076ba4`](#_0x701FDA1E82076BA4). ## Parameters * **p0**: diff --git a/PAD/DisableAllControlActions.md b/PAD/DisableAllControlActions.md index 8461e7a34..f826cdaa5 100644 --- a/PAD/DisableAllControlActions.md +++ b/PAD/DisableAllControlActions.md @@ -8,10 +8,6 @@ ns: PAD void DISABLE_ALL_CONTROL_ACTIONS(int padIndex); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). diff --git a/PAD/EnableAllControlActions.md b/PAD/EnableAllControlActions.md index 2aca59827..4a2657f26 100644 --- a/PAD/EnableAllControlActions.md +++ b/PAD/EnableAllControlActions.md @@ -9,9 +9,12 @@ void ENABLE_ALL_CONTROL_ACTIONS(int padIndex); ``` ``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. +padIndex: +0 - PLAYER_CONTROL +1 - Unknown +2 - FRONTEND_CONTROL ``` ## Parameters -* **padIndex**: +* **padIndex**: The control system instance to use. diff --git a/PAD/GetControlGroupInstructionalButton.md b/PAD/GetControlGroupInstructionalButton.md index e7decc890..1399c2202 100644 --- a/PAD/GetControlGroupInstructionalButton.md +++ b/PAD/GetControlGroupInstructionalButton.md @@ -9,12 +9,8 @@ aliases: ["0x80C2FD58D720C801"] char* GET_CONTROL_GROUP_INSTRUCTIONAL_BUTTON(int padIndex, int controlGroup, BOOL p2); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). * **controlGroup**: * **p2**: diff --git a/PAD/GetControlNormal.md b/PAD/GetControlNormal.md index f5fcd1a73..928d84c53 100644 --- a/PAD/GetControlNormal.md +++ b/PAD/GetControlNormal.md @@ -8,13 +8,9 @@ ns: PAD float GET_CONTROL_NORMAL(int padIndex, int control); ``` -``` -Returns the value of GET_CONTROL_VALUE normalized (i.e. a real number value between -1 and 1) -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value +Returns the value of [`GET_CONTROL_VALUE`](#_0xD95E79E8686D2C27) normalized, i.e. a real number value between -1.0 and 1.0 diff --git a/PAD/GetControlUnboundNormal.md b/PAD/GetControlUnboundNormal.md index 033965e4a..7b7f06b93 100644 --- a/PAD/GetControlUnboundNormal.md +++ b/PAD/GetControlUnboundNormal.md @@ -11,11 +11,10 @@ float GET_CONTROL_UNBOUND_NORMAL(int padIndex, int control); ``` Seems to return values between -1 and 1 for controls like gas and steering. -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. ``` ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/GetControlValue.md b/PAD/GetControlValue.md index 44fc17bcc..5c82b9fd8 100644 --- a/PAD/GetControlValue.md +++ b/PAD/GetControlValue.md @@ -8,12 +8,8 @@ ns: PAD int GET_CONTROL_VALUE(int padIndex, int control); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/GetDisabledControlNormal.md b/PAD/GetDisabledControlNormal.md index 9b5cd71ef..438eb5f87 100644 --- a/PAD/GetDisabledControlNormal.md +++ b/PAD/GetDisabledControlNormal.md @@ -8,13 +8,8 @@ ns: PAD float GET_DISABLED_CONTROL_NORMAL(int padIndex, int control); ``` -``` -control - c# works with (int)GTA.Control.CursorY / (int)GTA.Control.CursorX and returns the mouse movement (additive). -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/GetDisabledControlUnboundNormal.md b/PAD/GetDisabledControlUnboundNormal.md index dc4c532e6..e392fe1ba 100644 --- a/PAD/GetDisabledControlUnboundNormal.md +++ b/PAD/GetDisabledControlUnboundNormal.md @@ -9,13 +9,8 @@ aliases: ["0x4F8A26A890FD62FB"] float GET_DISABLED_CONTROL_UNBOUND_NORMAL(int padIndex, int control); ``` -``` -The "disabled" variant of _0x5B84D09CEC5209C5. -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/GetLocalPlayerAimState.md b/PAD/GetLocalPlayerAimState.md index 4b6b3db5b..49a2471ef 100644 --- a/PAD/GetLocalPlayerAimState.md +++ b/PAD/GetLocalPlayerAimState.md @@ -8,8 +8,6 @@ ns: PAD int GET_LOCAL_PLAYER_AIM_STATE(); ``` -``` -Returns the local player's targeting mode. See PLAYER::SET_PLAYER_TARGETING_MODE. -``` +Returns the local player's targeting mode. See [`SET_PLAYER_TARGETING_MODE`](#_0xB1906895227793F3). ## Return value diff --git a/PAD/IsControlEnabled.md b/PAD/IsControlEnabled.md index b60089b59..7737e5022 100644 --- a/PAD/IsControlEnabled.md +++ b/PAD/IsControlEnabled.md @@ -8,12 +8,8 @@ ns: PAD BOOL IS_CONTROL_ENABLED(int padIndex, int control); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/IsControlJustPressed.md b/PAD/IsControlJustPressed.md index ad11cad1b..074cde635 100644 --- a/PAD/IsControlJustPressed.md +++ b/PAD/IsControlJustPressed.md @@ -9,11 +9,10 @@ BOOL IS_CONTROL_JUST_PRESSED(int padIndex, int control); ``` Returns whether a control was newly pressed since the last check. -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. ## Parameters -* **padIndex**: The control system instance to use. Usually set to 0. -* **control**: The control ID to check. +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value True if the control was pressed. \ No newline at end of file diff --git a/PAD/IsControlJustReleased.md b/PAD/IsControlJustReleased.md index 00ccff8fb..8a99fb3d2 100644 --- a/PAD/IsControlJustReleased.md +++ b/PAD/IsControlJustReleased.md @@ -9,11 +9,10 @@ BOOL IS_CONTROL_JUST_RELEASED(int padIndex, int control); ``` Returns whether a control was newly released since the last check. -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. ## Parameters -* **padIndex**: The control system instance to use. Usually set to 0. -* **control**: The control ID to check. +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value True if the control was recently released. \ No newline at end of file diff --git a/PAD/IsControlPressed.md b/PAD/IsControlPressed.md index e5b13e0f2..5b03be3b9 100644 --- a/PAD/IsControlPressed.md +++ b/PAD/IsControlPressed.md @@ -9,11 +9,10 @@ BOOL IS_CONTROL_PRESSED(int padIndex, int control); ``` Returns whether a control is currently pressed. -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. ## Parameters -* **padIndex**: The control system instance to use. Usually set to 0. -* **control**: The control ID to check. +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value True if the control was pressed. \ No newline at end of file diff --git a/PAD/IsControlReleased.md b/PAD/IsControlReleased.md index 642c48039..b1ff3b5aa 100644 --- a/PAD/IsControlReleased.md +++ b/PAD/IsControlReleased.md @@ -9,11 +9,10 @@ BOOL IS_CONTROL_RELEASED(int padIndex, int control); ``` Returns whether a control is currently _not_ pressed. -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. ## Parameters -* **padIndex**: The control system instance to use. Usually set to 0. -* **control**: The control ID to check. +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value True if the control is not pressed. \ No newline at end of file diff --git a/PAD/IsDisabledControlJustPressed.md b/PAD/IsDisabledControlJustPressed.md index 051e16d96..79e6963a1 100644 --- a/PAD/IsDisabledControlJustPressed.md +++ b/PAD/IsDisabledControlJustPressed.md @@ -8,12 +8,8 @@ ns: PAD BOOL IS_DISABLED_CONTROL_JUST_PRESSED(int padIndex, int control); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/IsDisabledControlJustReleased.md b/PAD/IsDisabledControlJustReleased.md index 1d165c6c1..e8d712ecb 100644 --- a/PAD/IsDisabledControlJustReleased.md +++ b/PAD/IsDisabledControlJustReleased.md @@ -8,12 +8,8 @@ ns: PAD BOOL IS_DISABLED_CONTROL_JUST_RELEASED(int padIndex, int control); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/IsDisabledControlPressed.md b/PAD/IsDisabledControlPressed.md index a26d777b4..7b185f4dc 100644 --- a/PAD/IsDisabledControlPressed.md +++ b/PAD/IsDisabledControlPressed.md @@ -8,12 +8,8 @@ ns: PAD BOOL IS_DISABLED_CONTROL_PRESSED(int padIndex, int control); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/IsDisabledControlReleased.md b/PAD/IsDisabledControlReleased.md index 51905634d..654fa0806 100644 --- a/PAD/IsDisabledControlReleased.md +++ b/PAD/IsDisabledControlReleased.md @@ -9,12 +9,8 @@ aliases: ["0xFB6C4072E9A32E92"] BOOL _IS_DISABLED_CONTROL_RELEASED(int padIndex, int control); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. ## Return value diff --git a/PAD/IsUsingKeyboard.md b/PAD/IsUsingKeyboard.md index 5bc044a3f..dd531bbd5 100644 --- a/PAD/IsUsingKeyboard.md +++ b/PAD/IsUsingKeyboard.md @@ -9,12 +9,7 @@ aliases: ["_GET_LAST_INPUT_METHOD","_IS_INPUT_DISABLED"] BOOL _IS_USING_KEYBOARD(int padIndex); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -Used to be known as _GET_LAST_INPUT_METHOD & _IS_INPUT_DISABLED -``` - ## Parameters -* **padIndex**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). ## Return value diff --git a/PAD/IsUsingKeyboard_2.md b/PAD/IsUsingKeyboard_2.md index 93ba65994..95be42640 100644 --- a/PAD/IsUsingKeyboard_2.md +++ b/PAD/IsUsingKeyboard_2.md @@ -9,12 +9,7 @@ aliases: ["0x13337B38DB572509","_IS_INPUT_JUST_DISABLED"] BOOL _IS_USING_KEYBOARD_2(int padIndex); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -Used to be known as _IS_INPUT_JUST_DISABLED -``` - ## Parameters -* **padIndex**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). ## Return value diff --git a/PAD/N_0x23f09eadc01449d6.md b/PAD/N_0x23f09eadc01449d6.md index d80982b5e..2b5587b7f 100644 --- a/PAD/N_0x23f09eadc01449d6.md +++ b/PAD/N_0x23f09eadc01449d6.md @@ -8,12 +8,9 @@ ns: PAD BOOL _0x23F09EADC01449D6(int padIndex); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. Hardcoded to return false. -``` ## Parameters -* **padIndex**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). ## Return value diff --git a/PAD/N_0x6cd79468a1e595c6.md b/PAD/N_0x6cd79468a1e595c6.md index 26c7ae7b6..a40fe669f 100644 --- a/PAD/N_0x6cd79468a1e595c6.md +++ b/PAD/N_0x6cd79468a1e595c6.md @@ -8,11 +8,7 @@ ns: PAD BOOL _0x6CD79468A1E595C6(int padIndex); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). ## Return value diff --git a/PAD/SetControlLightEffectColor.md b/PAD/SetControlLightEffectColor.md index 15a4c7667..300841a8e 100644 --- a/PAD/SetControlLightEffectColor.md +++ b/PAD/SetControlLightEffectColor.md @@ -9,12 +9,8 @@ aliases: ["0x8290252FFF36ACB5","_SET_CONTROL_GROUP_COLOR"] void _SET_CONTROL_LIGHT_EFFECT_COLOR(int padIndex, int red, int green, int blue); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). * **red**: * **green**: * **blue**: diff --git a/PAD/SetControlNormal.md b/PAD/SetControlNormal.md index b38fc3e4f..5fdd31024 100644 --- a/PAD/SetControlNormal.md +++ b/PAD/SetControlNormal.md @@ -9,15 +9,11 @@ aliases: ["0xE8A25867FBA3B05E"] BOOL _SET_CONTROL_NORMAL(int padIndex, int control, float amount); ``` -``` This is for simulating player input. -amount is a float value from 0 - 1 -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` ## Parameters -* **padIndex**: -* **control**: -* **amount**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. +* **amount**: A value from 0.0 to 1.0 ## Return value diff --git a/PAD/SetInputExclusive.md b/PAD/SetInputExclusive.md index 77b4ee032..2b6a09312 100644 --- a/PAD/SetInputExclusive.md +++ b/PAD/SetInputExclusive.md @@ -8,11 +8,7 @@ ns: PAD void SET_INPUT_EXCLUSIVE(int padIndex, int control); ``` -``` -padIndex: 0 (PLAYER_CONTROL), 1 (unk) and 2 (unk) used in the scripts. -``` - ## Parameters -* **padIndex**: -* **control**: +* **padIndex**: The control system instance to use. See [`ENABLE_ALL_CONTROL_ACTIONS`](#_0xA5FFE9B05F199DE7). +* **control**: The [control ID](https://docs.fivem.net/docs/game-references/controls/#controls) to check. diff --git a/PATHFIND/SetRoadsBackToOriginalInAngledArea.md b/PATHFIND/SetRoadsBackToOriginalInAngledArea.md index 0c89b4d82..0ad58d512 100644 --- a/PATHFIND/SetRoadsBackToOriginalInAngledArea.md +++ b/PATHFIND/SetRoadsBackToOriginalInAngledArea.md @@ -8,7 +8,7 @@ ns: PATHFIND void SET_ROADS_BACK_TO_ORIGINAL_IN_ANGLED_AREA(float x1, float y1, float z1, float x2, float y2, float z2, float width); ``` -See [IS_POINT_IN_ANGLED_AREA](#_0x2A70BAE8883E4C81) for the definition of an angled area. +See [`IS_POINT_IN_ANGLED_AREA`](#_0x2A70BAE8883E4C81) for the definition of an angled area. ``` NativeDB Added Parameter 8: Any p7 diff --git a/PATHFIND/SetRoadsInAngledArea.md b/PATHFIND/SetRoadsInAngledArea.md index b49b3091d..535a661ff 100644 --- a/PATHFIND/SetRoadsInAngledArea.md +++ b/PATHFIND/SetRoadsInAngledArea.md @@ -10,7 +10,7 @@ void SET_ROADS_IN_ANGLED_AREA(float x1, float y1, float z1, float x2, float y2, unknown3 is related to ``SEND_SCRIPT_WORLD_STATE_EVENT > CNetworkRoadNodeWorldStateData`` in networked environments. -See [IS_POINT_IN_ANGLED_AREA](#_0x2A70BAE8883E4C81) for the definition of an angled area. +See [`IS_POINT_IN_ANGLED_AREA`](#_0x2A70BAE8883E4C81) for the definition of an angled area. ## Parameters * **x1**: X dimension of the angled area 'origin' diff --git a/PED/CreatePedInsideVehicle.md b/PED/CreatePedInsideVehicle.md index 03bb9977f..80c4d9876 100644 --- a/PED/CreatePedInsideVehicle.md +++ b/PED/CreatePedInsideVehicle.md @@ -8,13 +8,9 @@ ns: PED Ped CREATE_PED_INSIDE_VEHICLE(Vehicle vehicle, int pedType, Hash modelHash, int seat, BOOL isNetwork, BOOL bScriptHostPed); ``` -``` -pedType: see CREATE_PED -``` - ## Parameters * **vehicle**: -* **pedType**: +* **pedType**: See [`CREATE_PED`](#_0xD49F9B0955C367DE) * **modelHash**: * **seat**: * **isNetwork**: diff --git a/PED/GetPedCurrentMovementSpeed.md b/PED/GetPedCurrentMovementSpeed.md new file mode 100644 index 000000000..15c0799b0 --- /dev/null +++ b/PED/GetPedCurrentMovementSpeed.md @@ -0,0 +1,17 @@ +--- +ns: PED +aliases: ["0xF60165E1D2C5370B"] +--- +## _GET_PED_CURRENT_MOVEMENT_SPEED + +```c +// 0xF60165E1D2C5370B +BOOL _GET_PED_CURRENT_MOVEMENT_SPEED(Ped ped, float* speedX, float* speedY); +``` + +## Parameters +* **ped**: +* **speedX**: +* **speedY**: + +## Return value diff --git a/PED/GetPedEyeColor.md b/PED/GetPedEyeColor.md index 448d44335..03e17e4cf 100644 --- a/PED/GetPedEyeColor.md +++ b/PED/GetPedEyeColor.md @@ -9,7 +9,7 @@ aliases: ["0x76BBA2CEE66D47E9"] int _GET_PED_EYE_COLOR(Ped ped); ``` -A getter for [_SET_PED_EYE_COLOR](#_0x50B56988B170AFDF). Returns -1 if fails to get. +A getter for [`_SET_PED_EYE_COLOR`](#_0x50B56988B170AFDF). ## Parameters * **ped**: The target ped diff --git a/PED/GetPedNearbyPeds.md b/PED/GetPedNearbyPeds.md index 9bba708b3..0808dd475 100644 --- a/PED/GetPedNearbyPeds.md +++ b/PED/GetPedNearbyPeds.md @@ -8,22 +8,13 @@ ns: PED int GET_PED_NEARBY_PEDS(Ped ped, int* sizeAndPeds, int ignore); ``` -``` -sizeAndPeds - is a pointer to an array. The array is filled with peds found nearby the ped supplied to the first argument. -ignore - ped type to ignore -Return value is the number of peds found and added to the array passed. ------------------------------------ -To make this work in most menu bases at least in C++ do it like so, - Formatted Example: pastebin.com/D8an9wwp ------------------------------------ -Example: gtaforums.com/topic/789788-function-args-to-pedget-ped-nearby-peds/?p=1067386687 -Here's the right way to do it (console and pc): -pastebin.com/SsFej963 -``` +Console/PC structure definitions and example: pastebin.com/SsFej963 + +For FiveM/Cfx.Re use-cases refer to: [`GET_GAME_POOL`](#_0x2B9D4F50). ## Parameters * **ped**: * **sizeAndPeds**: -* **ignore**: +* **ignore**: Ped type to ignore ## Return value diff --git a/PED/IsPedDeadOrDying.md b/PED/IsPedDeadOrDying.md index d247efed2..01235f173 100644 --- a/PED/IsPedDeadOrDying.md +++ b/PED/IsPedDeadOrDying.md @@ -8,15 +8,11 @@ ns: PED BOOL IS_PED_DEAD_OR_DYING(Ped ped, BOOL p1); ``` -Seems to consistently return true if the ped is dead. -p1 is always passed 1 in the scripts. -I suggest to remove "OR_DYING" part, because it does not detect dying phase. -That's what the devs call it, cry about it. -lol +Seems to consistently return true if the ped is dead, however, it does not detect the dying phase. ## Parameters -* **ped**: The ped to check -* **p1**: Always `1` (`true`) in original scripts. +* **ped**: the ped +* **p1**: always passed 1 in the scripts; requires more research. ## Return value -Returns true if the player is dead, false otherwise. +Whether the ped is dead or dying. diff --git a/PED/IsPedDoingBeastJump.md b/PED/IsPedDoingBeastJump.md new file mode 100644 index 000000000..d9cd46779 --- /dev/null +++ b/PED/IsPedDoingBeastJump.md @@ -0,0 +1,16 @@ +--- +ns: PED +aliases: ["0x451D05012CCEC234"] +--- +## _IS_PED_DOING_BEAST_JUMP + +```c +// 0x451D05012CCEC234 +BOOL _IS_PED_DOING_BEAST_JUMP(Ped ped); +``` + + +## Parameters +* **ped**: + +## Return value diff --git a/PED/N_0x288df530c92dad6f.md b/PED/N_0x288df530c92dad6f.md index a981ab2c4..b4aef3666 100644 --- a/PED/N_0x288df530c92dad6f.md +++ b/PED/N_0x288df530c92dad6f.md @@ -5,11 +5,12 @@ ns: PED ```c // 0x288DF530C92DAD6F -void _0x288DF530C92DAD6F(Any p0, float p1); +void _0x288DF530C92DAD6F(Ped ped, float value); ``` +[`SET_VEHICLE_STEER_BIAS`](#_0x42A8EC77D5150CBE) for peds, e.g., `_SET_PED_STEER_BIAS`. ## Parameters -* **p0**: -* **p1**: +* **ped**: +* **value**: diff --git a/PED/N_0x451d05012ccec234.md b/PED/N_0x451d05012ccec234.md deleted file mode 100644 index 175e3e88b..000000000 --- a/PED/N_0x451d05012ccec234.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: PED ---- -## _0x451D05012CCEC234 - -```c -// 0x451D05012CCEC234 -Any _0x451D05012CCEC234(Any p0); -``` - - -## Parameters -* **p0**: - -## Return value diff --git a/PED/N_0x5615e0c5eb2bc6e2.md b/PED/N_0x5615e0c5eb2bc6e2.md deleted file mode 100644 index 544443b15..000000000 --- a/PED/N_0x5615e0c5eb2bc6e2.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: PED ---- -## _0x5615E0C5EB2BC6E2 - -```c -// 0x5615E0C5EB2BC6E2 -void _0x5615E0C5EB2BC6E2(Any p0, Any p1); -``` - - -## Parameters -* **p0**: -* **p1**: - diff --git a/PED/N_0x9a77dfd295e29b09.md b/PED/N_0x9a77dfd295e29b09.md index 3357c845b..d091a6e2f 100644 --- a/PED/N_0x9a77dfd295e29b09.md +++ b/PED/N_0x9a77dfd295e29b09.md @@ -5,11 +5,17 @@ ns: PED ```c // 0x9A77DFD295E29B09 0xC08FE5F6 -void _0x9A77DFD295E29B09(Any p0, BOOL p1); +void _0x9A77DFD295E29B09(Ped ped, BOOL toggle); ``` +``` +This native needs to be used when the ped is using a scenario +If toggle is true, the ped will stop his current scenario and become scared +If toggle is false, the ped will not be scared anymore and continue his scenario +Video : https://gyazo.com/974faa2509cc4ffce04f55b24336f562 +``` ## Parameters -* **p0**: -* **p1**: +* **ped**: +* **toggle**: diff --git a/PED/N_0xf2385935bffd4d92.md b/PED/N_0xf2385935bffd4d92.md index 046c84898..c9b759b2e 100644 --- a/PED/N_0xf2385935bffd4d92.md +++ b/PED/N_0xf2385935bffd4d92.md @@ -8,6 +8,7 @@ ns: PED BOOL _0xF2385935BFFD4D92(Ped ped); ``` +Initial guess of native: `_IS_PED_WEARING_MOTORCYCLE_HELMET`. ## Parameters * **ped**: diff --git a/PED/N_0xf60165e1d2c5370b.md b/PED/N_0xf60165e1d2c5370b.md deleted file mode 100644 index 5789c1eb9..000000000 --- a/PED/N_0xf60165e1d2c5370b.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -ns: PED ---- -## _0xF60165E1D2C5370B - -```c -// 0xF60165E1D2C5370B -BOOL _0xF60165E1D2C5370B(Ped ped, Any* p1, Any* p2); -``` - -``` -seems very related to aiming but GET_PED_CONFIG* to GET_PED_DECORATIONS* and no clue what it might be + no joaat to confirm -``` - -## Parameters -* **ped**: -* **p1**: -* **p2**: - -## Return value diff --git a/PED/N_0xfec9a3b1820f3331.md b/PED/N_0xfec9a3b1820f3331.md index 45d96b9cc..8f3023ef4 100644 --- a/PED/N_0xfec9a3b1820f3331.md +++ b/PED/N_0xfec9a3b1820f3331.md @@ -5,11 +5,12 @@ ns: PED ```c // 0xFEC9A3B1820F3331 -BOOL _0xFEC9A3B1820F3331(Any p0); +BOOL _0xFEC9A3B1820F3331(Ped ped); ``` +Native to check whether [`_SET_PED_SCUBA_GEAR_VARIATION`](#_0x36c6984c3ed0c911) is enabled/actived. ## Parameters -* **p0**: +* **ped**: ## Return value diff --git a/PED/SetCombatFloat.md b/PED/SetCombatFloat.md index ca7ffadd1..217ff328e 100644 --- a/PED/SetCombatFloat.md +++ b/PED/SetCombatFloat.md @@ -8,12 +8,7 @@ ns: PED void SET_COMBAT_FLOAT(Ped ped, int combatType, float p2); ``` -``` -combatType can be between 0-14. See GET_COMBAT_FLOAT below for a list of possible parameters. -``` - ## Parameters * **ped**: -* **combatType**: +* **combatType**: A value between 0-14, See [`GET_COMBAT_FLOAT`](#_0x52DFF8A10508090A) for a list of possible parameters. * **p2**: - diff --git a/PED/SetGroupFormation.md b/PED/SetGroupFormation.md index 529d2bf34..f63233d92 100644 --- a/PED/SetGroupFormation.md +++ b/PED/SetGroupFormation.md @@ -9,10 +9,15 @@ void SET_GROUP_FORMATION(int groupId, int formationType); ``` ``` -0: Default -1: Circle Around Leader +0: Freedom to move +1: Circle Around Leader 2: Alternative Circle Around Leader 3: Line, with Leader at center +4: Arrow Formation +5: "V" Formation +6: Line Follow Formation +7: Single Formation +8: Pairwise ``` ## Parameters diff --git a/PED/SetRelationshipGroupDontAffectWantedLevel.md b/PED/SetRelationshipGroupDontAffectWantedLevel.md new file mode 100644 index 000000000..bb3fd60ff --- /dev/null +++ b/PED/SetRelationshipGroupDontAffectWantedLevel.md @@ -0,0 +1,19 @@ +--- +ns: PED +aliases: ["0x5615E0C5EB2BC6E2"] +--- +## _SET_RELATIONSHIP_GROUP_DONT_AFFECT_WANTED_LEVEL + +```c +// 0x5615E0C5EB2BC6E2 +void _SET_RELATIONSHIP_GROUP_DONT_AFFECT_WANTED_LEVEL(Any group, BOOL p1); +``` + +``` +NativeDB Parameter 0: Hash group +``` + +## Parameters +* **group**: +* **p1**: + diff --git a/PED/UpdatePedHeadBlendData.md b/PED/UpdatePedHeadBlendData.md index 4c705710d..b29fd1491 100644 --- a/PED/UpdatePedHeadBlendData.md +++ b/PED/UpdatePedHeadBlendData.md @@ -8,9 +8,7 @@ ns: PED void UPDATE_PED_HEAD_BLEND_DATA(Ped ped, float shapeMix, float skinMix, float thirdMix); ``` -``` -See SET_PED_HEAD_BLEND_DATA(). -``` +See [`SET_PED_HEAD_BLEND_DATA`](#_0x9414E18B9434C2FE) ## Parameters * **ped**: diff --git a/PLAYER/GetPlayerName.md b/PLAYER/GetPlayerName.md index a298cd97e..684fd1454 100644 --- a/PLAYER/GetPlayerName.md +++ b/PLAYER/GetPlayerName.md @@ -8,7 +8,10 @@ ns: PLAYER char* GET_PLAYER_NAME(Player player); ``` +Returns the players name from a specified player index + ## Parameters -* **player**: +* **player**: The player index, or -1 to get the local player ped. ## Return value +The name of the queried player. "**Invalid**" if the player does not exist. diff --git a/PLAYER/SetPlayerHealthRechargeLimit.md b/PLAYER/SetPlayerHealthRechargeLimit.md index 8452eec7b..e32e07db9 100644 --- a/PLAYER/SetPlayerHealthRechargeLimit.md +++ b/PLAYER/SetPlayerHealthRechargeLimit.md @@ -11,6 +11,6 @@ void _SET_PLAYER_HEALTH_RECHARGE_LIMIT(Player player, float limit); ## Parameters -* **player**: -* **limit**: +* **player**: The local player ID. +* **limit**: A value between 0.0 and 1.0, 0.5 is default. diff --git a/PLAYER/SetPlayerWeaponDamageModifier.md b/PLAYER/SetPlayerWeaponDamageModifier.md index bfc099263..76e139547 100644 --- a/PLAYER/SetPlayerWeaponDamageModifier.md +++ b/PLAYER/SetPlayerWeaponDamageModifier.md @@ -8,10 +8,7 @@ ns: PLAYER void SET_PLAYER_WEAPON_DAMAGE_MODIFIER(Player player, float modifier); ``` -``` -This modifies the damage value of your weapon. Whether it is a multiplier or base damage is unknown. -Based on tests, it is unlikely to be a multiplier. -``` +The native ensures the 'modifier' parameter is 0.1 or greater. ## Parameters * **player**: diff --git a/SCRIPT/HasScriptLoaded.md b/SCRIPT/HasScriptLoaded.md index 64b49f004..8cdb410fc 100644 --- a/SCRIPT/HasScriptLoaded.md +++ b/SCRIPT/HasScriptLoaded.md @@ -8,9 +8,7 @@ ns: SCRIPT BOOL HAS_SCRIPT_LOADED(char* scriptName); ``` -``` Returns if a script has been loaded into the game. Used to see if a script was loaded after requesting. -``` ## Parameters * **scriptName**: diff --git a/SHAPETEST/StartShapeTestBox.md b/SHAPETEST/StartShapeTestBox.md index 5ff19582f..fe84bab54 100644 --- a/SHAPETEST/StartShapeTestBox.md +++ b/SHAPETEST/StartShapeTestBox.md @@ -6,9 +6,10 @@ aliases: ["0xFE466162C4401D18"] ```c // 0xFE466162C4401D18 0x249BC876 -int START_SHAPE_TEST_BOX(float x, float y, float z, float x1, float y2, float z2, float rotX, float rotY, float rotZ, Any p9, Any p10, Any entity, Any p12); +int START_SHAPE_TEST_BOX(float x, float y, float z, float x1, float y2, float z2, float rotX, float rotY, float rotZ, Any p9, int flags, Entity entity, Any p12); ``` +For more information, see [`START_EXPENSIVE_SYNCHRONOUS_SHAPE_TEST_LOS_PROBE`](#_0x377906D8A31E5586) and [`START_SHAPE_TEST_LOS_PROBE`](#_0x7EE9F5D83DD4F90E). ## Parameters * **x**: @@ -21,7 +22,7 @@ int START_SHAPE_TEST_BOX(float x, float y, float z, float x1, float y2, float z2 * **rotY**: * **rotZ**: * **p9**: -* **p10**: +* **flags**: * **entity**: * **p12**: diff --git a/SOCIALCLUB/ScProfanityCheckString.md b/SOCIALCLUB/ScProfanityCheckString.md index c3724934b..4e0d0490a 100644 --- a/SOCIALCLUB/ScProfanityCheckString.md +++ b/SOCIALCLUB/ScProfanityCheckString.md @@ -9,10 +9,9 @@ aliases: ["0x75632C5ECD7ED843","_SC_START_CHECK_STRING_TASK"] BOOL SC_PROFANITY_CHECK_STRING(char* string, int* token); ``` -``` Starts a task to check an entered string for profanity on the ROS/Social Club services. -See also: 1753344C770358AE, 82E4A58BABC15AE7. -``` + +See also: [`SC_PROFANITY_GET_CHECK_IS_VALID`](#_0x1753344C770358AE) and [`SC_PROFANITY_GET_CHECK_IS_PENDING`](#_0x82E4A58BABC15AE7). ## Parameters * **string**: diff --git a/STREAMING/FormatFocusHeading.md b/STREAMING/FormatFocusHeading.md deleted file mode 100644 index 2fc5d7d62..000000000 --- a/STREAMING/FormatFocusHeading.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -ns: STREAMING -aliases: ["0x219C7B8D53E429FD"] ---- -## FORMAT_FOCUS_HEADING - -```c -// 0x219C7B8D53E429FD 0x10B6AB36 -Any FORMAT_FOCUS_HEADING(float x, float y, float z, float rad, Any p4, Any p5); -``` - - -## Parameters -* **x**: -* **y**: -* **z**: -* **rad**: -* **p4**: -* **p5**: - -## Return value diff --git a/STREAMING/HasAnimSetLoaded.md b/STREAMING/HasAnimSetLoaded.md index f8c852cf5..ffeca52e6 100644 --- a/STREAMING/HasAnimSetLoaded.md +++ b/STREAMING/HasAnimSetLoaded.md @@ -8,12 +8,11 @@ ns: STREAMING BOOL HAS_ANIM_SET_LOADED(char* animSet); ``` -``` -Gets whether the specified animation set has finished loading. An animation set provides movement animations for a ped. See SET_PED_MOVEMENT_CLIPSET. -Animation set and clip set are synonymous. -``` +Gets whether the specified animation set has finished loading. An animation set provides movement animations for a ped. + +Animation set and clip set are synonymous. See [`SET_PED_MOVEMENT_CLIPSET`](#_0xAF8A94EDE7712BEF). ## Parameters -* **animSet**: +* **animSet**: ## Return value diff --git a/STREAMING/IsStreamvolActive.md b/STREAMING/IsStreamvolActive.md new file mode 100644 index 000000000..0703c3ebc --- /dev/null +++ b/STREAMING/IsStreamvolActive.md @@ -0,0 +1,12 @@ +--- +ns: STREAMING +aliases: ["0xBC9823AB80A3DCAC"] +--- +## IS_STREAMVOL_ACTIVE + +```c +// 0xBC9823AB80A3DCAC 0x56253356 +BOOL IS_STREAMVOL_ACTIVE(); +``` + +## Return value diff --git a/STREAMING/N_0x07c313f94746702c.md b/STREAMING/N_0x07c313f94746702c.md deleted file mode 100644 index fd096ab56..000000000 --- a/STREAMING/N_0x07c313f94746702c.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: STREAMING ---- -## _0x07C313F94746702C - -```c -// 0x07C313F94746702C 0x42CFE9C0 -Any _0x07C313F94746702C(Any p0); -``` - - -## Parameters -* **p0**: - -## Return value diff --git a/STREAMING/N_0x0ad9710cee2f590f.md b/STREAMING/N_0x0ad9710cee2f590f.md deleted file mode 100644 index 04dd5e3f6..000000000 --- a/STREAMING/N_0x0ad9710cee2f590f.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -ns: STREAMING ---- -## _0x0AD9710CEE2F590F - -```c -// 0x0AD9710CEE2F590F 0xC0157255 -Any _0x0AD9710CEE2F590F(float p0, float p1, float p2, float p3, float p4, float p5, Any p6); -``` - - -## Parameters -* **p0**: -* **p1**: -* **p2**: -* **p3**: -* **p4**: -* **p5**: -* **p6**: - -## Return value diff --git a/STREAMING/N_0x1ee7d8df4425f053.md b/STREAMING/N_0x1ee7d8df4425f053.md deleted file mode 100644 index ef7917df7..000000000 --- a/STREAMING/N_0x1ee7d8df4425f053.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -ns: STREAMING ---- -## _0x1EE7D8DF4425F053 - -```c -// 0x1EE7D8DF4425F053 0xE80F8ABE -void _0x1EE7D8DF4425F053(Any p0); -``` - - -## Parameters -* **p0**: - diff --git a/STREAMING/N_0x1f3f018bc3afa77c.md b/STREAMING/N_0x1f3f018bc3afa77c.md deleted file mode 100644 index 571933d65..000000000 --- a/STREAMING/N_0x1f3f018bc3afa77c.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -ns: STREAMING ---- -## _0x1F3F018BC3AFA77C - -```c -// 0x1F3F018BC3AFA77C 0x72344191 -Any _0x1F3F018BC3AFA77C(float p0, float p1, float p2, float p3, float p4, float p5, float p6, Any p7, Any p8); -``` - - -## Parameters -* **p0**: -* **p1**: -* **p2**: -* **p3**: -* **p4**: -* **p5**: -* **p6**: -* **p7**: -* **p8**: - -## Return value diff --git a/STREAMING/N_0x40aefd1a244741f2.md b/STREAMING/N_0x40aefd1a244741f2.md deleted file mode 100644 index 2a37f1676..000000000 --- a/STREAMING/N_0x40aefd1a244741f2.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -ns: STREAMING ---- -## _0x40AEFD1A244741F2 - -```c -// 0x40AEFD1A244741F2 0x9FA4AF99 -void _0x40AEFD1A244741F2(BOOL p0); -``` - - -## Parameters -* **p0**: - diff --git a/STREAMING/N_0x7d41e9d2d17c5b2d.md b/STREAMING/N_0x7d41e9d2d17c5b2d.md deleted file mode 100644 index bcb98b473..000000000 --- a/STREAMING/N_0x7d41e9d2d17c5b2d.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: STREAMING ---- -## _0x7D41E9D2D17C5B2D - -```c -// 0x7D41E9D2D17C5B2D 0x1B3521F4 -Any _0x7D41E9D2D17C5B2D(Any p0); -``` - - -## Parameters -* **p0**: - -## Return value diff --git a/STREAMING/N_0xbc9823ab80a3dcac.md b/STREAMING/N_0xbc9823ab80a3dcac.md deleted file mode 100644 index 53b6ca5e6..000000000 --- a/STREAMING/N_0xbc9823ab80a3dcac.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -ns: STREAMING ---- -## _0xBC9823AB80A3DCAC - -```c -// 0xBC9823AB80A3DCAC 0x56253356 -Any _0xBC9823AB80A3DCAC(); -``` - - -## Return value diff --git a/STREAMING/RemoveAnimSet.md b/STREAMING/RemoveAnimSet.md index 5ea44b663..d8b9b1043 100644 --- a/STREAMING/RemoveAnimSet.md +++ b/STREAMING/RemoveAnimSet.md @@ -8,11 +8,10 @@ ns: STREAMING void REMOVE_ANIM_SET(char* animSet); ``` -``` -Unloads the specified animation set. An animation set provides movement animations for a ped. See SET_PED_MOVEMENT_CLIPSET. -Animation set and clip set are synonymous. -``` +Unloads the specified animation set. An animation set provides movement animations for a ped. + +Animation set and clip set are synonymous. See [`SET_PED_MOVEMENT_CLIPSET`](#_0xAF8A94EDE7712BEF). ## Parameters -* **animSet**: +* **animSet**: diff --git a/STREAMING/RequestAnimSet.md b/STREAMING/RequestAnimSet.md index 500019c07..fadc389c4 100644 --- a/STREAMING/RequestAnimSet.md +++ b/STREAMING/RequestAnimSet.md @@ -8,10 +8,8 @@ ns: STREAMING void REQUEST_ANIM_SET(char* animSet); ``` -``` -Starts loading the specified animation set. An animation set provides movement animations for a ped. See SET_PED_MOVEMENT_CLIPSET. -``` +Starts loading the specified animation set. An animation set provides movement animations for a ped. See [`SET_PED_MOVEMENT_CLIPSET`](#_0xAF8A94EDE7712BEF). ## Parameters -* **animSet**: +* **animSet**: diff --git a/STREAMING/SetRenderHdOnly.md b/STREAMING/SetRenderHdOnly.md new file mode 100644 index 000000000..dab97ea0b --- /dev/null +++ b/STREAMING/SetRenderHdOnly.md @@ -0,0 +1,14 @@ +--- +ns: STREAMING +aliases: ["0x40AEFD1A244741F2"] +--- +## SET_RENDER_HD_ONLY + +```c +// 0x40AEFD1A244741F2 0x9FA4AF99 +void SET_RENDER_HD_ONLY(BOOL toggle); +``` + +## Parameters +* **toggle**: + diff --git a/STREAMING/StreamvolCreateFrustum.md b/STREAMING/StreamvolCreateFrustum.md new file mode 100644 index 000000000..5ecfa8f03 --- /dev/null +++ b/STREAMING/StreamvolCreateFrustum.md @@ -0,0 +1,27 @@ +--- +ns: STREAMING +aliases: ["0x1F3F018BC3AFA77C"] +--- +## STREAMVOL_CREATE_FRUSTUM + +```c +// 0x1F3F018BC3AFA77C 0x72344191 +Any STREAMVOL_CREATE_FRUSTUM(float p0, float p1, float p2, float p3, float p4, float p5, float p6, Any p7, Any p8); +``` + +``` +Always returns zero. +``` + +## Parameters +* **p0**: +* **p1**: +* **p2**: +* **p3**: +* **p4**: +* **p5**: +* **p6**: +* **p7**: +* **p8**: + +## Return value diff --git a/STREAMING/StreamvolCreateLine.md b/STREAMING/StreamvolCreateLine.md new file mode 100644 index 000000000..2c9298705 --- /dev/null +++ b/STREAMING/StreamvolCreateLine.md @@ -0,0 +1,25 @@ +--- +ns: STREAMING +aliases: ["0x0AD9710CEE2F590F"] +--- +## STREAMVOL_CREATE_LINE + +```c +// 0x0AD9710CEE2F590F 0xC0157255 +Any STREAMVOL_CREATE_LINE(float p0, float p1, float p2, float p3, float p4, float p5, Any p6); +``` + +``` +Always returns zero. +``` + +## Parameters +* **p0**: +* **p1**: +* **p2**: +* **p3**: +* **p4**: +* **p5**: +* **p6**: + +## Return value diff --git a/STREAMING/StreamvolCreateSphere.md b/STREAMING/StreamvolCreateSphere.md new file mode 100644 index 000000000..8093bee84 --- /dev/null +++ b/STREAMING/StreamvolCreateSphere.md @@ -0,0 +1,24 @@ +--- +ns: STREAMING +aliases: ["0x219C7B8D53E429FD","FORMAT_FOCUS_HEADING"] +--- +## STREAMVOL_CREATE_SPHERE + +```c +// 0x219C7B8D53E429FD 0x10B6AB36 +Any STREAMVOL_CREATE_SPHERE(float x, float y, float z, float rad, Any p4, Any p5); +``` + +``` +Always returns zero. +``` + +## Parameters +* **x**: +* **y**: +* **z**: +* **rad**: +* **p4**: +* **p5**: + +## Return value diff --git a/STREAMING/StreamvolDelete.md b/STREAMING/StreamvolDelete.md new file mode 100644 index 000000000..b172f2607 --- /dev/null +++ b/STREAMING/StreamvolDelete.md @@ -0,0 +1,14 @@ +--- +ns: STREAMING +aliases: ["0x1EE7D8DF4425F053"] +--- +## STREAMVOL_DELETE + +```c +// 0x1EE7D8DF4425F053 0xE80F8ABE +void STREAMVOL_DELETE(Any unused); +``` + +## Parameters +* **unused**: + diff --git a/STREAMING/StreamvolHasLoaded.md b/STREAMING/StreamvolHasLoaded.md new file mode 100644 index 000000000..58706c3de --- /dev/null +++ b/STREAMING/StreamvolHasLoaded.md @@ -0,0 +1,15 @@ +--- +ns: STREAMING +aliases: ["0x7D41E9D2D17C5B2D"] +--- +## STREAMVOL_HAS_LOADED + +```c +// 0x7D41E9D2D17C5B2D 0x1B3521F4 +BOOL STREAMVOL_HAS_LOADED(Any unused); +``` + +## Parameters +* **unused**: + +## Return value diff --git a/STREAMING/StreamvolIsValid.md b/STREAMING/StreamvolIsValid.md new file mode 100644 index 000000000..445cdcc62 --- /dev/null +++ b/STREAMING/StreamvolIsValid.md @@ -0,0 +1,15 @@ +--- +ns: STREAMING +aliases: ["0x07C313F94746702C"] +--- +## STREAMVOL_IS_VALID + +```c +// 0x07C313F94746702C 0x42CFE9C0 +BOOL STREAMVOL_IS_VALID(Any unused); +``` + +## Parameters +* **unused**: + +## Return value diff --git a/TASK/ClearVehicleTasks.md b/TASK/ClearVehicleTasks.md index 61b9c05dd..7217db088 100644 --- a/TASK/ClearVehicleTasks.md +++ b/TASK/ClearVehicleTasks.md @@ -16,4 +16,4 @@ NativeDB Introduced: v1290 ``` ## Parameters -* **vehicle**: +* **vehicle**: The vehicle to have tasks cleared diff --git a/TASK/GetNavmeshRouteResult.md b/TASK/GetNavmeshRouteResult.md index 627d6e3d9..7a4e25916 100644 --- a/TASK/GetNavmeshRouteResult.md +++ b/TASK/GetNavmeshRouteResult.md @@ -8,9 +8,7 @@ ns: TASK int GET_NAVMESH_ROUTE_RESULT(Ped ped); ``` -``` -See GET_NAVMESH_ROUTE_DISTANCE_REMAINING for more details. -``` +See [`GET_NAVMESH_ROUTE_DISTANCE_REMAINING`](#_0xC6F5C0BCDC74D62D) for more details. ## Parameters * **ped**: diff --git a/TASK/IsPedActiveInScenario.md b/TASK/IsPedActiveInScenario.md index 68a026c8e..b659e1863 100644 --- a/TASK/IsPedActiveInScenario.md +++ b/TASK/IsPedActiveInScenario.md @@ -8,6 +8,7 @@ ns: TASK BOOL IS_PED_ACTIVE_IN_SCENARIO(Ped ped); ``` +When passing a ped parameter, the function returns true if the ped is currently in any scenario. ## Parameters * **ped**: diff --git a/TASK/N_0x53ddc75bc3ac0a90.md b/TASK/N_0x53ddc75bc3ac0a90.md index 37418f499..8d24492b4 100644 --- a/TASK/N_0x53ddc75bc3ac0a90.md +++ b/TASK/N_0x53ddc75bc3ac0a90.md @@ -8,6 +8,8 @@ ns: TASK void _0x53DDC75BC3AC0A90(Vehicle vehicle); ``` +Related to [`_CLEAR_VEHICLE_TASKS`](#_0xDBBC7A2432524127) and requires more research (e.g., _CLEAR_VEHICLE_SECONDARY_TASKS). + ``` CLEAR_* @@ -15,4 +17,4 @@ NativeDB Introduced: v1290 ``` ## Parameters -* **vehicle**: +* **vehicle**: The vehicle to have tasks cleared diff --git a/TASK/SetTaskVehicleChaseBehaviorFlag.md b/TASK/SetTaskVehicleChaseBehaviorFlag.md index 51a136297..b99dd6a9e 100644 --- a/TASK/SetTaskVehicleChaseBehaviorFlag.md +++ b/TASK/SetTaskVehicleChaseBehaviorFlag.md @@ -9,11 +9,11 @@ void SET_TASK_VEHICLE_CHASE_BEHAVIOR_FLAG(Ped ped, int flag, BOOL set); ``` ``` -Flag 8: Medium-aggressive boxing tactic with a bit of PIT -Flag 1: Aggressive ramming of suspect -Flag 2: Ram attempts -Flag 32: Stay back from suspect, no tactical contact. Convoy-like. -Flag 16: Ramming, seems to be slightly less aggressive than 1-2. +* Flag 1: Aggressive ramming of suspect +* Flag 2: Ram attempts +* Flag 8: Medium-aggressive boxing tactic with a bit of PIT +* Flag 16: Ramming, seems to be slightly less aggressive than 1-2. +* Flag 32: Stay back from suspect, no tactical contact. Convoy-like. ``` ## Parameters diff --git a/TASK/TaskForceMotionState.md b/TASK/TaskForceMotionState.md index 42e9e240c..57a566559 100644 --- a/TASK/TaskForceMotionState.md +++ b/TASK/TaskForceMotionState.md @@ -8,11 +8,7 @@ ns: TASK void TASK_FORCE_MOTION_STATE(Ped ped, Hash state, BOOL p2); ``` -``` -p2 always false -[30/03/2017] ins1de : -See FORCE_PED_MOTION_STATE -``` +See [`FORCE_PED_MOTION_STATE`](#_0xF28965D04F570DCA) ## Parameters * **ped**: diff --git a/TASK/TaskLeaveAnyVehicle.md b/TASK/TaskLeaveAnyVehicle.md index b0897ba63..ba518e141 100644 --- a/TASK/TaskLeaveAnyVehicle.md +++ b/TASK/TaskLeaveAnyVehicle.md @@ -8,9 +8,7 @@ ns: TASK void TASK_LEAVE_ANY_VEHICLE(Ped ped, int p1, int flags); ``` -``` -Flags are the same flags used in TASK_LEAVE_VEHICLE -``` +Flags are the same flags used in [`TASK_LEAVE_VEHICLE`](#_0xD3DBCE61A490BE02) ## Parameters * **ped**: diff --git a/TASK/TaskOpenVehicleDoor.md b/TASK/TaskOpenVehicleDoor.md index 0349b5e2d..80b59d224 100644 --- a/TASK/TaskOpenVehicleDoor.md +++ b/TASK/TaskOpenVehicleDoor.md @@ -8,15 +8,14 @@ ns: TASK void TASK_OPEN_VEHICLE_DOOR(Ped ped, Vehicle vehicle, int timeOut, int seat, float speed); ``` -``` The given ped will try to open the nearest door to 'seat'. + Example: telling the ped to open the door for the driver seat does not necessarily mean it will open the driver door, it may choose to open the passenger door instead if that one is closer. -``` ## Parameters -* **ped**: -* **vehicle**: -* **timeOut**: -* **seat**: -* **speed**: +* **ped**: The ped to do the task +* **vehicle**: The vehicle whose doors the ped shoud open +* **timeOut**: Sets a timeout to the task; doesn't work for 0 +* **seat**: The seat index - the ped will attempt to open doors to get to the specified seat +* **speed**: diff --git a/TASK/TaskVehicleMissionCoorsTarget.md b/TASK/TaskVehicleMissionCoorsTarget.md index d42531c27..956046d9e 100644 --- a/TASK/TaskVehicleMissionCoorsTarget.md +++ b/TASK/TaskVehicleMissionCoorsTarget.md @@ -8,9 +8,7 @@ ns: TASK void TASK_VEHICLE_MISSION_COORS_TARGET(Ped ped, Vehicle vehicle, float x, float y, float z, int p5, int p6, int p7, float p8, float p9, BOOL DriveAgainstTraffic); ``` -``` -See TASK_VEHICLE_MISSION -``` +See [`TASK_VEHICLE_MISSION`](#_0x659427E0EF36BCDE). ## Parameters * **ped**: diff --git a/TASK/TaskVehicleMissionPedTarget.md b/TASK/TaskVehicleMissionPedTarget.md index 6463bebbd..944a40740 100644 --- a/TASK/TaskVehicleMissionPedTarget.md +++ b/TASK/TaskVehicleMissionPedTarget.md @@ -8,9 +8,7 @@ ns: TASK void TASK_VEHICLE_MISSION_PED_TARGET(Ped ped, Vehicle vehicle, Ped pedTarget, int missionType, float maxSpeed, int drivingStyle, float minDistance, float p7, BOOL DriveAgainstTraffic); ``` -``` -See TASK_VEHICLE_MISSION -``` +See [`TASK_VEHICLE_MISSION`](#_0x659427E0EF36BCDE). ## Parameters * **ped**: diff --git a/VEHICLE/AttachVehicleToCargobob.md b/VEHICLE/AttachVehicleToCargobob.md index ee55c77d5..4939dfafe 100644 --- a/VEHICLE/AttachVehicleToCargobob.md +++ b/VEHICLE/AttachVehicleToCargobob.md @@ -8,12 +8,15 @@ ns: VEHICLE void ATTACH_VEHICLE_TO_CARGOBOB(Vehicle vehicle, Vehicle cargobob, int p2, float x, float y, float z); ``` +``` +p2 is unknown and is always -1 in the script natives. +``` ## Parameters -* **vehicle**: -* **cargobob**: -* **p2**: -* **x**: -* **y**: -* **z**: +* **vehicle**: The vehicle which should be attached +* **cargobob**: The cargobob +* **p2**: +* **x**: +* **y**: +* **z**: diff --git a/VEHICLE/CreateVehicle.md b/VEHICLE/CreateVehicle.md index 8ffc50f63..213255304 100644 --- a/VEHICLE/CreateVehicle.md +++ b/VEHICLE/CreateVehicle.md @@ -25,4 +25,17 @@ NativeDB Added Parameter 8: BOOL p7 * **netMissionEntity**: Whether to register the vehicle as pinned to the script host in the R* network model. ## Return value -A script handle (fwScriptGuid index) for the vehicle, or `0` if the vehicle failed to be created. \ No newline at end of file +A script handle (fwScriptGuid index) for the vehicle, or `0` if the vehicle failed to be created. + +## Examples +```lua +local ModelHash = `adder` -- Use Compile-time hashes to get the hash of this model +if not IsModelInCdimage(ModelHash) then return end +RequestModel(ModelHash) -- Request the model +while not HasModelLoaded(ModelHash) do -- Waits for the model to load with a check so it does not get stuck in an infinite loop + Citizen.Wait(10) +end +local MyPed = PlayerPedId() +local Vehicle = CreateVehicle(ModelHash, GetEntityCoords(MyPed), GetEntityHeading(MyPed), true, false) -- Spawns a networked vehicle on your current coords +SetModelAsNoLongerNeeded(ModelHash) -- removes model from game memory as we no longer need it +``` diff --git a/VEHICLE/FixVehicleWindow.md b/VEHICLE/FixVehicleWindow.md index c66f9f1d2..9851ca9ec 100644 --- a/VEHICLE/FixVehicleWindow.md +++ b/VEHICLE/FixVehicleWindow.md @@ -5,33 +5,15 @@ ns: VEHICLE ```c // 0x772282EBEB95E682 0x6B8E990D -Any FIX_VEHICLE_WINDOW(Vehicle vehicle, int index); +Any FIX_VEHICLE_WINDOW(Vehicle vehicle, int windowIndex); ``` -int index = 0 to 13 +See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#_0x46E571A0E20D01F1). -0 = front right window -1 = front left window -2 = rear right window -3 = rear left window -4 = unsure -5 = unsure -6 = windowscreen -7 = rear windowscreen -8 = unsure -9 = unsure -10 = unsure -11 = unsure -12 = unsure -13 = unsure - - -Additional information: `FIX_VEHICLE_WINDOW` (0x140D0BB88) references an array of bone vehicle indices (0x141D4B3E0) `{ 2Ah, 2Bh, 2Ch, 2Dh, 2Eh, 2Fh, 28h, 29h }` that correspond to: `window_lf`, `window_rf`, `window_lr`, `window_rr`, `window_lm`, `window_rm`, `windscreen`, `windscreen_r`. This array is used by most vehwindow natives. - -Also, this function is coded to not work on vehicles of type: `CBike`, `Bmx`, `CBoat`, `CTrain`, and `CSubmarine`. +This function is coded to not work on vehicles of type: `CBike`, `Bmx`, `CBoat`, `CTrain`, and `CSubmarine`. ## Parameters * **vehicle**: -* **index**: +* **windowIndex**: ## Return value diff --git a/VEHICLE/GetEntryPositionOfDoor.md b/VEHICLE/GetEntryPositionOfDoor.md index 41df821be..8e20a011d 100644 --- a/VEHICLE/GetEntryPositionOfDoor.md +++ b/VEHICLE/GetEntryPositionOfDoor.md @@ -8,6 +8,7 @@ ns: VEHICLE Vector3 _GET_ENTRY_POSITION_OF_DOOR(Vehicle vehicle, int doorIndex); ``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) ## Parameters * **vehicle**: diff --git a/VEHICLE/GetIsDoorValid.md b/VEHICLE/GetIsDoorValid.md index 64c008ba3..42cf2c83f 100644 --- a/VEHICLE/GetIsDoorValid.md +++ b/VEHICLE/GetIsDoorValid.md @@ -9,6 +9,8 @@ aliases: ["_DOES_VEHICLE_HAVE_DOOR"] BOOL _GET_IS_DOOR_VALID(Vehicle vehicle, int doorIndex); ``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) + ## Parameters * **vehicle**: * **doorIndex**: diff --git a/VEHICLE/GetPedInVehicleSeat.md b/VEHICLE/GetPedInVehicleSeat.md index 48e986990..55e2c536e 100644 --- a/VEHICLE/GetPedInVehicleSeat.md +++ b/VEHICLE/GetPedInVehicleSeat.md @@ -31,3 +31,13 @@ One can use GET_VEHICLE_MAX_NUMBER_OF_PASSENGERS(vehicle) to get the amount of s ## Return value A handle to a ped in the specified vehicle seat, or 0 if no such ped existed. + +## Examples +```lua +-- Checks if the player ped is in the drivers seat of the vehicle they are in. +if GetPedInVehicleSeat(GetVehiclePedIsIn(PlayerPedId()), -1) == PlayerPedId() then + print("The player is the driver of this vehicle.") +else + print("The player is not the driver of this vehicle.") +end +``` diff --git a/VEHICLE/GetPedUsingVehicleDoor.md b/VEHICLE/GetPedUsingVehicleDoor.md index f1a88cc62..3c78856af 100644 --- a/VEHICLE/GetPedUsingVehicleDoor.md +++ b/VEHICLE/GetPedUsingVehicleDoor.md @@ -9,6 +9,8 @@ aliases: ["0x218297BF0CFD853B","_GET_PED_USING_VEHICLE_DOOR"] Ped GET_PED_USING_VEHICLE_DOOR(Vehicle vehicle, int doorIndex); ``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) + ## Parameters * **vehicle**: * **doorIndex**: diff --git a/VEHICLE/GetPositionOfVehicleRecordingAtTime.md b/VEHICLE/GetPositionOfVehicleRecordingAtTime.md index 7a2d58596..a15e083d9 100644 --- a/VEHICLE/GetPositionOfVehicleRecordingAtTime.md +++ b/VEHICLE/GetPositionOfVehicleRecordingAtTime.md @@ -8,10 +8,9 @@ ns: VEHICLE Vector3 GET_POSITION_OF_VEHICLE_RECORDING_AT_TIME(int recording, float time, char* script); ``` -``` This native does no interpolation between pathpoints. The same position will be returned for all times up to the next pathpoint in the recording. -See REQUEST_VEHICLE_RECORDING -``` + +See [`REQUEST_VEHICLE_RECORDING`](#_0xAF514CABE74CBF15). ## Parameters * **recording**: diff --git a/VEHICLE/GetVehicleColor.md b/VEHICLE/GetVehicleColor.md index a06fec404..445df5ffe 100644 --- a/VEHICLE/GetVehicleColor.md +++ b/VEHICLE/GetVehicleColor.md @@ -8,13 +8,11 @@ ns: VEHICLE void GET_VEHICLE_COLOR(Vehicle vehicle, int* r, int* g, int* b); ``` -``` -What's this for? Primary and Secondary RGB have their own natives and this one doesn't seem specific. -``` +See [`SET_VEHICLE_CUSTOM_PRIMARY_COLOUR`](#_0x7141766F91D15BEA) and [`SET_VEHICLE_CUSTOM_SECONDARY_COLOUR`](#_0x36CED73BFED89754). ## Parameters -* **vehicle**: -* **r**: -* **g**: -* **b**: +* **vehicle**: The target vehicle +* **r**: +* **g**: +* **b**: diff --git a/VEHICLE/GetVehicleDirtLevel.md b/VEHICLE/GetVehicleDirtLevel.md index 9bf4ba7dd..96385664c 100644 --- a/VEHICLE/GetVehicleDirtLevel.md +++ b/VEHICLE/GetVehicleDirtLevel.md @@ -8,11 +8,18 @@ ns: VEHICLE float GET_VEHICLE_DIRT_LEVEL(Vehicle vehicle); ``` -``` -Dirt level 0..15 -``` +A getter for [`SET_VEHICLE_DIRT_LEVEL`](#_0x79D3B596FE44EE8B). ## Parameters -* **vehicle**: +* **vehicle**: The vehicle to check. ## Return value +A number between 0.0 and 15.0 representing the vehicles dirt level. + +## Examples +```lua +local Vehicle = GetVehiclePedIsUsing(PlayerPedId()) +if GetVehicleDirtLevel(Vehicle) > 0.0 then -- if the cars dirt level is more than 0.0 then clean it. + SetVehicleDirtLevel(Vehicle, 0.0) -- set the vehicle dirt level to 0.0 +end +``` diff --git a/VEHICLE/GetVehicleDoorAngleRatio.md b/VEHICLE/GetVehicleDoorAngleRatio.md index bbcbe0d77..9a01e33f5 100644 --- a/VEHICLE/GetVehicleDoorAngleRatio.md +++ b/VEHICLE/GetVehicleDoorAngleRatio.md @@ -5,11 +5,13 @@ ns: VEHICLE ```c // 0xFE3F9C29F7B32BD5 0x0E399C26 -float GET_VEHICLE_DOOR_ANGLE_RATIO(Vehicle vehicle, int door); +float GET_VEHICLE_DOOR_ANGLE_RATIO(Vehicle vehicle, int doorIndex); ``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) + ## Parameters * **vehicle**: -* **door**: +* **doorIndex**: ## Return value diff --git a/VEHICLE/GetVehicleDoorDestroyType.md b/VEHICLE/GetVehicleDoorDestroyType.md index eb8fdf05a..ed9c77179 100644 --- a/VEHICLE/GetVehicleDoorDestroyType.md +++ b/VEHICLE/GetVehicleDoorDestroyType.md @@ -9,9 +9,9 @@ aliases: ["0xCA4AC3EAAE46EC7B"] int _GET_VEHICLE_DOOR_DESTROY_TYPE(Vehicle vehicle, int doorIndex); ``` -``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) + Returns vehicle door destroy type previously set with _SET_VEHICLE_DOOR_DESTROY_TYPE -``` ## Parameters * **vehicle**: diff --git a/VEHICLE/GetVehicleHomingLockonState.md b/VEHICLE/GetVehicleHomingLockonState.md new file mode 100644 index 000000000..b692f6b38 --- /dev/null +++ b/VEHICLE/GetVehicleHomingLockonState.md @@ -0,0 +1,22 @@ +--- +ns: VEHICLE +aliases: ["0xE6B0E8CFC3633BF0"] +--- +## GET_VEHICLE_HOMING_LOCKON_STATE + +```c +// 0xE6B0E8CFC3633BF0 0xFBDE9FD8 +int GET_VEHICLE_HOMING_LOCKON_STATE(Vehicle vehicle); +``` + +``` +Returns a value depending on the lock-on state of vehicle weapons. +0: not locked on +1: locking on +2: locked on +``` + +## Parameters +* **vehicle**: + +## Return value diff --git a/VEHICLE/GetVehicleNeonLightsColour.md b/VEHICLE/GetVehicleNeonLightsColour.md index d233ec9a0..5ac173838 100644 --- a/VEHICLE/GetVehicleNeonLightsColour.md +++ b/VEHICLE/GetVehicleNeonLightsColour.md @@ -8,10 +8,9 @@ ns: VEHICLE void _GET_VEHICLE_NEON_LIGHTS_COLOUR(Vehicle vehicle, int* r, int* g, int* b); ``` -``` Gets the color of the neon lights of the specified vehicle. -See _SET_VEHICLE_NEON_LIGHTS_COLOUR (0x8E0A582209A62695) for more information -``` + +See [`_SET_VEHICLE_NEON_LIGHTS_COLOUR`](#_0x8E0A582209A62695) for more information ## Parameters * **vehicle**: diff --git a/VEHICLE/GetVehicleRecordingId.md b/VEHICLE/GetVehicleRecordingId.md index c6a53c287..7f41ffb9a 100644 --- a/VEHICLE/GetVehicleRecordingId.md +++ b/VEHICLE/GetVehicleRecordingId.md @@ -8,9 +8,7 @@ ns: VEHICLE int GET_VEHICLE_RECORDING_ID(int recording, char* script); ``` -``` -See REQUEST_VEHICLE_RECORDING -``` +See [`REQUEST_VEHICLE_RECORDING`](#_0xAF514CABE74CBF15). ## Parameters * **recording**: diff --git a/VEHICLE/IsVehicleBeingHalted.md b/VEHICLE/IsVehicleBeingHalted.md new file mode 100644 index 000000000..d86dd7b77 --- /dev/null +++ b/VEHICLE/IsVehicleBeingHalted.md @@ -0,0 +1,22 @@ +--- +ns: VEHICLE +aliases: ["0xC69BB1D832A710EF"] +--- +## _IS_VEHICLE_BEING_HALTED + +```c +// 0xC69BB1D832A710EF +BOOL _IS_VEHICLE_BEING_HALTED(Vehicle vehicle); +``` + +``` +Returns true if vehicle is halted by BRING_VEHICLE_TO_HALT +_IS_VEHICLE_* +``` + +``` +NativeDB Introduced: v1493 +``` + +## Parameters +* **vehicle**: diff --git a/VEHICLE/IsVehicleDoorDamaged.md b/VEHICLE/IsVehicleDoorDamaged.md index 9c55fc975..1cd5e4094 100644 --- a/VEHICLE/IsVehicleDoorDamaged.md +++ b/VEHICLE/IsVehicleDoorDamaged.md @@ -8,9 +8,7 @@ ns: VEHICLE BOOL IS_VEHICLE_DOOR_DAMAGED(Vehicle veh, int doorID); ``` -``` -doorID starts at 0, not seeming to skip any numbers. Four door vehicles intuitively range from 0 to 3. -``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) ## Parameters * **veh**: diff --git a/VEHICLE/IsVehicleDoorFullyOpen.md b/VEHICLE/IsVehicleDoorFullyOpen.md index 1d021d7fd..99c216c9e 100644 --- a/VEHICLE/IsVehicleDoorFullyOpen.md +++ b/VEHICLE/IsVehicleDoorFullyOpen.md @@ -8,15 +8,7 @@ ns: VEHICLE BOOL IS_VEHICLE_DOOR_FULLY_OPEN(Vehicle vehicle, int doorIndex); ``` -doorIndex: -0 = Front Left Door -1 = Front Right Door -2 = Back Left Door -3 = Back Right Door -4 = Hood -5 = Trunk -6 = Trunk2 - +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) ## Parameters * **vehicle**: The vehicle to check. diff --git a/VEHICLE/IsVehicleParachuteActive.md b/VEHICLE/IsVehicleParachuteActive.md new file mode 100644 index 000000000..a7c8437c9 --- /dev/null +++ b/VEHICLE/IsVehicleParachuteActive.md @@ -0,0 +1,17 @@ +--- +ns: VEHICLE +aliases: ["0x3DE51E9C80B116CF"] +--- +## _IS_VEHICLE_PARACHUTE_ACTIVE + +```c +// 0x3DE51E9C80B116CF +BOOL _IS_VEHICLE_PARACHUTE_ACTIVE(Vehicle vehicle); +``` + +Does not work for vehicle of type: CBike, CBmx, CBoat, CTrain, CSubmarine. + +## Parameters +* **vehicle**: + +## Return value diff --git a/VEHICLE/IsVehicleVisible.md b/VEHICLE/IsVehicleVisible.md index 38f850dfa..729341cbf 100644 --- a/VEHICLE/IsVehicleVisible.md +++ b/VEHICLE/IsVehicleVisible.md @@ -8,10 +8,6 @@ ns: VEHICLE BOOL IS_VEHICLE_VISIBLE(Vehicle vehicle); ``` -``` -must be called after TRACK_VEHICLE_VISIBILITY -it's not instant so probabilly must pass an 'update' to see correct result. -``` ## Parameters * **vehicle**: diff --git a/VEHICLE/IsVehicleWindowIntact.md b/VEHICLE/IsVehicleWindowIntact.md index eaca6f738..10a1c26e2 100644 --- a/VEHICLE/IsVehicleWindowIntact.md +++ b/VEHICLE/IsVehicleWindowIntact.md @@ -8,13 +8,18 @@ ns: VEHICLE BOOL IS_VEHICLE_WINDOW_INTACT(Vehicle vehicle, int windowIndex); ``` -This will return false if the window is broken, or rolled down. -Window indexes: -0 = Front Right Window -1 = Front Left Window -2 = Back Right Window -3 = Back Left Window -Those numbers go on for vehicles that have more than 4 doors with windows. +```c +enum eWindowId { + VEH_EXT_WINDSCREEN = 0, + VEH_EXT_WINDSCREEN_R = 1, + VEH_EXT_WINDOW_LF = 2, + VEH_EXT_WINDOW_RF = 3, + VEH_EXT_WINDOW_LR = 4, + VEH_EXT_WINDOW_RR = 5, + VEH_EXT_WINDOW_LM = 6, + VEH_EXT_WINDOW_RM = 7, +} +``` ## Parameters * **vehicle**: diff --git a/VEHICLE/N_0x392183bb9ea57697.md b/VEHICLE/N_0x392183bb9ea57697.md deleted file mode 100644 index 473fe96ab..000000000 --- a/VEHICLE/N_0x392183bb9ea57697.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -ns: VEHICLE ---- -## _0x392183BB9EA57697 - -```c -// 0x392183BB9EA57697 -void _0x392183BB9EA57697(Vehicle vehicle, int wheelIndex, float p2); -``` - -``` -NativeDB Introduced: v2060 -``` - -## Parameters -* **vehicle**: -* **wheelIndex**: -* **p2**: diff --git a/VEHICLE/N_0x3b458ddb57038f08.md b/VEHICLE/N_0x3b458ddb57038f08.md index 926036961..51ead32bc 100644 --- a/VEHICLE/N_0x3b458ddb57038f08.md +++ b/VEHICLE/N_0x3b458ddb57038f08.md @@ -5,12 +5,15 @@ ns: VEHICLE ```c // 0x3B458DDB57038F08 -void _0x3B458DDB57038F08(Any p0, Any p1, Any p2); +void _0x3B458DDB57038F08(Vehicle vehicle, int doorIndex, BOOL toggle); ``` +``` +Usually used alongside other vehicle door natives. +``` ## Parameters -* **p0**: -* **p1**: -* **p2**: +* **vehicle**: +* **doorIndex**: +* **toggle**: diff --git a/VEHICLE/N_0x3de51e9c80b116cf.md b/VEHICLE/N_0x3de51e9c80b116cf.md deleted file mode 100644 index 4db0456dc..000000000 --- a/VEHICLE/N_0x3de51e9c80b116cf.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: VEHICLE ---- -## _0x3DE51E9C80B116CF - -```c -// 0x3DE51E9C80B116CF -Any _0x3DE51E9C80B116CF(Any p0); -``` - - -## Parameters -* **p0**: - -## Return value diff --git a/VEHICLE/N_0x4056ea1105f5abd7.md b/VEHICLE/N_0x4056ea1105f5abd7.md deleted file mode 100644 index 73a901114..000000000 --- a/VEHICLE/N_0x4056ea1105f5abd7.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -ns: VEHICLE ---- -## _0x4056EA1105F5ABD7 - -```c -// 0x4056EA1105F5ABD7 -void _0x4056EA1105F5ABD7(Any p0, Any p1); -``` - - -## Parameters -* **p0**: -* **p1**: - diff --git a/VEHICLE/N_0x4c815eb175086f84.md b/VEHICLE/N_0x4c815eb175086f84.md deleted file mode 100644 index 232d3c5ea..000000000 --- a/VEHICLE/N_0x4c815eb175086f84.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -ns: VEHICLE ---- -## _0x4C815EB175086F84 - -```c -// 0x4C815EB175086F84 -Any _0x4C815EB175086F84(Any p0, Any p1); -``` - - -## Parameters -* **p0**: -* **p1**: - -## Return value diff --git a/VEHICLE/N_0xc69bb1d832a710ef.md b/VEHICLE/N_0xc69bb1d832a710ef.md deleted file mode 100644 index 4065e64dc..000000000 --- a/VEHICLE/N_0xc69bb1d832a710ef.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -ns: VEHICLE ---- -## _0xC69BB1D832A710EF - -```c -// 0xC69BB1D832A710EF -Any _0xC69BB1D832A710EF(Any p0); -``` - -``` -NativeDB Introduced: v1493 -``` - -## Parameters -* **p0**: diff --git a/VEHICLE/N_0xc970d0e0fc31d768.md b/VEHICLE/N_0xc970d0e0fc31d768.md deleted file mode 100644 index 8130ef61c..000000000 --- a/VEHICLE/N_0xc970d0e0fc31d768.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -ns: VEHICLE ---- -## _0xC970D0E0FC31D768 - -```c -// 0xC970D0E0FC31D768 -void _0xC970D0E0FC31D768(Vehicle vehicle, int wheelIndex, float p2); -``` - -``` -NativeDB Introduced: v2060 -``` - -## Parameters -* **vehicle**: -* **wheelIndex**: -* **p2**: diff --git a/VEHICLE/N_0xe6b0e8cfc3633bf0.md b/VEHICLE/N_0xe6b0e8cfc3633bf0.md deleted file mode 100644 index a5949587d..000000000 --- a/VEHICLE/N_0xe6b0e8cfc3633bf0.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -ns: VEHICLE ---- -## _0xE6B0E8CFC3633BF0 - -```c -// 0xE6B0E8CFC3633BF0 0xFBDE9FD8 -int _0xE6B0E8CFC3633BF0(Vehicle vehicle); -``` - -``` -GET_VEHICLE_* -``` - -## Parameters -* **vehicle**: - -## Return value diff --git a/VEHICLE/PopOutVehicleWindscreen.md b/VEHICLE/PopOutVehicleWindscreen.md index cc4650c73..900cf3167 100644 --- a/VEHICLE/PopOutVehicleWindscreen.md +++ b/VEHICLE/PopOutVehicleWindscreen.md @@ -9,11 +9,7 @@ aliases: ["_DETACH_VEHICLE_WINDSCREEN"] void POP_OUT_VEHICLE_WINDSCREEN(Vehicle vehicle); ``` -``` Detaches the vehicle's windscreen. -For further information, see : gtaforums.com/topic/859570-glass/#entry1068894566 -Old name: _DETACH_VEHICLE_WINDSCREEN -``` ## Parameters * **vehicle**: diff --git a/VEHICLE/RemoveVehicleRecording.md b/VEHICLE/RemoveVehicleRecording.md index 870db1aa5..33ac3fd3d 100644 --- a/VEHICLE/RemoveVehicleRecording.md +++ b/VEHICLE/RemoveVehicleRecording.md @@ -8,9 +8,7 @@ ns: VEHICLE void REMOVE_VEHICLE_RECORDING(int recording, char* script); ``` -``` -See REQUEST_VEHICLE_RECORDING -``` +See [REQUEST_VEHICLE_RECORDING](#_0xAF514CABE74CBF15) ## Parameters * **recording**: diff --git a/VEHICLE/RemoveVehicleShadowEffect.md b/VEHICLE/RemoveVehicleShadowEffect.md index 8c95fdf99..dff60d0e3 100644 --- a/VEHICLE/RemoveVehicleShadowEffect.md +++ b/VEHICLE/RemoveVehicleShadowEffect.md @@ -9,7 +9,7 @@ aliases: ["0xF87D9F2301F7D206"] void _REMOVE_VEHICLE_SHADOW_EFFECT(Vehicle vehicle); ``` -Remove the weird shadow applied by [0xF0E4BA16D1DB546C](#_0xF0E4BA16D1DB546C). +Remove the weird shadow applied by [_SET_VEHICLE_SHADOW_EFFECT](#_0x2A70BAE8883E4C81) ## Parameters * **vehicle**: diff --git a/VEHICLE/RemoveVehicleWindow.md b/VEHICLE/RemoveVehicleWindow.md index 5c2fda664..df571e4ab 100644 --- a/VEHICLE/RemoveVehicleWindow.md +++ b/VEHICLE/RemoveVehicleWindow.md @@ -8,17 +8,7 @@ ns: VEHICLE void REMOVE_VEHICLE_WINDOW(Vehicle vehicle, int windowIndex); ``` -``` -windowIndex: -0 = Front Right Window -1 = Front Left Window -2 = Back Right Window -3 = Back Left Window -4 = Unknown -5 = Unknown -6 = Windscreen -7 = Rear Windscreen -``` +See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#_0x46E571A0E20D01F1). ## Parameters * **vehicle**: diff --git a/VEHICLE/RollDownWindow.md b/VEHICLE/RollDownWindow.md index 232c08212..985926177 100644 --- a/VEHICLE/RollDownWindow.md +++ b/VEHICLE/RollDownWindow.md @@ -8,13 +8,7 @@ ns: VEHICLE Any ROLL_DOWN_WINDOW(Vehicle vehicle, int windowIndex); ``` -``` -windowIndex: -0 = Front Right Window -1 = Front Left Window -2 = Back Right Window -3 = Back Left Window -``` +See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#_0x46E571A0E20D01F1). ``` NativeDB Return Type: void diff --git a/VEHICLE/RollUpWindow.md b/VEHICLE/RollUpWindow.md index 8be2df616..237f3b754 100644 --- a/VEHICLE/RollUpWindow.md +++ b/VEHICLE/RollUpWindow.md @@ -8,14 +8,11 @@ ns: VEHICLE Any ROLL_UP_WINDOW(Vehicle vehicle, int windowIndex); ``` -0 = Front Left Window -1 = Front Right Window -2 = Back Left Window -3 = Back Right Window - +See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#_0x46E571A0E20D01F1). +``` NativeDB Return Type: void - +``` ## Parameters * **vehicle**: diff --git a/VEHICLE/SetHeliMainRotorHealth.md b/VEHICLE/SetHeliMainRotorHealth.md new file mode 100644 index 000000000..5ce11f10d --- /dev/null +++ b/VEHICLE/SetHeliMainRotorHealth.md @@ -0,0 +1,15 @@ +--- +ns: VEHICLE +aliases: ["0x4056EA1105F5ABD7"] +--- +## _SET_HELI_MAIN_ROTOR_HEALTH + +```c +// 0x4056EA1105F5ABD7 +void _SET_HELI_MAIN_ROTOR_HEALTH(Vehicle vehicle, float health); +``` + +## Parameters +* **vehicle**: +* **health**: + diff --git a/VEHICLE/SetPlanePropellersHealth.md b/VEHICLE/SetPlanePropellersHealth.md new file mode 100644 index 000000000..d45564863 --- /dev/null +++ b/VEHICLE/SetPlanePropellersHealth.md @@ -0,0 +1,16 @@ +--- +ns: VEHICLE +aliases: ["0x4C815EB175086F84"] +--- +## _SET_PLANE_PROPELLERS_HEALTH + +```c +// 0x4C815EB175086F84 +void _SET_PLANE_PROPELLERS_HEALTH(Vehicle plane, float health); +``` + +## Parameters +* **plane**: +* **health**: + +## Return value diff --git a/VEHICLE/SetTyreSoftnessMultiplier.md b/VEHICLE/SetTyreSoftnessMultiplier.md new file mode 100644 index 000000000..7b0fecc50 --- /dev/null +++ b/VEHICLE/SetTyreSoftnessMultiplier.md @@ -0,0 +1,34 @@ +--- +ns: VEHICLE +aliases: ["0x392183BB9EA57697"] +--- +## _SET_TYRE_SOFTNESS_MULTIPLIER + +```c +// 0x392183BB9EA57697 +void _SET_TYRE_SOFTNESS_MULTIPLIER(Vehicle vehicle, int wheelIndex, float multiplier); +``` + +``` +Controls how fast the tires wear out. +Default values from Rockstar's Open Wheel Race JSON's: +"owrtss" (Soft): 2.2 +"owrtsm" (Medium): 1.7 +"owrtsh" (Hard): 1.2 +Usable wheels: +0: wheel_lf +1: wheel_rf +2: wheel_lm1 +3: wheel_rm1 +4: wheel_lr +5: wheel_rr +``` + +``` +NativeDB Introduced: v2060 +``` + +## Parameters +* **vehicle**: +* **wheelIndex**: +* **multiplier**: diff --git a/VEHICLE/SetTyreTractionLossMultiplier.md b/VEHICLE/SetTyreTractionLossMultiplier.md new file mode 100644 index 000000000..6e86b2342 --- /dev/null +++ b/VEHICLE/SetTyreTractionLossMultiplier.md @@ -0,0 +1,34 @@ +--- +ns: VEHICLE +aliases: ["0xC970D0E0FC31D768"] +--- +## _SET_TYRE_TRACTION_LOSS_MULTIPLIER + +```c +// 0xC970D0E0FC31D768 +void _SET_TYRE_TRACTION_LOSS_MULTIPLIER(Vehicle vehicle, int wheelIndex, float multiplier); +``` + +``` +Controls how much traction the wheel loses. +Default values from Rockstar's Open Wheel Race JSON's: +"owrtds" (Soft): 0.05 +"owrtdm" (Medium): 0.45 +"owrtdh" (Hard): 0.8 +Usable wheels: +0: wheel_lf +1: wheel_rf +2: wheel_lm1 +3: wheel_rm1 +4: wheel_lr +5: wheel_rr +``` + +``` +NativeDB Introduced: v2060 +``` + +## Parameters +* **vehicle**: +* **wheelIndex**: +* **multiplier**: diff --git a/VEHICLE/SetVehicleControlsInverted.md b/VEHICLE/SetVehicleControlsInverted.md index f8e2692b5..9e8a2108e 100644 --- a/VEHICLE/SetVehicleControlsInverted.md +++ b/VEHICLE/SetVehicleControlsInverted.md @@ -9,6 +9,10 @@ aliases: ["0x5B91B229243351A8"] void _SET_VEHICLE_CONTROLS_INVERTED(Vehicle vehicle, BOOL state); ``` +``` +Inverts vehicle's controls. So INPUT_VEH_ACCELERATE will be INPUT_VEH_BRAKE and vise versa (same for A/D controls) +Doesn't work for planes/helis. +``` ## Parameters * **vehicle**: diff --git a/VEHICLE/SetVehicleDirtLevel.md b/VEHICLE/SetVehicleDirtLevel.md index 7820e017b..3fc8bf93b 100644 --- a/VEHICLE/SetVehicleDirtLevel.md +++ b/VEHICLE/SetVehicleDirtLevel.md @@ -8,13 +8,14 @@ ns: VEHICLE void SET_VEHICLE_DIRT_LEVEL(Vehicle vehicle, float dirtLevel); ``` -``` -You can't use values greater than 15.0 -You can see why here: pastebin.com/Wbn34fGD -Also, R* does (float)(rand() % 15) to get a random dirt level when generating a vehicle. -``` +Sets the dirt level of the passed vehicle. ## Parameters -* **vehicle**: -* **dirtLevel**: +* **vehicle**: The vehicle to set. +* **dirtLevel**: A number between 0.0 and 15.0 representing the vehicles dirt level. +## Examples +```lua +local Vehicle = GetVehiclePedIsUsing(PlayerPedId()) +SetVehicleDirtLevel(Vehicle, 0.0) -- set the vehicle dirt level to 0.0 +``` diff --git a/VEHICLE/SetVehicleDoorBroken.md b/VEHICLE/SetVehicleDoorBroken.md index cd38e352f..d696e49a4 100644 --- a/VEHICLE/SetVehicleDoorBroken.md +++ b/VEHICLE/SetVehicleDoorBroken.md @@ -8,17 +8,7 @@ ns: VEHICLE void SET_VEHICLE_DOOR_BROKEN(Vehicle vehicle, int doorIndex, BOOL deleteDoor); ``` -``` -doorIndex: -0 = Front Right Door -1 = Front Left Door -2 = Back Right Door -3 = Back Left Door -4 = Hood -5 = Trunk -Changed last paramater from CreateDoorObject To NoDoorOnTheFloor because when on false, the door object is created,and not created when on true...the former parameter name was counter intuitive...(by Calderon) -Calderon is a moron. -``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) ## Parameters * **vehicle**: diff --git a/VEHICLE/SetVehicleDoorCanBreak.md b/VEHICLE/SetVehicleDoorCanBreak.md index fff121267..1c4efda94 100644 --- a/VEHICLE/SetVehicleDoorCanBreak.md +++ b/VEHICLE/SetVehicleDoorCanBreak.md @@ -9,9 +9,7 @@ aliases: ["_SET_VEHICLE_DOOR_BREAKABLE"] void _SET_VEHICLE_DOOR_CAN_BREAK(Vehicle vehicle, int doorIndex, BOOL isBreakable); ``` -``` -Keeps Vehicle Doors/Hood/Trunk from breaking off -``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) ## Parameters * **vehicle**: diff --git a/VEHICLE/SetVehicleDoorControl.md b/VEHICLE/SetVehicleDoorControl.md index 67a9fb14e..462d8f4ae 100644 --- a/VEHICLE/SetVehicleDoorControl.md +++ b/VEHICLE/SetVehicleDoorControl.md @@ -8,16 +8,7 @@ ns: VEHICLE void SET_VEHICLE_DOOR_CONTROL(Vehicle vehicle, int doorIndex, int speed, float angle); ``` -``` -doorIndex: -0 = Front Left Door (driver door) -1 = Front Right Door -2 = Back Left Door -3 = Back Right Door -4 = Hood -5 = Trunk -6 = Trunk2 -``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) ## Parameters * **vehicle**: diff --git a/VEHICLE/SetVehicleDoorLatched.md b/VEHICLE/SetVehicleDoorLatched.md index 4e2b4c27c..bdb9e98ee 100644 --- a/VEHICLE/SetVehicleDoorLatched.md +++ b/VEHICLE/SetVehicleDoorLatched.md @@ -8,6 +8,8 @@ ns: VEHICLE void SET_VEHICLE_DOOR_LATCHED(Vehicle vehicle, int doorIndex, BOOL forceClose, BOOL lock, BOOL p4); ``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) + ## Parameters * **vehicle**: * **doorIndex**: diff --git a/VEHICLE/SetVehicleDoorOpen.md b/VEHICLE/SetVehicleDoorOpen.md index e3499ac87..4703d6496 100644 --- a/VEHICLE/SetVehicleDoorOpen.md +++ b/VEHICLE/SetVehicleDoorOpen.md @@ -8,21 +8,19 @@ ns: VEHICLE void SET_VEHICLE_DOOR_OPEN(Vehicle vehicle, int doorIndex, BOOL loose, BOOL openInstantly); ``` -``` -doorIndex: -0 = Front Left Door -1 = Front Right Door -2 = Back Left Door -3 = Back Right Door -4 = Hood -5 = Trunk -6 = Back -7 = Back2 -``` +Sets the specified door index open on the passed vehicle. See [`IS_VEHICLE_DOOR_FULLY_OPEN`](#_0x3E933CFF7B111C22). + ## Parameters -* **vehicle**: -* **doorIndex**: -* **loose**: -* **openInstantly**: +* **vehicle**: Vehicle. +* **doorIndex**: Index of the door you want to open (0-7) +* **loose**: Whether the door is "loose" (if true the doors have no "spring" and can be closed easily.) +* **openInstantly**: Whether the doors open instantly (if true this native seems to ignore loose) +## Examples +```lua +local Vehicle = GetVehiclePedIsUsing(PlayerPedId()) +for i = 0, 5 do + SetVehicleDoorOpen(Vehicle, i, false, true) -- will open every door from 0-5 +end +``` diff --git a/VEHICLE/SetVehicleDoorShut.md b/VEHICLE/SetVehicleDoorShut.md index 8bddd1a64..cc90c55f0 100644 --- a/VEHICLE/SetVehicleDoorShut.md +++ b/VEHICLE/SetVehicleDoorShut.md @@ -8,19 +8,30 @@ ns: VEHICLE void SET_VEHICLE_DOOR_SHUT(Vehicle vehicle, int doorIndex, BOOL closeInstantly); ``` -``` -doorIndex: -0 = Front Left Door -1 = Front Right Door -2 = Back Left Door -3 = Back Right Door -4 = Hood -5 = Trunk -6 = Trunk2 +Sets the specified door index shut on the passed vehicle. + +```c +enum eDoorId +{ + VEH_EXT_DOOR_DSIDE_F = 0, + VEH_EXT_DOOR_DSIDE_R = 1, + VEH_EXT_DOOR_PSIDE_F = 2, + VEH_EXT_DOOR_PSIDE_R = 3, + VEH_EXT_BONNET = 4, + VEH_EXT_BOOT = 5, + // 0x872E72B8 = 0xFFFFFFFF, +} ``` ## Parameters -* **vehicle**: -* **doorIndex**: -* **closeInstantly**: +* **vehicle**: Vehicle. +* **doorIndex**: Index of the door you want to close. +* **closeInstantly**: Whether the doors close instantly. +## Examples +```lua +local Vehicle = GetVehiclePedIsUsing(PlayerPedId()) +for i = 0, 5 do + SetVehicleDoorShut(Vehicle, i, false) -- will close all doors from 0-5 +end +``` diff --git a/VEHICLE/SetVehicleDoorsLockedForAllPlayers.md b/VEHICLE/SetVehicleDoorsLockedForAllPlayers.md index 22abfccd1..70149addc 100644 --- a/VEHICLE/SetVehicleDoorsLockedForAllPlayers.md +++ b/VEHICLE/SetVehicleDoorsLockedForAllPlayers.md @@ -8,14 +8,6 @@ ns: VEHICLE void SET_VEHICLE_DOORS_LOCKED_FOR_ALL_PLAYERS(Vehicle vehicle, BOOL toggle); ``` -``` -After some analysis, I've decided that these are what the parameters are. -We can see this being used in R* scripts such as "am_mp_property_int.ysc.c4": -l_11A1 = PED::GET_VEHICLE_PED_IS_IN(PLAYER::PLAYER_PED_ID(), 1); -... -VEHICLE::SET_VEHICLE_DOORS_LOCKED_FOR_ALL_PLAYERS(l_11A1, 1); -``` - ## Parameters * **vehicle**: * **toggle**: diff --git a/VEHICLE/SetVehicleExclusiveDriver.md b/VEHICLE/SetVehicleExclusiveDriver.md index 2813d5a03..c156477d4 100644 --- a/VEHICLE/SetVehicleExclusiveDriver.md +++ b/VEHICLE/SetVehicleExclusiveDriver.md @@ -9,13 +9,11 @@ aliases: ["SET_VEHICLE_EXCLUSIVE_DRIVER"] void _0x41062318F23ED854(Vehicle vehicle, Ped ped, int index); ``` -``` -Used to be incorrectly named SET_VEHICLE_EXCLUSIVE_DRIVER; likely SET_VEHICLE_ALLOW_*: +Used to be incorrectly named `SET_VEHICLE_EXCLUSIVE_DRIVER`; likely `SET_VEHICLE_ALLOW_*`. -Toggles a flag related to SET_VEHICLE_EXCLUSIVE_DRIVER, however, doesn't enable that feature (or trigger script events related to it). +Toggles a flag related to `SET_VEHICLE_EXCLUSIVE_DRIVER`, however, doesn't enable that feature (or trigger script events related to it). -See _SET_VEHICLE_EXCLUSIVE_DRIVER_2. -``` +See [`_SET_VEHICLE_EXCLUSIVE_DRIVER_2`](#_0xB5C51B5502E85E83). ``` NativeDB Parameter 1: BOOL toggle @@ -23,7 +21,7 @@ NativeDB Removed Parameter 2: int index ``` ## Parameters -* **vehicle**: -* **ped**: +* **vehicle**: +* **ped**: * **index**: diff --git a/VEHICLE/SetVehicleIndividualDoorsLocked.md b/VEHICLE/SetVehicleIndividualDoorsLocked.md index 1f5fd3af0..c36fe3d22 100644 --- a/VEHICLE/SetVehicleIndividualDoorsLocked.md +++ b/VEHICLE/SetVehicleIndividualDoorsLocked.md @@ -9,9 +9,7 @@ aliases: ["SET_PED_TARGETTABLE_VEHICLE_DESTROY","_SET_VEHICLE_DOOR_DESTROY_TYPE" void SET_VEHICLE_INDIVIDUAL_DOORS_LOCKED(Vehicle vehicle, int doorIndex, int destroyType); ``` -``` -destroyType is 1 for opens on damage, 2 for breaks on damage. -``` +See eDoorId declared in [`SET_VEHICLE_DOOR_SHUT`](#_0x93D9BD300D7789E5) ## Parameters * **vehicle**: diff --git a/VEHICLE/SmashVehicleWindow.md b/VEHICLE/SmashVehicleWindow.md index 5b32b0a31..0007116b6 100644 --- a/VEHICLE/SmashVehicleWindow.md +++ b/VEHICLE/SmashVehicleWindow.md @@ -5,29 +5,13 @@ ns: VEHICLE ```c // 0x9E5B5E4D2CCD2259 0xDDD9A8C2 -Any SMASH_VEHICLE_WINDOW(Vehicle vehicle, int index); +Any SMASH_VEHICLE_WINDOW(Vehicle vehicle, int windowIndex); ``` -int index = 0 to 13 - -0 = front right window -1 = front left window -2 = rear right window -3 = rear left window -4 = unsure -5 = unsure -6 = windowscreen -7 = unsure -8 = rear windowscreen -9 = unsure -10 = unsure -11 = unsure -12 = unsure -13 = unsure - +See eWindowId declared in [`IS_VEHICLE_WINDOW_INTACT`](#_0x46E571A0E20D01F1). ## Parameters * **vehicle**: -* **index**: +* **windowIndex**: ## Return value diff --git a/VEHICLE/StartPlaybackRecordedVehicle.md b/VEHICLE/StartPlaybackRecordedVehicle.md index 9b8b2200c..062f36737 100644 --- a/VEHICLE/StartPlaybackRecordedVehicle.md +++ b/VEHICLE/StartPlaybackRecordedVehicle.md @@ -8,10 +8,9 @@ ns: VEHICLE void START_PLAYBACK_RECORDED_VEHICLE(Vehicle vehicle, int recording, char* script, BOOL p3); ``` -``` p3 is some flag related to 'trailers' (invokes CVehicle::GetTrailer). -See REQUEST_VEHICLE_RECORDING -``` + +See [`REQUEST_VEHICLE_RECORDING`](#_0xAF514CABE74CBF15). ## Parameters * **vehicle**: diff --git a/WEAPON/GetSelectedPedWeapon.md b/WEAPON/GetSelectedPedWeapon.md index c89d1067b..a838a80c3 100644 --- a/WEAPON/GetSelectedPedWeapon.md +++ b/WEAPON/GetSelectedPedWeapon.md @@ -8,18 +8,6 @@ ns: WEAPON Hash GET_SELECTED_PED_WEAPON(Ped ped); ``` -``` -Returns the hash of the weapon. -var num7 = WEAPON::GET_SELECTED_PED_WEAPON(num4); -sub_27D3(num7); -switch (num7) -{ - case 0x24B17070: - Also see WEAPON::GET_CURRENT_PED_WEAPON. Difference? - ------------------------------------------------------------------------- - The difference is that GET_SELECTED_PED_WEAPON simply returns the ped's current weapon hash but GET_CURRENT_PED_WEAPON also checks the weapon object and returns true if the hash of the weapon object equals the weapon hash -``` - ## Parameters * **ped**: