ND-Framework

https://ndcore.dev/
Admin
ND-Framework is a multipurpose, secure, and optimized framework for game servers, featuring a...
Tokens:16,467
Snippets:210
Trust Score:6.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Configure Resource Start Order

Source: https://ndcore.dev/addons/characters

Add these lines to your server.cfg to ensure dependencies are loaded before the character resource.

```text
start fivem-appearance
start ND_Characters
```

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

### Configure Resource Start Order

Source: https://ndcore.dev/setup

Define the required resource load order in your server.cfg file to ensure dependencies are initialized before ND_Core.

```text
start oxmysql
start ox_lib
start ND_Core
# all other resources below
```

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

### Get Player Server Information

Source: https://ndcore.dev/core/server/functions

Retrieves identifiers and Discord information for a given player source.

```lua
local info = NDCore.getPlayerServerInfo(source)
```

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

### ND_Core Configuration File

Source: https://ndcore.dev/setup

Contains server settings, Discord integration, gameplay mechanics, and group definitions. Ensure this file is executed in server.cfg before the resource starts.

```text
# Your servers name
setr core:serverName "My FiveM Server"
 
# Discord invite link
setr core:discordInvite "https://discord.gg/Z9Mxu72zZ6"
 
# Discord app id for rich presence
setr core:discordAppId "858146067018416128"
 
# Images for discord rich presence
setr core:discordAsset "andyyy"
setr core:discordAssetSmall "andyyy"
 
# Buttons for discord rich presence
setr core:discordActionText "DISCORD"
setr core:discordActionLink "https://discord.gg/Z9Mxu72zZ6"
 
setr core:discordActionText2 "STORE"
setr core:discordActionLink2 "https://andyyy.tebex.io/category/fivem-scripts"
 
# Used for getting users roles from your server, this can be useful for discord based scripts, if you don't add then it won't be used.
# set core:discordGuildId "123456789012345678"
# set core:discordBotToken "EXAMPLE_TOKEN.abc123.xyz456"
 
# if set to true, and you have your discord token connected, users will have to join your discord to join your fivem server.
set core:discordMemeberRequired false
 
# The identifier to use for characters. Players aren't allowed to join without it, license is good don't change unless you know what you're doing.
set core:characterIdentifier "license"
 
# disable vehicle air contorl for cars and other land vehicles that's not supposed to do flips in air.
setr core:disableVehicleAirControl true
 
# % chance of random vehicles being unlocked.
setr core:randomUnlockedVehicleChance 30
 
# if true player must either hotwire a vehicle or have keys to start the engine.
setr core:requireKeys true
 
# If true it will use ox_inventory keys item for vehicles, if false it will use a keybind.
setr core:useInventoryForKeys true
 
# You can set admins here by their identifiers, admins will receive admin group in core and have access to group.admin ace perms.
# You can also use Discord role ids, Admins get access to commands and more.
set core:admins ["fivem:1459624", "fivem:1152629"]
set core:adminDiscordRoles ["944284542758449212", "93422454258349612", "93345451558145232"]
 
# Give groups for roles, this could be any group. If they player has the discord role they receive the group and ace perm with the same name.
set core:groupRoles {
    "staff": ["955176855474929694", "1010595496915648624"]
}
 
# Compatibility with other frameworks, backwards is NDCore v1, if you're not using any of these compatible frameworks then remove them from this list. Available compatibility: ["backwards", "esx", "qb"]
setr core:compatibility ["backwards"]
 
# Allow ox_lib to use commands, don't remove this!
add_ace resource.ox_lib command.add_ace allow
add_ace resource.ox_lib command.remove_ace allow
add_ace resource.ox_lib command.add_principal allow
add_ace resource.ox_lib command.remove_principal allow
 
# This is jobs, gangs, police, fire, ambulance, everything.
# minumumBossRank is the mimimum rank a player becomes boss as, some scripts may utilize boss for different permissions.
# Rank number is counted from left to right.
setr core:groups {
    "unemployed": {
        "label": "Unemployed",
        "minimumBossRank": 1,
        "ranks": ["Unemployed"]
    },
    "sahp": {
        "label": "SAHP",
        "minimumBossRank": 5,
        "ranks": ["Trooper", "Senior Trooper", "Corporal", "Sergeant", "Lieutenant", "Chief"]
    },
    "lspd": {
        "label": "LSPD",
        "minimumBossRank": 5,
        "ranks": ["Officer", "Senior officer", "Corporal", "Sergeant", "Lieutenant", "Chief"]
    },
    "bcso": {
        "label": "BCSO",
        "minimumBossRank": 5,
        "ranks": ["Officer", "Senior officer", "Corporal", "Sergeant", "Lieutenant", "Chief"]
    },
    "swat": {
        "label": "SWAT",
        "minimumBossRank": 3,
        "ranks": ["Member", "Sniper", "Team lead", "Commander"]
    },
    "lsfd": {
        "label": "LSFD",
        "minimumBossRank": 5,
        "ranks": ["Volunteer", "Firefighter", "Senior firefighter", "Lieutenant", "Fire Chief"]
    },
    "ballas": {
        "label": "Ballas",
        "minimumBossRank": 2,
        "ranks": ["Member", "Leader"]
    },
    "families": {
        "label": "Families",
        "minimumBossRank": 2,
        "ranks": ["Member", "Leader"]
    },
    "cartel": {
        "label": "Madrazo Cartel",
        "minimumBossRank": 2,
        "ranks": ["Member", "Leader"]
    }
}
```

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

### Get player license

Source: https://ndcore.dev/core/server/player

