Skip to content

Commit 2dd5e26

Browse files
prepare for release 20201211.1
1 parent df9191f commit 2dd5e26

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

docs/server.lua

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ function EnsureEntityStateBag(entity) end
9292
function GetAirDragMultiplierForPlayersVehicle(playerSrc) end
9393

9494

95-
--- Returns all vehicle handles known to the server.
95+
--- Returns all vehicle handles known to the server.
9696
--- The data returned adheres to the following layout:
9797
---
9898
--- ```
@@ -107,7 +107,7 @@ function GetAirDragMultiplierForPlayersVehicle(playerSrc) end
107107
function GetAllVehicles() end
108108

109109

110-
--- Returns all object handles known to the server.
110+
--- Returns all object handles known to the server.
111111
--- The data returned adheres to the following layout:
112112
---
113113
--- ```
@@ -122,7 +122,7 @@ function GetAllVehicles() end
122122
function GetAllObjects() end
123123

124124

125-
--- Returns all peds handles known to the server.
125+
--- Returns all peds handles known to the server.
126126
--- The data returned adheres to the following layout:
127127
---
128128
--- ```
@@ -158,15 +158,15 @@ function GetEntityMaxHealth(entity) end
158158

159159

160160
--- Gets the current coordinates for a specified entity. This native is used server side when using OneSync. See <a href="#_0x3FEF770D40960D5A" >GET_ENTITY_COORDS</a> for client side.
161-
--- @usage local function ShowCoordinates()
162-
--- local player = source
163-
--- local ped = GetPlayerPed(player)
164-
--- local playerCoords = GetEntityCoords(ped)
165-
---
166-
--- print(playerCoords) -- vector3(...)
167-
--- end
168-
---
169-
--- RegisterNetEvent("myCoordinates")
161+
--- @usage local function ShowCoordinates()
162+
--- local player = source
163+
--- local ped = GetPlayerPed(player)
164+
--- local playerCoords = GetEntityCoords(ped)
165+
---
166+
--- print(playerCoords) -- vector3(...)
167+
--- end
168+
---
169+
--- RegisterNetEvent("myCoordinates")
170170
--- AddEventHandler("myCoordinates", ShowCoordinates
171171
--- @hash 0x1647F1CB
172172
--- @api server
@@ -554,8 +554,8 @@ function GetPlayerPed(playerSrc) end
554554

555555

556556
--- ```
557-
--- Gets the amount of time player has spent evading the cops.
558-
--- Counter starts and increments only when cops are chasing the player.
557+
--- Gets the amount of time player has spent evading the cops.
558+
--- Counter starts and increments only when cops are chasing the player.
559559
--- If the player is evading, the timer will pause.
560560
--- ```
561561
---
@@ -698,15 +698,15 @@ function GetVehicleHeadlightsColour(vehicle) end
698698

699699

700700
--- ```
701-
--- enum VehicleLockStatus = {
702-
--- None = 0,
703-
--- Unlocked = 1,
704-
--- Locked = 2,
705-
--- LockedForPlayer = 3,
706-
--- StickPlayerInside = 4, -- Doesn't allow players to exit the vehicle with the exit vehicle key.
707-
--- CanBeBrokenInto = 7, -- Can be broken into the car. If the glass is broken, the value will be set to 1
708-
--- CanBeBrokenIntoPersist = 8, -- Can be broken into persist
709-
--- CannotBeTriedToEnter = 10, -- Cannot be tried to enter (Nothing happens when you press the vehicle enter key).
701+
--- enum VehicleLockStatus = {
702+
--- None = 0,
703+
--- Unlocked = 1,
704+
--- Locked = 2,
705+
--- LockedForPlayer = 3,
706+
--- StickPlayerInside = 4, -- Doesn't allow players to exit the vehicle with the exit vehicle key.
707+
--- CanBeBrokenInto = 7, -- Can be broken into the car. If the glass is broken, the value will be set to 1
708+
--- CanBeBrokenIntoPersist = 8, -- Can be broken into persist
709+
--- CannotBeTriedToEnter = 10, -- Cannot be tried to enter (Nothing happens when you press the vehicle enter key).
710710
--- }
711711
--- ```
712712
---
@@ -898,9 +898,9 @@ function IsPedAPlayer(ped) end
898898

899899

900900
--- ```
901-
--- This will return true if the player is evading wanted level, meaning that the wanted level stars are blink.
902-
--- Otherwise will return false.
903-
---
901+
--- This will return true if the player is evading wanted level, meaning that the wanted level stars are blink.
902+
--- Otherwise will return false.
903+
---
904904
--- If the player is not wanted, it simply returns false.
905905
--- ```
906906
---
@@ -1067,17 +1067,17 @@ function NetworkGetVoiceProximityOverride(playerSrc) end
10671067
function RegisterConsoleListener(listener) end
10681068

10691069

1070-
--- Registers a build task factory for resources.
1070+
--- Registers a build task factory for resources.
10711071
--- The function should return an object (msgpack map) with the following fields:
10721072
---
10731073
--- ```
1074-
--- {
1075-
--- // returns whether the specific resource should be built
1076-
--- shouldBuild = func(resourceName: string): bool,
1077-
---
1078-
--- // asynchronously start building the specific resource.
1079-
--- // call cb when completed
1080-
--- build = func(resourceName: string, cb: func(success: bool, status: string): void): void
1074+
--- {
1075+
--- // returns whether the specific resource should be built
1076+
--- shouldBuild = func(resourceName: string): bool,
1077+
---
1078+
--- // asynchronously start building the specific resource.
1079+
--- // call cb when completed
1080+
--- build = func(resourceName: string, cb: func(success: bool, status: string): void): void
10811081
--- }
10821082
--- ```
10831083
---
@@ -1100,7 +1100,7 @@ function RegisterResourceBuildTaskFactory(factoryId, factoryFn) end
11001100
function ScheduleResourceTick(resourceName) end
11011101

11021102

1103-
--- Writes the specified data to a file in the specified resource.
1103+
--- Writes the specified data to a file in the specified resource.
11041104
--- Using a length of `-1` will automatically detect the length assuming the data is a C string.
11051105
---
11061106
--- @hash 0xA09E7E7B
@@ -1114,7 +1114,7 @@ function ScheduleResourceTick(resourceName) end
11141114
function SaveResourceFile(resourceName, fileName, data, dataLength) end
11151115

11161116

1117-
--- Requests the specified player to buy the passed SKU. This'll pop up a prompt on the client, which upon acceptance
1117+
--- Requests the specified player to buy the passed SKU. This'll pop up a prompt on the client, which upon acceptance
11181118
--- will open the browser prompting further purchase details.
11191119
---
11201120
--- @hash 0x96F93CCE
@@ -1192,7 +1192,7 @@ function SetGameType(gametypeName) end
11921192
function SetHttpHandler(handler) end
11931193

11941194

1195-
--- It overrides the default distance culling radius of an entity. Set to `0.0` to reset.
1195+
--- It overrides the default distance culling radius of an entity. Set to `0.0` to reset.
11961196
--- If you want to interact with an entity outside of your players' scopes set the radius to a huge number.
11971197
---
11981198
--- @hash 0xD3A183A3

0 commit comments

Comments
 (0)