Skip to content

Commit

Permalink
ci: generate native definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Mar 3, 2024
1 parent 4d24c86 commit 81b3471
Show file tree
Hide file tree
Showing 7 changed files with 155 additions and 105 deletions.
16 changes: 7 additions & 9 deletions library/natives/GTAV/CAM.lua
Original file line number Diff line number Diff line change
Expand Up @@ -1041,15 +1041,6 @@ function N_0x62374889a4d59f72() end
---This native does not have an official description.
function N_0x62ecfcfdee7885d6() end

---**`CAM` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x661B5C8654ADD825)
---```
---SET_CAM_*
---```
---@param cam number
---@param p1 boolean
function N_0x661b5c8654add825(cam, p1) end

---**`CAM` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x705A276EBFF3133D)
---This native does not have an official description.
Expand Down Expand Up @@ -1356,6 +1347,13 @@ function SetCamAffectsAiming(cam, toggle) end
---@param phase number
function SetCamAnimCurrentPhase(cam, phase) end

---**`CAM` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x661B5C8654ADD825)
---Makes the minimap follow a scripted camera's rotation instead of the gameplay cam.
---@param cam number
---@param toggle boolean
function SetCamControlsMiniMapHeading(cam, toggle) end

---**`CAM` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x4D41783FB745E42E)
---```
Expand Down
34 changes: 22 additions & 12 deletions library/natives/GTAV/ENTITY.lua
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ function ForceEntityAiAndAnimationUpdate(entity) end

---**`ENTITY` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x428CA6DBD1094446)
---Freezes or unfreezes an entity preventing its coordinates to change by the player if set to `true`. You can still change the entity position using SET_ENTITY_COORDS.
---Freezes or unfreezes an entity preventing its coordinates to change by the player if set to `true`. You can still change the entity position using [`SET_ENTITY_COORDS`](#\_0x06843DA7060A026B).
---@param entity number
---@param toggle boolean
function FreezeEntityPosition(entity, toggle) end
Expand Down Expand Up @@ -1605,15 +1605,21 @@ function SetEntityCoords(entity, xPos, yPos, zPos, alive, deadFlag, ragdollFlag,

---**`ENTITY` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x239A3351AC1DA385)
---Sets the coordinates (world position) for a specified entity.
---Teleports an entity to specified coordinates directly, with options to maintain certain behaviors post-teleportation.
---
---**Note**:
---
---* This native allows precise placement of entities without the usual adjustments for collision or interaction with the environment that may occur with other teleportation natives.
---* The `keepTasks` and `keepIK` parameters are specifically useful for maintaining the current state of a ped, ensuring actions or animations are not abruptly stopped due to the teleportation.
---* Setting `doWarp` to `false` is useful when simulating continuous movement or when the entity should interact with its immediate surroundings upon arrival.
---@param entity number
---@param xPos number
---@param yPos number
---@param zPos number
---@param alive boolean
---@param deadFlag boolean
---@param ragdollFlag boolean
function SetEntityCoordsNoOffset(entity, xPos, yPos, zPos, alive, deadFlag, ragdollFlag) end
---@param x number
---@param y number
---@param z number
---@param keepTasks boolean
---@param keepIK boolean
---@param doWarp boolean
function SetEntityCoordsNoOffset(entity, x, y, z, keepTasks, keepIK, doWarp) end

---**`ENTITY` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x621873ECE1178967)
Expand Down Expand Up @@ -1831,14 +1837,18 @@ function SetEntityRenderScorched(entity, toggle) end

---**`ENTITY` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x8524A8B0171D5E07)
---This native does not have an official description.
---Sets the rotation of a specified entity in the game world.
---
---```
---NativeDB Introduced: v323
---```
---@param entity number
---@param pitch number
---@param roll number
---@param yaw number
---@param rotationOrder number
---@param p5 boolean
function SetEntityRotation(entity, pitch, roll, yaw, rotationOrder, p5) end
---@param bDeadCheck boolean
function SetEntityRotation(entity, pitch, roll, yaw, rotationOrder, bDeadCheck) end

---**`ENTITY` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x57C5DB656185EAC4)
Expand Down
10 changes: 5 additions & 5 deletions library/natives/GTAV/HUD.lua
Original file line number Diff line number Diff line change
Expand Up @@ -2537,11 +2537,6 @@ function N_0x24a49beaf468dc90(p0, p2, p3, p4) end
---@param toggle boolean
function N_0x2790f4b17d098e26(toggle) end

---**`HUD` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x2916A928514C9827)
---This native does not have an official description.
function N_0x2916a928514c9827() end

---**`HUD` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x2C173AE2BDB9385E)
---GET_BLIP_\*
Expand Down Expand Up @@ -3074,6 +3069,11 @@ function ReleaseControlOfFrontend() end
---@return boolean
function ReleaseNamedRendertarget(name) end

---**`HUD` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x2916A928514C9827)
---Forces the map menu to reload.
function ReloadMapMenu() end

---**`HUD` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x86A652570E5F25DD)
---Removes the blip from your map.
Expand Down
161 changes: 96 additions & 65 deletions library/natives/GTAV/MISC.lua
Original file line number Diff line number Diff line change
Expand Up @@ -915,7 +915,11 @@ function GetGlobalCharBuffer() end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x8BDC7BFC57A81E76)
---This native does not have an official description.
---Attempts to identify the highest ground Z-coordinate and determine the corresponding surface normal directly beneath a specified 3D coordinate.
---
---```
---NativeDB Introduced: v323
---```
---@param x number
---@param y number
---@param z number
Expand All @@ -926,32 +930,41 @@ function GetGroundZAndNormalFor_3dCoord(x, y, z) end
GetGroundZCoordWithOffsets = GetGroundZAndNormalFor_3dCoord

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0xC906A7DAB05C8D2B)
---[Native Documentation](https://docs.fivem.net/natives/?_0x9E82F0F362881B29)
---Determines the highest ground Z-coordinate directly below a specified 3D coordinate, excluding any objects at that point. Optionally, water can be considered as ground when determining the highest point.
---
---```
---Bear in mind this native can only calculate the elevation when the coordinates are within the client's render distance.
---NativeDB Added Parameter 6: BOOL ignoreDistToWaterLevelCheck - If set to true, the distance to the water level will be ignored when checking for water as ground.
---```
---
---```
---NativeDB Added Parameter 6: BOOL p5
---NativeDB Introduced: v505
---```
---@param x number
---@param y number
---@param z number
---@param ignoreWater boolean
---@param waterAsGround boolean
---@return boolean, number
function GetGroundZFor_3dCoord(x, y, z, ignoreWater) end
function GetGroundZExcludingObjectsFor_3dCoord(x, y, z, waterAsGround) end

---@deprecated
GetGroundZFor_3dCoord_2 = GetGroundZExcludingObjectsFor_3dCoord

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x9E82F0F362881B29)
---[Native Documentation](https://docs.fivem.net/natives/?_0xC906A7DAB05C8D2B)
---```
---Bear in mind this native can only calculate the elevation when the coordinates are within the client's render distance.
---```
---
---```
---NativeDB Added Parameter 6: BOOL p5
---```
---@param x number
---@param y number
---@param z number
---@param p4 boolean
---@param ignoreWater boolean
---@return boolean, number
function GetGroundZFor_3dCoord_2(x, y, z, p4) end
function GetGroundZFor_3dCoord(x, y, z, ignoreWater) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0xD24D37CC275948CC)
Expand Down Expand Up @@ -1706,39 +1719,6 @@ function N_0x1178e104409fe58c(p0, p1) end
---@return boolean
function N_0x19bfed045c647c49(ped) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x1BB299305C3E8C13)
---```
---SCRIPT_RACE_*
---```
---@param p0 any
---@param p1 any
---@param p2 any
---@param p3 any
function N_0x1bb299305c3e8c13(p0, p1, p2, p3) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x1EAE0A6E978894A2)
---```
---Unsure about the use of this native but here's an example:
---void sub_8709() {
--- MISC::_1EAE0A6E978894A2(0, 1);
--- MISC::_1EAE0A6E978894A2(1, 1);
--- MISC::_1EAE0A6E978894A2(2, 1);
--- MISC::_1EAE0A6E978894A2(3, 1);
--- MISC::_1EAE0A6E978894A2(4, 1);
--- MISC::_1EAE0A6E978894A2(5, 1);
--- MISC::_1EAE0A6E978894A2(6, 1);
--- MISC::_1EAE0A6E978894A2(7, 1);
--- MISC::_1EAE0A6E978894A2(8, 1);
---}
---So it appears that p0 ranges from 0 to 8.
---ENABLE_DISPATCH_SERVICE, seems to have a similar layout.
---```
---@param p0 number
---@param p1 boolean
function N_0x1eae0a6e978894a2(p0, p1) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x2107A3773771186D)
---```
Expand Down Expand Up @@ -2343,12 +2323,29 @@ function ScriptRaceGetPlayerSplitTime(player) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x0A60017F841A54F2)
---This native does not have an official description.
---@param p0 any
---@param p1 any
---@param p2 any
---@param p3 any
function ScriptRaceInit(p0, p1, p2, p3) end
---Initializes a script race in GTA:Online and sets up the helper split time system.
---
---```
---NativeDB Introduced: v323
---```
---@param numCheckpoints number
---@param numLaps number
---@param numPlayers number
---@param localPlayer number
function ScriptRaceInit(numCheckpoints, numLaps, numPlayers, localPlayer) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x1BB299305C3E8C13)
---Records that a player has successfully passed a checkpoint during a scripted race in GTA:Online. This native should be used after initializing the race with [`SCRIPT_RACE_INIT`](#\_0x0A60017F841A54F2).
---
---```
---NativeDB Introduced: v323
---```
---@param ped number
---@param checkpoint number
---@param lap number
---@param time number
function ScriptRacePlayerHitCheckpoint(ped, checkpoint, lap, time) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x1FF6BF9A63E5757F)
Expand Down Expand Up @@ -2712,24 +2709,31 @@ function SetTimeScale(timeScale) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x29B487C359E19889)
---Immediately changes the game's weather to the specified type, which will then persist for one cycle before the game resumes its natural weather progression.
---
---**Note:** This native is not supported in networked sessions. Please refer to [`SET_OVERRIDE_WEATHER`](#\_0xA43D5C6FE51ADBEF) or [`SET_WEATHER_TYPE_NOW_PERSIST`](#\_0xED712CA327900C8A) if you want to override weather in networked sessions.
---
---```
---// timecycle_keyframe_data
---BLIZZARD = 0x27EA2814
---CLEAR = 0x36A83D84
---CLEARING = 0x6DB1A50D
---CLOUDS = 0x30FDAF5C
---EXTRASUNNY = 0x97AA0A79
---FOGGY = 0xAE737644
---HALLOWEEN = 0xC91A3202
---NEUTRAL = 0xA4CA1326
---OVERCAST = 0xBB898D2D
---RAIN = 0x54A69840
---SMOG = 0x10DCF4B5
---SNOW = 0xEFB6EFF6
---SNOWLIGHT = 0x23FB812B
---THUNDER = 0xB677829F
---XMAS = 0xAAC9C895
---NativeDB Introduced: v323
---```
---
---**Weather Types:**
---
---* CLEAR
---* EXTRASUNNY
---* CLOUDS
---* OVERCAST
---* RAIN
---* CLEARING
---* THUNDER
---* SMOG
---* FOGGY
---* XMAS
---* SNOW
---* SNOWLIGHT
---* BLIZZARD
---* HALLOWEEN
---* NEUTRAL
---@param weatherType string
function SetWeatherTypeNow(weatherType) end

Expand All @@ -2751,7 +2755,13 @@ SetWeatherTypeOverTime = SetWeatherTypeOvertimePersist

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x704983DF373B198F)
---Refer to [`SET_WEATHER_TYPE_NOW_PERSIST`](#\_0xED712CA327900C8A) for weather types.
---Sets the current weather type to persist indefinitely until changed.
---
---**Note:** This native is not supported in networked sessions. Please refer to [`SET_OVERRIDE_WEATHER`](#\_0xA43D5C6FE51ADBEF) or [`SET_WEATHER_TYPE_NOW_PERSIST`](#\_0xED712CA327900C8A) if you want to override weather in networked sessions.
---
---```
---NativeDB Introduced: v323
---```
---@param weatherType string
function SetWeatherTypePersist(weatherType) end

Expand Down Expand Up @@ -2959,6 +2969,27 @@ function StopSaveStruct() end
---@return boolean, number
function StringToInt(string) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x1EAE0A6E978894A2)
---Suppresses or enables a specific type of random event for the current frame.
---
---```cpp
---enum eEventType {
--- RC_PED_STEAL_VEHICLE = 0,
--- RC_PED_JAY_WALK_LIGHT = 1,
--- RC_COP_PURSUE = 2,
--- RC_COP_PURSUE_VEHICLE_FLEE_SPAWNED = 3,
--- RC_COP_VEHICLE_DRIVING_FAST = 4,
--- RC_COP_VEHICLE_DRIVING_SLOW = 5,
--- RC_DRIVER_RECKLESS = 6,
--- RC_DRIVER_PRO = 7,
--- RC_PED_PURSUE_WHEN_HIT_BY_CAR = 8
---}
---```
---@param eventType number
---@param enable boolean
function SupressRandomEventThisFrame(eventType, enable) end

---**`MISC` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x632106CC96E82E91)
---This native does not have an official description.
Expand Down
14 changes: 10 additions & 4 deletions library/natives/GTAV/NETWORK.lua
Original file line number Diff line number Diff line change
Expand Up @@ -2042,10 +2042,15 @@ function NetworkAllocateTunablesRegistrationDataMap() end

