Hexa Framework ​

hexa_core is version 3.0.0 of the framework that every other Hexa resource is built on. Its only hard dependency is oxmysql.

Version 3.0.0 flattened the public API. If you have written for this framework before, the shortest possible summary is: delete .Functions from every call you have.

The core object is flat ​

local Core = exports['hexa_core']:GetCoreObject()

RegisterCommand('bonus', function(source)
    local Player = Core.GetPlayer(source)
    if not Player then return end
    Player.AddMoney('cash', 100, 'daily bonus')
end, false)

The old spellings Core.Functions.GetPlayer(source) and Player.Functions.AddMoney(...) still resolve for one more release. Each one prints a single warning naming the resource that called it, then forwards to the new name.

Registering an item is not giving an item ​

These two verbs used to share a name and mean opposite things. They no longer do, and this is the distinction to internalise before anything else.

-- defines a NEW KIND of item for the whole server
Core.RegisterItem('canteen', {
    name = 'canteen',
    label = 'Canteen',
    weight = 2,
    type = 'item',
    image = 'canteen.png',
    unique = false,
    useable = true,
    shouldClose = true,
})

-- puts one in ONE player's satchel
local Player = Core.GetPlayer(source)
Player.AddItem('canteen', 1, false, false, 'shop purchase')

The catalogue verbs are Core.RegisterItem, Core.UnregisterItem, Core.RegisterItems and Core.UpdateItemDefinition, with the same shape for jobs: Core.RegisterJob, Core.UnregisterJob, Core.RegisterJobs and Core.UpdateJobDefinition. The player verbs are Player.AddItem and Player.RemoveItem.

Callbacks in both directions ​

-- server
Core.CreateCallback('bank:getBalance', function(source, cb)
    local Player = Core.GetPlayer(source)
    cb(Player and Player.GetMoney('bank') or 0)
end)

-- client
Core.TriggerCallback('bank:getBalance', function(balance)
    print(('balance: %s'):format(balance))
end)

Saving is the server's job ​

The save cadence used to run on the client, which meant a client that stopped sending stopped being saved. The server owns it now.

-- force a player into the next sweep after changing their data yourself
local Player = Core.GetPlayer(source)
Player.MarkDirty()

Core.SaveAllPlayers() writes everyone immediately and returns how many were written; it is what onResourceStop calls when Config.Save.OnResourceStop is left on. Disconnects are saved unconditionally by playerDropped; the shipped Config.Save.OnDrop key is retained but is not currently read.

Logging ​

One printer set, identical on both sides, printf style.

Core.Log('spawned %d wagons', 4)
Core.Warn('no grade %s on job %s', grade, job)
Core.Error('save failed for %s', citizenid)
Core.PrintDebug('bucket now %d', bucket)
Core.DumpTable(Player.PlayerData)

Core.PrintDebug is gated on Config.Debug and checks the switch before it formats anything, so leaving debug calls in shipped code costs nothing. hexa_core also listens for hexa_log:server:CreateLog itself and forwards to Discord when a URL is set in Config.Log.Webhooks.

Where to go next ​

• Introduction for installation and the first resource
• Configuration for every config key
• Player object for the full method list
• Server functions and client functions for the API reference
• Compatibility bridges for RSG Core and VORP Core migration