Retrieves specific license data for a player using an identifier.

```lua
player.getLicense(identifier)
```

```lua
local player = NDCore.getPlayer(source)
local licenses = player.getMetadata("licenses") or {}
local driverLicense = nil
for i=1, #licenses do
    local license = licenses[i]
    if licenses.type == "driver" then
        driverLicense = licenses.identifier
        break
    end
end
 
if driverLicense then
    local license = player.getLicense(driverLicense)
    print(json.encode(license, {indent=true}))
    --[[
        type = "driver",
        status = "valid",
        issued = 123123,
        expires = 123123,
        identifier = 123abc123abc
    ]]
end
```

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

### Get all character vehicles

Source: https://ndcore.dev/core/server/functions

Retrieves a list of all vehicles owned by a specific character.

```lua
NDCore.getVehicles(characterId)
```

```lua
local player = NDCore.getPlayer(source)
local vehicles = NDCore.getVehicles(player.id)
for i=1, #vehicles do
    local veh = vehicles[i]
    print(json.encode(veh, {indent=true}))
    --[[
        {
            id = 5,
            owner = 25,
            plate = "1234ABCD",
            properties = json.decode(vehicle.properties) or {},
            stored = true,
            impounded = false,
            stolen = false,
            available = true
        }
    ]]
end
```

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

### Get player group information

Source: https://ndcore.dev/core/server/player

Retrieves group data for a specific character by name.

```lua
player.getGroup(name)
```

```lua
local player = NDCore.getPlayer(source)
local group = player.getGroup("swat")
print(json.encode(group, {indent=true}))
--[[
    label = "SWAT",
    rankName = "Commander",
    rank = 4,
    isJob = nil
]]
```

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

### NDCore.isResourceStarted

Source: https://ndcore.dev/core/shared/functions

Checks if a specific resource is currently started. Supports an optional callback function to handle state changes.

```APIDOC
## NDCore.isResourceStarted(resourceName, cb)

### Description
Checks if a resource is started. This function also supports a callback for when the resource's state changes.

### Parameters
- **resourceName** (string) - Required - The name of the resource to check.
- **cb** (function) - Optional - A callback function triggered when the resource state changes.

### Returns
- **started** (boolean) - Returns true if the resource is started, otherwise false.

### Example
```lua
-- Basic check
local started = NDCore.isResourceStarted("ND_Fuel")
print(started)

-- Check with callback
NDCore.isResourceStarted("ND_Fuel", function(started)
    print("ND_Fuel status started:", started)
end)
```
```

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

### Get vehicle data by ID

Source: https://ndcore.dev/core/server/functions

Retrieves vehicle information using a unique vehicle ID.

```lua
local vehicle = NDCore.getVehicleById(id)
print(json.encode(vehicle, {indent=true}))
--[[
    {
        id = 5,
        owner = 25,
        plate = "1234ABCD",
        properties = json.decode(vehicle.properties) or {},
        stored = true,
        impounded = false,
        stolen = false,
        available = true
    }
]]
```

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

### Get player job information

Source: https://ndcore.dev/core/server/player

Retrieves the current job name and associated job information for the player.

```lua
player.getJob()
```

```lua
local player = NDCore.getPlayer(source)
local jobName, jobInfo = player.getJob()
```

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

### Get vehicle from entity

Source: https://ndcore.dev/core/server/functions

Retrieves an NDCore vehicle object from a game entity.

```lua
local vehicle = NDCore.getVehicle(entity)
```

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

### Get Player Data

Source: https://ndcore.dev/core/server/functions

Retrieves the player object containing data and functions for a specific source.

```lua
local player = NDCore.getPlayer(source)
```

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

### Get Discord Information

Source: https://ndcore.dev/core/server/functions

Retrieves Discord user details including nickname and roles by Discord user ID.

```lua
local discordInfo = NDCore.getDiscordInfo(discordUserId)
```

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

### Get Players From Coordinates

Source: https://ndcore.dev/core/client/functions

Returns the local playerId of the closest player within a specified distance from given coordinates. Only detects players known to the client.

```lua
local closestPlayer = NDCore.getPlayersFromCoords(distance, coords)
```

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

### Get Multiple Players

Source: https://ndcore.dev/core/server/functions

Retrieves a list of active players, optionally filtered by key-value pairs and returned as an array or object.

```lua
NDCore.getPlayers(key, value, returnArray)
```

```lua
local players = NDCore.getPlayers("job", "windowcleaner", true)
for i=1, #players do
    local ply = players[i]
    print(ply.fullname)
end
```

```lua
local players = NDCore.getPlayers("job", "windowcleaner", false)
for playerSource, playerData in pairs(players) do
    print(playerData.fullname)
end
```

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

### Get Player Data

Source: https://ndcore.dev/core/client/functions

Retrieves the current player object containing data without attached player functions.

```lua
local player = NDCore.getPlayer()
```

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

### player.createLicense()

Source: https://ndcore.dev/core/server/player

Creates a new license for the character.

```APIDOC
## player.createLicense(licenseType, expire)

### Description
Create a license for the character, this can be any type of license.

### Parameters
- **licenseType** (string) - Required - The type of license (e.g., "driver", "weapon").
- **expire** (number) - Optional - Expiration timestamp. Defaults to one month if not provided.
```

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

### Load SQL File

Source: https://ndcore.dev/core/server/functions

Executes an oxmysql query from a specified SQL file.

```lua
local success = NDCore.loadSQL(fileLocation, resource)
```

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

### ND Main Recipe URL

Source: https://ndcore.dev/setup

