OpenMiner/docs/lua-api-key.md

Lua API: Key

Example

mod:key {
	id = "inventory",
	name = "Inventory",
	default_key = "E"
}

mod:key_callback("default:inventory", function(client, screen_width, screen_height, gui_scale)
	show_inventory(client, screen_width, screen_height, gui_scale)
end)

Attributes

default_key

Keyboard key mapped to this key by default.

Example:

default_key = "E"

name

Name of the key. Optional field, uses id if not defined.

Example:

name = "Inventory"

id

ID of the key. Mandatory field.

Example:

id = "inventory"

IDs are usually of the form mod:key but the mod: prefix is prepended automatically so it's not needed.