Exports

A list of available exports for integrating with cd_dispatch3d.

Note

These exports are entirely optional and can be used as needed within your own scripts or integrations.

---

Client

Get Player Info

Returns useful information about a player that can be used to create new dispatch notifications.

@parameters

--- @return table data A table containing the player’s data.
--- @example
--- local data = exports['cd_dispatch']:GetPlayerInfo()
---
--- print(json.encode(data))

local data = exports['cd_dispatch3d']:GetPlayerInfo()

---

Get All Dispatch Notifications

Returns all active dispatch notifications.

@parameters

--- @return table notifications A table containing all current dispatch notifications.
--- @example
--- local notifications = exports['cd_dispatch']:GetAllDispatchNotifications()

--- print(json.encode(notifications))

local notifications = exports['cd_dispatch']:GetAllDispatchNotifications()

---

Get Player’s Dispatch Data

Returns a player’s dispatch-related character data (e.g., callsign, character name, and status).

@parameters

--- @return table playerData A table containing the player’s dispatch data.
--- @example
--- local playerData = exports['cd_dispatch']:GetPlayersDispatchData()

--- print(json.encode(playerData))

local playerData = exports['cd_dispatch']:GetPlayersDispatchData()

---

Get Config

Returns all configuration data from the dispatch’s config.lua file.

@parameters

--- @return table configData A table containing the dispatch configuration.
--- @example
--- local config = exports['cd_dispatch']:GetConfig()

--- print(json.encode(config))

local config = exports['cd_dispatch']:GetConfig()

---

Server

Get All Dispatch Notifications

Returns all active dispatch notifications.

@parameters

--- @return table notifications A table containing all current dispatch notifications.
--- @example
--- local notifications = exports['cd_dispatch']:GetAllDispatchNotifications()

--- print(json.encode(notifications))

local notifications = exports['cd_dispatch']:GetAllDispatchNotifications()

---

Get Player’s Dispatch Data

Returns a player’s dispatch character data, such as callsign, character name, and status.

@parameters

--- @param source number The player’s server ID.
--- @return table playerData A table containing the player’s dispatch data.
--- @example
--- local source= source
--- local playerData = exports['cd_dispatch']:GetPlayersDispatchData(source)

--- print(json.encode(playerData))

local playerData = exports['cd_dispatch']:GetPlayersDispatchData(source)

---

Get Config

Returns all configuration data from the dispatch’s config.lua file.

@parameters

--- @return table configData A table containing the dispatch configuration.
--- @example
--- local config = exports['cd_dispatch']:GetConfig()

--- print(json.encode(config))

local config = exports['cd_dispatch']:GetConfig()