Use this URL in the txAdmin 'Remote URL Template' field to deploy the full ND Framework experience.

```text
https://raw.githubusercontent.com/ND-Framework/txadmin-recipe/main/nd-main.yaml
```

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

### Create player license

Source: https://ndcore.dev/core/server/player

Registers a new license for a character. If no expiration is provided, it defaults to one month.

```lua
player.createLicense(licenseType, expire)
```

```lua
-- create a driver license that expires in a month.
player.createLicense("driver", os.time()+2592000)
```

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

### NDCore.createVehicle

Source: https://ndcore.dev/core/server/functions

Spawns a new vehicle with the provided configuration.

```APIDOC
## NDCore.createVehicle(info)

### Description
Spawns a vehicle. If no vehicleId is passed a temporary one will be created.

### Parameters
- **info** (table) - Required - Configuration object containing owner, vehicleId, properties, coords, heading, model, keys, and source.

### Returns
- **vehicle** (table) - The created vehicle object.
```

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

### Configure NPWD Framework

Source: https://ndcore.dev/addons/phone

Set the framework variable in your server configuration file to enable ND Core integration.

```cfg
set npwd:framework ndcore
```

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

### NDCore.loadSQL

Source: https://ndcore.dev/core/server/functions

Executes an SQL file query.

```APIDOC
## NDCore.loadSQL(fileLocation, resource)

### Description
Runs an oxmysql query for the content in an SQL file.

### Parameters
- **fileLocation** (string) - Required - Path to the SQL file.
- **resource** (string) - Required - The resource name.

### Returns
- **success** (boolean) - True if the query executed successfully.
```

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

### Configure NPWD Database

Source: https://ndcore.dev/addons/phone

Define the database schema settings in the configuration file to map player data to the phone system.

```json
"database": {
    "useIdentifierPrefix": true,
    "playerTable": "nd_characters",
    "identifierColumn": "identifier",
    "identifierType": "license",
    "profileQueries": true,
    "phoneNumberColumn": "phonenumber"
},
```

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

### Create AI Ped

Source: https://ndcore.dev/core/client/functions

Spawns a static NPC with optional blip, animation, and interaction settings.

```lua
NDCore.createAiPed(info)
```

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

### Create New Character

Source: https://ndcore.dev/core/server/functions

Creates a new player character in the database and returns the player object.

```lua
NDCore.newCharacter(source, info)
```

```lua
local player = NDCore.newCharacter(source, {
    firstname = "John",
    lastname = "Doe",
    dob = "29/03/1999",
    gender = "male",
    cash = 2500,
    bank = 8000
})
 
print(player.firstname) -- John
```

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

### player.getLicense()

Source: https://ndcore.dev/core/server/player

Retrieves license data for a specific identifier.

```APIDOC
## player.getLicense(identifier)

### Description
Get a license from the player.

### Parameters
- **identifier** (string) - Required - The unique identifier of the license.

### Returns
- **data** (table) - The license data object.
```

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

### Configure MDT inventory item

Source: https://ndcore.dev/addons/mdt

Add this item definition to your inventory configuration to enable the use of the MDT tablet.

```lua
["mdt"] = {
    label = "MDT",
    weight = 800,
    client = {
        export = "ND_MDT.useTablet"
    }
}
```

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

### Open Wardrobe Export

Source: https://ndcore.dev/addons/appearanceshops

Use this export to trigger the wardrobe interface, useful for house scripts or other custom locations.

```lua
exports["ND_AppearanceShops"]:openWardrobe()
```

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

### Importing NDCore in fxmanifest.lua

Source: https://ndcore.dev/core

Methods for importing NDCore shared, server, or client scripts into your resource manifest.

```lua
shared_script "@ND_Core/init.lua"
```

```lua
shared_scripts {
    "@ND_Core/init.lua"
}
```

```lua
server_script "@ND_Core/init.lua"
```

```lua
client_script "@ND_Core/init.lua"
```

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

### player.updateLicense()

Source: https://ndcore.dev/core/server/player

Updates the data for an existing player license.

```APIDOC
## player.updateLicense(identifier, newData)

### Description
Update a players license data.

### Parameters
- **identifier** (string) - Required - The unique identifier of the license.
- **newData** (table) - Required - The new data to update the license with.
```

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

### Enable Multi-Character

Source: https://ndcore.dev/core/server/functions

Toggles multi-character support, which is disabled by default.

```lua
NDCore.enableMultiCharacter(enable)
```

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

### Fetch All Characters

Source: https://ndcore.dev/core/server/functions

Retrieves all characters owned by a specific player source.

```lua
local characters = NDCore.fetchAllCharacters(source)
```

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

### NDCore.giveVehicleAccess

Source: https://ndcore.dev/core/server/functions

Grants a player keys to a specific vehicle.

```APIDOC
## NDCore.giveVehicleAccess(source, vehicle, access)

### Description
Give a player keys to a vehicle.

### Parameters
- **source** (number) - Required - The player source ID.
- **vehicle** (entity) - Required - The vehicle entity.
- **access** (boolean) - Required - Whether to grant or revoke access.
```

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

### Configure NOS inventory item

Source: https://ndcore.dev/addons/nitro

Add this item definition to your ox_inventory items configuration to enable the NOS bottle.

```lua
["nos"] = {
    label = "NOS Bottle",
    weight = 2000,
    stack = false,
    close = true,
    client = {
        disable = { move = true, car = true, combat = true },
        usetime = 3500,
        cancel = true,
        export = "ND_Nitro.nos"
    }
},
```

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

