Merge pull request #450 from OoliteProject/witchjump_js_enhancements

phkb · web-flow · commit befc6c2b8649 · 2023-10-01T16:12:38.000+11:00
Witchjump js enhancements
diff --git a/src/Core/Entities/PlayerEntity.h b/src/Core/Entities/PlayerEntity.h
@@ -370,7 +370,8 @@ typedef enum
 	OOSystemID				system_id;
 	OOSystemID				target_system_id;
 	OOSystemID				info_system_id;
-
+	OOSystemID				previous_system_id;
+	
 	float					occlusion_dial;
 	
 	OOSystemID				found_system_id;
@@ -510,6 +511,8 @@ typedef enum
 	OORouteType				ANA_mode;
 	OOTimeDelta				witchspaceCountdown;
 	
+	NSString				*_jumpCause;
+
 	// player commander data
 	NSString				*_commanderName;
 	NSString				*_lastsaveName;
@@ -857,11 +860,15 @@ typedef enum
 - (NSPoint) adjusted_chart_centre;
 - (OORouteType) ANAMode;
 
+- (NSString *) jumpCause;
+- (void) setJumpCause:(NSString *)value;
 
 - (OOSystemID) systemID;
 - (void) setSystemID:(OOSystemID) sid;
 - (OOSystemID) targetSystemID;
 - (void) setTargetSystemID:(OOSystemID) sid;
+- (OOSystemID) previousSystemID;
+- (void) setPreviousSystemID:(OOSystemID) sid;
 - (OOSystemID) nextHopTargetSystemID;
 - (OOSystemID) infoSystemID;
 - (void) setInfoSystemID: (OOSystemID) sid moveChart:(BOOL) moveChart;
diff --git a/src/Core/Entities/PlayerEntity.m b/src/Core/Entities/PlayerEntity.m
@@ -696,6 +696,18 @@ - (void) setSystemID:(OOSystemID) sid
 }
 
 
