diff --git a/docs/server.lua b/docs/server.lua index ad09ca3..f472757 100644 --- a/docs/server.lua +++ b/docs/server.lua @@ -92,7 +92,7 @@ function EnsureEntityStateBag(entity) end function GetAirDragMultiplierForPlayersVehicle(playerSrc) end ---- Returns all vehicle handles known to the server. +--- Returns all vehicle handles known to the server. --- The data returned adheres to the following layout: --- --- ``` @@ -107,7 +107,7 @@ function GetAirDragMultiplierForPlayersVehicle(playerSrc) end function GetAllVehicles() end ---- Returns all object handles known to the server. +--- Returns all object handles known to the server. --- The data returned adheres to the following layout: --- --- ``` @@ -122,7 +122,7 @@ function GetAllVehicles() end function GetAllObjects() end ---- Returns all peds handles known to the server. +--- Returns all peds handles known to the server. --- The data returned adheres to the following layout: --- --- ``` @@ -158,15 +158,15 @@ function GetEntityMaxHealth(entity) end --- Gets the current coordinates for a specified entity. This native is used server side when using OneSync. See GET_ENTITY_COORDS for client side. ---- @usage local function ShowCoordinates() ---- local player = source ---- local ped = GetPlayerPed(player) ---- local playerCoords = GetEntityCoords(ped) ---- ---- print(playerCoords) -- vector3(...) ---- end ---- ---- RegisterNetEvent("myCoordinates") +--- @usage local function ShowCoordinates() +--- local player = source +--- local ped = GetPlayerPed(player) +--- local playerCoords = GetEntityCoords(ped) +--- +--- print(playerCoords) -- vector3(...) +--- end +--- +--- RegisterNetEvent("myCoordinates") --- AddEventHandler("myCoordinates", ShowCoordinates --- @hash 0x1647F1CB --- @api server @@ -554,8 +554,8 @@ function GetPlayerPed(playerSrc) end --- ``` ---- Gets the amount of time player has spent evading the cops. ---- Counter starts and increments only when cops are chasing the player. +--- Gets the amount of time player has spent evading the cops. +--- Counter starts and increments only when cops are chasing the player. --- If the player is evading, the timer will pause. --- ``` --- @@ -698,15 +698,15 @@ function GetVehicleHeadlightsColour(vehicle) end --- ``` ---- enum VehicleLockStatus = { ---- None = 0, ---- Unlocked = 1, ---- Locked = 2, ---- LockedForPlayer = 3, ---- StickPlayerInside = 4, -- Doesn't allow players to exit the vehicle with the exit vehicle key. ---- CanBeBrokenInto = 7, -- Can be broken into the car. If the glass is broken, the value will be set to 1 ---- CanBeBrokenIntoPersist = 8, -- Can be broken into persist ---- CannotBeTriedToEnter = 10, -- Cannot be tried to enter (Nothing happens when you press the vehicle enter key). +--- enum VehicleLockStatus = { +--- None = 0, +--- Unlocked = 1, +--- Locked = 2, +--- LockedForPlayer = 3, +--- StickPlayerInside = 4, -- Doesn't allow players to exit the vehicle with the exit vehicle key. +--- CanBeBrokenInto = 7, -- Can be broken into the car. If the glass is broken, the value will be set to 1 +--- CanBeBrokenIntoPersist = 8, -- Can be broken into persist +--- CannotBeTriedToEnter = 10, -- Cannot be tried to enter (Nothing happens when you press the vehicle enter key). --- } --- ``` --- @@ -898,9 +898,9 @@ function IsPedAPlayer(ped) end --- ``` ---- This will return true if the player is evading wanted level, meaning that the wanted level stars are blink. ---- Otherwise will return false. ---- +--- This will return true if the player is evading wanted level, meaning that the wanted level stars are blink. +--- Otherwise will return false. +--- --- If the player is not wanted, it simply returns false. --- ``` --- @@ -1067,17 +1067,17 @@ function NetworkGetVoiceProximityOverride(playerSrc) end function RegisterConsoleListener(listener) end ---- Registers a build task factory for resources. +--- Registers a build task factory for resources. --- The function should return an object (msgpack map) with the following fields: --- --- ``` ---- { ---- // returns whether the specific resource should be built ---- shouldBuild = func(resourceName: string): bool, ---- ---- // asynchronously start building the specific resource. ---- // call cb when completed ---- build = func(resourceName: string, cb: func(success: bool, status: string): void): void +--- { +--- // returns whether the specific resource should be built +--- shouldBuild = func(resourceName: string): bool, +--- +--- // asynchronously start building the specific resource. +--- // call cb when completed +--- build = func(resourceName: string, cb: func(success: bool, status: string): void): void --- } --- ``` --- @@ -1100,7 +1100,7 @@ function RegisterResourceBuildTaskFactory(factoryId, factoryFn) end function ScheduleResourceTick(resourceName) end ---- Writes the specified data to a file in the specified resource. +--- Writes the specified data to a file in the specified resource. --- Using a length of `-1` will automatically detect the length assuming the data is a C string. --- --- @hash 0xA09E7E7B @@ -1114,7 +1114,7 @@ function ScheduleResourceTick(resourceName) end function SaveResourceFile(resourceName, fileName, data, dataLength) end ---- Requests the specified player to buy the passed SKU. This'll pop up a prompt on the client, which upon acceptance +--- Requests the specified player to buy the passed SKU. This'll pop up a prompt on the client, which upon acceptance --- will open the browser prompting further purchase details. --- --- @hash 0x96F93CCE @@ -1192,7 +1192,7 @@ function SetGameType(gametypeName) end function SetHttpHandler(handler) end ---- It overrides the default distance culling radius of an entity. Set to `0.0` to reset. +--- It overrides the default distance culling radius of an entity. Set to `0.0` to reset. --- If you want to interact with an entity outside of your players' scopes set the radius to a huge number. --- --- @hash 0xD3A183A3