### NDCore.createAiPed

Source: https://ndcore.dev/core/client/functions

Creates a static NPC that can be interacted with.

```APIDOC
## NDCore.createAiPed

### Description
Create a static npc that can be interacted with.

### Parameters
- **info** (table) - Configuration object containing:
  - **model** (string|number) - The ped model.
  - **blip** (table) - Blip configuration (sprite, scale, color, label, groups).
  - **anim** (table) - Animation configuration (dict, clip).
  - **options** (table) - Interaction options (ox_target).

### Returns
- **id** (number) - The ID of the created AI ped.
```

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

### Create a dispatch via export

Source: https://ndcore.dev/addons/mdt

Use this export to trigger a new dispatch call within the MDT system. The location field is optional if coordinates are provided.

```lua
exports["ND_MDT"]:createDispatch({
    caller = "John Doe",
    location = "Sandy shores", -- not required
    callDescription = "Whiteness bank robbery",
    coords = vec3(x, y, z) -- if this is used and location isn't used then it will still display the location from these coords.
})
```

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

### Configure Character Spawn Locations

Source: https://ndcore.dev/addons/characters

Define spawn points categorized by job. Characters always see DEFAULT spawns, plus any job-specific locations.

```lua
spawns = {
    ["DEFAULT"] = {
        {label = "Dream View Motel (Paleto Bay)", coords = vec4(-102.78, 6336.28, 31.49, 0)},
        {label = "Eastern Motel (Sandy Shores)", coords = vec4(343.53, 2636.94, 43.94, 0)},
        {label = "Legion Square", coords = vec4(196.96, -934.54, 29.69, 0)},
        {label = "Del Perro Pier", coords = vec4(-1616.69, -1073.81, 12.15, 0)},
        {label = "LSIA", coords = vec4(-1039.65, -2741.02, 12.89, 0)}
    },
    ["Police"] = {
        {label = "Paleto Bay Sheriff", coords = vec4(-447.2, 6009.4, 30.72, 0)},
        {label = "Sandy Shores Sheriff", coords = vec4(1849.4, 3688.6, 33.27, 0)},
        {label = "Mission Row PD", coords = vec4(437.6, -986.6, 29.69, 0)}
    }
}
```

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

### Define Character Jobs

Source: https://ndcore.dev/addons/characters

Configure available jobs and their required Discord role IDs. Setting the ID to "0" grants access to all players.

```lua
jobs = {
    ["Unemplyed"] = {"0"}, -- everyone can select Uneployed.
    ["Police"] = {
        "872921520719142932", -- players with these two discord roles can only select Police.
        "872921520719142932"
    }
}
```

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

### Configure Bank Transaction Limits

Source: https://ndcore.dev/addons/banking

Sets the maximum and minimum limits for bank withdrawals and deposits.

```lua
maxWithdrawDepositBank = 50000
```

```lua
minWithdrawDepositBank = 1000
```

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

### Accessing NDCore Exports

Source: https://ndcore.dev/core

Techniques for retrieving player data using NDCore exports in client scripts.

```lua
local player = exports["ND_Core"]:getPlayer()
 
print(player.firstname)
```

```lua
local NDCore = exports["ND_Core"]
 
local player = NDCore:getPlayer()
 
print(player.firstname)
```

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

### Check resource status with NDCore.isResourceStarted

Source: https://ndcore.dev/core/shared/functions

Determines if a specific resource is currently running. Returns a boolean value indicating the current state.

```lua
local started = NDCore.isResourceStarted(resourceName, cb)
```

```lua
local started = NDCore.isResourceStarted("ND_Fuel")
print(started)
```

```lua
NDCore.isResourceStarted("ND_Fuel", function(started)
    print("ND_Fuel status started:", started)
end)
```

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

### player.setJob(name, rank)

Source: https://ndcore.dev/core/server/player

Sets the character's job and rank.

```APIDOC
## player.setJob(name, rank)

### Description
Set character job & rank. This function works like addGroup.

### Parameters
- **name** (string) - The name of the job.
- **rank** (number) - The rank level to assign.

### Returns
- **group** (table) - The job group data.
```

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

### NDCore.enableMultiCharacter

Source: https://ndcore.dev/core/server/functions

Toggles multi-character support.

```APIDOC
## NDCore.enableMultiCharacter(enable)

### Description
Enables or disables multi-character support for the server.

### Parameters
- **enable** (boolean) - Required - Whether to enable multi-character.
```

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

### Listen for ND:moneyChange events

Source: https://ndcore.dev/core/server/events

Triggered when a player's account balance changes. Use this to track financial updates for specific accounts.

```lua
AddEventHandler("ND:moneyChange", function(source, account, amount, action, reason)
 
end)
```

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

### Create a vehicle

Source: https://ndcore.dev/core/server/functions

Spawns a new vehicle with specified properties. If no vehicleId is provided, a temporary one is created.

```lua
local vehicle = NDCore.createVehicle()
```

```lua
-- works like this:
NDCore.createVehicle({
    model = `taxi`,
    coords = vec4(x, y, z, w)
})
 
-- also like this:
NDCore.createVehicle({
    model = `taxi`,
    coords = vec3(x, y, z)
    heading = w
})
 
-- also can add owner that will receive keys.
local player = NDCore.getPlayer(source)
NDCore.createVehicle({
    model = `taxi`,
    coords = vec4(x, y, z, w),
    owner = player.id
})
 
-- more key access can be given.
local player = NDCore.getPlayer(source)
NDCore.createVehicle({
    model = `taxi`,
    coords = vec4(x, y, z, w),
    keys = {
        [player.id] = true
    }
})
```

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

