parse prop flags and further ensure props are inited and closed correctly

Author: MjnMixael

code/lab/manager/lab_manager.cpp

@@ -10,6 +10,7 @@
 #include "ship/ship.h"
 #include "ship/shipfx.h"
 #include "particle/particle.h"
+#include "prop/prop.h"
 #include "weapon/muzzleflash.h"
 #include "weapon/beam.h"
 #include "ai/aigoals.h"
@@ -45,6 +46,7 @@ LabManager::LabManager() {
 	debris_init();
 	extern void debris_page_in();
 	debris_page_in();
+	props_level_init();
 	asteroid_level_init();
 	shockwave_level_init();
 	ship_level_init();

code/lab/manager/lab_manager.h

@@ -58,6 +58,9 @@ class LabManager {
 		// Unload any asteroids that were loaded
 		asteroid_level_close();
 
+		// Unload any props that were loaded
+		props_level_close();
+
 		// Lab can only be entered from the Mainhall so this should be safe
 		model_free_all();
 

code/object/object.cpp

@@ -672,6 +672,10 @@ void obj_delete_all()
 		obj_delete(i);
 	}
 
+	// If we've removed all objects then we can safely
+	// clear the Props vector TODO maybe remove this?
+	Props.clear();
+
 	mprintf(("Cleanup: Deleted %i objects\n", counter));
 }
 

code/prop/prop.cpp

@@ -6,6 +6,7 @@
 #include "model/model.h"
 #include "model/modelreplace.h"
 #include "parse/parselo.h"
+#include "prop/prop_flags.h"
 #include "render/3d.h"
 #include "ship/shipfx.h"
 #include "object/objcollide.h"
@@ -24,6 +25,15 @@ SCP_vector<prop_category> Prop_categories;
 
 static SCP_vector<SCP_string> Removed_props;
 
+flag_def_list_new<Prop::Info_Flags> Prop_flags[] = {
+    { "no_collide",					Prop::Info_Flags::No_collide,				true, false },
+    { "no_fred",					Prop::Info_Flags::No_fred,				true, false },
+    { "no lighting",				Prop::Info_Flags::No_lighting,			true, false }
+	//{ "no impact debris",			Prop::Info_Flags::No_impact_debris,		true, false },
+};
+
+const size_t Num_prop_flags = sizeof(Prop_flags) / sizeof(flag_def_list_new<Prop::Info_Flags>);
+
 /**
  * Return the index of Prop_info[].name that is *token.
  */
@@ -193,7 +203,7 @@ void parse_prop_table(const char* filename)
 			pip->name = fname;
 		}
 
-		if (optional_string("+POF file:")) {
+		if (optional_string("$POF file:")) {
 			char temp[32];
 			stuff_string(temp, F_NAME, MAX_FILENAME_LEN);
 
@@ -257,6 +267,44 @@ void parse_prop_table(const char* filename)
 			stuff_string(pip->category, F_NAME);
 		}
 
+		if (optional_string("$Flags:")) {
+			SCP_vector<SCP_string> prop_strings;
+			stuff_string_list(prop_strings);
+
+			for (const auto& flag : prop_strings) {
+				// get ship type from ship flags
+				const char* cur_flag = flag.c_str();
+				bool flag_found = false;
+
+				// check various ship flags
+				for (size_t idx = 0; idx < Num_prop_flags; idx++) {
+					if (!stricmp(Prop_flags[idx].name, cur_flag)) {
+						flag_found = true;
+
+						if (!Prop_flags[idx].in_use)
+							Warning(LOCATION,
+								"Use of '%s' flag for Prop Class '%s' - this flag is no longer needed.",
+								Prop_flags[idx].name,
+								pip->name.c_str());
+						else
+							pip->flags.set(Prop_flags[idx].def);
+
+						break;
+					}
+				}
+
+				// catch typos or deprecations
+				if (!stricmp(cur_flag, "no-collide") || !stricmp(cur_flag, "no_collide")) {
+					flag_found = true;
+					pip->flags.set(Prop::Info_Flags::No_collide);
+				}
+
+				if (!flag_found) {
+					Warning(LOCATION, "Bogus string in ship flags: %s\n", cur_flag);
+				}
+			}
+		}
+
 		if (optional_string("$Custom data:")) {
 			parse_string_map(pip->custom_data, "$end_custom_data", "+Val:");
 		}
@@ -723,6 +771,40 @@ void prop_render(object* obj, model_draw_list* scene)
 	model_render_queue(&render_info, scene, pip->model_num, &obj->orient, &obj->pos);
 }
 
