Merge pull request #6832 from MjnMixael/team_colors_followup

Get, set, browse team colors with Lua

Author: JohnAFernandez

code/scripting/api/libs/tables.cpp

@@ -8,6 +8,7 @@
 #include "scripting/api/objs/intelentry.h"
 #include "scripting/api/objs/shipclass.h"
 #include "scripting/api/objs/shiptype.h"
+#include "scripting/api/objs/team_colors.h"
 #include "scripting/api/objs/weaponclass.h"
 #include "scripting/api/objs/wingformation.h"
 
@@ -340,5 +341,37 @@ ADE_FUNC(__len, l_Tables_WingFormations, nullptr, "Number of wing formations", "
 	return ade_set_args(L, "i", static_cast<int>(Wing_formations.size()) + 1);
 }
 
+//*****SUBLIBRARY: Tables/TeamColors
+ADE_LIB_DERIV(l_Tables_TeamColors, "TeamColors", nullptr, nullptr, l_Tables);
+
+ADE_INDEXER(l_Tables_TeamColors, "number/string IndexOrName", "Array of team colors", "teamcolor", "Team color handle, or invalid handle if name is invalid")
+{
+	const char* name;
+	if (!ade_get_args(L, "*s", &name))
+		return ade_set_error(L, "o", l_TeamColor.Set(-1));
+
+	// look up by name
+	for (int i = 0; i < static_cast<int>(Team_Names.size()); ++i) {
+		if (!stricmp(Team_Names[i].c_str(), name)) {
+			return ade_set_args(L, "o", l_TeamColor.Set(i));
+		}
+	}
+
+	// look up by number
+	int idx = atoi(name);
+	if (idx > 0) {
+		idx--; // Lua --> C/C++
+	} else {
+		return ade_set_args(L, "o", l_TeamColor.Set(-1));
+	}
+
+	return ade_set_args(L, "o", l_TeamColor.Set(idx));
+}
+
+ADE_FUNC(__len, l_Tables_TeamColors, nullptr, "Number of  team colors", "number", "Number of team colors")
+{
+	return ade_set_args(L, "i", static_cast<int>(Team_Names.size()));
+}
+
 }
 }

code/scripting/api/objs/parse_object.cpp

@@ -7,7 +7,8 @@
 #include "vecmath.h"
 #include "weaponclass.h"
 #include "wing.h"
-//#include "globalincs/alphacolors.h" //Needed for team colors
+#include "team_colors.h"
+#include "globalincs/alphacolors.h" //Needed for team colors
 
 #include "mission/missionparse.h"
 
@@ -333,31 +334,35 @@ ADE_VIRTVAR(Team, l_ParseObject, "team", "The team of the parsed ship.", "team",
 	return ade_set_args(L, "o", l_Team.Set(poh->getObject()->team));
 }
 
-ADE_VIRTVAR(TeamColor, l_ParseObject, "string", "The team color", "string", "The name of the team color or empty if not set or invalid.")
+ADE_VIRTVAR(TeamColor, l_ParseObject, "teamcolor", "The team color. Setting the team color here will not be reflected in the mission if the ship is already created. You must do that on the Ship object instead.", "teamcolor", "The team color handle or nil if not set or invalid.")
 {
 	parse_object_h* poh = nullptr;
-	const char* team_color = nullptr;
-	if (!ade_get_args(L, "o|s", l_ParseObject.GetPtr(&poh), &team_color))
-		return ade_set_error(L, "s", "");
+	int idx = -1;
+	if (!ade_get_args(L, "o|o", l_ParseObject.GetPtr(&poh), l_TeamColor.Get(&idx)))
+		return ADE_RETURN_NIL;
 
 	if (!poh->isValid())
-		return ade_set_error(L, "s", "");
-
-	//Set team color
-	if (ADE_SETTING_VAR && team_color != nullptr) {
+		return ADE_RETURN_NIL;
 
+	// Set team color
+	if (ADE_SETTING_VAR && SCP_vector_inbounds(Team_Names, idx)) {
 		// Verify
-		/*if (Team_Colors.find(team_color) == Team_Colors.end()) {
+		const auto& it = Team_Colors.find(Team_Names[idx]);
+		if (it == Team_Colors.end()) {
 			mprintf(("Invalid team color specified in mission file for ship %s. Not setting!\n", poh->getObject()->name));
 		} else {
-			poh->getObject()->team_color_setting = team_color;
-		}*/
+			poh->getObject()->team_color_setting = Team_Names[idx];
+		}
+	}
 
-		LuaError(L, "Setting team colors is not yet supported!");
-	
-	}	
+	// look up by name
+	for (int i = 0; i < static_cast<int>(Team_Names.size()); ++i) {
+		if (lcase_equal(Team_Names[i], poh->getObject()->team_color_setting)) {
+			return ade_set_args(L, "o", l_TeamColor.Set(i));
+		}
+	}
 
