Skip to Content
R3 ServicesmanagerServices
Context menu

Context menu

The context menu providers provide a service that allows resources to show players a context menu.

Usage

To retrieve the context menu provider, use the load function with "contextMenu" for the service parameter.

Lua:

local contextMenuProvider = exports.r3_servicesmanager:load("contextMenu")

JavaScript:

const contextMenuProvider = exports.r3_servicesmanager.load("contextMenu");

Client

On the client side, the following methods are available:

openMenu

Opens a context menu for the player.

contextMenuProvider.openMenu(contextMenuOptions)

Parameters:

Returns:

  • nil

closeMenu

Closes the context menu that is currently open.

contextMenuProvider.closeMenu()

Returns:

  • nil

Types

The following types are used within the context menu provider:

ContextMenuOptions

An object containing the options for a context menu.

Fields:

  • id: string
  • title: string
  • elements: ContextMenuElement[]
  • onClose: fun(): nil (optional, gets called when the menu is closed by the user or using closeMenu as well as when an element is selected)

ContextMenuElement

An object containing the options for a single context menu element.

Fields:

  • title: string
  • description: string (optional)
  • icon: string (optional, full font awesome 5 icon including prefix such as “fas fa-”)
  • disabled: boolean (optional)
  • onSelect: fun(): nil (optional)

Registration

To register a menu provider, ensure it implements all methods described above. Check out contextMenu.lua and contextMenu.ts for type definitions.

When your provider object implements all methods, you can register it as follows:

Lua:

exports.r3_servicesmanager:register("contextMenu", provider, priority, GetCurrentResourceName())

JavaScript:

exports.r3_servicesmanager.register("contextMenu", provider, priority, GetCurrentResourceName());

For priority, it is recommended to use priority 2, this corresponds to ServicePriority.Normal. It would be even better to allow server owners to configure the used priority in the configuration of your resource so that they can choose which resource takes priority.

Callback
Economy