Merge pull request #7123 from Goober5000/ship_cleanup_tweak

tweak ship_cleanup

Author: Goober5000

code/mission/missionparse.cpp

@@ -663,7 +663,7 @@ MONITOR(NumShipArrivals)
 MONITOR(NumShipDepartures)
 
 const std::shared_ptr<scripting::Hook<scripting::hooks::ShipDepartConditions>> OnDepartureStartedHook = scripting::Hook<scripting::hooks::ShipDepartConditions>::Factory(
-	"On Departure Started", "Called when a ship starts the departure process.",
+	"On Departure Started", "Called when a ship initiates a departure (acquires a hangar bay path or begins to warp) but is not actually exiting the mission yet.",
 	{
 		{"Self", "ship", "An alias for Ship."},
 		{"Ship", "ship", "The ship that has begun the departure process."},

code/scripting/api/libs/mission.cpp

@@ -486,7 +486,7 @@ ADE_INDEXER(l_Mission_Ships, "number/string IndexOrName", "Gets ship", "ship", "
 	auto entry = ship_registry_get(name);
 	if (entry)
 	{
-		if (entry->has_shipp())
+		if (entry->has_objp())
 			objnum = entry->objnum;
 	}
 	else

code/scripting/global_hooks.cpp

@@ -304,7 +304,7 @@ const std::shared_ptr<Hook<ShipDepartConditions>> OnShipDepart = Hook<ShipDepart
 	"Invoked when a ship departs the mission without being destroyed.",
 	{
 		{"Ship", "ship", "The ship departing the mission"},
-		{"JumpNode", "string", "The name of the jump node the ship jumped out of. Can be nil."},
+		{"JumpNode", "string", "The name of the jump node the ship was in when it departed. Can be nil."},
 		{"Method", "ship", "The name of the method the ship used to depart. One of: 'SHIP_DEPARTED', 'SHIP_DEPARTED_WARP', 'SHIP_DEPARTED_BAY', 'SHIP_VANISHED', 'SHIP_DEPARTED_REDALERT'."},
 	});
 

code/ship/ship.cpp

@@ -9134,11 +9134,9 @@ void ship_cleanup(int shipnum, int cleanup_mode)
 	// this should never happen
 	Assertion(Ship_registry_map.find(shipp->ship_name) != Ship_registry_map.end(), "Ship %s was destroyed, but was never stored in the ship registry!", shipp->ship_name);
 
-	// Goober5000 - handle ship registry
+	// Goober5000 - handle ship registry, part 1
 	auto entry = &Ship_registry[Ship_registry_map[shipp->ship_name]];
 	entry->status = ShipStatus::EXITED;
-	entry->objnum = -1;
-	entry->shipnum = -1;
 	entry->cleanup_mode = cleanup_mode;
 
 	// add the information to the exited ship list
@@ -9289,6 +9287,10 @@ void ship_cleanup(int shipnum, int cleanup_mode)
 	// (for exploding ships, this list should have already been cleared by now, via
 	// do_dying_undock_physics, except in the case of the destroy-instantly sexp)
 	dock_dead_undock_all(objp);
+
+	// Goober5000 - handle ship registry, part 2
+	entry->objnum = -1;
+	entry->shipnum = -1;
 }
 
 /**