+- (OOSystemID) previousSystemID
+{
+	return previous_system_id;
+}
+
+
+- (void) setPreviousSystemID:(OOSystemID) sid
+{
+	previous_system_id = sid;
+}
+
+
 - (OOSystemID) targetSystemID
 {
 	return target_system_id;
@@ -909,13 +921,16 @@ - (NSDictionary *) commanderDataDictionary
 	NSString	*gal_id = [NSString stringWithFormat:@"%u", galaxy_number];
 	NSString	*sys_id = [NSString stringWithFormat:@"%d", system_id];
 	NSString	*tgt_id = [NSString stringWithFormat:@"%d", target_system_id];
+	NSString	*prv_id = [NSString stringWithFormat:@"%d", previous_system_id];
+
 	// Variable requiredCargoSpace not suitable for Oolite as it currently stands: it retroactively changes a savegame cargo space.
 	//unsigned 	passenger_space = [[OOEquipmentType equipmentTypeWithIdentifier:@"EQ_PASSENGER_BERTH"] requiredCargoSpace];
 	//if (passenger_space == 0) passenger_space = PASSENGER_BERTH_SPACE;
 	
 	[result setObject:gal_id		forKey:@"galaxy_id"];
 	[result setObject:sys_id	forKey:@"system_id"];
 	[result setObject:tgt_id	forKey:@"target_id"];
+	[result setObject:prv_id	forKey:@"previous_system_id"];
 	[result setObject:[NSNumber numberWithFloat:saved_chart_zoom] forKey:@"chart_zoom"];
 	[result setObject:[NSNumber numberWithInt:ANA_mode] forKey:@"chart_ana_mode"];
 	[result setObject:[NSNumber numberWithInt:longRangeChartMode] forKey:@"chart_colour_mode"];
@@ -1260,6 +1275,7 @@ - (BOOL)setCommanderDataFromDictionary:(NSDictionary *) dict
 		if (longRangeChartMode == OOLRC_MODE_UNKNOWN) longRangeChartMode = OOLRC_MODE_SUNCOLOR;
 
 		target_system_id = [dict oo_intForKey:@"target_id" defaultValue:system_id];
+		previous_system_id = [dict oo_intForKey:@"previous_system_id" defaultValue:system_id];
 		info_system_id = target_system_id;
 		coord_vals = ScanTokensFromString([[UNIVERSE systemManager] getProperty:@"coordinates" forSystem:target_system_id inGalaxy:galaxy_number]);		
 		cursor_coordinates.x = [coord_vals oo_unsignedCharAtIndex:0];
@@ -2414,6 +2430,8 @@ - (void) dealloc
 
 	DESTROY(dockingReport);
 	
+	DESTROY(_jumpCause);
+
 	[self destroySound];
 	
 	DESTROY(scannedWormholes);
@@ -3874,7 +3892,7 @@ - (void) performWitchspaceExitUpdates:(OOTimeDelta)delta_t
 		// similarly reset the misjump range to the traditional 0.5
 		[self setScriptedMisjumpRange:0.5];
 
-		[self doScriptEvent:OOJSID("shipExitedWitchspace")];
+		[self doScriptEvent:OOJSID("shipExitedWitchspace") withArgument:[self jumpCause]];
 
 		[self doBookkeeping:delta_t]; // arrival frame updates
 
@@ -7489,9 +7507,14 @@ - (void) enterGalacticWitchspace
 
 
 	[self setStatus:STATUS_ENTERING_WITCHSPACE];
-	ShipScriptEventNoCx(self, "shipWillEnterWitchspace", OOJSSTR("galactic jump"), INT_TO_JSVAL(destGalaxy));
+	JSContext *context = OOJSAcquireContext();
+	[self setJumpCause:@"galactic jump"];
+	[self setPreviousSystemID:[self currentSystemID]];
+	ShipScriptEvent(context, self, "shipWillEnterWitchspace", STRING_TO_JSVAL(JS_InternString(context, [[self jumpCause] UTF8String])), INT_TO_JSVAL(destGalaxy));
+	OOJSRelinquishContext(context);
+
 	[self noteCompassLostTarget];
-	
+
 	[self witchStart];
 	
 	[UNIVERSE removeAllEntitiesExceptPlayer];
@@ -7585,7 +7608,11 @@ - (void) enterWormhole:(WormholeEntity *) w_hole
 	wormhole = [w_hole retain];
 	[self addScannedWormhole:wormhole];
 	[self setStatus:STATUS_ENTERING_WITCHSPACE];
-	ShipScriptEventNoCx(self, "shipWillEnterWitchspace", OOJSSTR("wormhole"), INT_TO_JSVAL([w_hole destination]));
+	JSContext *context = OOJSAcquireContext();
+	[self setJumpCause:@"wormhole"];
+	[self setPreviousSystemID:[self currentSystemID]];
+	ShipScriptEvent(context, self, "shipWillEnterWitchspace", STRING_TO_JSVAL(JS_InternString(context, [[self jumpCause] UTF8String])), INT_TO_JSVAL([w_hole destination]));
+	OOJSRelinquishContext(context);
 	if ([self scriptedMisjump]) 
 	{
 		misjump = YES; // a script could just have changed this to true;
@@ -7653,7 +7680,11 @@ - (void) enterWitchspace
 	[self addScannedWormhole:wormhole];
 	
 	[self setStatus:STATUS_ENTERING_WITCHSPACE];
-	ShipScriptEventNoCx(self, "shipWillEnterWitchspace", OOJSSTR("standard jump"), INT_TO_JSVAL(jumpTarget));
+	JSContext *context = OOJSAcquireContext();
+	[self setJumpCause:@"standard jump"];
+	[self setPreviousSystemID:[self currentSystemID]];
+	ShipScriptEvent(context, self, "shipWillEnterWitchspace", STRING_TO_JSVAL(JS_InternString(context, [[self jumpCause] UTF8String])), INT_TO_JSVAL(jumpTarget));
+	OOJSRelinquishContext(context);
 
 	[self updateSystemMemory];
 	NSUInteger legality = [self legalStatusOfCargoList];
@@ -7854,7 +7885,7 @@ - (void) leaveWitchspace
 		[self doScriptEvent:OOJSID("playerEnteredNewGalaxy") withArgument:[NSNumber numberWithUnsignedInt:galaxy_number]];
 	}
 	
-	[self doScriptEvent:OOJSID("shipWillExitWitchspace")];
+	[self doScriptEvent:OOJSID("shipWillExitWitchspace") withArgument:[self jumpCause]];
 	[UNIVERSE setUpBreakPattern:[self breakPatternPosition] orientation:orientation forDocking:NO];
 }
 
@@ -12955,6 +12986,20 @@ - (void) setDockTarget:(ShipEntity *)entity
 }
 
 
