Overextended

https://overextended.dev/
Admin
Overextended is a collection of open-source resources for FiveM including OxMySQL, Ox Lib, Ox Core,...
Tokens:162,549
Snippets:1,791
Trust Score:7.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install and Build Ox Doorlock

Source: https://overextended.dev/docs/ox_doorlock

Clone the repository, navigate to the web directory, install dependencies, and build the project. Ensure you have bun installed.

```bash
git clone https://github.com/overextended/ox_doorlock.git
cd ox_doorlock/web
bun i
bun run build
```

--------------------------------

### Example Get Time Left

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Demonstrates retrieving the remaining time in milliseconds, seconds, minutes, hours, and all formats.

```lua
local timer = lib.timer(5000, function()
    print("timer ended")
end, true)

print(timer:getTimeLeft('ms')) -- 5000 miliseconds
print(timer:getTimeLeft('s'))  -- 5.00 seconds
print(timer:getTimeLeft('m'))  -- 0.08 minutes
print(timer:getTimeLeft('h'))  -- 0.00 hours
print(timer:getTimeLeft())     -- {ms = 5000, s = 5.00, m = 0.08, h = 0.00 }
```

--------------------------------

### Basic TextUI Usage Example

Source: https://overextended.dev/docs/ox_lib/Interface/Client/textui

A simple example demonstrating how to show the TextUI with just the required text argument.

```LuaJS
lib.showTextUI('[E] - Fuel vehicle')
```

```javascript
import lib from '@overextended/ox_lib/client';

lib.showTextUI('[E] - Fuel vehicle');
```

--------------------------------

### Install Ox Inventory with ESX Legacy

Source: https://overextended.dev/docs/ox_inventory/Frameworks/esx

Ensure ox_inventory is started after es_extended in your server.cfg for proper integration.

```lua
start oxmysql
start ox_lib
start es_extended
start qtarget
start ox_inventory
```

--------------------------------

### Create and Open Temporary Stash Example

Source: https://overextended.dev/docs/ox_inventory/Functions/Server

Example demonstrating how to create a temporary stash with initial items and then open it for a player. The stash is identified by its returned inventory ID.

```lua
local mystash = exports.ox_inventory:CreateTemporaryStash({
    label = 'mystash',
    slots = 5,
    maxWeight = 5000,
    items = {
        { 'WEAPON_MINISMG', 1 },
        { 'ammo-9', 69 },
        { 'water', 2, { label = 'Mineral water' } }
    }
})

TriggerClientEvent('ox_inventory:openInventory', 1, 'stash', mystash)
```

--------------------------------

### Example Timer Creation

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Example of creating a timer that executes a function after 5000 milliseconds.

```lua
local timer = lib.timer(5000, function()
   print("timer ended")
end)
```

--------------------------------

### Install OxMySQL npm Package

Source: https://overextended.dev/oxmysql

Install the OxMySQL npm package for JavaScript resources to get intellisense and a usage similar to Lua.

```bash
# With pnpm
pnpm add @overextended/oxmysql
```

```bash
# With Yarn
yarn add @overextended/oxmysql
```

```bash
# With npm
npm install @overextended/oxmysql
```

--------------------------------

### Example: Triggering a Server Callback with Response Handling

Source: https://overextended.dev/docs/ox_lib/Callback/JavaScript/Client

This example demonstrates triggering a server callback named 'test:server' after a delay and logging the response received from the server.

```javascript
setTimeout(async () => {
  const args = [1, null, 3, null, null, 6];
  const response = await triggerServerCallback<{ serverValue: number }>("test:server", 1, args);
  if (!response) return;
  console.log("Response from server", response);
}, 100);
```

--------------------------------

### Clone and Build Ox Core

Source: https://overextended.dev/docs/ox_core

Follow these commands to clone the Ox Core repository, install dependencies, and build the project. Ensure you have Git, Node.js, and bun installed, along with MariaDB.

```bash
git clone https://github.com/overextended/ox_core.git
cd ox_core
bun i
bun run build
```

--------------------------------

### Example Alert Dialog Usage (JavaScript)

Source: https://overextended.dev/docs/ox_lib/Interface/Client/alert

An example demonstrating how to call `lib.alertDialog` with various options using `async/await` in JavaScript and log the result. The result indicates whether the user confirmed or canceled.

```javascript
import lib from '@overextended/ox_lib/client';

const alert = await lib.alertDialog({
  header: 'Hello there',
  content: 'General Kenobi  
 Markdown support!',
  centered: true,
  cancel: true,
});

console.log(alert);
```

--------------------------------

### Module Export Example

Source: https://overextended.dev/docs/ox_lib/Require/Shared

A simple example of a module exporting a table containing event mappings.

```lua
return {
  disconnect = 'onPlayerDropped',
}
```

--------------------------------

### Example Warn Print

Source: https://overextended.dev/docs/ox_lib/Print/Shared

An example of how to use the warn print function with a variable.

```lua
lib.print.warn("query latency high: ", latency)
```

--------------------------------

### Example Alert Dialog Usage (Lua)

Source: https://overextended.dev/docs/ox_lib/Interface/Client/alert

An example demonstrating how to call `lib.alertDialog` with various options in Lua and print the result. The result indicates whether the user confirmed or canceled.

```Lua
local alert = lib.alertDialog({
    header = 'Hello there',
    content = 'General Kenobi  
 Markdown support!',
    centered = true,
    cancel = true
})

print(alert)
```

--------------------------------

### English Locale File Example

Source: https://overextended.dev/docs/ox_lib/Locale/Shared

Example of an English locale JSON file. Locale files should be saved as './locales/langcode.json'.

```json
{
  "grand_theft_auto": "grand theft auto",
  "male": "male",
  "female": "female",
  "suspect_sex": "suspect is %s"
}
```