---**`NETWORK` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x267C78C60E806B9A)
---This native does not have an official description.
---Allows scripts to use attachment commands on entities (eg. [`ATTACH_ENTITY_TO_ENTITY`](#\_0x6B9BBD38AB0796DF)) that are not controlled by the client.
---
---**Note:** This is only local and does not affect entities on other machines. This is used by the ferris wheel script to sync players on carts.
---@param entity number
---@param toggle boolean
function NetworkAllowLocalEntityAttachment(entity, toggle) end
function NetworkAllowRemoteAttachmentModification(entity, toggle) end

---@deprecated
NetworkAllowLocalEntityAttachment = NetworkAllowRemoteAttachmentModification

---**`NETWORK` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0x15337C7C268A27B2)
Expand Down Expand Up @@ -4505,8 +4510,9 @@ function NetworkOverrideClockMillisecondsPerGameMinute(ms) end

---**`NETWORK` `client`**
---[Native Documentation](https://docs.fivem.net/natives/?_0xE679E3E06E363892)
---Works in Singleplayer too.
---Passing wrong data (e.g. hours above 23) will cause the game to crash.
---Overrides the game clock time for the local player, allowing for manipulation of the in-game time. This native is effective in both multiplayer and singleplayer modes.
---
---**Note:** Passing wrong data (e.g. hours above 23) will cause the game to crash.
---@param hours number
---@param minutes number
---@param seconds number
Expand Down
Loading

0 comments on commit 81b3471

Please sign in to comment.