Exports

Client Exports

OpenMenu

Opens the admin menu or one of its submenus and returns a bool whether the menu was opened. A menu only opens if the player could also open it from inside the admin menu. All other open menus are closed before.

local success = exports['hex_admin_menu']:OpenMenu(menuName)

-- open the vehicle spawner directly
exports['hex_admin_menu']:OpenMenu('spawn_vehicle')

HasPermission

Checks if a group has a permission in Config.Permissions and returns a bool. Returns false if one of the arguments is missing. All areas and actions are listed under Permissions.

local hasPermission = exports['hex_admin_menu']:HasPermission(group, area, action)

-- can admins give items?
local canGiveItems = exports['hex_admin_menu']:HasPermission('admin', 'framework_menu', 'giveitem')

RunAction

Runs an action of the admin menu as the local player. The server checks the permissions of the player and sends the same notifications as the menu, so this export returns nothing.

Like in the menu, only the give actions can target other players. All other actions always affect the player who calls the export and ignore the targetId. All actions and their data are listed under Actions.

exports['hex_admin_menu']:RunAction(action, targetId, data)

-- give 5 bread to the player with the id 12
exports['hex_admin_menu']:RunAction('giveitem', 12, { item = 'bread', count = 5, reason = 'Support' })

-- repair the vehicle you are sitting in
exports['hex_admin_menu']:RunAction('repair_vehicle')

isInAduty

Returns a bool whether the player is in admin duty.

local isInAduty = exports['hex_admin_menu']:isInAduty()

SetAdminDuty

Turns the admin duty of the player on or off.

exports['hex_admin_menu']:SetAdminDuty(state)

SetNoClip

Turns noclip on or off. Turning it on only works with the noclip permission and, if Config.AntiAbuse is enabled, while the player is in admin duty or their group is in Config.AntiAbuseBypass.

exports['hex_admin_menu']:SetNoClip(state, ignoreLogs)

setNametags

Turns the nametags of the player on or off.

exports['hex_admin_menu']:setNametags(state, ignoreLogs)

Server Exports

HasPermission

Checks if a group has a permission in Config.Permissions and returns a bool. Works the same as the client export.

local hasPermission = exports['hex_admin_menu']:HasPermission(group, area, action)

RunAction

Runs an action of the admin menu and returns a bool whether it was successful and an error code if not.

• With data.admin the action runs as this staff member. Their permissions are checked and the logs show their name.
• Without data.admin the action runs as system without a permission check and is logged as System (resource name). This only works for give actions.

Like in the menu, only the give actions can target other players. All other actions affect data.admin and ignore the targetId.

local success, errorCode = exports['hex_admin_menu']:RunAction(action, targetId, data)

-- give a vehicle as system, for example as an event reward
local success, errorCode = exports['hex_admin_menu']:RunAction('givevehicle', 12, { model = 'adder', reason = 'Event Reward' })

-- repair the vehicle the staff member is sitting in
local success, errorCode = exports['hex_admin_menu']:RunAction('repair_vehicle', nil, { admin = source })

Actions

Every action has the same name as its permission in Config.Permissions. When a player runs an action, their group needs this permission.

Only the four give actions use the targetId. All other actions affect the player who runs them, which is the local player on the client and data.admin on the server.

Data Object

Error Codes

The server export RunAction returns one of these codes if the action failed. On the client the player gets a notification instead.

Permissions

These are the default areas and actions in Config.Permissions. They are used by all exports on this page.