--------------------------------

### Full Progress Bar Example (JavaScript)

Source: https://overextended.dev/docs/ox_lib/Interface/Client/progress

This JavaScript example demonstrates the asynchronous usage of `lib.progressBar` with `await`. It includes similar configurations for duration, label, animation, and props as the LuaJS version. The result is checked using an if-else statement.

```JavaScript
import lib from '@overextended/ox_lib/client'

if (await lib.progressBar({
  duration: 2000,
  label: 'Drinking water',
  useWhileDead: false,
  canCancel: true,
  disable: {
    car: true,
  },
  anim: {
    dict: 'mp_player_intdrink',
    clip: 'loop_bottle'
  },
  prop: {
    model: `prop_ld_flow_bottle`,
    pos: {x: 0.03, y: 0.03, z: 0.02},
    rot: {x: 0.0, y: 0.0, z: -1.5}
  },
})) console.log('Do stuff when complete');
else console.log('Do stuff when cancelled')
```

--------------------------------

### Start UI Game Development Server

Source: https://overextended.dev/ox_lib

Run the development server for UI that writes changes to disk for in-game use.

```bash
bun start:game
```

--------------------------------

### Install Bun Globally

Source: https://overextended.dev/docs/guides/bun

Installs Bun globally using npm. This is a prerequisite for using Bun's package management features.

```bash
npm install -g bun
```

--------------------------------

### Resource Start Order

Source: https://overextended.dev/docs/ox_inventory

Configure the correct start order for Ox Inventory and its dependencies in your server configuration to prevent errors.

```lua
start oxmysql   # this should be one of the first resources
start ox_lib
start framework # the name of your framework (i.e. ox_core, es_extended, qbx_core)
start ox_target
start ox_inventory
```

--------------------------------

### Start UI Development Server with Hot Reloads

Source: https://overextended.dev/ox_lib

Run the development server for UI with hot reloads enabled.

```bash
bun start
```

--------------------------------

### RawExecute Callback Example (JavaScript)

Source: https://overextended.dev/docs/oxmysql/Functions/rawExecute

Provides an example of rawExecute using a callback in JavaScript for handling query responses. Make sure the 'identifier' variable is initialized beforehand.

```javascript
MySQL.rawExecute('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', [
  identifier
], (response) => {
  console.log(JSON.stringify(response))
})
```

--------------------------------

### Install OxMySQL npm Package

Source: https://overextended.dev/docs/oxmysql

Install the OxMySQL npm package for JavaScript projects to enable intellisense and streamline usage.

```bash
# With pnpm
pnpm add @overextended/oxmysql

# With Yarn
yarn add @overextended/oxmysql

# With npm
npm install @overextended/oxmysql
```

--------------------------------

### Locale Usage Example (JS)

Source: https://overextended.dev/docs/ox_lib/Locale/Shared

Example demonstrating how to initialize the locale module and periodically log formatted locale strings. This includes translating 'grand_theft_auto' and constructing a 'suspect_sex' phrase.

```javascript
import { initLocale, locale } from '@overextended/ox_lib/shared'

// Load the locale module
initLocale()

setInterval(() => {
  console.log(locale('grand_theft_auto'))
  console.log(locale('suspect_sex', locale('male')))
}, 5000)
```

--------------------------------

### Example Restart Timer

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Creates a timer that continuously restarts itself after completion.

```lua
-- this will create a timer that just keeps restarting itself
local timer

timer = lib.timer(5000, function()
    print("timer ended")
    timer:restart()
end, true)

```

--------------------------------

### French Locale File Example

Source: https://overextended.dev/docs/ox_lib/Locale/Shared

Example of a French locale JSON file. Ensure the file is named according to the ISO language code (e.g., './locales/fr.json').

```json
{
  "grand_theft_auto": "vol de voiture",
  "male": "homme",
  "female": "femme",
  "suspect_sex": "le suspect est %s"
}
```

--------------------------------

### Locale Usage Example (Lua)

Source: https://overextended.dev/docs/ox_lib/Locale/Shared

Example demonstrating how to load the locale module and periodically print formatted locale strings. This includes translating 'grand_theft_auto' and constructing a 'suspect_sex' phrase.

```lua
-- Load the locale module
lib.locale()

SetInterval(function()
    print(locale('grand_theft_auto'))
    print(locale('suspect_sex', locale('male')))
end, 5000)
```

--------------------------------

### Clone and Build Ox Lib

Source: https://overextended.dev/docs/ox_lib

Instructions for cloning the Ox Lib repository, installing dependencies, and building the web assets.

```bash
git clone https://github.com/overextended/ox_lib.git
cd ox_lib/web
bun i
bun run build
```

--------------------------------

### Example: Set Specific Menu Option

Source: https://overextended.dev/docs/ox_lib/Interface/Client/menu

Demonstrates replacing the 3rd option of a menu with new label and icon properties.

```LuaJS
lib.setMenuOptions('some_menu_id', {label = 'New option', icon = 'plus'}, 3)
```

```javascript
import lib from '@overextended/ox_lib/client';

lib.setMenuOptions('some_menu_id', { label: 'New option', icon: 'plus' }, 3);
```

--------------------------------

### Build UI Source Files

Source: https://overextended.dev/docs/ox_lib

Commands to install dependencies and build UI source files for Ox Lib.

```bash
cd into the web directory.
run `bun i` to install the dependencies.
run `bun run build` to build the source files.
```

--------------------------------

### Full Progress Bar Example (LuaJS)

Source: https://overextended.dev/docs/ox_lib/Interface/Client/progress

A comprehensive example of using `lib.progressBar` in LuaJS, including animation and prop configurations. The function returns a boolean indicating completion or cancellation, which can be handled with an if-else statement.

