lua table prop support

Author: MjnMixael

code/model/modelrender.cpp

@@ -25,6 +25,7 @@
 #include "mod_table/mod_table.h"
 #include "nebula/neb.h"
 #include "particle/particle.h"
+#include "prop/prop.h"
 #include "render/3dinternal.h"
 #include "render/batching.h"
 #include "ship/ship.h"
@@ -3135,6 +3136,22 @@ bool render_tech_model(tech_render_type model_type, int x1, int y1, int x2, int
 
 			break;
 
+		case TECH_PROP:
+			prop_info* pip;
+			pip = &Prop_info[class_idx];
+
+			closeup_pos = &pip->closeup_pos;
+			closeup_zoom = pip->closeup_zoom;
+
+			if (pip->flags[Prop::Info_Flags::No_lighting]) {
+				model_lighting = false;
+			}
+
+			// Make sure model is loaded
+			model_num = model_load(pip->pof_file);
+
+			break;
+
 		case TECH_WEAPON:
 			weapon_info* wip;
 			wip = &Weapon_info[class_idx];

code/model/modelrender.h

@@ -31,7 +31,8 @@ typedef enum {
 	TECH_SHIP,
 	TECH_WEAPON,
 	TECH_POF,
-	TECH_JUMP_NODE
+	TECH_JUMP_NODE,
+	TECH_PROP,
 } tech_render_type;
 
 inline int in_box(const vec3d *min, const vec3d *max, const vec3d *pos, const vec3d *view_position)

code/parse/sexp.h

@@ -19,6 +19,7 @@
 
 class ship_subsys;
 class ship;
+class prop;
 class waypoint_list;
 class object;
 class waypoint;
@@ -1484,6 +1485,7 @@ struct wing;
 // Goober5000 - stuff with caching
 // (included in the header file because Lua uses the first three)
 extern const ship_registry_entry *eval_ship(int node);
+extern const prop* eval_prop(int node);
 extern wing *eval_wing(int node);
 extern int sexp_get_variable_index(int node);
 extern int sexp_atoi(int node);

code/parse/sexp/LuaSEXP.cpp

@@ -17,6 +17,8 @@
 #include "scripting/api/objs/message.h"
 #include "scripting/api/objs/model.h"
 #include "scripting/api/objs/oswpt.h"
+#include "scripting/api/objs/prop.h"
+#include "scripting/api/objs/propclass.h"
 #include "scripting/api/objs/sexpvar.h"
 #include "scripting/api/objs/ship.h"
 #include "scripting/api/objs/shipclass.h"
@@ -28,6 +30,7 @@
 #include "scripting/api/objs/wing.h"
 #include "scripting/scripting.h"
 #include "ship/ship.h"
+#include "prop/prop.h"
 #include "utils/string_utils.h"
 #include "weapon/weapon.h"
 
@@ -41,13 +44,16 @@ static SCP_unordered_map<SCP_string, int> parameter_type_mapping {
 														  { "string",       OPF_STRING },
 														  { "ship",         OPF_SHIP },
 														  { "shipname",     OPF_SHIP },
+														  { "prop",         OPF_PROP },
+														  { "propname",     OPF_PROP },
 														  { "team",         OPF_IFF },
 														  { "waypointpath", OPF_WAYPOINT_PATH },
 														  { "waypoint",     OPF_POINT },
 														  { "variable",     OPF_VARIABLE_NAME },
 														  { "message",      OPF_MESSAGE },
 														  { "wing",         OPF_WING },
 														  { "shipclass",    OPF_SHIP_CLASS_NAME },
+														  { "propclass",    OPF_PROP_CLASS_NAME },
 														  { "weaponclass",  OPF_WEAPON_NAME },
 														  { "soundentry",   OPF_GAME_SND }, 
 														  { "ship+waypoint",OPF_SHIP_POINT },
@@ -199,6 +205,29 @@ luacpp::LuaValue LuaSEXP::sexpToLua(int node, int argnum, int parent_node) const
 
 		return LuaValue::createValue(_action.getLuaState(), l_Ship.Set(object_h(objp)));
 	}
+	case OPF_PROP: {
+		auto ship_entry = eval_prop(node);
+
+		// if this is a shipname type, we want the name of a valid ship but not the ship itself
+		// (if the ship is not valid, return an empty string)
+		if (argtype.first == "propname") {
+			return LuaValue::createValue(_action.getLuaState(), ship_entry ? ship_entry->prop_name : "");
+		}
+
+		if (!ship_entry || (ship_entry->objnum >= 0)) {
+			// Name is invalid
+			return LuaValue::createValue(_action.getLuaState(), l_Prop.Set(object_h()));
+		}
+
+		auto objp = &Objects[ship_entry->objnum];
+
+		// The other SEXP code does not validate the object type so this should be safe
+		Assertion(objp->type == OBJ_PROP,
+			"Prop '%s' was found in the Props array but has a different object type in the Objects array. Get a coder!",
+			CTEXT(node));
+
+		return LuaValue::createValue(_action.getLuaState(), l_Prop.Set(object_h(objp)));
+	}
 	case OPF_MESSAGE: {
 		auto name = CTEXT(node);
 
@@ -224,6 +253,10 @@ luacpp::LuaValue LuaSEXP::sexpToLua(int node, int argnum, int parent_node) const
 		auto name = CTEXT(node);
 		return LuaValue::createValue(_action.getLuaState(), l_Shipclass.Set(ship_info_lookup(name)));
 	}
+	case OPF_PROP_CLASS_NAME: {
+		auto name = CTEXT(node);
+		return LuaValue::createValue(_action.getLuaState(), l_Propclass.Set(prop_info_lookup(name)));
+	}
 	case OPF_WEAPON_NAME: {
 		auto name = CTEXT(node);
 		return LuaValue::createValue(_action.getLuaState(), l_Weaponclass.Set(weapon_info_lookup(name)));

code/prop/prop.cpp

@@ -8,6 +8,8 @@
 
 MONITOR(NumPropsRend)
 
+bool Props_inited = false;
+
 SCP_vector<prop_info> Prop_info;
 
 SCP_vector<prop> Props;
@@ -142,9 +144,67 @@ void parse_prop_table(const char* filename)
 		required_string("+POF file:");
 		stuff_string(pip->pof_file, F_NAME, MAX_FILENAME_LEN);
 
+		if (optional_string("$Closeup_pos:")) {
+			stuff_vec3d(&pip->closeup_pos);
+		} else if (first_time && VALID_FNAME(pip->pof_file)) {
+			// Calculate from the model file. This is inefficient, but whatever
+			int model_idx = model_load(pip->pof_file);
+			polymodel* pm = model_get(model_idx);
+
+			// Go through, find best
+			pip->closeup_pos.xyz.z = fabsf(pm->maxs.xyz.z);
+
+			float temp = fabsf(pm->mins.xyz.z);
+			if (temp > pip->closeup_pos.xyz.z)
+				pip->closeup_pos.xyz.z = temp;
+
+			// Now multiply by 2
+			pip->closeup_pos.xyz.z *= -2.0f;
+
+			// We're done with the model.
+			model_unload(model_idx);
+		}
+
+		if (optional_string("$Closeup_zoom:")) {
+			stuff_float(&pip->closeup_zoom);
+
+			if (pip->closeup_zoom <= 0.0f) {
+				mprintf(("Warning!  Prop '%s' has a $Closeup_zoom value that is less than or equal to 0 (%f). Setting "
+						 "to default value.\n",
+					pip->name,
+					pip->closeup_zoom));
+				pip->closeup_zoom = 0.5f;
+			}
+		}
+
 		if(optional_string("$Detail distance:")) {
 			pip->num_detail_levels = (int)stuff_int_list(pip->detail_distance, MAX_PROP_DETAIL_LEVELS, RAW_INTEGER_TYPE);
 		}
+
+		if (optional_string("$Custom data:")) {
+			parse_string_map(pip->custom_data, "$end_custom_data", "+Val:");
+		}
+
+		if (optional_string("$Custom Strings")) {
+			while (optional_string("$Name:")) {
+				custom_string cs;
+
+				// The name of the string
+				stuff_string(cs.name, F_NAME);
+
+				// Arbitrary string value used for grouping strings together
+				required_string("+Value:");
+				stuff_string(cs.value, F_NAME);
+
+				// The string text itself
+				required_string("+String:");
+				stuff_string(cs.text, F_MULTITEXT);
+
+				pip->custom_strings.push_back(cs);
+			}
+
+			required_string("$end_custom_strings");
+		}
 	}
 
 	required_string("#END");
@@ -160,6 +220,8 @@ void prop_init()
 
 	// parse any modular tables
 	parse_modular_table("*-prp.tbm", parse_prop_table);
+
+	Props_inited = true;
 }
 
 /**
@@ -327,6 +389,125 @@ void prop_delete(object* obj)
 	Props.erase(Props.begin() + num);
 }
 
+/**
+ * Change the prop model for a prop to that for prop class 'prop_type'
+ *
+ * @param n			index of prop in ::Props[] array
+ * @param prop_type	prop class (index into ::Prop_info vector)
+ */
+static void prop_model_change(int n, int prop_type)
+{
+	Assert( n >= 0 && n < MAX_PROPS );
+	prop* sp = &Props[n];
+	prop_info* sip = &(Prop_info[prop_type]);
+	object* objp = &Objects[sp->objnum];
+	polymodel_instance* pmi = model_get_instance(sp->model_instance_num);
+
+	// get new model
+	if (sip->model_num == -1) {
+		sip->model_num = model_load(sip->pof_file);
+	}
+
+	polymodel* pm = model_get(sip->model_num);
+	Objects[sp->objnum].radius = model_get_radius(pm->id);
+
+	// page in nondims in game
+	if ( !Fred_running )
+		model_page_in_textures(sip->model_num, prop_type);
+
+	// allocate memory for keeping glow point bank status (enabled/disabled)
+	{
+		bool val = true; // default value, enabled
+
+		// clear out any old gpb's first, then add new ones if needed
+		sp->glow_point_bank_active.clear();
+
+		if (pm->n_glow_point_banks)
+			sp->glow_point_bank_active.resize( pm->n_glow_point_banks, val );
+		
+		// set any default off banks to off
+		for (int bank = 0; bank < pm->n_glow_point_banks; bank++) {
+			glow_point_bank_override* gpo = nullptr;
+
+			SCP_unordered_map<int, void*>::iterator gpoi = sip->glowpoint_bank_override_map.find(bank);
+			if (gpoi != sip->glowpoint_bank_override_map.end()) {
+				gpo = (glow_point_bank_override*)sip->glowpoint_bank_override_map[bank];
+			}
+
+			if (gpo) {
+				if (gpo->default_off) {
+					sp->glow_point_bank_active[bank] = false;
+				}
+			}
+		}
+	}
+
+	if ( sip->num_detail_levels != pm->n_detail_levels )
+	{
+		if ( !Is_standalone )
+		{
+			// just log to file for standalone servers
+			Warning(LOCATION, "For prop '%s', detail level\nmismatch. Table has %d,\nPOF has %d.", sip->name, sip->num_detail_levels, pm->n_detail_levels );
+		}
+		else
+		{
+			nprintf(("Warning",  "For prop '%s', detail level mismatch. Table has %d, POF has %d.", sip->name, sip->num_detail_levels, pm->n_detail_levels ));
+		}
+	}	
+	for (int i=0; i<pm->n_detail_levels; i++ )
+		pm->detail_depth[i] = (i < sip->num_detail_levels) ? i2fl(sip->detail_distance[i]) : 0.0f;
+
+	// reset texture animations
+	//sp->base_texture_anim_timestamp = _timestamp();
+
+	model_delete_instance(sp->model_instance_num);
+
+	// create new model instance data
+	// note: this is needed for both subsystem stuff and submodel animation stuff
+	sp->model_instance_num = model_create_instance(OBJ_INDEX(objp), sip->model_num);
+	pmi = model_get_instance(sp->model_instance_num);
+}
+
+/**
+ * Change the prop class on a prop, and changing all required information
+ * for consistency
+ *
+ * @param n			index of prop in ::Props[] array
+ * @param prop_type	prop class (index into ::Prop_info vector)
+ * @param by_sexp	SEXP reference
+ */
+void change_prop_type(int n, int prop_type)
+{
+	Assert( n >= 0 && n < MAX_PROPS );
+	prop* sp = &Props[n];
+
+	// do a quick out if we're already using the new ship class
+	if (sp->prop_info_index == prop_type)
+		return;
+
+	int objnum = sp->objnum;
+	//auto prop_entry = ship_registry_get(sp->prop_name);
+
+	prop_info* sip = &(Prop_info[prop_type]);
+	prop_info* sip_orig = &Prop_info[sp->prop_info_index];
+	object* objp = &Objects[objnum];
+
+	// point to new ship data
+	prop_model_change(n, prop_type);
+	sp->prop_info_index = prop_type;
+
+	// get the before and after models (the new model may have only been loaded in ship_model_change)
+	auto pm = model_get(sip->model_num);
+	auto pm_orig = model_get(sip_orig->model_num);
+
+	// check class-specific flags
+
+	if (sip->flags[Prop::Info_Flags::No_collide])								// changing TO a no-collision ship class
+		obj_set_flags(objp, objp->flags - Object::Object_Flags::Collides);
+	else if (sip_orig->flags[Prop::Info_Flags::No_collide])						// changing FROM a no-collision ship class
+		obj_set_flags(objp, objp->flags + Object::Object_Flags::Collides);
+}
+
 void prop_render(object* obj, model_draw_list* scene)
 {
 	int num = obj->instance;

code/prop/prop.h

@@ -10,14 +10,17 @@
 #define MAX_PROP_DETAIL_LEVELS    MAX_SHIP_DETAIL_LEVELS
 
 typedef struct prop_info {
-	char name[NAME_LENGTH];               // Prop name
-	char pof_file[MAX_FILENAME_LEN];      // Pof filename
-	int model_num;                        // The model number of the loaded POF
-	//int model_instance;                   // The model instance
-	int num_detail_levels;                // Detail levels of the model
-	int detail_distance[MAX_PROP_DETAIL_LEVELS]; // distance to change detail levels at
-	SCP_unordered_map<int, void*> glowpoint_bank_override_map;
-	flagset<Prop::Info_Flags> flags; // Info flags
+	char name[NAME_LENGTH];                                     // Prop name
+	char pof_file[MAX_FILENAME_LEN];                            // Pof filename
+	vec3d closeup_pos;                                          // position for camera when using ship in closeup view (eg briefing and techroom)
+	float closeup_zoom;                                         // zoom when using ship in closeup view (eg briefing and techroom)
+	int model_num;                                              // The model number of the loaded POF
+	int num_detail_levels;                                      // Detail levels of the model
+	int detail_distance[MAX_PROP_DETAIL_LEVELS];                // distance to change detail levels at
+	SCP_unordered_map<int, void*> glowpoint_bank_override_map;  // Glow point bank overrides currently unused
+	flagset<Prop::Info_Flags> flags;                            // Info flags
+	SCP_map<SCP_string, SCP_string> custom_data;                // Custom data for this prop
+	SCP_vector<custom_string> custom_strings;                   // Custom strings for this prop
 } prop_info;
 
 typedef struct prop {
@@ -41,11 +44,18 @@ typedef struct parsed_prop {
 	flagset<Mission::Parse_Object_Flags> flags;
 } parsed_prop;
 
+extern bool Props_inited;
+
 // Global prop info array
 extern SCP_vector<prop_info> Prop_info;
 
 extern SCP_vector<prop> Props;
 
+inline int prop_info_size()
+{
+	return static_cast<int>(Prop_info.size());
+}
+
 // Load all props from table
 void prop_init();
 
@@ -59,4 +69,6 @@ void props_level_close();
 int prop_info_lookup(const char* token);
 int prop_name_lookup(const char* name);
 
+void change_prop_type(int n, int prop_type);
+
 void spawn_test_prop();