add a few hud lua methods (#6692)

Author: MjnMixael

code/hud/hud.cpp

@@ -291,7 +291,7 @@ static int Damage_flash_timer;
 
 HudGauge::HudGauge():
 base_w(0), base_h(0), gauge_type(-1), font_num(font::FONT1), lock_color(false), sexp_lock_color(false), reticle_follow(false),
-active(false), off_by_default(false), sexp_override(false), pop_up(false), disabled_views(0), only_render_in_chase_view(false), render_for_cockpit_toggle(0), custom_gauge(false),
+active(false), off_by_default(false), sexp_override(false), pop_up(false), disabled_views(0), scripting_render_override(false), only_render_in_chase_view(false), render_for_cockpit_toggle(0), custom_gauge(false),
 texture_target(-1), canvas_w(-1), canvas_h(-1), target_w(-1), target_h(-1)
 {
 	position[0] = 0;
@@ -323,7 +323,7 @@ texture_target(-1), canvas_w(-1), canvas_h(-1), target_w(-1), target_h(-1)
 HudGauge::HudGauge(int _gauge_object, int _gauge_config, bool _slew, bool _message, int _disabled_views, int r, int g, int b):
 base_w(0), base_h(0), gauge_type(_gauge_config), gauge_object(_gauge_object), font_num(font::FONT1), lock_color(false), sexp_lock_color(false),
 reticle_follow(_slew), active(false), off_by_default(false), sexp_override(false), pop_up(false), message_gauge(_message),
-disabled_views(_disabled_views), only_render_in_chase_view(false), render_for_cockpit_toggle(0), custom_gauge(false), textoffset_x(0), textoffset_y(0), texture_target(-1),
+disabled_views(_disabled_views), scripting_render_override(false), only_render_in_chase_view(false), render_for_cockpit_toggle(0), custom_gauge(false), textoffset_x(0), textoffset_y(0), texture_target(-1),
 canvas_w(-1), canvas_h(-1), target_w(-1), target_h(-1)
 {
 	Assertion(_gauge_config <= NUM_HUD_GAUGES && _gauge_config >= 0, "Gauge has an invalid config ID!");
@@ -367,7 +367,7 @@ canvas_w(-1), canvas_h(-1), target_w(-1), target_h(-1)
 HudGauge::HudGauge(int _gauge_config, bool _slew, int r, int g, int b, char* _custom_name, char* _custom_text, char* frame_fname, int txtoffset_x, int txtoffset_y):
 base_w(0), base_h(0), gauge_type(_gauge_config), gauge_object(HUD_OBJECT_CUSTOM), font_num(font::FONT1), lock_color(false), sexp_lock_color(false),
 reticle_follow(_slew), active(false), off_by_default(false), sexp_override(false), pop_up(false), message_gauge(false),
-disabled_views(VM_EXTERNAL | VM_DEAD_VIEW | VM_WARP_CHASE | VM_PADLOCK_ANY), can_popup(false), use_iff_color(false), use_tag_color(false), only_render_in_chase_view(false), 
+disabled_views(VM_EXTERNAL | VM_DEAD_VIEW | VM_WARP_CHASE | VM_PADLOCK_ANY), scripting_render_override(false), can_popup(false), use_iff_color(false), use_tag_color(false), only_render_in_chase_view(false), 
 render_for_cockpit_toggle(0), custom_gauge(true), textoffset_x(txtoffset_x), textoffset_y(txtoffset_y), texture_target(-1), canvas_w(-1), canvas_h(-1), target_w(-1), target_h(-1)
 {
 	position[0] = 0;
@@ -780,6 +780,16 @@ void HudGauge::updateSexpOverride(bool sexp)
 	sexp_override = sexp;
 }
 
+bool HudGauge::getScriptingOverride() const
+{
+	return scripting_render_override;
+}
+
+void HudGauge::updateScriptingOverride(bool toggle)
+{
+	scripting_render_override = toggle;
+}
+
 void HudGauge::updatePopUp(bool pop_up_flag)
 {
 	pop_up = pop_up_flag;
@@ -1415,6 +1425,10 @@ bool HudGauge::canRender() const
 		}
 	}
 
+	if (scripting_render_override) {
+		return false;
+	}
+
 	return true;
 }
 
@@ -4342,6 +4356,21 @@ HudGauge *hud_get_gauge(const char *name, bool check_all_custom_gauges)
 		if (idx >= 0 && idx < (int)default_hud_gauges.size())
 			gauge = default_hud_gauges[idx].get();
 	}
