Skip to content

Commit

Permalink
improve some parameter descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
thelindat committed Sep 25, 2024
1 parent 7f5a00e commit 59fbe25
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 12 deletions.
8 changes: 4 additions & 4 deletions pages/ox_lib/Modules/DisableControls/Client.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Client

A centralized way to track and disable controls.
A centralized way to track and disable [game controls](https://docs.fivem.net/docs/game-references/controls/#controls).

## lib.disableControls

Expand All @@ -19,7 +19,7 @@ If the control is already being tracked, the stored counter will be incremented.
lib.disableControls:Add(...)
```

- vararg: `number` or `table`
- vararg: `number` or `number[]`
- Control(s) to add a stored count of

## lib.disableControls:Remove
Expand All @@ -31,7 +31,7 @@ If the stored counter for a given control is greater than one, the stored counte
lib.disableControls:Remove(...)
```

- vararg: `number` or `table`
- vararg: `number` or `number[]`
- Control(s) to remove a stored count of

## lib.disableControls:Clear
Expand All @@ -42,5 +42,5 @@ Clears the stored counter(s) for the specified control(s).
lib.disableControls:Clear(...)
```

- vararg: `number` or `table`
- vararg: `number` or `number[]`
- Control(s) to clear out from being tracked
2 changes: 1 addition & 1 deletion pages/ox_lib/Modules/VehicleProperties/Client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ lib.setVehicleProperties(vehicle, props)
```

- vehicle: `entity`
- props: `table` (`object`)
- props: `table`

<Tabs items={["Lua", "JS"]}>
<Tab>
Expand Down
7 changes: 3 additions & 4 deletions pages/ox_lib/Modules/Zones/Shared.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ lib.zones.poly(data)

- data: `table`
- points: `vector3[]`
- All z values must match
- An array of 3d points defining the polygon's shape.
- thickness?: `number`
- Default: `4`
- The height of the polygon, defaulting to `4`.
- onEnter?: `function(self: table)`
- onExit?: `function(self: table)`
- inside?: `function(self: table)`
Expand All @@ -37,8 +37,7 @@ lib.zones.box(data)
- size?: `vector3`
- Default: `vec3(2, 2, 2)`
- rotation?: `number`
- Angle in degrees
- Default: `0`
- Angle in degrees, defaulting to `0`.
- onEnter?: `function(self: table)`
- onExit?: `function(self: table)`
- inside?: `function(self: table)`
Expand Down
10 changes: 7 additions & 3 deletions pages/ox_target/Functions/Client.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -190,12 +190,13 @@ exports.ox_target:addSphereZone(parameters)
```

- parameters: `table`
- coords: `vector`
- coords: `vector3`
- name?: `string`
- An optional name to refer to the zone instead of using the `id`.
- radius?: `number`
- debug?: `boolean`
- drawSprite?: `boolean`
- Draw a sprite at the centroid of the zone. Defaults to `true`.
- options: `TargetOptions`

Return:
Expand All @@ -210,13 +211,14 @@ exports.ox_target:addBoxZone(parameters)
```

- parameters: `table`
- coords: `vector`
- coords: `vector3`
- name?: `string`
- An optional name to refer to the zone instead of using the `id`.
- size?: `vector3`
- rotation?: `number`
- debug?: `boolean`
- drawSprite?: `boolean`
- Draw a sprite at the centroid of the zone. Defaults to `true`.
- options: `TargetOptions`

Return:
Expand All @@ -232,12 +234,14 @@ exports.ox_target:addPolyZone(parameters)

- parameters: `table`
- points: `vector3[]`
- All z values must match
- An array of 3d points defining the polygon's shape.
- name?: `string`
- An optional name to refer to the zone instead of using the `id`.
- thickness?: `number`
- The height of the polygon, defaulting to `4`.
- debug?: `boolean`
- drawSprite?: `boolean`
- Draw a sprite at the centroid of the zone. Defaults to `true`.
- options: `TargetOptions`

Return:
Expand Down

0 comments on commit 59fbe25

Please sign in to comment.