Ares-Armory Exports

All exports use the resource name weaponGame.

-- client
exports.weaponGame:exportName(...)
-- or
exports['weaponGame']:exportName(...)

-- server (same syntax)
exports.weaponGame:exportName(...)

---

Client Exports

openWorkbench

Opens the workbench UI on the local client.

local opened = exports.weaponGame:openWorkbench(weapons)

Param	Type	Required	Description
weapons	string | table | nil	No	Which weapons to show. See below.

weapons values:

• nil or 'all' — show every weapon

• { 'ak47', 'beretta' } — show only these weapon keys

Returns: boolean — true if the menu opened, false if blocked (player is crafting or menu is on cooldown).

-- Show all weapons
exports.weaponGame:openWorkbench()
exports.weaponGame:openWorkbench('all')

-- Show only pistols
exports.weaponGame:openWorkbench({ 'beretta' })

-- Show a custom selection
exports.weaponGame:openWorkbench({ 'ak47', 'ms500' })

---

closeWorkbench

Closes the workbench UI and releases NUI focus.

exports.weaponGame:closeWorkbench()

No parameters, no return value.

---

isCrafting

Check if the player is currently in a crafting action (progress bar is active).

local crafting = exports.weaponGame:isCrafting()

Returns: boolean

---

isMenuOpen

Check if the workbench menu is currently open and holding NUI focus.

local open = exports.weaponGame:isMenuOpen()

Returns: boolean

---

isNearTable

Check if the player is near any crafting table (within the configured interaction distance).

local near = exports.weaponGame:isNearTable()

Returns: boolean

---

getConfig

Get the full Config table, including weapons, materials, tables, and options.

local cfg = exports.weaponGame:getConfig()

Returns: table — the full Config object.

-- Example: read interaction distance
local dist = exports.weaponGame:getConfig().Options.Table.InteractionDistance

---

getWeapons

Get the weapon definitions table.

local weapons = exports.weaponGame:getWeapons()

Returns: table — keyed by weapon ID.

--[[
{
    ['ak47'] = {
        jsConfig = "ak47",
        model    = "weapon_assaultrifle",
        parts    = { "ak47part1", "ak47part2", "ak47part3", "ak47part4" },
        display  = "AK 47"
    },
    ['beretta'] = { ... },
    ...
}
]]

---

getMaterials

Get the materials / craftable parts table.

local mats = exports.weaponGame:getMaterials()

Returns: table — keyed by material ID.

--[[
{
    ['ak47part1'] = {
        display   = "AK-47 Top Cover",
        craftTime = 8,
        costs     = { ["metal_scrap"] = 3 }
    },
    ...
}
]]

---

Server Exports

openWorkbench

Open the workbench UI for a specific player (from the server).

exports.weaponGame:openWorkbench(source, weapons)

Param	Type	Required	Description
source	number	Yes	Server ID of the target player.
weapons	string | table | nil	No	Same as the client version: nil/'all' for everything, or a table of keys.

No return value (fires a client event).

-- Open all weapons for player 1
exports.weaponGame:openWorkbench(1)

-- Open only the beretta for player 1
exports.weaponGame:openWorkbench(1, { 'beretta' })

---

closeWorkbench

Close the workbench UI for a specific player.

exports.weaponGame:closeWorkbench(source)

Param	Type	Required	Description
source	number	Yes	Server ID of the target player.

---

getConfig

Get the full Config table.

local cfg = exports.weaponGame:getConfig()

Returns: table — same structure as the client getConfig.

---

getWeapons

Get the weapon definitions.

local weapons = exports.weaponGame:getWeapons()

Returns: table — same format as client getWeapons.

---

getMaterials

Get the materials table.

local mats = exports.weaponGame:getMaterials()

Returns: table — same format as client getMaterials.

---

getTableLocations

Get the coordinates of every crafting table as a flat list of vec3 values.

local locations = exports.weaponGame:getTableLocations()

Returns: table — array of vec3.

--[[
{
    vec3(-151.23, -984.49, 114.12),
    vec3(145.87, 142.44, 111.92),
}
]]

---

isPlayerNearTable

Check if a player is within interaction range of any crafting table (server-side distance check).

local near = exports.weaponGame:isPlayerNearTable(source)

Param	Type	Required	Description
source	number	Yes	Server ID of the player.

Returns: boolean

---

isPlayerCrafting

Check if a player is currently crafting anything (part or weapon).

local crafting = exports.weaponGame:isPlayerCrafting(source)

Param	Type	Required	Description
source	number	Yes	Server ID of the player.

Returns: boolean

---

getNearestTable

Get the raw Config.Tables entry for the table closest to the player (within range).

local entry = exports.weaponGame:getNearestTable(source)

Param	Type	Required	Description
source	number	Yes	Server ID of the player.

Returns: vec3 | table | nil — the raw entry from Config.Tables, or nil if not near any table.

The returned value depends on how the table was defined in config:

• Plain format: vec3(-151.23, -984.49, 114.12)

• Extended format: { coords = vec3(145.87, 142.44, 111.92), weapons = { 'ak47', 'beretta' } }

Use the shared helpers GetTableCoords(entry) and GetTableWeapons(entry) to normalize.

---

getAvailableWeapons

Get the weapon filter for the table nearest to a player.

local weapons = exports.weaponGame:getAvailableWeapons(source)

Param	Type	Required	Description
source	number	Yes	Server ID of the player.

Returns:

• 'all' (string) — table shows every weapon

• { 'ak47', 'beretta' } (table) — table only shows these weapons

• nil — player is not near any table

local weapons = exports.weaponGame:getAvailableWeapons(source)

if weapons == nil then
    print("Player not near a table")
elseif weapons == 'all' then
    print("This table has all weapons")
else
    print("This table has: " .. table.concat(weapons, ', '))
end