Menu

The server-side Menu module opens a keyboard navigated menu for a target player identified by their server id. The first parameter is always the player's server id. The call is forwarded to the client through the MSK callback system.

See the client-side documentation for the full list of menu and item fields, and for the controls.

Naming

The namespaced form MSK.Menu.* is the recommended one. The flat names MSK.ShowMenu and MSK.HideMenu point at the exact same functions and stay supported. MSK.Menu.Close is an alias of MSK.Menu.Hide.

The exports are always flat: exports.msk_core:ShowMenu(...).

Callbacks do not cross the network

Everything you send from the server is serialized. Lua functions do not survive that, so onSelect, onSelected, onSideScroll, onCheck and onClose are lost when you pass an inline menu from the server.

You have two clean options:

1. Register the menu client-side (with all its callbacks) and open it from the server by its id. This is the recommended way, and the only way to receive onSideScroll or onCheck.
2. Use event / serverEvent + args on the items instead of onSelect.

MSK.Menu.Show

Opens a menu for a specific player.

Parameters
playerId - number - The target player's server id
idOrData - string/table - Id of a menu registered on the client, or an inline menu definition

-- Recommended: the menu (including its callbacks) is registered on the client,
-- the server only opens it.
MSK.Menu.Show(playerId, 'tuning_menu')

-- Inline from the server. Note: no callbacks, use serverEvent instead.
MSK.Menu.Show(playerId, {
    id = 'quick_menu',
    title = 'Quick Actions',
    items = {
        { label = 'Repair', icon = 'wrench', serverEvent = 'myscript:repair', args = { target = playerId } },
    }
})

-- Backwards compatible alias:
MSK.ShowMenu(playerId, 'tuning_menu')

-- As an Export:
exports.msk_core:ShowMenu(playerId, 'tuning_menu')

MSK.Menu.Hide

Closes the menu of a specific player. MSK.Menu.Close is an alias of this function.

Parameters
playerId - number - The target player's server id

MSK.Menu.Hide(playerId)

-- Backwards compatible alias:
MSK.HideMenu(playerId)

-- As an Export:
exports.msk_core:HideMenu(playerId)