```LuaJS
if lib.progressBar({
    duration = 2000,
    label = 'Drinking water',
    useWhileDead = false,
    canCancel = true,
    disable = {
        car = true,
    },
    anim = {
        dict = 'mp_player_intdrink',
        clip = 'loop_bottle'
    },
    prop = {
        model = `prop_ld_flow_bottle`,
        pos = vec3(0.03, 0.03, 0.02),
        rot = vec3(0.0, 0.0, -1.5)
    },
}) then print('Do stuff when complete') else print('Do stuff when cancelled') end
```

--------------------------------

### Example Pause Timer

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Demonstrates pausing a timer and its effect on the execution flow.

```lua
local timer = lib.timer(5000, function()
    print("timer ended")
end, true)

timer:pause()
```

--------------------------------

### Example: Player Permission Check

Source: https://overextended.dev/docs/ox_core/Classes/Server/OxPlayer

Demonstrates how to add a permission to a group and then check if a player has that permission. Requires 'Ox.SetGroupPermission' to be available.

```lua
-- Adding a permission to a group
Ox.SetGroupPermission('police', 1, 'handcuff', 'allow')

-- Checking if a player has the 'handcuff' permission
if player.hasPermission('group.police.handcuff') then
    -- Do something
end
```

--------------------------------

### Example Play Timer

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Shows how to resume a paused timer. Note that the remaining time is extended by the pause duration.

```lua
local timer = lib.timer(5000, function()
    print("timer ended")
end, true)

timer:pause()

Wait(1000)

timer:play()
--timer finishes in 6 seconds rather than 5 because of the pause
```

--------------------------------

### Clone Repository and Build

Source: https://overextended.dev/docs/ox_inventory

Clone the Ox Inventory repository and build the web assets. Ensure Node.js and bun are installed.

```bash
git clone https://github.com/overextended/ox_inventory.git
cd ox_inventory/web
bun i
bun run build
```

--------------------------------

### Disable Setup Notification

Source: https://overextended.dev/ox_inventory

Toggle the notification that appears when the inventory is ready to use.

```lua
setr inventory:disablesetupnotification 0
```

--------------------------------

### Module Import and Usage Example

Source: https://overextended.dev/ox_lib/Modules/Require/Shared

Demonstrates how to structure a resource with sub-modules and import them using require. The imported module's return value is used.

```lua
local mylib = {
  events = require 'data.events'
}

print('Loaded mylib')

return mylib
```

```lua
return {
  disconnect = 'onPlayerDropped',
}
```

```lua
local mylib = require '@mylib.import'
print(mylib.events.disconnect)
```

--------------------------------

### Example isPaused

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Illustrates checking the paused state of a timer before and after pausing it.

```lua
local timer = lib.timer(5000, function()
    print("timer ended")
end, true)

print(timer:isPaused()) -- false

timer:pause()

print(timer:isPaused()) -- true
```

--------------------------------

### Get Player Account

Source: https://overextended.dev/docs/ox_core/Classes/Server/OxPlayer

Retrieves the player's default OxAccount object. No specific setup is required beyond having a player object.

```javascript
player.getAccount()
```

--------------------------------

### Get Inventory Items

Source: https://overextended.dev/docs/ox_inventory/Functions/Server

Fetches all items currently present in a specified inventory. This function can be used to list the contents of an inventory, for example, the player's inventory using 'source'.

```lua
exports.ox_inventory:GetInventoryItems(inv, owner)
```

```lua
local playerItems = exports.ox_inventory:GetInventoryItems(source)
```

--------------------------------

### Create and Configure Zones

Source: https://overextended.dev/docs/ox_lib/Zones/Shared

Examples demonstrating how to create different types of zones (polygon, sphere, cuboid) and attach event handlers for entering, exiting, and being inside the zone. The 'debug' option can be enabled to visualize the zones.

```LuaTypeScript
function onEnter(self)
    print('entered zone', self.id)
end

function onExit(self)
    print('exited zone', self.id)
end

function inside(self)
    print('you are inside zone ' .. self.id)
end

local poly = lib.zones.poly({
    points = {
        vec(413.8, -1026.1, 29),
        vec(411.6, -1023.1, 29),
        vec(412.2, -1018.0, 29),
        vec(417.2, -1016.3, 29),
        vec(422.3, -1020.0, 29),
        vec(426.8, -1015.9, 29),
        vec(431.8, -1013.0, 29),
        vec(437.3, -1018.4, 29),
        vec(432.4, -1027.2, 29),
        vec(424.7, -1023.5, 29),
        vec(420.0, -1030.2, 29),
        vec(409.8, -1028.4, 29),
    },
    thickness = 2,
    debug = true,
    inside = inside,
    onEnter = onEnter,
    onExit = onExit
})

local sphere = lib.zones.sphere({
    coords = vec3(442.5363, -1017.666, 28.65637),
    radius = 1,
    debug = true,
    inside = inside,
    onEnter = onEnter,
    onExit = onExit
})

local box = lib.zones.box({
    coords = vec3(442.5363, -1017.666, 28.65637),
    size = vec3(1, 1, 1),
    rotation = 45,
    debug = true,
    inside = inside,
    onEnter = onEnter,
    onExit = onExit
})
```

