Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Screens, the inventory key and the sign editor

A client mod can close the screen a player has open, open the player's inventory, and read which sign the sign editor is on. The two writes take the same paths as the keys the player uses, so the server sees only the packets of a normal client.

#![allow(unused)]
fn main() {
// Escape: close whatever is open.
if host.close_screen() {
    // a screen was open and is now closed
}

// The inventory key, key.inventory.
if host.open_inventory() {
    // the inventory screen is up (or the ridden vehicle's screen was asked for)
}

// Which sign the editor is on, if any.
if let Some(sign) = host.sign_editor() {
    let _ = (sign.pos, sign.front);
}
}

ClientHost::close_screen() follows the screen's own Escape close. A container screen closes as the player's container close: the client sends ServerboundContainerClosePacket with the menu's id and then closes its copy of the menu. It never drops a container menu locally alone, which would leave the server's menu open. A pause menu closes to the game, another screen runs its own close, and the sign editor sends ServerboundSignUpdatePacket with the lines being edited, as Escape does. The death screen does not close this way. The screen hooks' closing notices fire as they do for Escape. It returns false when no screen is open.

ClientHost::open_inventory() does what key.inventory does: it opens the player's inventory screen locally and sends nothing, because the player's menu is always open on the server. Riding a vehicle with its own inventory (a tamed mount or a chest boat), it sends the open-inventory player command (ServerboundPlayerCommandPacket) at the player's next tick instead, as the key's press is. It returns false with a screen already open, for a spectator, in a portal transition, or with no world.

ClientHost::sign_editor() returns Some(SignEditView { pos, front }) while the sign editor is open: the sign's block position and whether its front side is being edited. It returns None with no sign editor open, or outside a world. A close of the sign editor always sends the sign update, however it closes; there is no close that skips it, because the vanilla client never omits that packet.