+// Draft. Props vector uses std::optional to allow for empty slots for deleted props so the indices of the remaining
+// props do not change. In long FRED sessions without saving and loading, this can lead to a lot of empty slots. However,
+// saving and loading the level will naturally compact the props vector by way of clearing and re-adding props.
+void compact_props_vector()
+{
+	SCP_vector<std::optional<prop>> new_props;
+	SCP_unordered_map<int, int> index_remap;
+
+	for (size_t i = 0; i < Props.size(); ++i) {
+		if (Props[i].has_value()) {
+			index_remap[static_cast<int>(i)] = static_cast<int>(new_props.size());
+			new_props.push_back(std::move(Props[i]));
+		}
+	}
+
+	Props = std::move(new_props);
+
+	// Remap object instances
+	for (object* obj = GET_FIRST(&obj_used_list); obj != END_OF_LIST(&obj_used_list); obj = GET_NEXT(obj)) {
+		if (obj->type == OBJ_PROP && obj->instance >= 0) {
+			auto it = index_remap.find(obj->instance);
+			Assertion(it != index_remap.end(), "Object is pointing to invalid prop index %d! Get a coder!", obj->instance);
+
+			if (it != index_remap.end()) {
+				obj->instance = it->second;
+			}
+		}
+	}
+}
+
+void props_level_init() {
+	Props.clear();
+}
+
 void props_level_close()
 {
 	for (auto& opt_prop : Props) {
@@ -735,7 +817,6 @@ void props_level_close()
 	Props.clear();
 }
 
-
 // handles prop-ship/debris/asteroid/weapon collisions
 int prop_check_collision(object* prop_obj, object* other_obj, vec3d* hitpos, collision_info_struct* prop_hit_info)
 {

code/prop/prop.h

@@ -78,6 +78,7 @@ int prop_create(matrix* orient, vec3d* pos, int prop_type, const char* name = nu
 void prop_delete(object* obj);
 void prop_render(object* obj, model_draw_list* scene);
 
+void props_level_init();
 void props_level_close();
 
 int prop_info_lookup(const char* token);

code/prop/prop_flags.h

@@ -24,8 +24,8 @@ FLAG_LIST(Prop_Flags){
 FLAG_LIST(Info_Flags){
 	No_collide = 0,      // No collisions
 	No_fred,             // not available in fred
-	//No_impact_debris,
 	No_lighting,
+	//No_impact_debris,
 
 	NUM_VALUES};
 

fred2/management.cpp

@@ -877,6 +877,7 @@ void clear_mission(bool fast_reload)
 		model_free_all();				// Free all existing models
 
 	ai_init();
+	props_level_init();
 	asteroid_level_init();
 	ship_level_init();
 	nebula_init(Nebula_index, Nebula_pitch, Nebula_bank, Nebula_heading);

freespace2/freespace.cpp

@@ -935,6 +935,7 @@ void game_level_close()
 		shockwave_level_close();
 		fireball_close();	
 		shield_hit_close();
+		props_level_close();
 		asteroid_level_close();
 		jumpnode_level_close();
 		waypoint_level_close();
@@ -1064,6 +1065,7 @@ void game_level_init()
 	NavSystem_Init();				// zero out the nav system
 
 	ai_level_init();				//	Call this before ship_init() because it reads ai.tbl.
+	props_level_init();
 	multi_init_oo_and_ship_tracker();	// Inits/resets multiplayer ship tracking system.  Has to be done before creating any ships.
 	ship_level_init();
 	player_level_init();

qtfred/src/mission/Editor.cpp

@@ -13,6 +13,7 @@
 #include <mission/missiongoals.h>
 #include <asteroid/asteroid.h>
 #include <jumpnode/jumpnode.h>
+#include <prop/prop.h>
 #include <util.h>
 #include <mission/missionmessage.h>
 #include <gamesnd/eventmusic.h>
@@ -484,6 +485,7 @@ void Editor::clearMission(bool fast_reload) {
 		model_free_all();                // Free all existing models
 
 	ai_init();
+	props_level_init();
 	asteroid_level_init();
 	ship_level_init();
 	nebula_init(Nebula_index, Nebula_pitch, Nebula_bank, Nebula_heading);