+- (NSString *) jumpCause
+{ 
+	return _jumpCause;
+}
+
+
+- (void) setJumpCause:(NSString *)value
+{
+	NSParameterAssert(value != nil);
+	[_jumpCause autorelease];
+	_jumpCause = [value copy];
+}
+
+
 - (NSString *) commanderName
 {
 	return _commanderName;
diff --git a/src/Core/Scripting/OOJSPlayerShip.m b/src/Core/Scripting/OOJSPlayerShip.m
@@ -160,6 +160,7 @@
 	kPlayerShip_targetSystem,					// target system id, int, read-write
 	kPlayerShip_nextSystem,						// next hop system id, read-only
 	kPlayerShip_infoSystem,						// info (F7 screen) system id, int, read-write
+	kPlayerShip_previousSystem,					// previous system id, read-only
 	kPlayerShip_torusEngaged,					// torus in use, boolean, read-only
 	kPlayerShip_viewDirection,					// view direction identifier, string, read-only
 	kPlayerShip_viewPositionAft,					// view position offset, vector, read-only
@@ -230,6 +231,7 @@
 	{ "targetSystem",					kPlayerShip_targetSystem,					OOJS_PROP_READWRITE_CB },
 	{ "nextSystem",                     kPlayerShip_nextSystem,                     OOJS_PROP_READONLY_CB },
 	{ "infoSystem",						kPlayerShip_infoSystem,						OOJS_PROP_READWRITE_CB },
+	{ "previousSystem",					kPlayerShip_previousSystem,					OOJS_PROP_READONLY_CB },
 	{ "torusEngaged",					kPlayerShip_torusEngaged,					OOJS_PROP_READONLY_CB },
 	{ "viewDirection",					kPlayerShip_viewDirection,					OOJS_PROP_READONLY_CB },
 	{ "viewPositionAft",				kPlayerShip_viewPositionAft,				OOJS_PROP_READONLY_CB },
@@ -477,6 +479,10 @@ static JSBool PlayerShipGetProperty(JSContext *context, JSObject *this, jsid pro
 			*value = INT_TO_JSVAL([player infoSystemID]);
 			return YES;
 
+		case kPlayerShip_previousSystem:
+			*value = INT_TO_JSVAL([player previousSystemID]);
+			return YES;
+			
 		case kPlayerShip_routeMode:
 		{
 			OORouteType route = [player ANAMode];
diff --git a/src/Core/Universe.m b/src/Core/Universe.m
@@ -1032,9 +1032,12 @@ - (void) carryPlayerOn:(StationEntity*)carrier inWormhole:(WormholeEntity*)wormh
 
 		[player setWormhole:wormhole];
 		[player addScannedWormhole:wormhole];
-
-		ShipScriptEventNoCx(player, "shipWillEnterWitchspace", OOJSSTR("carried"), INT_TO_JSVAL(dest));
-		
+		JSContext *context = OOJSAcquireContext();
+		[player setJumpCause:@"carried"];
+		[player setPreviousSystemID:[player systemID]];
+		ShipScriptEvent(context, player, "shipWillEnterWitchspace", STRING_TO_JSVAL(JS_InternString(context, [[player jumpCause] UTF8String])), INT_TO_JSVAL(dest));
+		OOJSRelinquishContext(context);
+	
 		[self allShipsDoScriptEvent:OOJSID("playerWillEnterWitchspace") andReactToAIMessage:@"PLAYER WITCHSPACE"];
 
 		[player setRandom_factor:(ranrot_rand() & 255)];						// random factor for market values is reset
@@ -1076,8 +1079,8 @@ - (void) carryPlayerOn:(StationEntity*)carrier inWormhole:(WormholeEntity*)wormh
 											 alpha:0.0f];
 
 		[self setWitchspaceBreakPattern:YES];
-		[player doScriptEvent:OOJSID("shipWillExitWitchspace")];
-		[player doScriptEvent:OOJSID("shipExitedWitchspace")];
+		[player doScriptEvent:OOJSID("shipWillExitWitchspace") withArgument:[player jumpCause]];
+		[player doScriptEvent:OOJSID("shipExitedWitchspace") withArgument:[player jumpCause]];
 		[player setWormhole:nil];
 
 }
@@ -1095,7 +1098,8 @@ - (void) setUpUniverseFromStation
 		// check the nearest system
 		OOSystemID sys = [self findSystemNumberAtCoords:coords withGalaxy:[player galaxyNumber] includingHidden:YES];
 		BOOL interstel =[dockedStation interstellarUndockingAllowed];// && (s_seed.d != coords.x || s_seed.b != coords.y); - Nikos 20110623: Do we really need the commented out check?
-		
+		[player setPreviousSystemID:[player currentSystemID]];
+
 		// remove everything except the player and the docked station
 		if (dockedStation && !interstel)
 		{	// jump to the nearest system
@@ -1148,8 +1152,9 @@ - (void) setUpUniverseFromStation
 					[dockedStation setPosition: pos];
 				}
 				[self setWitchspaceBreakPattern:YES];
-				[player doScriptEvent:OOJSID("shipWillExitWitchspace")];
-				[player doScriptEvent:OOJSID("shipExitedWitchspace")];
+				[player setJumpCause:@"carried"];
+				[player doScriptEvent:OOJSID("shipWillExitWitchspace") withArgument:[player jumpCause]];
+				[player doScriptEvent:OOJSID("shipExitedWitchspace") withArgument:[player jumpCause]];
 			}
 		}
 	}