```typescript
import { Zone } from "@overextended/ox_lib";
import { Vector2, Vector3 } from "@overextended/core/vector";

function onEnter(this: Zone) {
  console.log(`entered ${this.id}`)
}

function onExit(this: Zone) {
  console.log(`exited ${this.id}`)
}

function inside(this: Zone) {
  console.log(`inside ${this.id}`)
}

const shouldDraw = true;

Zone.Prism([
  new Vector2(413.8, -1026.1),
  new Vector2(411.6, -1023.1),
  new Vector2(412.2, -1018.0),
  new Vector2(417.2, -1016.3),
  new Vector2(422.3, -1020.0),
  new Vector2(426.8, -1015.9),
  new Vector2(431.8, -1013.0),
  new Vector2(437.3, -1018.4),
  new Vector2(432.4, -1027.2),
  new Vector2(424.7, -1023.5),
  new Vector2(420.0, -1030.2),
  new Vector2(409.8, -1028.4)
], 2, 29)

Zone.Sphere(new Vector3(442.5363, -1017.666, 28.65637), 1)

Zone.Cuboid(new Vector3(442.5363, -1017.666, 28.65637), 1, 1, 1)

Zone.map.forEach((zone) => {
  zone.inside = inside;
  zone.onEnter = onEnter;
  zone.onExit = onExit;
  zone.shouldDraw = shouldDraw;
})
```

--------------------------------

### Example of Data Conversion

Source: https://overextended.dev/docs/ox_inventory/Functions/Server

Illustrates the transformation of item data from an old format to the new ox_inventory format.

```lua
Old: [{"cola":1, "bread":3}]
New: [{"slot":1,"name":"cola","count":1},
{"slot":2,"name":"bread","count":3}]
```

--------------------------------

### Using lib.waitFor to Get a Value

Source: https://overextended.dev/docs/ox_lib/WaitFor/Shared

Example of using lib.waitFor to repeatedly call a function until it returns a non-nil value. The function returns 'abc' when math.random(0, 1) equals 1.

```lua
local value --[['abc']] = lib.waitFor(function()
    if math.random(0, 1) == 1 then return 'abc' end
end)
```

--------------------------------

### Get Inventory Details

Source: https://overextended.dev/docs/ox_inventory/Functions/Server

Retrieves detailed information about an inventory, optionally filtering by owner. Returns null if the inventory is not found. The example demonstrates fetching an inventory named 'example_stash' and printing its encoded JSON representation.

```lua
exports.ox_inventory:GetInventory(inv, owner)
```

```lua
local inventory = exports.ox_inventory:GetInventory('example_stash', false)
print(json.encode(inventory, {indent = true}))
--[[ 
    {
        "id": "example_stash, 
        "label": "Police Stash",
        "type": "stash, 
        "slots": 50,
        "weight": 0,
        "maxWeight": 100000,
        "owner": false,
        ...
    }
]]
```

--------------------------------

### Example: Calculate and Add Item Based on Carry Amount

Source: https://overextended.dev/docs/ox_inventory/Functions/Server

Shows how to use CanCarryAmount to determine how much of an item can be added and then uses AddItem to give the player that amount. This ensures players don't receive more than they can carry.

```lua
-- Checks how much you can carry
amountToAdd = exports.ox_inventory:CanCarryAmount(inv, 'stone')
-- Adds the amount
exports.ox_inventory:AddItem(inv, 'stone', amountToAdd)
```

--------------------------------

### Run UI Development Server

Source: https://overextended.dev/docs/ox_lib

Start the UI development server with hot reloads for browser development, or for in-game development with resource restarts.

```bash
bun start
```

```bash
bun start:game
```

--------------------------------

### Define and Extend Classes with lib.class

Source: https://overextended.dev/docs/ox_lib/Class/Shared

Demonstrates how to define a base class 'Person' and extend it to create 'Professor' and 'Student' classes. Shows constructor usage, calling superclass constructors, and defining methods. Includes examples of instantiating these classes and interacting with their properties and methods.

```lua
---@class Person : OxClass
---@field name string
local Person = lib.class('Person')

function Person:constructor(name)
    print('calling Person constructor for', name)
    self.name = name
end

-- Professor Class (extends Person)

---@class Professor : Person
---@field teaches string
local Professor = lib.class('Professor', Person)

function Professor:constructor(name, teaches)
    print('calling Professor constructor for', name)
    self:super(name)
    self.teaches = teaches
end

function Professor:introduceSelf()
    print(("My name is %s, and I will be your %s professor."):format(self.name, self.teaches))
end

function Professor:grade(paper)
    local grade = math.random(1, 4)
    print(grade)
end

CreateThread(function()
    local walter = Professor:new('Walter', 'Chemistry')

    walter:introduceSelf()
    walter:grade('my paper')
end)


-- Student Class (extends Person)

---@class Student : Person
---@field private private { year: number }
local Student = lib.class('Student', Person)

---@param name string
---@param year number
function Student:constructor(name, year)
    print('calling Student constructor for', name)
    self:super(name)
    self.private.year = year
end

function Student:introduceSelf()
    print(("Hi! I'm %s, and I'm in year %s."):format(self.name, self.private.year))
end

---@param year number
function Student:setYear(year)
    self.private.year = year
end

CreateThread(function()
    local jesse = Student:new('Jesse', 2)

    jesse:introduceSelf() -- Hi! I'm Jesse, and I'm in year 2.
    jesse:setYear(3)
    jesse:introduceSelf() -- Hi! I'm Jesse, and I'm in year 3.
    print(jesse.private.year) -- nil
    print(getmetatable(jesse.private)) -- private
    jesse.private.year = 4 -- error
end)
```

--------------------------------

### JSON Data Example

Source: https://overextended.dev/docs/ox_lib/Require/Shared

An example of a JSON structure that can be loaded by `lib.loadJson`. This structure represents event mappings.

```json
{
  "disconnect": "onPlayerDropped"
}
```

--------------------------------

### Shared Format - Queries and Values

Source: https://overextended.dev/docs/oxmysql/Functions/transaction

Example of defining queries and a shared set of parameters for a transaction.

```lua
-- You might rename "values" as "parameters" for mysql-async compatibility.
local queries = {
    'INSERT INTO `test` (id, name) VALUES (@someid, @somename)',
    'SET `name` = @newname IN `test` WHERE `id` = @someid'
}

local values = {
    someid = 2,
    somename = 'John Doe',
    newname = 'John Notdoe'
}
```

