MiniMenu¶

Overview¶

The MiniMenu is the primary mechanism for interacting with the game.

Each element in the game, whether a 2D Interface Component or a 3D game world NPC Entity, will add MiniMenuEntries to the MiniMenu when the cursor, or a tap, is positioned over them.
These entries are recalculated on every Client Logic tick, so long as the MiniMenu remains closed.

When the MiniMenu is opened, by right-click or long-press, the current list of available entries is shown.
The list is sorted by priority, with the higher priority entries shown at the top.

The highest priority entry in the list is activated when you left-click or tap while the MiniMenu is closed.
This is also the entry which interface tooltips are generated for, and which affects the current Cursor sprite.

Accessing the MiniMenu¶

As the MiniMenu's list of MiniMenuEntries is in constant flux, access and making changes to the MiniMenu is restricted to within specific Events.

The principal event for managing the MiniMenu is Event.MiniMenuReady.
This event provides access to the full list of entries, as well as the ability to Swap entries.

Additional events Event.MiniMenuOpened and Event.MiniMenuClosed provide read-only access to the presented list of entries.

Event.MiniMenuEntryAdded is called when each new entry is added, providing access only to that entry.

Event.MiniMenuEntrySelected is called when a MiniMenu entry is chosen.
This can be from a left-click or tap on a game element, or from selecting an entry from the open MiniMenu.

The only MiniMenu state available outside of these events is MiniMenu.IsOpen().

MiniMenuEntry¶

A MiniMenuEntry contains information about a specific action from a specific source, which should occur when the entry is selected.

The entry source, like an NPC entity or Interface Component, is indicated by MiniMenuEntryType, which covers all the places where actions can be gathered.

Entries also provide additional data, depending on the MiniMenuEntryType.
This can be things like access to a source NPCEntity or a ground CoordGrid.

See MiniMenuEntry properties for additional information.

Actions and Ops¶

There is a fixed number of possible actions available, shown in MiniMenuActionType.
These actions can be handled by the Client, sent to the Server, or both at the same time.

The legacy name for these actions is called an Op.
Each source, like an NPC or Component, has a set of numbered Ops which are individually referred to as Op1, Op2, etc.

Each type also has a Target Op, referred to as OpT.
This is used to apply one entity to another - such as a Spell or Ability to an in-game NPC.

Verbs and Subjects¶

Most entries have a Verb, like "Chop down", and a Subject, like "Oak Tree".
Some simpler entries have only a Verb, such as "Walk" or "Cancel".

There are a few common verb types, shown in MiniMenuActionVerbType.
These are used to present display strings for common Ops like MiniMenuActionVerbType.ATTACK or MiniMenuActionVerbType.EXAMINE, while MiniMenuActionVerbType.OP covers all custom Ops.

Custom Ops are found in entity configs, or are manually defined in Component OP configs.

For entities, the Subject display string comes from the entity config's displayName while the Verb string depends on each individual Op found in the entity config.

Sorting¶

Entries are sorted within the MiniMenu in the following order:

• Entity distance to camera
• Subject, which groups entries belonging to the same entity or Component
• Action Priority

Enumerations¶

MiniMenuEntryType¶

A list of all the possible source types for each MiniMenuEntry.

MiniMenuActionVerbType¶

The type of action for each entry.
MiniMenuActionVerbType.OP is the most common.

MiniMenuActionType¶

All available types of action that can be found in a MiniMenuEntry.

Entity sources have individual actions for each numbered Op, such as OP_LOC1 or OP_OBJ6.

Component Ops use IF_BUTTONX1 and IF_BUTTONX2 with the Op number found in MiniMenuEntry.componentData.opIndex.

The entry source type, and the related property data for the source, are also provided.

MiniMenu Functions¶

IsOpen¶

function MiniMenu.IsOpen() -> Boolean

Returns whether the MiniMenu is currently open.
This static method be called at any time.

-- Skip some processing if the minimenu is open
if not MiniMenu.IsOpen() then
    ...
end

MiniMenu Methods¶

Add¶

function MiniMenu:Add(label : String, action : Function, ...)

Adds a MiniMenuEntry to the end of the current list of minimenu entries.
It will be displayed with the label specified and call the Lua function specified, with any additional arguments provided in order.

function logAdd(a,b)
    log(a .. " + " .. b .. " = " .. a+b)
end

function miniMenuEntryAddedEvent(addedEvent)
    miniMenuEvent.miniMenu:Add("Log Add (3 + 5)", logAdd, 3, 5)
end

Event.MiniMenuReady.Subscribe("miniMenuEntryAddedEvent", miniMenuEntryAddedEvent)

Swap¶

function MiniMenu:Swap(indexA : Integer, indexB : Integer)

Swaps MiniMenuEntries found at the two provided indices of MiniMenu.entries.

function onMiniMenuReady(miniMenuEvent)
    -- Get the available entries
    local entries = miniMenuEvent.miniMenu.entries

    -- Store the index of entries we find
    local idxA = 0
    local idxB = 0

    -- Loop all the entries
    for i,entry in ipairs(entries) do

        -- If we find the Lumbridge Market bank chest, make a note of the Op indices
        -- NOTE: The tile coords in entry.locData should ideally be compared here, to make sure the entities match

        if entry.actionType == MiniMenuActionType.OP_LOC2 and entry.locData.config == config.Loc.CBTV2CA_DEPOSIT_BOX then
            idxA = i
        elseif entry.actionType == MiniMenuActionType.OP_LOC4 and entry.locData.config == config.Loc.CBTV2CA_DEPOSIT_BOX then
            idxB = i
        end
    end

    -- If we found a bank chest, and stored the indices, swap them
    if idxA ~= 0 and idxB ~= 0 then
        miniMenuEvent.miniMenu:Swap(idxA, idxB)
    end
end

Event.MiniMenuReady.Subscribe("myEvent", onMiniMenuReady)

MiniMenu Properties¶

MiniMenuEntry Properties¶

NPCData Properties¶

LocData Properties¶

ObjData Properties¶

PlayerData Properties¶

GroundData Properties¶

MapElementData Properties¶

ComponentData Properties¶