### Configure ATM Withdrawal Values

Source: https://ndcore.dev/addons/banking

Defines the preset withdrawal amounts available when interacting with an ATM.

```lua
valuesWithdrawATM = {20, 50, 100, 200, 500, 1000}
```

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

### Define Casino Chips in Inventory

Source: https://ndcore.dev/addons/casino

Add the casino_chips item to your inventory configuration file.

```lua
["casino_chips"] = {
    label = "Chips"
}
```

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

### player.drop(reason)

Source: https://ndcore.dev/core/server/player

Kicks the player from the server with a specified reason.

```APIDOC
### Method
`player.drop(reason)`

### Parameters
- **reason** (string) - The message displayed to the player upon being kicked.
```

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

### player.getJob()

Source: https://ndcore.dev/core/server/player

Retrieves the current job name and job information for the player.

```APIDOC
## player.getJob()

### Description
Get the player job and job group.

### Returns
- **jobName** (string) - The name of the job.
- **jobInfo** (table) - The job group data.
```

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

### Fetch Character

Source: https://ndcore.dev/core/server/functions

Retrieves a character from the database using a specific identifier.

```lua
local character = NDCore.fetchCharacter(identifier, source)
```

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

### NDCore.newCharacter

Source: https://ndcore.dev/core/server/functions

Creates a new player character in the database.

```APIDOC
## NDCore.newCharacter(source, info)

### Description
Creates a new player character and saves it to the database.

### Parameters
- **source** (number) - Required - The player source ID.
- **info** (table) - Required - Character details including firstname, lastname, dob, gender, cash, bank, groups, metadata, and inventory.

### Returns
- **player** (table) - The created player object.
```

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

### player.save()

Source: https://ndcore.dev/core/server/player

Saves the character's data to the database.

```APIDOC
## player.save()

### Description
Save a characters data to the database.

### Signature
`player.save()`
```

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

### Give vehicle access

Source: https://ndcore.dev/core/server/functions

Grants a player keys to a specific vehicle entity.

```lua
NDCore.giveVehicleAccess(source, vehicle, access)
```

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

### Listen for characterLoaded event

Source: https://ndcore.dev/core/client/events

Triggered when a player successfully selects a character. The character table contains player data.

```lua
AddEventHandler("ND:characterLoaded", function(character)
    print(character.firstname, character.lastname)
end)
```

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

### NDCore.getPlayer

Source: https://ndcore.dev/core/client/functions

Retrieves the current player data.

```APIDOC
## NDCore.getPlayer

### Description
Returns the player object containing player data.

### Returns
- **player** (table) - The player data object.
```

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

### NDCore.getPlayerServerInfo

Source: https://ndcore.dev/core/server/functions

Retrieves server-specific information for a player, including identifiers and discord data.

```APIDOC
## NDCore.getPlayerServerInfo(source)

### Description
Returns identifiers and discord information for the specified player.

### Parameters
- **source** (number) - Required - The player source ID.

### Returns
- **info** (table) - Contains identifiers and discord tables.
```

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

### createDispatch

Source: https://ndcore.dev/addons/mdt

Triggers a new dispatch call within the MDT system.

```APIDOC
## createDispatch

### Description
Allows developers to programmatically create a dispatch entry in the MDT system.

### Signature
`exports["ND_MDT"]:createDispatch(data)`

### Parameters
- **caller** (string) - Required - The name of the person reporting the incident.
- **callDescription** (string) - Required - A description of the incident.
- **location** (string) - Optional - The text description of the location.
- **coords** (vector3) - Optional - The coordinates of the incident. If provided without a location string, the system will attempt to resolve the location from these coordinates.
```

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

### Create Invoice Export

Source: https://ndcore.dev/addons/banking

Use this export to generate an invoice between two parties. The request parameter determines if the player must manually accept the invoice.

```lua
exports["ND_Banking"]:createInvoice(amount, due, request, from, to)
```

```lua
local from = {
    name = "Government",
    account = "0"
}
 
local player = NDCore.getPlayer(source)
local to = {
    character = player.id
}
 
local banking = exports["ND_Banking"]
banking:createInvoice(500, 7, false, from, to)
```

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

### player.revive()

Source: https://ndcore.dev/core/server/player

Revives the player.

```APIDOC
### Method
`player.revive()`
```

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

### characterLoaded

Source: https://ndcore.dev/core/client/events

Triggered when a player selects a character.

```APIDOC
## characterLoaded

### Description
This is triggered when a player selects a character.

### Parameters
- **character** (table) - Contains player data.

### Example
```lua
AddEventHandler("ND:characterLoaded", function(character)
    print(character.firstname, character.lastname)
end)
```
```

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

### NDCore.spawnOwnedVehicle

Source: https://ndcore.dev/core/server/functions

Spawns a vehicle owned by the player after checking availability.

```APIDOC
## NDCore.spawnOwnedVehicle(source, vehicleId, coords)

### Description
Spawns a vehicle that's owned by the player and checks for availability.

### Parameters
- **source** (number) - Required - The player source.
- **vehicleId** (number) - Required - The ID of the vehicle.
- **coords** (vector4) - Required - The spawn coordinates.

### Returns
- **vehicle** (table) - The spawned vehicle object.
```

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

### Listen for updateMoney event

Source: https://ndcore.dev/core/client/events

Triggered when character money values change. Use this to update HUD elements.

```lua
AddEventHandler("ND:updateMoney", function(cash, bank)
    print(cash, bank)
end)
```

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