--------------------------------

### Disable Client Weapons and Setup Notification

Source: https://overextended.dev/docs/ox_inventory

Globally disable weapons for all players or suppress the inventory setup notification.

```lua
setr inventory:disableweapons 0
setr inventory:disablesetupnotification 0
```

--------------------------------

### Get All Registered Zones

Source: https://overextended.dev/docs/ox_lib/Zones/Shared

Retrieves all zones that have been registered within the system. Use this to get a complete list of available zones.

```LuaTypeScript
lib.zones.getAllZones()
```

```typescript
import { Zone } from "@overextended/ox_lib";

Zone.getAll();
```

--------------------------------

### Register and Show Client Menu (JavaScript)

Source: https://overextended.dev/docs/ox_lib/Interface/Client/menu

Register a menu with options like title, position, and callbacks for selection, scrolling, checking, and closing. Then, register a command to display the menu.

```javascript
import lib from '@overextended/ox_lib/client';

lib.registerMenu(
  {
    id: 'some_menu_id',
    title: 'Menu title',
    position: 'top-right',
    onSideScroll: (selected, scrollIndex, args) => {
      console.log('Scroll: ', selected, scrollIndex, args);
    },
    onSelected: (selected, secondary, args) => {
      if (!secondary) {
        console.log('Normal button');
      } else {
        if (args.isCheck) {
          console.log('Check button');
        }

        if (args.isScroll) {
          console.log('Scroll button');
        }
      }
      console.log(selected, secondary, JSON.stringify(args, null, 2));
    },
    onCheck: (selected, checked, args) => {
      console.log('Check: ', selected, checked, args);
    },
    onClose: (keyPressed) => {
      console.log('Menu closed');
      if (keyPressed) {
        console.log(`Pressed ${keyPressed} to close the menu`);
      }
    },
    options: [
      { label: 'Simple button', description: 'It has a description!' },
      { label: 'Checkbox button', checked: true },
      { label: 'Scroll button with icon', icon: 'arrows-up-down-left-right', values: ['hello', 'there'] },
      { label: 'Button with args', args: { someArg: 'nice_button' } },
      {
        label: 'List button',
        values: ['You', 'can', 'side', 'scroll', 'this'],
        description: 'It also has a description!',
      },
      { label: 'List button with default index', values: ['You', 'can', 'side', 'scroll', 'this'], defaultIndex: 5 },
      {
        label: 'List button with args',
        values: ['You', 'can', 'side', 'scroll', 'this'],
        args: { someValue: 3, otherValue: 'value' },
      },
    ],
  },
  (selected, scrollIndex, args) => {
    console.log(selected, scrollIndex, args);
  }
);

RegisterCommand(
  'testmenu',
  () => {
    lib.showMenu('some_menu_id');
  },
  false
);
```

--------------------------------

### Specific Format - Array of Tables

Source: https://overextended.dev/docs/oxmysql/Functions/transaction

Example of defining queries and their individual values for a transaction using an array of tables.

```lua
-- You might rename "values" as "parameters" for mysql-async compatibility.
local queries = {
    { query = 'INSERT INTO `test` (id) VALUES (?)', values = { 1 }},
    { query = 'INSERT INTO `test` (id, name) VALUES (?, ?)', values = { 2, 'bob' }},
}
```

--------------------------------

### Set Framework and Inventory Slots

Source: https://overextended.dev/docs/ox_inventory

Configure the inventory framework (e.g., 'esx', 'qbx') and the number of slots available for player inventories.

```lua
setr inventory:framework "esx"
setr inventory:slots 50
```

--------------------------------

### Install Ox Core npm Package for JavaScript

Source: https://overextended.dev/docs/ox_core

Install the ox_core npm package for use in your JavaScript resources. This package provides full TypeScript support and Intellisense.

```bash
bun i @overextended/ox_core
```

--------------------------------

### RawExecute Promise Example (Lua)

Source: https://overextended.dev/docs/oxmysql/Functions/rawExecute

Demonstrates using rawExecute with a promise-based approach in Lua to fetch user data. Ensure the 'identifier' variable is defined before execution.

```lua
local response = MySQL.rawExecute.await('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', {
    identifier
})


print(json.encode(response, { indent = true, sort_keys = true }))
```

--------------------------------

### Register Custom Stash - Server

Source: https://overextended.dev/docs/ox_inventory/Guides/stashes

Defines stash properties and registers a custom stash using `RegisterStash` on server resource start. Ensure the ox_inventory resource is started.

```lua
-- Server
local stash = {
    id = '42wallabyway',
    label = '42 Wallaby Way',
    slots = 50,
    weight = 100000,
    owner = 'char1:license'
}

AddEventHandler('onServerResourceStart', function(resourceName)
    if resourceName == 'ox_inventory' or resourceName == GetCurrentResourceName() then
        exports.ox_inventory:RegisterStash(stash.id, stash.label, stash.slots, stash.weight, stash.owner)
    end
end)

-- Client
exports.ox_inventory:openInventory('stash', {id='42wallabyway', owner=property.owner})
```

--------------------------------

### Register a Basic Context Menu

Source: https://overextended.dev/docs/ox_lib/Interface/Client/context

This snippet shows the basic syntax for registering a context menu. Ensure you have imported the lib from '@overextended/ox_lib/client'.

```Lua
lib.registerContext(context)
```

```javascript
import lib from '@overextended/ox_lib/client';

lib.registerContext(context);
```

--------------------------------

### Get Time Left

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Returns the remaining time on the timer. The `format` parameter specifies the unit ('ms', 's', 'm', 'h'), or nil to get all units in a table.

```lua
timer:getTimeLeft(format)
```

--------------------------------

### Register and Show Client Menu (Lua)

Source: https://overextended.dev/docs/ox_lib/Interface/Client/menu

