Skip to main content

Placeholders

MachineEngine's placeholders are zMenu placeholders, for machine menus: write them as %zmenu_machineengine_<key>% in a menu file. There is no PlaceholderAPI expansion.

Inside a machine's menu they show that machine. To check the values of a machine, run /machineengine placeholders while looking at it.

The machine​

KeyValue
typeThe machine type, e.g. mekanized:crusher.
type_namespaceIts namespace (mekanized).
type_valueIts value (crusher).
stateactive, scheduled, waiting, blocked, sleeping or disabled.
placeholdertrue if the machine belongs to a missing addon.
last_wakeWhy it last woke up (a key), or empty.
errorIts last error, or empty.
facingnorth, south, east or west…
x, y, z, worldIts position.
upgradesNumber of upgrades installed.
upgrade_<namespace>_<value>Number of one upgrade installed, e.g. upgrade_mekanized_upgrade_speed.
escrowAmount held back in transfers between regions (Folia); normally 0.

Storages​

<id> is a storage of the machine (energy, input…). Storage ids may contain _.

KeyValue
storage_<id>_amountAmount held (all slots).
storage_<id>_capacityCapacity.
storage_<id>_freeCapacity left.
storage_<id>_percentFill, 0 to 100.
storage_<id>_barA 10-character bar of █ and ░.
storage_<id>_resourceWhat it holds (first filled slot), or empty.
storage_<id>_nameIts name, translated for the player.
storage_<id>_colorIts color, #RRGGBB (for tinted bars).
storage_<id>_cell_<k>Level of cell k (0 to 2) of a 3-slot textured fill bar.

Each slot on its own, n starting at 1: storage_<id>_slot_<n>_amount, _capacity, _resource, _name, _color, _cell_<k>.

The process​

KeyValue
process_activetrue while a process runs.
process_recipeThe recipe key, or empty.
process_statusidle, running, waiting_for_cost, output_blocked, completed or returning.
process_progressTicks done.
process_durationTicks in total.
process_remainingTicks left.
process_remaining_secondsSeconds left, rounded up.
process_percentProgress, 0 to 100.
process_barA 10-character bar.
process_cell_<k>Level of cell k of a textured progress bar.

Lists, data and sides​

KeyValue
list_<id>_sizeRows in one of the machine type's lists, e.g. list_upgrades_size.
list_<id>_<index>_<field>A field of a row, index from 0, e.g. list_upgrades_0_count. Empty past the end.
data_<id>A value the machine type exposes (a mode, a setting).
data_<id>_cellThat value as the level (0 to 16) of a one-slot bar.
side_<group>_<side>The configuration of a side (front, back, left, right, top, bottom) for a port group.
side_<group>_<side>_modeThe same as none, input, output or both.

The upgrades list, on every machine with upgrade slots, has the fields id, namespace, value, count, max, installed and item.

The player​

player_<namespace>_<id> shows a value an addon keeps for the player viewing the menu, or one of their settings — e.g. %zmenu_machineengine_player_mekanized_radiation_hud%. A / in the id becomes _. These work in any zMenu menu, not only machine menus.