[Lua API] Key definition: OK. Can't be remapped yet.

Author: Unarelith

docs/lua-api-key.md

@@ -8,14 +8,25 @@ mod:key {
 	name = "Inventory",
 	default_key = "E"
 
-	key_callback = function(client, screen_width, screen_height, gui_scale)
+	callback = function(client, screen_width, screen_height, gui_scale)
 		show_inventory(client, screen_width, screen_height, gui_scale)
 	end
 }
 ```
 
 ## Attributes
 
+### `callback`
+
+Function called when the key is pressed.
+
+Example:
+```lua
+callback = function(client, screen_width, screen_height, gui_scale)
+	show_inventory(client, screen_width, screen_height, gui_scale)
+end
+```
+
 ### `default_key`
 
 Keyboard key mapped to this key by default.
@@ -25,6 +36,8 @@ Example:
 default_key = "E"
 ```
 
+Names are defined [here](https://github.com/Unarelith/GameKit/blob/master/source/core/input/KeyboardUtils.cpp).
+
 ### `name`
 
 Name of the key. Optional field, uses `id` if not defined.

mods/creative_inventory/init.lua

@@ -26,81 +26,87 @@
 --
 mod = openminer.mod_loader:register_mod("creative_inventory")
 
-function show_creative_window(client, screen_width, screen_height, gui_scale)
-	items = {}
-	for k, v in pairs(openminer.registry:items()) do
-		if k ~= 1 and not v:has_group("group:ci_ignore") then
-			items[#items + 1] = {v:string_id()}
+mod:key {
+	id = "creative_inventory",
+	name = "Creative window",
+	default_key = "H",
+
+	callback = function(client, screen_width, screen_height, gui_scale)
+		items = {}
+		for k, v in pairs(openminer.registry:items()) do
+			if k ~= 1 and not v:has_group("group:ci_ignore") then
+				items[#items + 1] = {v:string_id()}
+			end
 		end
-	end
 
-	local gui = LuaGUI.new()
+		local gui = LuaGUI.new()
 
-	gui:set_size(195, 136)
-	gui:set_centered(true)
+		gui:set_size(195, 136)
+		gui:set_centered(true)
 
-	gui:image {
-		name = "img_background",
-		pos = {x = 0, y = 0},
+		gui:image {
+			name = "img_background",
+			pos = {x = 0, y = 0},
 
-		texture = mod:path() .. "/textures/gui/creative_window.png",
-		clip = {x = 0, y = 0, width = 195, height = 136},
-	}
+			texture = mod:path() .. "/textures/gui/creative_window.png",
+			clip = {x = 0, y = 0, width = 195, height = 136},
+		}
 
-	gui:inventory_data {
-		name = "inv_data",
+		gui:inventory_data {
+			name = "inv_data",
 
-		width = 9,
-		height = 7,
+			width = 9,
+			height = 7,
 
-		items = items,
+			items = items,
 
-		is_unlimited = true,
-	}
+			is_unlimited = true,
+		}
 
-	gui:inventory {
-		name = "inv_creative_items",
-		pos = {x = 8, y = 17},
+		gui:inventory {
+			name = "inv_creative_items",
+			pos = {x = 8, y = 17},
 
-		inventory = {
-			source = "temp",
-			inventory_name = "inv_data",
-			offset = 0,
-			count = 9 * 5,
-		},
+			inventory = {
+				source = "temp",
+				inventory_name = "inv_data",
+				offset = 0,
+				count = 9 * 5,
+			},
 
-		size = {x = 9, y = 7}
-	}
+			size = {x = 9, y = 7}
+		}
 
-	gui:scroll_bar {
-		name = "scroll_bar",
-		pos = {x = 175, y = 18},
+		gui:scroll_bar {
+			name = "scroll_bar",
+			pos = {x = 175, y = 18},
 
-		texture = mod:path() .. "/textures/gui/tabs.png",
-		clip = {x = 232, y = 0, width = 12, height = 15},
-		clip_selected = {x = 244, y = 0, width = 12, height = 15},
+			texture = mod:path() .. "/textures/gui/tabs.png",
+			clip = {x = 232, y = 0, width = 12, height = 15},
+			clip_selected = {x = 244, y = 0, width = 12, height = 15},
 
-		widget = "inv_creative_items",
+			widget = "inv_creative_items",
 
-		min_y = 0,
-		max_y = 110 - 15,
-	}
+			min_y = 0,
+			max_y = 110 - 15,
+		}
 
-	gui:inventory {
-		name = "inv_hotbar",
-		pos = {x = 8, y = 111},
+		gui:inventory {
+			name = "inv_hotbar",
+			pos = {x = 8, y = 111},
 
-		inventory = {
-			source = "player",
-			player = "player",
-			inventory_name = "main",
-			offset = 0,
-			count = 9,
-		},
+			inventory = {
+				source = "player",
+				player = "player",
+				inventory_name = "main",
+				offset = 0,
+				count = 9,
+			},
 
-		size = {x = 9, y = 1},
-	}
+			size = {x = 9, y = 1},
+		}
 
-	gui:show(client);
-end
+		gui:show(client);
+	end
+}
 

mods/default/inventory.lua

@@ -26,77 +26,73 @@
 --
 local modpath = mod:path()
 
-function show_inventory(client, screen_width, screen_height, gui_scale)
-	local gui = LuaGUI.new()
-
-	gui:set_size(176, 166)
-	gui:set_centered(true)
+mod:key {
+	id = "inventory",
+	name = "Inventory",
+	default_key = "E",
 
-	gui:image {
-		name = "img_background",
-		pos = {x = 0, y = 0},
+	callback = function(client, screen_width, screen_height, gui_scale)
+		local gui = LuaGUI.new()
 
-		texture = modpath .. "/textures/gui/inventory.png",
-		clip = {x = 0, y = 0, width = 176, height = 166},
-	}
+		gui:set_size(176, 166)
+		gui:set_centered(true)
 
-	gui:inventory {
-		name = "inv_main",
-		pos = {x = 7, y = 83},
+		gui:image {
+			name = "img_background",
+			pos = {x = 0, y = 0},
 
-		inventory = {
-			source = "player",
-			player = "player",
-			inventory_name = "main",
-			offset = 9,
-			count = 9 * 3,
-		},
+			texture = modpath .. "/textures/gui/inventory.png",
+			clip = {x = 0, y = 0, width = 176, height = 166},
+		}
 
-		size = {x = 9, y = 3},
+		gui:inventory {
+			name = "inv_main",
+			pos = {x = 7, y = 83},
 
-		shift_destination = "inv_hotbar,inv_main",
-	}
+			inventory = {
+				source = "player",
+				player = "player",
+				inventory_name = "main",
+				offset = 9,
+				count = 9 * 3,
+			},
 
-	gui:inventory {
-		name = "inv_hotbar",
-		pos = {x = 7, y = 141},
+			size = {x = 9, y = 3},
 
-		inventory = {
-			source = "player",
-			player = "player",
-			inventory_name = "main",
-			offset = 0,
-			count = 9,
-		},
+			shift_destination = "inv_hotbar,inv_main",
+		}
 
-		size = {x = 9, y = 1},
+		gui:inventory {
+			name = "inv_hotbar",
+			pos = {x = 7, y = 141},
 
-		shift_destination = "inv_main,inv_hotbar",
-	}
+			inventory = {
+				source = "player",
+				player = "player",
+				inventory_name = "main",
+				offset = 0,
+				count = 9,
+			},
 
-	gui:crafting {
-		name = "inv_crafting",
-		pos = {x = 97, y = 17},
-		result_pos = {x = 97 + 56, y = 17 + 10},
+			size = {x = 9, y = 1},
 
-		inventory = {
-			source = "temp",
-			size = 2,
-		},
+			shift_destination = "inv_main,inv_hotbar",
+		}
 
-		shift_destination = "inv_main,inv_hotbar",
-	}
+		gui:crafting {
+			name = "inv_crafting",
+			pos = {x = 97, y = 17},
+			result_pos = {x = 97 + 56, y = 17 + 10},
 
-	gui:show(client)
-end
+			inventory = {
+				source = "temp",
+				size = 2,
+			},
 
-mod:key {
-	id = "inventory",
-	name = "Inventory",
-	default_key = "E",
+			shift_destination = "inv_main,inv_hotbar",
+		}
 
-	key_callback = function(client, screen_width, screen_height, gui_scale)
-		show_inventory(client, screen_width, screen_height, gui_scale)
+		gui:show(client)
 	end
 }
 

source/client/core/KeyboardHandler.cpp

@@ -48,9 +48,6 @@ KeyboardHandler::KeyboardHandler() {
 	addKey(GameKey::Dig,             "Dig",             sf::Keyboard::L);
 	addKey(GameKey::Use,             "Use",             sf::Keyboard::M);
 
-	addKey(GameKey::Inventory,       "Inventory",       sf::Keyboard::E);
-	addKey(GameKey::CreativeWindow,  "CreativeWindow",  sf::Keyboard::H);
-
 	addKey(GameKey::Chat,            "Chat",            sf::Keyboard::T);
 	addKey(GameKey::Command,         "Command",         sf::Keyboard::Divide);
 

source/client/network/ClientCommandHandler.cpp

@@ -89,20 +89,6 @@ void ClientCommandHandler::sendPlayerPlaceBlock(s32 x, s32 y, s32 z, u32 block)
 	m_client.send(packet);
 }
 
-void ClientCommandHandler::sendPlayerInventoryRequest() {
-	Network::Packet packet;
-	packet << Network::Command::PlayerInventory
-		<< u16(Config::screenWidth) << u16(Config::screenHeight) << u8(Config::guiScale);
-	m_client.send(packet);
-}
-
-void ClientCommandHandler::sendPlayerCreativeWindowRequest() {
-	Network::Packet packet;
-	packet << Network::Command::PlayerCreativeWindow
-		<< u16(Config::screenWidth) << u16(Config::screenHeight) << u8(Config::guiScale);
-	m_client.send(packet);
-}
-
 void ClientCommandHandler::sendPlayerHeldItemChanged(u8 hotbarSlot, u16 itemID) {
 	Network::Packet packet;
 	packet << Network::Command::PlayerHeldItemChanged
@@ -144,6 +130,13 @@ void ClientCommandHandler::sendChatMessage(const std::string &message) {
 	m_client.send(packet);
 }
 
+void ClientCommandHandler::sendKeyPressed(u16 keyID) {
+	Network::Packet packet;
+	packet << Network::Command::KeyPressed << keyID
+		<< Config::screenWidth << Config::screenHeight << Config::guiScale;
+	m_client.send(packet);
+}
+
 template<typename ComponentType>
 static void addComponentCommandCallback(Network::Command command, Client &client, ClientCommandHandler::EntityMap &entityMap, ClientWorld &world) {
 	client.setCommandCallback(command, [&](Network::Packet &packet) {

source/client/network/ClientCommandHandler.hpp

@@ -51,13 +51,12 @@ class ClientCommandHandler {
 		void sendPlayerRotUpdate();
 		void sendPlayerDigBlock(const glm::ivec4 &selectedBlock);
 		void sendPlayerPlaceBlock(s32 x, s32 y, s32 z, u32 block);
-		void sendPlayerInventoryRequest();
-		void sendPlayerCreativeWindowRequest();
 		void sendPlayerHeldItemChanged(u8 hotbarSlot, u16 itemID);
 		void sendBlockActivated(const glm::ivec4 &selectedBlock);
 		void sendBlockInvUpdate(Inventory &inventory);
 		void sendChunkRequest(s32 chunkX, s32 chunkY, s32 chunkZ);
 		void sendChatMessage(const std::string &message);
+		void sendKeyPressed(u16 keyID);
 
 		void setupCallbacks();
 

source/client/states/GameState.cpp

@@ -118,6 +118,13 @@ void GameState::onEvent(const sf::Event &event) {
 			gk::Mouse::setCursorGrabbed(true);
 			gk::Mouse::setCursorVisible(false);
 		}
+		else if (event.type == sf::Event::KeyPressed) {
+			for (auto &key : m_registry.keys()) {
+				if (event.key.code == key.defaultKeyCode()) {
+					m_clientCommandHandler.sendKeyPressed(key.id());
+				}
+			}
+		}
 
 		m_hud.onEvent(event);
 	}
@@ -140,13 +147,6 @@ void GameState::update() {
 
 	if (!m_stateStack->empty() && &m_stateStack->top() == this) {
 		m_player.processInputs();
-
-		if (gk::GamePad::isKeyPressedOnce(GameKey::Inventory)) {
-			m_clientCommandHandler.sendPlayerInventoryRequest();
-		}
-		else if (gk::GamePad::isKeyPressedOnce(GameKey::CreativeWindow)) {
-			m_clientCommandHandler.sendPlayerCreativeWindowRequest();
-		}
 	}
 
 	m_player.updatePosition(m_world);