### Set vehicle as owned

Source: https://ndcore.dev/core/server/functions

Registers a vehicle in the database as owned by a specific player.

```lua
local vehicleId = NDCore.setVehicleOwned(playerId, properties, stored)
```

```lua
local player = NDCore.getPlayer(source)
local vehicleId = NDCore.setVehicleOwned(player.id, properties, true)
```

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

### getData

Source: https://ndcore.dev/core/server/player

Retrieves specific data associated with a player.

```APIDOC
## player.getData(data)

### Description
Retrieves data from the player's data store.

### Parameters
- **data** (string) - The key of the data to retrieve.

### Returns
- **data** (any) - The value associated with the provided key.
```

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

### NDCore.fetchAllCharacters

Source: https://ndcore.dev/core/server/functions

Fetches all characters owned by a player.

```APIDOC
## NDCore.fetchAllCharacters(source)

### Description
Returns a table of all characters owned by the player.

### Parameters
- **source** (number) - Required - The player source ID.

### Returns
- **characters** (table) - A table of character information.
```

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

### player.addMoney

Source: https://ndcore.dev/core/server/player

Adds a specified amount of money to a player's bank or cash account.

```APIDOC
## player.addMoney(account, amount, reason)

### Description
Add money to a character's account. Supported accounts are 'cash' and 'bank'.

### Parameters
- **account** (string) - Required - The account type ('bank' or 'cash').
- **amount** (number) - Required - The amount to add.
- **reason** (string) - Required - The reason for the addition.

### Returns
- **success** (boolean) - Returns true if the operation was successful.

### Example
```lua
local player = NDCore.getPlayer(source)
local success = player.addMoney("bank", 1500, "Daily salary")
print(success)
```
```

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

### Define Job Salaries

Source: https://ndcore.dev/addons/characters

Set the payout amount for specific jobs, triggered at the defined paycheck interval.

```lua
salaries = {
    ["Police"] = 100,
    ["Ambulance"] = 200
},
```

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

### player.active()

Source: https://ndcore.dev/core/server/player

Sets the character as the current active character for the player.

```APIDOC
### Method
`player.active()`
```

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

### Update player license

Source: https://ndcore.dev/core/server/player

Modifies existing license data for a player.

```lua
player.updateLicense(identifier, newData)
```

```lua
local player = NDCore.getPlayer(source)
player.updateLicense("123abc123abc", {
    status = "suspended"
})
```

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

### player.depositMoney

Source: https://ndcore.dev/core/server/player

Transfers money from the player's cash account to their bank account.

```APIDOC
## player.depositMoney(amount)

### Description
Moves money from the 'cash' account to the 'bank' account.

### Parameters
- **amount** (number) - Required - The amount to deposit.

### Returns
- **success** (boolean) - Returns true if the operation was successful.

### Example
```lua
local player = NDCore.getPlayer(source)
local success = player.depositMoney(20)
print(success)
```
```

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

### exports["ND_Banking"]:createInvoice

Source: https://ndcore.dev/addons/banking

Creates a new invoice for a player. The invoice can be set to require acceptance or be mandatory for payment within a specified due date.

```APIDOC
## exports["ND_Banking"]:createInvoice(amount, due, request, from, to)

### Description
Creates an invoice that can be sent to a player. The invoice can be configured to require player acceptance or be automatically due.

### Parameters
- **amount** (number) - The monetary value of the invoice.
- **due** (number) - The number of days until the invoice is due.
- **request** (boolean) - If true, the player must accept the invoice.
- **from** (table) - The sender information containing name, account, source, and character.
- **to** (table) - The receiver information containing name, account, source, and character.

### Example
```lua
local from = {
    name = "Government",
    account = "0"
}
 
local player = NDCore.getPlayer(source)
local to = {
    character = player.id
}
 
local banking = exports["ND_Banking"]
banking:createInvoice(500, 7, false, from, to)
```
```

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

### Share vehicle keys

Source: https://ndcore.dev/core/server/functions

Shares vehicle access keys between two players.

```lua
local success = NDCore.shareVehicleKeys(source, targetSource, vehicle)
```

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

### getPlayer()

Source: https://ndcore.dev/core

Retrieves the current player object from the ND_Core export.

```APIDOC
## getPlayer()

### Description
Retrieves the player data object from the ND_Core resource.

### Usage
```lua
local player = exports["ND_Core"]:getPlayer()
print(player.firstname)
```
```

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

### Define inventory items in items.lua

Source: https://ndcore.dev/addons/inventory

Defines item properties such as weight, stackability, and associated server or client exports for ND_Core functionality.

```lua
["keys"] = {
    label = "Car keys",
    weight = 50,
    stack = false,
    close = true,
    allowArmed = true,
    server = {
        export = "ND_Core.keys"
    },
    buttons = {
        {
            label = "Trunk",
            action = function(slot)
                exports["ND_Core"]:keyControl("trunk", slot)
            end
        },
        {
            label = "Disable key",
            action = function(slot)
                exports["ND_Core"]:keyControl("disable", slot)
            end
        }
    }
},
["lockpick"] = {
    label = "Lockpick",
    weight = 160,
    consume = 1,
    stack = true,
    close = true,
    client = {
        export = "ND_Core.lockpick"
    }
},
["tools"] = {
    label = "Tools",
    description = "Can be used to hotwire vehicles.",
    weight = 800,
    consume = 1,
    stack = true,
    close = true,
    client = {
        export = "ND_Core.hotwire"
    }
},
```

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

### Drop Player

Source: https://ndcore.dev/core/server/player