+
+	// If we still haven't found it then we might be using ship specific builtin gauges and not a default_hud_gauge
+	if (gauge == nullptr) {
+		ship_info* player_sip = nullptr;
+		if (Player_ship && Player_ship->ship_info_index >= 0)
+			player_sip = &Ship_info[Player_ship->ship_info_index];
+
+		if (player_sip != nullptr) {
+			for (auto& ship_gauge : player_sip->hud_gauges) {
+				if (!stricmp(name, ship_gauge->getConfigName().c_str())) {
+					gauge = ship_gauge.get();
+				}
+			}
+		}
+	}
 	return gauge;
 }
 

code/hud/hud.h

@@ -241,6 +241,7 @@ class HudGauge
 	int popup_timer;
 	bool message_gauge;
 	int disabled_views;
+	bool scripting_render_override;
 
 	// Config stuff
 	SCP_string config_name;
@@ -322,6 +323,8 @@ class HudGauge
 	void updateActive(bool show);
 	void updatePopUp(bool pop_up_flag);
 	void updateSexpOverride(bool sexp);
+	bool getScriptingOverride() const;
+	void updateScriptingOverride(bool toggle);
 	void initChase_view_only(bool chase_view_only);
 	void initCockpit_view_choice(int cockpit_view_choice);
 	void initVisible_in_config(bool visible);

code/hud/hudsquadmsg.cpp

@@ -2770,6 +2770,10 @@ bool HudGaugeSquadMessage::canRender() const
 		return false;
 	}
 
+	if (scripting_render_override) {
+		return false;
+	}
+
 	return true;
 }
 

code/scripting/api/objs/hudconfig.cpp

@@ -199,6 +199,24 @@ ADE_VIRTVAR(Name, l_Gauge_Config, nullptr, "The name of this gauge", "string", "
 	return ade_set_args(L, "s", current.getGauge()->getConfigName().c_str());
 }
 
+ADE_VIRTVAR(isCustom, l_Gauge_Config, nullptr, "If the gauge is custom or builtin", "boolean", "True if custom, false otherwise")
+{
+	gauge_config_h current;
+	if (!ade_get_args(L, "o", l_Gauge_Config.Get(&current))) {
+		return ADE_RETURN_NIL;
+	}
+
+	if (!current.isValid()) {
+		return ade_set_error(L, "b", false);
+	}
+
+	if (ADE_SETTING_VAR) {
+		LuaError(L, "This property is read only.");
+	}
+
+	return ade_set_args(L, "b", current.getGauge()->isCustom());
+}
+
 ADE_VIRTVAR(CurrentColor,
 	l_Gauge_Config,
 	"color",

code/scripting/api/objs/hudgauge.cpp

@@ -256,6 +256,23 @@ ADE_FUNC(setColor,
 	return ADE_RETURN_NIL;
 }
 
+ADE_FUNC(setRenderOverride,
+	l_HudGauge,
+	"boolean",
+	"Sets a rendering override to enable or disable rendering of this gauge. This takes precedence over all other gauge toggles!",
+	"boolean",
+	"True to enable the override and stop the gauge from rendering, false otherwise")
+{
+	HudGauge* gauge;
+	bool override = false;
+	if (!ade_get_args(L, "o|b", l_HudGauge.Get(&gauge), &override))
+		return ADE_RETURN_NIL;
+
+	gauge->updateScriptingOverride(override);
+
+	return ade_set_args(L, "b", gauge->getScriptingOverride());
+}
+
 ADE_VIRTVAR(RenderFunction,
             l_HudGauge,
             "function (HudGaugeDrawFunctions gauge_handle) => void",