State Bags, Exports & Events

Other resources can see what staff are doing (noclip, freecam, spectate and every other quick menu tool), see who is frozen, jailed or in community service, ask who is staff, ban, kick or jail players through Bablo Admin, react to zones drawn on the Map page, open the panel and show notifications.

State bags#

Bablo Admin keeps a set of player state bags up to date. They are set by the server, so players can’t fake them, and they are readable everywhere: Player(source).state on the server, LocalPlayer.state or Player(serverId).state on any client. A bag is set while the thing is on and removed (nil) when it ends. Bags left over from an earlier run are cleared when the resource starts.

-- server
if Player(source).state.babloNoclip then
    -- staff noclip, don't flag it
end
 
-- client
if LocalPlayer.state.babloFreecam then
    -- hide the HUD while the staff member is in freecam
end
 
-- react the moment it changes, on the server or the client
AddStateBagChangeHandler('babloNoclip', nil, function(bagName, key, value)
    local player = GetPlayerFromStateBagName(bagName)
    print(('player %s noclip: %s'):format(player, tostring(value)))
end)

Staff tools#

One bag per quick menu toggle. The value is true while the tool is on.

babloStaffTag is set while the staff tag is shown. Its value is { text, colour }, the text and HUD colour of the tag.

Player states#

Server exports#

IsStaff#

Returns true when the player is staff (has a rank, or is an owner from Config.Owners / Config.OwnerAce).

local isStaff = exports['bablo-admin']:IsStaff(source)

HasPermission#

Returns true when the player is staff and their rank grants the permission. Full-access staff (*) get true for every key. See the permission keys.

if exports['bablo-admin']:HasPermission(source, 'player.kick') then
    -- allowed
end

GetStaff#

Returns the player’s staff details, or nil when they are not staff.

local staff = exports['bablo-admin']:GetStaff(source)
if staff then
    print(staff.name, staff.tier and staff.tier.label, staff.hierarchy)
end

RegisterZoneHandler#

Zones drawn on the Map page can name a custom handler. Register a handler with that name and it is called when a player enters or leaves the zone.

exports['bablo-admin']:RegisterZoneHandler('my_safezone', function(playerId, zone, inside)
    if inside then
        print(('%s entered zone %s (#%d)'):format(GetPlayerName(playerId), zone.name, zone.id))
    else
        print(('%s left zone %s'):format(GetPlayerName(playerId), zone.name))
    end
end)

Returns true when registered. Player positions are checked once per second on the server, and only for zones that have a custom handler.

Player state#

The same information as the state bags, for scripts that prefer exports.

if exports['bablo-admin']:IsNoclipping(source) then
    -- staff noclip
end

Tool names are the staff tools without bablo, starting with a small letter: noclip, godMode, superJump and so on.

Actions from other scripts#

Ban, kick, warn, jail and more through Bablo Admin, for example from an anticheat. The action shows up in the ban list, the player’s history and the action log like any other, with the name of the resource that called it and Another script as the place it came from.

local ok, problem = exports['bablo-admin']:BanPlayer(source, 'Speed hack', 60 * 24)
if not ok then print('ban failed: ' .. problem) end

Every action returns true and its result when it worked, or false and a reason:

Internal exports#

GetHostStats and ListImageFiles exist for the resource’s own use (dashboard CPU and memory, vehicle pictures). Don’t call GetHostStats from another resource: each call resets the CPU sample the dashboard uses.

Shared exports#

These work on the server and the client.

GetConfig#

Returns the Config table, with auto values already resolved (for example Config.Framework is 'qbcore', 'qbox' or 'esx').

local config = exports['bablo-admin']:GetConfig()

GetFramework#

Returns the detected framework: 'qbcore', 'qbox', 'esx', or nil when none was found.

local framework = exports['bablo-admin']:GetFramework()

Client exports#

For the local player. They read the same state bags.

if exports['bablo-admin']:IsInFreecam() then
    -- hide the HUD
end

Client events#

Open the admin panel#

Triggers the same access check as /admin and opens the panel for the local player. Players who are not staff get the “no access” notification. Does nothing while the panel is already open.

TriggerEvent('bablo-admin:openPanel')

Panel opened or closed#

Fired on the local client whenever the admin panel opens or closes.

AddEventHandler('bablo-admin:panelVisible', function(visible)
    -- visible is true when the panel opened, false when it closed
end)

Show a notification#

Shows a notification through the provider set in Config.Notifications (the built-in notifications, ox_lib, your framework or Config.CustomNotify).

-- server
TriggerClientEvent('bablo-admin:notify', playerId, {
    kind = 'success',
    title = 'Garage',
    body = 'Your vehicle was returned.',
    duration = 6000,
})
 
-- client
TriggerEvent('bablo-admin:notify', { kind = 'info', body = 'Hello' })

Zone handler events#

When a zone’s custom handler name contains a : and no server handler is registered under that name, the name is sent as a client event to the player who entered or left:

-- zone editor: custom handler = 'myresource:zone'
RegisterNetEvent('myresource:zone', function(zone, inside)
    -- zone = { id = number, name = string }, inside = true on enter, false on leave
end)