Kicks the player from the server with a specified reason.

```lua
player.drop(reason)
```

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

### Deposit money to bank

Source: https://ndcore.dev/core/server/player

Transfers funds from the player's cash account to their bank account.

```lua
local success = player.depositMoney(amount)
```

```lua
local player = NDCore.getPlayer(source)
local success = player.depositMoney(20)
print(success)
```

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

### player.notify(...)

Source: https://ndcore.dev/core/server/player

Sends a notification to the player, automatically detecting the configured notification script.

```APIDOC
### Method
`player.notify(...)`

### Parameters
- **...** (any) - Notification content or arguments.
```

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

### Send Player Notification

Source: https://ndcore.dev/core/server/player

Sends a notification to the player, automatically detecting the configured notification script.

```lua
player.notify(...)
```

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

### Listen for ND:characterLoaded events

Source: https://ndcore.dev/core/server/events

Triggered when a player selects a character. Provides access to the character's data and functions.

```lua
AddEventHandler("ND:characterLoaded", function(character)
 
end)
```

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

### NDCore.shareVehicleKeys

Source: https://ndcore.dev/core/server/functions

Shares vehicle keys between two players.

```APIDOC
## NDCore.shareVehicleKeys(source, targetSource, vehicle)

### Description
Give a player access to another players vehicle as if they are next to eachother and hand the keys.

### Parameters
- **source** (number) - Required - The source player.
- **targetSource** (number) - Required - The target player.
- **vehicle** (entity) - Required - The vehicle entity.

### Returns
- **success** (boolean) - Whether the keys were shared successfully.
```

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

### player.addGroup(name, rank)

Source: https://ndcore.dev/core/server/player

Adds a group to the player's character with a specified rank.

```APIDOC
### Method
`player.addGroup(name, rank)`

### Parameters
- **name** (string) - The name of the group defined in ndcore.cfg.
- **rank** (number) - Optional. The rank level within the group. Defaults to 1.

### Returns
- **group** (table) - Returns a table containing the group information.
```

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

### Retrieve Character Metadata

Source: https://ndcore.dev/core/server/player

Fetch metadata from a character using either a string key or a table of keys.

```lua
player.getMetadata(metadata)
```

```lua
local player = NDCore.getPlayer(source)
local count = player.getMetadata("deathCount")
if count then
    local result = ("%s died %d times"):format(player.name, count)
    print(result) -- John died 5 times
end
```

```lua
local player = NDCore.getPlayer(source)
local metadata = player.getMetadata({"deathCount", "currentlyDead"})
local name = player.name
 
if metadata.currentlyDead then
    local result = ("%s is currently dead"):format(name)
    print(result) -- John is currently dead
end
if metadata.deathCount then
    local result = ("%s died %d times"):format(name, count)
    print(result) -- John died 5 times
end
```

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

### Define Police Inventory Items

Source: https://ndcore.dev/addons/police

Configuration for police-related items in items.lua, utilizing exports for functionality like shielding, deploying spikestrips, and handcuffing.

```lua
["shield"] = {
    label = "Police shield",
    weight = 8000,
    stack = false,
    consume = 0,
    client = {
        export = "ND_Police.useShield",
        add = function(total)
            if total > 0 then
                    pcall(function() return exports["ND_Police"]:hasShield(true) end)
                end
            end,
        remove = function(total)
            if total < 1 then
                pcall(function() return exports["ND_Police"]:hasShield(false) end)
            end
        end
    }
},
["spikestrip"] = {
    label = "Spikestrip",
    weight = 500,
    client = {
        export = "ND_Police.deploySpikestrip"
    }
},
["cuffs"] = {
    label = "Handcuffs",
    weight = 150,
    client = {
        export = "ND_Police.cuff"
    }
},
["zipties"] = {
    label = "Zipties",
    weight = 10,
    client = {
        export = "ND_Police.ziptie"
    }
},
["tools"] = {
    label = "Tools",
    description = "Can be used to hotwire vehicles.",
    weight = 800,
    consume = 1,
    stack = true,
    close = true,
    client = {
        export = "ND_Core.hotwire",
        event = "ND_Police:unziptie"
    }
},
["handcuffkey"] = {
    label = "Handcuff key",
    weight = 10,
    client = {
        export = "ND_Police.uncuff"
    }
},
["casing"] = {
    label = "Bullet Casing"
},
["projectile"] = {
    label = "Projectile"
},
```

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

### Add Player Group

Source: https://ndcore.dev/core/server/player

Assigns a group and rank to the player character.

```lua
player.addGroup(name, rank)
```

```lua
--[[ group from ndcore.cfg
    "swat": {
        "label": "SWAT",
        "ranks": ["Member", "Sniper", "Team lead", "Commander"]
    }
]]
local player = NDCore.getPlayer(source)
player.addGroup("swat", 1) -- this will set the player as member.
player.addGroup("swat", 4) -- this will set the player as Commander.
```

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

### NDCore.notify

Source: https://ndcore.dev/core/client/functions

Triggers a notification for the player.

```APIDOC
## NDCore.notify

### Description
Sends a notification to the player, automatically detecting the configured notification script.
```

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

### NDCore.setVehicleOwned

Source: https://ndcore.dev/core/server/functions

Registers a vehicle as owned and adds it to the database.

```APIDOC
## NDCore.setVehicleOwned(playerId, properties, stored)

### Description
This function will register the vehicle owned and add it to the database.

### Parameters
- **playerId** (number) - Required - The ID of the player.
- **properties** (table) - Required - Vehicle properties.
- **stored** (boolean) - Required - Initial storage status.

### Returns
- **vehicleId** (number) - The ID of the newly registered vehicle.
```

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

