Client

Last updated on

local panel = OPX.Api.Get('panel')

From client code inside opx_infinity. Every function answers a Result. None yields. Messages written before the page is ready are queued (max 256), then sent once it reports ready.

Open

Opens a panel from a spec. An unknown field refuses it (unknown_field).

panel.Open(spec)

Parameters

• spec: table — see The panel spec

Returns

• Result — { handle, id }; panel_busy if another owner's panel is open, unless spec.steal = true

local opened = panel.Open({
  owner = 'mymodule', id = 'stock', title = 'STOCK', search = true,
  actions = { { id = 'buy', label = 'Buy', primary = true } },
  on = function(p)
    if p.action == 'select' then panel.Update(p.handle, { selected = { [p.tab] = p.item } }) end
  end,
})
if opened.ok then panel.Append(opened.value.handle, { { id = 'a', label = 'Item A' } }, true) end

Close

Closes it; the callback gets close with reason.

panel.Close(handle, reason)

Parameters

• handle: integer
• reason?: string
  • Default caller, max 32 characters.

Returns

• Result — true

Update

Changes any patchable field. selected is merged per tab.

panel.Update(handle, patch)

Parameters

• handle?: integer
  • nil targets the open panel; an old handle answers stale_handle.
• patch: table
  • Patchable fields, plus clearItems = true to empty the item list first.

Returns

• Result — true

Append

Adds items. An item with an existing id replaces it. Large batches are split to fit the host's 1024-node payload limit.

panel.Append(handle, items, done)

Parameters

• handle?: integer
• items: table[]
  • Up to 200 per call, 5000 per panel.
• done?: boolean
  • true ends the loading state.

Returns

• Result — true

Confirm

Shows a confirm dialog. The answer arrives as a confirm action.

panel.Confirm(handle, question)

Parameters

• handle?: integer
• question: table|false|nil
  • { id, title?, text?, yes?, no? } — title max 60, text max 240, buttons max 40. nil or false withdraws it.

Returns

• Result — true

panel.Confirm(handle, { id = 'buy', title = 'Buy it?', text = '250 eddies' })

State

Whether a panel is open, and whose.

panel.State()

Returns

• Result
  • { open = false }
  • or { open, handle, owner, id, tab, items, busy, dialog } — items is the item count

The panel spec

Spec-only fields (cannot be patched):

Patchable fields

Allowed in Open and Update.

• A button is { id, label, icon?, primary?, disabled? }: id max 64, label max 40, icon a name from OPX.Glyphs.
• tiles.entries are the keys of the boxes (record names). labels (optional) is the caption under each box; images (optional) the picture in it: a bare file name under the page's images/clothing/ (letters, digits, _, -, .; at most 64 characters), never a path.
• labels and images are parallel to entries and must have the same length, or the whole tiles is refused (invalid_tiles). '' means no caption or no picture; with no caption the box shows the entry name.

Items

The action payload

on(payload) and opx:on:panel:action receive { panel, handle, owner, action, … } plus:

The pause key behaves like Escape: with dismiss = 'ask' it raises dismiss and leaves the panel open (a dialog up swallows it); otherwise it closes with reason pause.