Fix dragger tool not reverting car correctly on cancel

Co-authored-by: guysv <sviryguy@gmail.com>

Author: Basssiiie

src/services/spacingEditor.ts

@@ -1,6 +1,6 @@
 import { RideTrain } from "../objects/rideTrain";
 import * as Log from "../utilities/logger";
-import { getTileByCoords } from "../utilities/map";
+import { getIndexForTrackElementAt } from "../utilities/map";
 import { abs } from "../utilities/math";
 import { isNull, isUndefined } from "../utilities/type";
 import { getSubpositionTranslationDistance, getTrackSegmentDistances, TrackDistances } from "./subpositionHelper";
@@ -200,7 +200,7 @@ function calculateSpacingToPrecedingVehicle(car: Car, carInFront: Car): number |
 /**
  * Get a track iterator for the specified track location.
  */
-function getTrackIteratorAtLocation(trackLocation: CoordsXYZD): TrackIterator | null
+function getTrackIteratorAtLocation(trackLocation: CarTrackLocation): TrackIterator | null
 {
 	const currentTrackIndex = getIndexForTrackElementAt(trackLocation);
 	if (isNull(currentTrackIndex))
@@ -218,27 +218,6 @@ function getTrackIteratorAtLocation(trackLocation: CoordsXYZD): TrackIterator |
 	return iterator;
 }
 
-/**
- * Finds the index of a matching track element on the specified tile.
- */
-function getIndexForTrackElementAt(coords: CoordsXYZD): number | null
-{
-	const tile = getTileByCoords(coords.x, coords.y);
-	const allElements = tile.elements, len = allElements.length;
-
-	for (let i = 0; i < len; i++)
-	{
-		const element = tile.elements[i];
-		if (element.type === "track"
-			&& element.baseZ === coords.z
-			&& element.direction === coords.direction)
-		{
-			return i;
-		}
-	}
-	return null;
-}
-
 /**
  * Returns true if the two locations are exactly equal, or false if not.
  */

src/services/vehicleDragger.ts

@@ -2,7 +2,7 @@ import { Store } from "openrct2-flexui";
 import { isMultiplayer } from "../environment";
 import { getCarById, RideVehicle } from "../objects/rideVehicle";
 import * as Log from "../utilities/logger";
-import { alignWithMap, getTileElement, toTileUnit } from "../utilities/map";
+import { alignWithMap, getIndexForTrackElementAt, getTileElement, toTileUnit } from "../utilities/map";
 import { cancelCurrentTool, cancelTools } from "../utilities/tools";
 import { isNumber, isUndefined } from "../utilities/type";
 import { register } from "./actions";
@@ -21,8 +21,7 @@ export const dragToolId = "rve-drag-vehicle";
 /**
  * Enable or disable a tool to drag the vehicle to a new location.
  */
-export function toggleVehicleDragger(isPressed: boolean, storeVehicle: Store<[RideVehicle, number] | null>, storeX: Store<number>, storeY: Store<number>, storeZ: Store<number>,
-	storeTrackLocation: Store<CarTrackLocation | null>, storeTrackProgress: Store<number>, onCancel: () => void): void
+export function toggleVehicleDragger(isPressed: boolean, storeVehicle: Store<[RideVehicle, number] | null>, storeX: Store<number>, storeY: Store<number>, storeZ: Store<number>, storeTrackLocation: Store<CarTrackLocation | null>, storeTrackProgress: Store<number>, onCancel: () => void): void
 {
 	const rideVehicle = storeVehicle.get();
 	if (!isPressed || !rideVehicle)
@@ -75,6 +74,13 @@ export function toggleVehicleDragger(isPressed: boolean, storeVehicle: Store<[Ri
 			if (originalPosition.revert)
 			{
 				Log.debug("[VehicleDragger] Finish tool & revert position to", originalPosition, rideVehicle[0]._car());
+
+				const track = originalPosition.track;
+				if (track)
+				{
+					(<DragPosition>originalPosition).trackElementIndex = getIndexForTrackElementAt(track);
+				}
+
 				updateCarPosition(rideVehicle, originalPosition, DragState.Cancel);
 			}
 			ui.tileSelection.tiles = [];
@@ -100,6 +106,9 @@ interface DragPosition extends CoordsXYZ
 {
 	trackElementIndex?: number | null;
 	progress?: number | null;
+
+	/** The track to move on to. Only available when cancelling the tool. */
+	track?: CarTrackLocation | null;
 }
 
 /**
@@ -201,19 +210,31 @@ function updateVehicleDrag(args: DragVehicleArgs): void
 {
 	const id = args.target;
 	const car = getCarById(args.target);
+
 	if (!car)
 	{
 		return;
 	}
 
 	const position = args.position;
 	const progress = position.progress;
+	let skipCarXYZ: boolean | undefined;
+
 	if (isNumber(position.trackElementIndex) && isNumber(progress))
 	{
-		car.moveToTrack(toTileUnit(position.x), toTileUnit(position.y), position.trackElementIndex);
+		const track: CoordsXY = position.track || position;
+
+		car.moveToTrack(toTileUnit(track.x), toTileUnit(track.y), position.trackElementIndex);
 		car.travelBy(getDistanceFromProgress(car, progress - car.trackProgress));
+
+		// If cancelling, also update the car XYZ, as it may be different from the track.
+		if (args.state !== DragState.Cancel)
+		{
+			skipCarXYZ = true;
+		}
 	}
-	else
+
+	if (!skipCarXYZ)
 	{
 		car.x = position.x;
 		car.y = position.y;

src/utilities/map.ts

@@ -34,3 +34,25 @@ export function getTileElement(x: number, y: number, elementIdx: number): TileEl
 	const tile = getTileByCoords(x, y);
 	return tile.getElement(elementIdx);
 }
+
+/**
+ * Finds the index of a matching track element on the specified tile.
+ */
+export function getIndexForTrackElementAt(location: CarTrackLocation): number | null
+{
+	const tile = getTileByCoords(location.x, location.y);
+	const allElements = tile.elements, len = allElements.length;
+
+	for (let i = 0; i < len; i++)
+	{
+		const element = tile.elements[i];
+		if (element.type === "track"
+			&& element.baseZ === location.z
+			&& element.direction === location.direction
+			&& element.trackType === location.trackType)
+		{
+			return i;
+		}
+	}
+	return null;
+}