### Set vehicle lock status

Source: https://ndcore.dev/core/server/vehicle

Toggles the locked state of the vehicle.

```lua
vehicle.setLocked(status)
```

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

### NDCore.getVehicle

Source: https://ndcore.dev/core/server/functions

Retrieves NDCore vehicle data from a game entity.

```APIDOC
## NDCore.getVehicle(entity)

### Description
Get NDCore vehicle from an entity.

### Parameters
- **entity** (number) - Required - The game entity ID.

### Returns
- **vehicle** (table) - The vehicle data table.
```

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

### ND:characterLoaded

Source: https://ndcore.dev/core/server/events

Triggered when a player selects a character.

```APIDOC
## ND:characterLoaded

### Description
Triggered when a player selects a character. This event is not safe for net and should only be listened to.

### Parameters
- **character** (table) - The character data including player functions.

### Example
```lua
AddEventHandler("ND:characterLoaded", function(character)
 
end)
```
```

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

### NDCore.getDiscordInfo

Source: https://ndcore.dev/core/server/functions

Retrieves discord information for a specific user ID.

```APIDOC
## NDCore.getDiscordInfo(discordUserId)

### Description
Returns discord information for a user. Returns nil if not found.

### Parameters
- **discordUserId** (string) - Required - The discord user ID.

### Returns
- **discordInfo** (table) - Contains nickname, user, and roles.
```

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

### Set player job and rank

Source: https://ndcore.dev/core/server/player

Assigns a job and rank to a character, functioning similarly to addGroup.

```lua
player.setJob(name, rank)
```

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

### player.getGroup(name)

Source: https://ndcore.dev/core/server/player

Retrieves group information for a specific group name from the player's data.

```APIDOC
## player.getGroup(name)

### Description
Get group information from character.

### Parameters
- **name** (string) - The name of the group to retrieve.

### Returns
- **group** (table) - Contains info from player data.
```

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

### player.triggerEvent(eventName, ...)

Source: https://ndcore.dev/core/server/player

Triggers a client-side event specifically for the player.

```APIDOC
### Method
`player.triggerEvent(eventName, ...)`

### Parameters
- **eventName** (string) - The name of the event to trigger.
- **...** (any) - Additional arguments to pass to the event.
```

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

### ND:moneyChange

Source: https://ndcore.dev/core/server/events

Triggered when a player account balance changes. This event should only be listened to.

```APIDOC
## ND:moneyChange

### Description
Triggered when a player account balance changes. This event is not safe for net and should only be listened to.

### Parameters
- **source** (number) - The player source ID.
- **account** (string) - The account name.
- **amount** (number) - The amount changed.
- **action** (string) - The action performed: "set", "remove", or "add".
- **reason** (string) - The reason for the change.

### Example
```lua
AddEventHandler("ND:moneyChange", function(source, account, amount, action, reason)
 
end)
```
```

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

### Spawn owned vehicle

Source: https://ndcore.dev/core/server/functions

Spawns a vehicle that is already owned by the player, checking for availability.

```lua
local vehicle = NDCore.spawnOwnedVehicle(source, vehicleId, coords)
```

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

### Retrieve Player Data

Source: https://ndcore.dev/core/server/player

Access specific player data fields using the getData method.

```lua
player.getData(data)
```

```lua
local player = NDCore.getPlayer(source)
local playerName = player.getData("fullname")
print(playerName)
```

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

### player.unload()

Source: https://ndcore.dev/core/server/player

Unloads a currently playing player character and saves their data and location.

```APIDOC
## player.unload()

### Description
Unload a currently playing player character, this will save the character data, location & more.

### Signature
`player.unload()`
```

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

### player.setCoords(coords)

Source: https://ndcore.dev/core/server/player

Sets the player ped coordinates using a vector3 or vector4.

```APIDOC
### Method
`player.setCoords(coords)`

### Parameters
- **coords** (vector3 | vector4) - The coordinates to set for the player.

### Returns
- **success** (boolean) - Returns true if the operation was successful.
```

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

### Set Player Coordinates

Source: https://ndcore.dev/core/server/player

Updates the player ped coordinates using a vector3 or vector4.

```lua
player.setCoords(coords)
```

```lua
local player = NDCore.getPlayer(source)
local coords = vec3(123.4, 123.4, 123.4)
player.setCoords(coords)
 
-- vector4 also works.
coords = vec4(123.4, 123.4, 123.4, 123.4)
player.setCoords(coords)
```

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

### Trigger Player Event

Source: https://ndcore.dev/core/server/player

Triggers a client-side event specifically for the player.

```lua
player.triggerEvent(eventName, ...)
```

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

### Listen for characterUnloaded event

Source: https://ndcore.dev/core/client/events

Triggered when a player leaves or switches characters. The character table contains player data and functions.

```lua
AddEventHandler("ND:characterUnloaded", function(character)
    print(character.firstname, character.lastname)
end)
```

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

### Save player data

Source: https://ndcore.dev/core/server/player

Persists the current character data to the database.

```lua
local saved = player.save()
```

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

### Notify Player

Source: https://ndcore.dev/core/client/functions

Triggers a notification for the player, automatically detecting the configured notification script.

```lua
NDCore.notify(...)
```

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

### player.delete()

Source: https://ndcore.dev/core/server/player

Deletes a character completely from the system.

```APIDOC
## player.delete()

### Description
Delete a character completely.

### Signature
`player.delete()`
```
Tokens:
Raw