Allow mods to force-show the crosshair on touchscreen for bows etc.

doc/lua_api.md

@@ -8372,6 +8372,18 @@ child will follow movement and rotation of that bone.
           Does not affect players with the `debug` privilege.
         * `chat`: Modifies the client's permission to view chat on the HUD.
           The client may locally elect to not view chat. Does not affect the console.
+        * `touch_hide_crosshair_if_unused`:
+          * Touchscreen players can use the client-side setting `touch_use_crosshair`
+            to choose whether they want to play with or without a crosshair.
+            When `touch_use_crosshair` is false, the entire screen can be used
+            to interact with nodes and objects.
+          * If `touch_hide_crosshair_if_unused` is true, this also hides the
+            crosshair.
+          * Set `touch_hide_crosshair_if_unused` to false to show the crosshair
+            regardless. This is useful for items that always work based on the
+            player's look direction, commonly bows or guns. Only affects clients
+            with protocol version >= 46.
+    * All flags default to `true`.
     * If a flag equals `nil`, the flag is not modified
 * `hud_get_flags()`: returns a table of player HUD flags with boolean values.
     * See `hud_set_flags` for a list of flags that can be toggled.

src/client/game.cpp

@@ -4375,7 +4375,8 @@ void Game::drawScene(ProfilerGraph *graph, RunStats *stats)
 			(player->hud_flags & HUD_FLAG_CROSSHAIR_VISIBLE) &&
 			(this->camera->getCameraMode() != CAMERA_MODE_THIRD_FRONT));
 
-	if (g_touchcontrols && isTouchCrosshairDisabled())
+	if (g_touchcontrols && isTouchCrosshairDisabled() &&
+			(player->hud_flags & HUD_FLAG_TOUCH_HIDE_CROSSHAIR_IF_UNUSED))
 		draw_crosshair = false;
 
 	this->m_rendering_engine->draw_scene(sky_color, this->m_game_ui->m_flags.show_hud,

src/hud.cpp

@@ -55,7 +55,7 @@ const struct EnumString es_HudElementStat[] =
 	{0, NULL},
 };
 
-const struct EnumString es_HudBuiltinElement[] =
+const struct EnumString es_HudFlag[] =
 {
 	{HUD_FLAG_HOTBAR_VISIBLE,        "hotbar"},
 	{HUD_FLAG_HEALTHBAR_VISIBLE,     "healthbar"},
@@ -66,5 +66,6 @@ const struct EnumString es_HudBuiltinElement[] =
 	{HUD_FLAG_MINIMAP_RADAR_VISIBLE, "minimap_radar"},
 	{HUD_FLAG_BASIC_DEBUG,           "basic_debug"},
 	{HUD_FLAG_CHAT_VISIBLE,          "chat"},
+	{HUD_FLAG_TOUCH_HIDE_CROSSHAIR_IF_UNUSED, "touch_hide_crosshair_if_unused"},
 	{0, NULL},
 };

src/hud.h

@@ -49,6 +49,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #define HUD_FLAG_MINIMAP_RADAR_VISIBLE (1 << 6)
 #define HUD_FLAG_BASIC_DEBUG           (1 << 7)
 #define HUD_FLAG_CHAT_VISIBLE          (1 << 8)
+#define HUD_FLAG_TOUCH_HIDE_CROSSHAIR_IF_UNUSED (1 << 9)
 
 #define HUD_PARAM_HOTBAR_ITEMCOUNT 1
 #define HUD_PARAM_HOTBAR_IMAGE 2
@@ -116,7 +117,7 @@ struct HudElement {
 
 extern const EnumString es_HudElementType[];
 extern const EnumString es_HudElementStat[];
-extern const EnumString es_HudBuiltinElement[];
+extern const EnumString es_HudFlag[];
 
 // Minimap stuff
 

src/player.cpp

@@ -77,7 +77,7 @@ Player::Player(const std::string &name, IItemDefManager *idef):
 		HUD_FLAG_CROSSHAIR_VISIBLE | HUD_FLAG_WIELDITEM_VISIBLE |
 		HUD_FLAG_BREATHBAR_VISIBLE | HUD_FLAG_MINIMAP_VISIBLE   |
 		HUD_FLAG_MINIMAP_RADAR_VISIBLE | HUD_FLAG_BASIC_DEBUG   |
-		HUD_FLAG_CHAT_VISIBLE;
+		HUD_FLAG_CHAT_VISIBLE | HUD_FLAG_TOUCH_HIDE_CROSSHAIR_IF_UNUSED;
 
 	hud_hotbar_itemcount = HUD_HOTBAR_ITEMCOUNT_DEFAULT;
 }

src/script/lua_api/l_object.cpp

@@ -1873,7 +1873,7 @@ int ObjectRef::l_hud_set_flags(lua_State *L)
 	u32 mask  = 0;
 	bool flag;
 
-	const EnumString *esp = es_HudBuiltinElement;
+	const EnumString *esp = es_HudFlag;
 	for (int i = 0; esp[i].str; i++) {
 		if (getboolfield(L, 2, esp[i].str, flag)) {
 			flags |= esp[i].num * flag;
@@ -1896,7 +1896,7 @@ int ObjectRef::l_hud_get_flags(lua_State *L)
 		return 0;
 
 	lua_newtable(L);
-	const EnumString *esp = es_HudBuiltinElement;
+	const EnumString *esp = es_HudFlag;
 	for (int i = 0; esp[i].str; i++) {
 		lua_pushboolean(L, (player->hud_flags & esp[i].num) != 0);
 		lua_setfield(L, -2, esp[i].str);