Register a menu with options like title, position, and callbacks for selection, scrolling, checking, and closing. Then, register a command to display the menu.

```lua
lib.registerMenu({
    id = 'some_menu_id',
    title = 'Menu title',
    position = 'top-right',
    onSideScroll = function(selected, scrollIndex, args) 
        print("Scroll: ", selected, scrollIndex, args)
    end,
    onSelected = function(selected, secondary, args) 
        if not secondary then
            print("Normal button")
        else
            if args.isCheck then
                print("Check button")
            end

            if args.isScroll then
                print("Scroll button")
            end
        end
        print(selected, secondary, json.encode(args, {indent=true}))
    end,
    onCheck = function(selected, checked, args) 
        print("Check: ", selected, checked, args)
    end,
    onClose = function(keyPressed) 
        print('Menu closed')
        if keyPressed then
            print(('Pressed %s to close the menu'):format(keyPressed))
        end
    end,
    options = {
        {label = 'Simple button', description = 'It has a description!'},
        {label = 'Checkbox button', checked = true},
        {label = 'Scroll button with icon', icon = 'arrows-up-down-left-right', values={'hello', 'there'}},
        {label = 'Button with args', args = {someArg = 'nice_button'}},
        {label = 'List button', values = {'You', 'can', 'side', 'scroll', 'this'}, description = 'It also has a description!'},
        {label = 'List button with default index', values = {'You', 'can', 'side', 'scroll', 'this'}, defaultIndex = 5},
        {label = 'List button with args', values = {'You', 'can', 'side', 'scroll', 'this'}, args = {someValue = 3, otherValue = 'value'}},
    }
}, function(selected, scrollIndex, args)
    print(selected, scrollIndex, args)
end)

RegisterCommand('testmenu', function()
    lib.showMenu('some_menu_id')
end)
```

--------------------------------

### Skill Check Usage Example

Source: https://overextended.dev/docs/ox_lib/Interface/Client/skillcheck

Demonstrates how to call `lib.skillCheck` with a mix of preset and custom difficulties, along with specific input keys.

```Lua
local success = lib.skillCheck({'easy', 'easy', {areaSize = 60, speedMultiplier = 2}, 'hard'}, {'w', 'a', 's', 'd'})
```

```javascript
import lib from '@overextended/ox_lib/client';

const success = await lib.skillCheck(
  ['easy', 'easy', { areaSize: 60, speedMultiplier: 2 }, 'hard'],
  ['w', 'a', 's', 'd']
);
```

--------------------------------

### Scaleform Usage Examples

Source: https://overextended.dev/docs/ox_lib/Scaleform/Client

Demonstrates various methods for interacting with a Scaleform instance, including calling methods, setting properties, and managing drawing states.

```lua
local scaleform = lib.scaleform:new({
  name = 'scaleform',
  fullScreen = boolean,
  x = 1.0,
  y = 1.0,
  width = 2.0,
  height = 2.0,
  renderTarget = {
    name = 'target',
    model = `model_name`
  }
})

-- Call a Scaleform Method
scaleform:callMethod('method', { 1, 2, 3 })

-- Set Fullscreen Scaleform
scaleform:setFullScreen(false)

-- Set Scaleform Properties (x, y, width, height)
scaleform:setProperties(1.0, 1.0, 2.0, 2.0)

-- Set Scaleform Render Target
scaleform:setRenderTarget('target', `model_name`)

-- Get Drawing State
local state = scaleform:isDrawing()

-- Draw
scaleform:draw()

-- Start Drawing
scaleform:startDrawing()

-- Stop Drawing
scaleform:stopDrawing()

-- Dispose of Scaleform
scaleform:dispose()
```

--------------------------------

### Get All or Specific Item Data

Source: https://overextended.dev/docs/ox_inventory/Functions/Server

Retrieves registered item data. Optionally specify an item name to get data for only that item. Fetching all data is not recommended for performance reasons.

```lua
exports.ox_inventory:Items(itemName)
```

--------------------------------

### Usage Example for lib.load

Source: https://overextended.dev/docs/ox_lib/Require/Shared

Loads a Lua file using `lib.load` and prints a confirmation message. This is useful for dynamically loading scripts that should not be cached.

```lua
local events = lib.load('data.events')

print('Loaded events')
```

--------------------------------

### Custom Styled TextUI Example

Source: https://overextended.dev/docs/ox_lib/Interface/Client/textui

Demonstrates how to customize the TextUI's appearance using the options table, including position, icon, and inline styles.

```LuaJS
lib.showTextUI('[E] - Pick apple', {
    position = "top-center",
    icon = 'hand',
    style = {
        borderRadius = 0,
        backgroundColor = '#48BB78',
        color = 'white'
    }
})
```

```javascript
import lib from '@overextended/ox_lib/client';

lib.showTextUI('[E] - Pick apple', {
  position: 'top-center',
  icon: 'hand',
  style: {
    borderRadius: 0,
    backgroundColor: '#48BB78',
    color: 'white',
  },
});
```

--------------------------------

### Create Metadata Item Example

Source: https://overextended.dev/docs/ox_inventory/Guides/metadata

Define a shop entry for a 'pokemon_card' with specific metadata, such as label, description, image, and custom stats.

```lua
inventory = {
    {name = 'pokemon_card', price = 300, metadata = {
        label = 'Charizard',
        description = 'It is said that Charizard’s fire burns hotter if it has experienced harsh battles.',
        image = 'panties',
        type = 'Fire',
        hp = 78,
        attack = 84,
        defense = 78
    }}
}
```

--------------------------------

### Prepare Query with Callback (Lua)

Source: https://overextended.dev/docs/oxmysql/Functions/prepare

Use this when you need to execute a prepared query and handle the response using a callback function. The callback receives the query results.

