Skip to content

Commit

Permalink
chore(docs): add qbx_vehiclekeys
Browse files Browse the repository at this point in the history
  • Loading branch information
Manason committed Oct 27, 2024
1 parent 10be90f commit 447678e
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 2 deletions.
2 changes: 0 additions & 2 deletions pages/resources/qbx_management/exports/client.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import { Callout } from 'nextra/components';

# Client Exports

## OpenBossMenu
Expand Down
13 changes: 13 additions & 0 deletions pages/resources/qbx_vehiclekeys.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: qbx_vehiclekeys
---

import { Cards, Card } from 'nextra/components';
import { IconBrandGithub, IconTag } from '@tabler/icons-react';

# qbx_vehiclekeys

<Cards>
<Card icon={<IconBrandGithub />} title="GitHub" href="https://github.com/Qbox-Project/qbx_vehiclekeys" />
<Card icon={<IconTag />} title="Releases" href="https://github.com/Qbox-Project/qbx_vehiclekeys/releases" />
</Cards>
3 changes: 3 additions & 0 deletions pages/resources/qbx_vehiclekeys/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"exports": "Exports"
}
11 changes: 11 additions & 0 deletions pages/resources/qbx_vehiclekeys/exports/client.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Client Exports

## HasKeys

Returns whether the player has keys to the given vehicle entity

```lua
exports.qbx_vehiclekeys:HasKeys(vehicle)
```

- vehicle: `number`
37 changes: 37 additions & 0 deletions pages/resources/qbx_vehiclekeys/exports/server.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Server Exports

## HasKeys

Returns whether the player has keys to the given vehicle entity

```lua
exports.qbx_vehiclekeys:HasKeys(source, vehicle)
```

- source: `number`
- vehicle: `number`

## GiveKeys

Gives keys to a player so that they can unlock/lock the doors and toggle the engine.
Notifies the player unless skipNotification is true.

```lua
exports.qbx_vehiclekeys:GiveKeys(source, vehicle, skipNotification)
```

- source: `number`
- vehicle: `number`
- skipNotification?: `boolean`

## RemoveKeys

Removes keys from the player. Notifies the player unless skipNotification is true.

```lua
exports.qbx_vehiclekeys:RemoveKeys(source, vehicle, skipNotification)
```

- source: `number`
- vehicle: `number`
- skipNotification?: `boolean`

0 comments on commit 447678e

Please sign in to comment.