menu

Clicks a row of a menu that is already open. Composed here rather than taken from the API, which clicks a row it is handed: this finds the row whose command matches and then hands it to the same aim-and-confirm click every interact uses. False when no menu is open or no row matches.

if menuContains("Attack") { clickMenu("Attack") }

Closes an open menu by moving the pointer off it, never by clicking - a left click on the world walks the character there or attacks whatever is standing on the spot. True when no menu is up afterwards.

closeMenu()

Which menu row the pointer is sitting on, 0 at the top, or -1 for none. For reporting: nothing needs it in order to click.

print("pointer is on row", hoveredSlot())

The verb of the most recent action as it was drawn, or empty.

print(lastMenuAction())

The kind of the most recent action, lower case, or empty. The same value 'on menu' would have been given, for a script that would rather poll.

if lastMenuKind() == "drop_item" { print("something went on the floor") }

The target of the most recent action as it was drawn, or empty.

print(lastMenuTarget())

The verb as the menu drew it, like "Attack" or "Take". This is display text and changes with the server; match on menuKind when you can.

print(menuAction(), menuTarget())

How many menu actions this client has sent since it started. Compare it between passes to notice that something happened without caring what.

let before = menuActionCount()

Whether the open menu offers this option. Case is ignored, and the target is not compared - "Attack" matches "Attack Goblin".

if menuContains("Talk-to") { clickMenu("Talk-to") }

How many options the open menu has, or zero when none is open.

if menuCount() > 0 { closeMenu() }

The ground item the action was aimed at, or none.

let loot = menuDrop()

The server index of the actor the action was aimed at, or -1.

print("index", menuIndex())

The inventory item the action was aimed at, or none.

let used = menuItem()

The kind of the action being handled, lower case, like "attack_npc", "take_item" or "cast_on_npc". Empty when nothing has happened yet. Inside 'on menu' this is the action the block was called for; outside it is the most recent one.

if menuKind() == "take_item" { print("picked something up") }

The player name the action carried, for the actions aimed at a player. Empty for everything else.

if menuKind() == "trade_player" { print("trading", menuName()) }

The npc the action was aimed at, or none when it was not aimed at one. The ordinary npc commands work on it.

let it = menuNpc()

The object the action was aimed at, or none.

let tree = menuObject()

The packet the action sent, or -1. For working out what a build does, not for ordinary scripting.

print("opcode", menuOpcode())

The lines of the open menu, as the player reads them, or an empty list when none is open.

for option in menuOptions() { print(option) }

The player the action was aimed at, or none.

let them = menuPlayer()

The inventory slot the action used, or -1. This is the slot of the item being used ON something, which is not the same as menuItem for a use-on action.

if menuSlot() >= 0 { print("used slot", menuSlot()) }

The spell the action cast, as a spell id, or -1 when it cast nothing.

if menuSpell() >= 0 { print("cast spell", menuSpell()) }

The target as the menu drew it, like "Goblin" or "Coins". Display text, same caveat as menuAction.

if menuTarget() == "Chicken" { print("pecking order") }

Where on the ground the action happened, for the actions that name a tile. None for the rest.

let where = menuTile()

The wall or door the action was aimed at, or none.

let door = menuWall()

Whether menu actions can be read on this client at all. False on a server whose menu dispatch is not woven, where 'on menu' never runs and the readers answer empty.

if menuWorks() == false { print("no menu actions on this server") }

The kinds of the last few actions, oldest first, so a pass-based script can catch several that happened between its passes.

if contains(recentMenuKinds(), "take_item") { print("picked something up") }