```Lua
MySQL.prepare('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', {
    identifier
}, function(response)
    print(json.encode(response, { indent = true, sort_keys = true }))
end)
```

--------------------------------

### Example: Registering a Client Callback

Source: https://overextended.dev/docs/ox_lib/Callback/JavaScript/Client

Register a client-side handler for the 'test:client' event. This function logs received arguments and returns a client-specific value.

```javascript
onServerCallback("test:client", (\(...args: [number, number, string]) => {
  console.log(args);
  return {
    clientValue: "Value from the client",
  };
});
```

--------------------------------

### get

Source: https://overextended.dev/docs/ox_lib/Ped

Retrieves a value from the entity's statebag.

```APIDOC
## get

### Description
Returns a value from the entity's statebag.

### Method
`entity:get(key)` or `entity.get(key)`

### Parameters
* **key** (`string`) - Required - The key of the statebag entry to retrieve.

### Returns
* `unknown` - The value associated with the key.
```

--------------------------------

### getCoords

Source: https://overextended.dev/docs/ox_lib/Prop

Gets the entity's current coordinates.

```APIDOC
## getCoords

### Description
Gets the entity's current coordinates.

### Returns
- **Vector3** - The entity's current coordinates.
```

--------------------------------

### get

Source: https://overextended.dev/docs/ox_lib/Prop

Returns a value from the entity's statebag.

```APIDOC
## get

### Description
Returns a value from the entity's statebag.

### Parameters
#### Path Parameters
- **key** (string) - Required - The key of the statebag entry to retrieve.

### Returns
- **unknown** - The value associated with the key.
```

--------------------------------

### Enable Client Key Actions

Source: https://overextended.dev/docs/ox_inventory

Enable specific control actions to be triggered when the inventory is open.

```lua
setr inventory:enablekeys [249]
```

--------------------------------

### timer:restart

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Resets the timer to its initial duration and starts it again.

```APIDOC
## timer:restart

### Description
Resets and starts the timer.

### Signature
```
timer:restart()
```

### Example
```lua
-- this will create a timer that just keeps restarting itself
local timer

timer = lib.timer(5000, function()
    print("timer ended")
    timer:restart()
end, true)

```
```

--------------------------------

### Restart a Timer

Source: https://overextended.dev/docs/ox_lib/Timer/Shared

Resets and starts the timer again from its initial duration.

```lua
timer:restart()
```

--------------------------------

### getRoutingBucket

Source: https://overextended.dev/docs/ox_lib/Prop

Gets the entity's current routing bucket.

```APIDOC
## getRoutingBucket

### Description
Gets the entity's current routing bucket.

### Returns
- **number** - The entity's current routing bucket ID.
```

--------------------------------

### Full Radial Menu Usage Example

Source: https://overextended.dev/docs/ox_lib/Interface/Client/radial

Demonstrates registering a radial menu ('police_menu') with multiple items, including one that opens a sub-menu and another with an inline select function. It also shows adding global radial items and dynamically adding/removing an item based on player proximity using the points system.

```LuaJS
exports('myMenuHandler', function(menu, item)
    print(menu, item)

    if menu == 'police_menu' and item == 1 then
        print('Handcuffs')
    end
end)

lib.registerRadial({
  id = 'police_menu',
  items = {
    {
      label = 'Handcuff',
      icon = 'handcuffs',
      onSelect = 'myMenuHandler'
    },
    {
      label = 'Frisk',
      icon = 'hand'
    },
    {
      label = 'Fingerprint',
      icon = 'fingerprint'
    },
    {
      label = 'Jail',
      icon = 'bus'
    },
    {
      label = 'Search',
      icon = 'magnifying-glass',
      onSelect = function()
        print('Search')
      end
    }
  }
})

lib.addRadialItem({
  {
    id = 'police',
    label = 'Police',
    icon = 'shield-halved',
    menu = 'police_menu'
  },
  {
    id = 'business_stuff',
    label = 'Business',
    icon = 'briefcase',
    onSelect = function()
      print("Business")
    end
  }
})

local coords = GetEntityCoords(cache.ped)
local point = lib.points.new(coords, 5)

function point:onEnter()
  lib.addRadialItem({
    id = 'garage_access',
    icon = 'warehouse',
    label = 'Garage',
    onSelect = function()
      print('Garage')
    end
  })
end

function point:onExit()
  lib.removeRadialItem('garage_access')
end
```

```javascript
import lib from '@overextended/ox_lib/client'

exports('myMenuHandler', (menu, item) => {
    console.log(menu, item)

    if (menu === 'police_menu' and item === 1) {
        console.log('Handcuffs')
    }
})

lib.registerRadial({
  id: 'police_menu',
  items: [
    {
      label: 'Handcuff',
      icon: 'handcuffs',
      onSelect: 'myMenuHandler'
    },
    {
      label: 'Frisk',
      icon: 'hand'
    },
    {
      label: 'Fingerprint',
      icon: 'fingerprint'
    },
    {
      label: 'Jail',
      icon: 'bus'
    },
    {
      label: 'Search',
      icon: 'magnifying-glass',
      onSelect: () => {
        console.log('Search')
      }
    }
  ]
})

lib.addRadialItem([
  {
    id: 'police',
    label: 'Police',
    icon: 'shield-halved',
    menu: 'police_menu'
  },
  {
    id: 'business_stuff',
    label: 'Business',
    icon: 'briefcase',
    onSelect: () => {
      console.log('Business')
    }
  }
])
```

--------------------------------

### getModel

Source: https://overextended.dev/docs/ox_lib/Prop

Gets the entity's current model hash.

```APIDOC
## getModel

### Description
Gets the entity's current model hash.

### Returns
- **number** - The entity's model hash.
```

--------------------------------

### Get Vehicle Coordinates

