From 447678e5ac80c0afca186174a22bdba9039dd0b3 Mon Sep 17 00:00:00 2001 From: Manason Date: Sat, 26 Oct 2024 18:50:41 -0700 Subject: [PATCH] chore(docs): add qbx_vehiclekeys --- .../qbx_management/exports/client.mdx | 2 - pages/resources/qbx_vehiclekeys.mdx | 13 +++++++ pages/resources/qbx_vehiclekeys/_meta.json | 3 ++ .../qbx_vehiclekeys/exports/client.mdx | 11 ++++++ .../qbx_vehiclekeys/exports/server.mdx | 37 +++++++++++++++++++ 5 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 pages/resources/qbx_vehiclekeys.mdx create mode 100644 pages/resources/qbx_vehiclekeys/_meta.json create mode 100644 pages/resources/qbx_vehiclekeys/exports/client.mdx create mode 100644 pages/resources/qbx_vehiclekeys/exports/server.mdx diff --git a/pages/resources/qbx_management/exports/client.mdx b/pages/resources/qbx_management/exports/client.mdx index 03e540a6..87815e69 100644 --- a/pages/resources/qbx_management/exports/client.mdx +++ b/pages/resources/qbx_management/exports/client.mdx @@ -1,5 +1,3 @@ -import { Callout } from 'nextra/components'; - # Client Exports ## OpenBossMenu diff --git a/pages/resources/qbx_vehiclekeys.mdx b/pages/resources/qbx_vehiclekeys.mdx new file mode 100644 index 00000000..cb456db4 --- /dev/null +++ b/pages/resources/qbx_vehiclekeys.mdx @@ -0,0 +1,13 @@ +--- +title: qbx_vehiclekeys +--- + +import { Cards, Card } from 'nextra/components'; +import { IconBrandGithub, IconTag } from '@tabler/icons-react'; + +# qbx_vehiclekeys + + + } title="GitHub" href="https://github.com/Qbox-Project/qbx_vehiclekeys" /> + } title="Releases" href="https://github.com/Qbox-Project/qbx_vehiclekeys/releases" /> + diff --git a/pages/resources/qbx_vehiclekeys/_meta.json b/pages/resources/qbx_vehiclekeys/_meta.json new file mode 100644 index 00000000..562a7f42 --- /dev/null +++ b/pages/resources/qbx_vehiclekeys/_meta.json @@ -0,0 +1,3 @@ +{ + "exports": "Exports" +} diff --git a/pages/resources/qbx_vehiclekeys/exports/client.mdx b/pages/resources/qbx_vehiclekeys/exports/client.mdx new file mode 100644 index 00000000..2d761734 --- /dev/null +++ b/pages/resources/qbx_vehiclekeys/exports/client.mdx @@ -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` diff --git a/pages/resources/qbx_vehiclekeys/exports/server.mdx b/pages/resources/qbx_vehiclekeys/exports/server.mdx new file mode 100644 index 00000000..784a1b5e --- /dev/null +++ b/pages/resources/qbx_vehiclekeys/exports/server.mdx @@ -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`