-	return ade_set_args(L, "s", poh->getObject()->team_color_setting);
+	return ADE_RETURN_NIL;
 }
 
 ADE_VIRTVAR(InitialHull, l_ParseObject, "number", "The initial hull percentage of this parsed ship.", "number",

code/scripting/api/objs/ship.cpp

@@ -15,6 +15,7 @@
 #include "shipclass.h"
 #include "subsystem.h"
 #include "team.h"
+#include "team_colors.h"
 #include "texture.h"
 #include "vecmath.h"
 #include "weaponclass.h"
@@ -867,6 +868,39 @@ ADE_VIRTVAR(Team, l_Ship, "team", "Ship's team", "team", "Ship team, or invalid
 	return ade_set_args(L, "o", l_Team.Set(shipp->team));
 }
 
+ADE_VIRTVAR(TeamColor, l_Ship, "teamcolor", "The team color. Note that setting the team color here is instant. If you need a fade, then use the sexp.", "teamcolor", "The team color handle or nil if not set or invalid.")
+{
+	object_h* oh = nullptr;
+	int idx = -1;
+	if (!ade_get_args(L, "o|o", l_Ship.GetPtr(&oh), l_TeamColor.Get(&idx)))
+		return ADE_RETURN_NIL;
+
+	if (!oh->isValid())
+		return ADE_RETURN_NIL;
+
+	ship* shipp = &Ships[oh->objp()->instance];
+
+	//Set team color
+	if (ADE_SETTING_VAR && SCP_vector_inbounds(Team_Names, idx)) {
+		// Verify
+		const auto& it = Team_Colors.find(Team_Names[idx]);
+		if (it == Team_Colors.end()) {
+			mprintf(("Invalid team color specified in mission file for ship %s. Not setting!\n", shipp->ship_name));
+		} else {
+			shipp->team_name = Team_Names[idx];
+		}
+	}
+
+	// look up by name
+	for (int i = 0; i < static_cast<int>(Team_Names.size()); ++i) {
+		if (lcase_equal(Team_Names[i], shipp->team_name)) {
+			return ade_set_args(L, "o", l_TeamColor.Set(i));
+		}
+	}
+
+	return ADE_RETURN_NIL;
+}
+
 ADE_VIRTVAR_DEPRECATED(PersonaIndex, l_Ship, "number", "Persona index", "number", "The index of the persona from messages.tbl, 0 if no persona is set", gameversion::version(25, 0), "Deprecated in favor of Persona")
 {
 	object_h *objh;

code/scripting/api/objs/shipclass.cpp

@@ -8,6 +8,7 @@
 #include "cockpit_display.h"
 #include "species.h"
 #include "shiptype.h"
+#include "team_colors.h"
 #include "vecmath.h"
 #include "ship/ship.h"
 #include "playerman/player.h"
@@ -1113,7 +1114,7 @@ ADE_FUNC(isInTechroom, l_Shipclass, NULL, "Gets whether or not the ship class is
 ADE_FUNC(renderTechModel,
 	l_Shipclass,
 	"number X1, number Y1, number X2, number Y2, [number RotationPercent =0, number PitchPercent =0, number "
-	"BankPercent=40, number Zoom=1.3, boolean Lighting=true, string TeamColor=nil]",
+	"BankPercent=40, number Zoom=1.3, boolean Lighting=true, teamcolor TeamColor=nil]",
 	"Draws ship model as if in techroom. True for regular lighting, false for flat lighting.",
 	"boolean",
 	"Whether ship was rendered")
@@ -1123,8 +1124,8 @@ ADE_FUNC(renderTechModel,
 	int idx;
 	float zoom = 1.3f;
 	bool lighting = true;
-	const char* team_color = nullptr;
-	if(!ade_get_args(L, "oiiii|ffffbs", l_Shipclass.Get(&idx), &x1, &y1, &x2, &y2, &rot_angles.h, &rot_angles.p, &rot_angles.b, &zoom, &lighting, &team_color))
+	int tc_idx = -1;
+	if(!ade_get_args(L, "oiiii|ffffbo", l_Shipclass.Get(&idx), &x1, &y1, &x2, &y2, &rot_angles.h, &rot_angles.p, &rot_angles.b, &zoom, &lighting, l_TeamColor.Get(&tc_idx)))
 		return ade_set_error(L, "b", false);
 
 	if(idx < 0 || idx >= ship_info_size())
@@ -1133,6 +1134,8 @@ ADE_FUNC(renderTechModel,
 	if(x2 < x1 || y2 < y1)
 		return ade_set_args(L, "b", false);
 
+	ship_info* sip = &Ship_info[idx];
+
 	CLAMP(rot_angles.p, 0.0f, 100.0f);
 	CLAMP(rot_angles.b, 0.0f, 100.0f);
 	CLAMP(rot_angles.h, 0.0f, 100.0f);
@@ -1147,20 +1150,26 @@ ADE_FUNC(renderTechModel,
 	rot_angles.h = (rot_angles.h*0.01f) * PI2;
 	vm_rotate_matrix_by_angles(&orient, &rot_angles);
 
-	SCP_string tcolor = team_color ? team_color : "";
+	SCP_string tcolor = sip->default_team_name;
+	if (SCP_vector_inbounds(Team_Names, tc_idx)) {
+		const auto& it = Team_Colors.find(Team_Names[tc_idx]);
+		if (it != Team_Colors.end()) {
+			tcolor = Team_Names[tc_idx];
+		}
+	}
 
 	return ade_set_args(L, "b", render_tech_model(TECH_SHIP, x1, y1, x2, y2, zoom, lighting, idx, &orient, tcolor));
 }
 
 // Nuke's alternate tech model rendering function
-ADE_FUNC(renderTechModel2, l_Shipclass, "number X1, number Y1, number X2, number Y2, [orientation Orientation=nil, number Zoom=1.3, string TeamColor=nil]", "Draws ship model as if in techroom", "boolean", "Whether ship was rendered")
+ADE_FUNC(renderTechModel2, l_Shipclass, "number X1, number Y1, number X2, number Y2, [orientation Orientation=nil, number Zoom=1.3, teamcolor TeamColor=nil]", "Draws ship model as if in techroom", "boolean", "Whether ship was rendered")
 {
 	int x1,y1,x2,y2;
 	int idx;
 	float zoom = 1.3f;
 	matrix_h *mh = nullptr;
-	const char* team_color = nullptr;
-	if(!ade_get_args(L, "oiiiio|fs", l_Shipclass.Get(&idx), &x1, &y1, &x2, &y2,  l_Matrix.GetPtr(&mh), &zoom, &team_color))
+	int tc_idx = -1;
+	if(!ade_get_args(L, "oiiiio|fo", l_Shipclass.Get(&idx), &x1, &y1, &x2, &y2,  l_Matrix.GetPtr(&mh), &zoom, l_TeamColor.Get(&tc_idx)))
 		return ade_set_error(L, "b", false);
 
 	if(idx < 0 || idx >= ship_info_size())
@@ -1169,17 +1178,25 @@ ADE_FUNC(renderTechModel2, l_Shipclass, "number X1, number Y1, number X2, number
 	if(x2 < x1 || y2 < y1)
 		return ade_set_args(L, "b", false);
 
+	ship_info* sip = &Ship_info[idx];
+
 	//Handle angles
 	matrix *orient = mh->GetMatrix();
 
-	SCP_string tcolor = team_color ? team_color : "";
+	SCP_string tcolor = sip->default_team_name;
+	if (SCP_vector_inbounds(Team_Names, tc_idx)) {
+		const auto& it = Team_Colors.find(Team_Names[tc_idx]);
+		if (it != Team_Colors.end()) {
+			tcolor = Team_Names[tc_idx];
+		}
+	}
 
 	return ade_set_args(L, "b", render_tech_model(TECH_SHIP, x1, y1, x2, y2, zoom, true, idx, orient, tcolor));
 }
 
 ADE_FUNC(renderSelectModel,
 	l_Shipclass,
-	"boolean restart, number x, number y, [number width = 629, number height = 355, number currentEffectSetting = default, number zoom = 1.3, string TeamColor=nil]",
+	"boolean restart, number x, number y, [number width = 629, number height = 355, number currentEffectSetting = default, number zoom = 1.3, teamcolor TeamColor=nil]",
 	"Draws the 3D select ship model with the chosen effect at the specified coordinates. Restart should "
 	"be true on the first frame this is called and false on subsequent frames. Valid selection effects are 1 (fs1) or 2 (fs2), "
 	"defaults to the mod setting or the model's setting. Zoom is a multiplier to the model's closeup_zoom value.",
@@ -1194,8 +1211,8 @@ ADE_FUNC(renderSelectModel,
 	int y2 = 355;
 	int effect = -1;
 	float zoom = 1.3f;
-	const char* team_color = nullptr;
-	if (!ade_get_args(L, "obii|iiifs", l_Shipclass.Get(&idx), &restart, &x1, &y1, &x2, &y2, &effect, &zoom, &team_color))
+	int tc_idx = -1;
+	if (!ade_get_args(L, "obii|iiifo", l_Shipclass.Get(&idx), &restart, &x1, &y1, &x2, &y2, &effect, &zoom, l_TeamColor.Get(&tc_idx)))
 		return ADE_RETURN_NIL;
 
 	if (idx < 0 || idx >= ship_info_size())
@@ -1230,7 +1247,14 @@ ADE_FUNC(renderSelectModel,
 	model_render_params render_info;
 
 	if (sip->uses_team_colors) {
-		SCP_string tcolor = team_color ? team_color : sip->default_team_name;
+		SCP_string tcolor = sip->default_team_name;
+
+		if (SCP_vector_inbounds(Team_Names, tc_idx)) {
+			const auto& it = Team_Colors.find(Team_Names[tc_idx]);
+			if (it != Team_Colors.end()) {
+				tcolor = Team_Names[tc_idx];
+			}
+		}
 		render_info.set_team_color(tcolor, "none", 0, 0);
 	}
 
@@ -1260,7 +1284,7 @@ ADE_FUNC(renderOverheadModel,
 	"number x, number y, [number width = 467, number height = 362, number|table /* selectedSlot = -1 or empty table */, number selectedWeapon = -1, number hoverSlot = -1, "
 	"number bank1_x = 170, number bank1_y = 203, number bank2_x = 170, number bank2_y = 246, number bank3_x = 170, number bank3_y = 290, "
 	"number bank4_x = 552, number bank4_y = 203, number bank5_x = 552, number bank5_y = 246, number bank6_x = 552, number bank6_y = 290, "
-	"number bank7_x = 552, number bank7_y = 333, number style = 0, string TeamColor=nil]",
+	"number bank7_x = 552, number bank7_y = 333, number style = 0, teamcolor TeamColor=nil]",
 	"Draws the 3D overhead ship model with the lines pointing from bank weapon selections to bank firepoints. SelectedSlot refers to loadout "
 	"ship slots 1-12 where wing 1 is 1-4, wing 2 is 5-8, and wing 3 is 9-12. SelectedWeapon is the index into weapon classes. HoverSlot refers "
 	"to the bank slots 1-7 where 1-3 are primaries and 4-6 are secondaries. Lines will be drawn from any bank containing the SelectedWeapon to "
@@ -1301,12 +1325,12 @@ ADE_FUNC(renderOverheadModel,
 
 	int weapon_list[MAX_SHIP_WEAPONS] = {-1, -1, -1, -1, -1, -1, -1};
 
-	const char* team_color = nullptr;
+	int tc_idx = -1;
 
 	if (lua_isnumber(L, 6)) {
 
 		if (!ade_get_args(L,
-				"oii|iiiiiiiiiiiiiiiiiiiis",
+				"oii|iiiiiiiiiiiiiiiiiiiio",
 				l_Shipclass.Get(&idx),
 				&x1,
 				&y1,
@@ -1330,7 +1354,7 @@ ADE_FUNC(renderOverheadModel,
 				&bank7_x,
 				&bank7_y,
 				&style,
-			    &team_color))
+				l_TeamColor.Get(&tc_idx)))
 			return ADE_RETURN_NIL;
 
 		// Convert this from the Lua index
@@ -1344,7 +1368,7 @@ ADE_FUNC(renderOverheadModel,
 		}
 	} else {
 		if (!ade_get_args(L,
-				"oii|iitiiiiiiiiiiiiiiiiis",
+				"oii|iitiiiiiiiiiiiiiiiiio",
 				l_Shipclass.Get(&idx),
 				&x1,
 				&y1,
@@ -1368,7 +1392,7 @@ ADE_FUNC(renderOverheadModel,
 				&bank7_x,
 				&bank7_y,
 				&style,
-				&team_color))
+				l_TeamColor.Get(&tc_idx)))
 			return ADE_RETURN_NIL;
 
 		int count = 0;
@@ -1415,7 +1439,13 @@ ADE_FUNC(renderOverheadModel,
 
 	ship_info* sip = &Ship_info[idx];
 
-	SCP_string tcolor = team_color ? team_color : sip->default_team_name;
+	SCP_string tcolor = sip->default_team_name;
+	if (SCP_vector_inbounds(Team_Names, tc_idx)) {
+		const auto& it = Team_Colors.find(Team_Names[tc_idx]);
+		if (it != Team_Colors.end()) {
+			tcolor = Team_Names[tc_idx];
+		}
+	}
 
 	int modelNum = model_load(sip->pof_file, sip);
 	model_page_in_textures(modelNum, idx);