Source: https://overextended.dev/docs/ox_core/Classes/Server/OxVehicle

Returns the current coordinates of the vehicle.

```javascript
vehicle.getCoords()
```

--------------------------------

### getHeading

Source: https://overextended.dev/docs/ox_lib/Prop

Gets the entity's current heading (or yaw) in degrees.

```APIDOC
## getHeading

### Description
Gets the entity's current heading (or yaw) in degrees.

### Returns
- **number** - The entity's current heading in degrees.
```

--------------------------------

### Set Custom Framework

Source: https://overextended.dev/docs/ox_inventory

Use this command to set the target framework to 'custom' when integrating with an unsupported system.

```shell
setr inventory:framework "custom"
```

--------------------------------

### Get Entity Model Hash

Source: https://overextended.dev/docs/ox_lib/Ped

Retrieves the model hash of the entity.

```lua
entity:getModel()
```

```typescript
entity.getModel()
```

--------------------------------

### OxVehicle.get

Source: https://overextended.dev/docs/ox_core/Classes/Server/OxVehicle

Get the value of a specific key from the vehicle's metadata.

```APIDOC
## OxVehicle.get

### Description
Get the value of a specific key from the vehicle's metadata.

### Method
`get(key)`

### Parameters
#### Query Parameters
- **key** (string) - Required - The metadata key to retrieve the value for.

### Returns
#### Success Response
- `unknown` - The value associated with the provided key.
```

--------------------------------

### Set Framework and Inventory Slots

Source: https://overextended.dev/ox_inventory

Configure the inventory framework (e.g., 'esx') and the number of player inventory slots. Ensure the framework is supported.

```lua
setr inventory:framework "esx"

setr inventory:slots 50
```

--------------------------------

### Registered Hooks

Source: https://overextended.dev/docs/ox_lib/Hooks

Examples of pre-registered hooks managed by ox_lib that other resources can interact with.

```APIDOC
## Registered Hooks

These hook pipelines are registered and managed by ox_lib for other resources to interact with. See EventHook for more information.

### ox_lib:setPlayerState
This hook is used when `sv_stateBagStrictMode` is enabled, preventing arbitrary modification of player states. Changes are rejected by default if they don't pass the predicate.

#### Usage
```lua
lib.registerHook('ox_lib:setPlayerState', predicate, { key: state })
```
```typescript
import { registerHook } from "@overextended/ox_lib/hooks";

registerHook('ox_lib:setPlayerState', predicate, { key: state });
```

### ox_lib:setEntityState
This hook is used when `sv_stateBagStrictMode` is enabled, preventing arbitrary modification of entity states. Changes are rejected by default if they don't pass the predicate.

#### Usage
```lua
lib.registerHook('ox_lib:setEntityState', predicate, { key: state })
```
```typescript
import { registerHook } from "@overextended/ox_lib/hooks";

registerHook('ox_lib:setEntityState', predicate, { key: state });
```
```

--------------------------------

### Example: Manage Item Addition Based on Weight Capacity

Source: https://overextended.dev/docs/ox_inventory/Functions/Server

Demonstrates how to use CanCarryWeight to check weight capacity and adjust the amount of an item to be added if the full amount cannot be carried. This prevents errors related to exceeding weight limits.

```lua
-- Checks if player can carry 1000 grams.
local fillAmount = 1000
local canCarryWeight, freeWeight = ox_inventory:CanCarryWeight(playerId, fillAmount)

if freeWeight == 0 then
  -- Player can't carry weight.
  return
elseif not canCarryWeight then
  -- Modify fillAmount, because inventory can't carry specified weight
  fillAmount = freeWeight
end

-- Do something
```

--------------------------------

### Client-Side Inventory Settings

Source: https://overextended.dev/ox_inventory

Configure client-side inventory behaviors including image path, auto-reload, screen blur, and hotkeys.

```lua
setr inventory:imagepath "nui://ox_inventory/web/images"

setr inventory:autoreload false

setr inventory:screenblur true

setr inventory:keys ["F2", "K", "TAB"]
```

--------------------------------

### Get Vehicle Plate

Source: https://overextended.dev/docs/ox_lib/Vehicle

Retrieves the number plate text displayed on the vehicle.

```lua
entity:getPlate()
```

```typescript
entity.getPlate()
```

--------------------------------

### Get Entity Heading

Source: https://overextended.dev/docs/ox_lib/Ped

Retrieves the current heading (yaw) of the entity in degrees.

```lua
entity:getHeading()
```

```typescript
entity.getHeading()
```

--------------------------------

### Prepare (Callback)

Source: https://overextended.dev/docs/oxmysql/Functions/prepare

Executes a prepared SQL statement using a callback function. It takes the SQL query, an array of parameters, and a callback function that receives the response.

```APIDOC
## prepare (Callback)

### Description
Executes a prepared SQL statement using a callback function. It takes the SQL query, an array of parameters, and a callback function that receives the response.

### Method
`MySQL.prepare(query: string, params: any[], callback: function)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```lua
MySQL.prepare('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', {
    identifier
}, function(response)
    print(json.encode(response, { indent = true, sort_keys = true }))
end)
```
```javascript
MySQL.prepare('SELECT `firstname`, `lastname` FROM `users` WHERE `identifier` = ?', [
  identifier
], (response) => {
  console.log(JSON.stringify(response))
})
```

### Response
#### Success Response
The callback function receives the query results. The structure of the response depends on the SELECT statement (column, row, or array of rows).

#### Response Example
```json
{
    "example": "response body"
}
```

### Aliases
* `exports.oxmysql.prepare`
```

--------------------------------

### Get Group Account

Source: https://overextended.dev/docs/ox_core/Functions/server

Retrieves the `OxAccount` object for a specified group name.

```javascript
Ox.GetGroupAccount(groupName)
```
Tokens:
Raw