Scripting: Add Car.moveToTrack API #23359

guysv · 2024-12-09T00:13:31Z

So #22272 introduced the ability to set a vehicle's track location property, which allows teleporting vehicles across any other track piece available.

Back when I wrote that addition, I noticed that merely setting trackLocation does not actually trigger vehicle redraw. The vehicle teleports to its correct position only after trying to advance the track a bit on its own.

Alternatively, you could trigger track advancement with car.travelBy(), which is how I made the demo. I came to realize using travelBy is kind of hack, so here I figured a way to trigger vehicle redraw after setting trackLocation.

The way travelBy gets this effect is by adding some pending progress to be made for that vehicle (vehicle.remaining_distance, and calling UpdateTrackMotion, which eventually translates remaining_distance into calls to UpdateTrackMotionForwards (when going forward)

So the first move is to introduce a new vehicle flag VehicleFlags::UpdateSingleCar, that bypasses UpdateTrackMotion remaining_distance check, and makes the call to UpdateTrackMotionForwards regardless of pending moves.

Next, use VehicleFlags::UpdateSingleCar to also prevent UpdateTrackMotionForwards from advancing vehicle.track_progress, as we don't want to advance there when just recalculating state due to new trackLocation.

Errm nvm. all that, see second comment. Anyway I found how to recalculate vehicle state according to new track location

@Basssiiie FYI

guysv · 2024-12-09T00:15:01Z

Maybe instead of modifying trackLocation_set, I could introduce a new dedicated Car scripting method dedicated to calling UpdateTrackChange. Open for ideas.

guysv · 2024-12-09T13:31:52Z

I pushed a new version that calculates the new vehicle state on its own instead of piggy-backing UpdateTrackMotionForwards

guysv · 2024-12-09T14:35:48Z

rctdemo17.mp4

le demo (now without travelBy())

I also added track_progress clipping code to be within the current piece when coming from a longer one.

duncanspumpkin · 2024-12-09T17:18:08Z

src/openrct2/ride/Vehicle.cpp

@@ -584,6 +584,20 @@ void Vehicle::MoveRelativeDistance(int32_t distance)
    ClearFlag(VehicleFlags::MoveSingleCar | VehicleFlags::CollisionDisabled);
 }

+void Vehicle::UpdateTrackChange()


This is all only ever useful for your one scripting bit of code it would make more sense to keep it with the rest of the scripting function.

but doesn't it touch private Vehicle fields? I thought this means it has to happen in Vehicle.cpp no?

_vehicleCurPosition namely.

_vehicleCurPosition namely.

Pretty sure that is a global var

well but it's still only accessible from Vehicle.cpp if it's defined there. But nevermind that because I just tested and it works well with just using a local variable instead. dunno why it's being done like that in the existing functions.

But... on my way trying to move it to ScVehicle I ran into couple of Vehicle functions that really are private.
GetTrackProgress/GetMoveInfo/GetRideTypeDescriptor. What do you suggest?

I think the reason all the other users are using a global Is just because thats how it worked in assembly. I'd need to have a look see how all this is getting updated. Perhaps there is a different function we can make that can be used by a few other consumers. I'm just not a fan of having basically half a function in one file and the other half in another.

Not sure I follow what are you suggesting to do? refactor the bunch of other similar code to a single function that sorta looks like what I made?

duncanspumpkin · 2024-12-11T23:01:00Z

I would say bump scripting api version but I'm not sure it's needed at this time.

guysv · 2024-12-12T08:13:22Z

(comment deleted)

I thought I wrote trackLocation_set but I just expanded it to set more track properties onto the vehicle.
I can't tell if anyone who ever used car.trackLocation wants to get redraws now. Probably not?

That's why in my starting attempt I tried to confine all the code that relates to the redraw itself in another function, in case we want to introduce as a new method to Car that won't break earlier car.trackLocation usages.

guysv · 2024-12-12T22:24:15Z

Okay nevermind that^ I think we're ready for merge here.

Basssiiie

I'm still running in some redraw issues when moving the vehicle when the game is paused. Note how only half of the sprite is redrawn in the screenshot below.

When a game tick is triggered (either via the shortcut or unpausing), the vehicle is redrawn fully.

Basssiiie · 2024-12-15T14:00:38Z

src/openrct2/ride/Vehicle.cpp

+    // Clip track progress to avoid being out of bounds of current piece
+    uint16_t trackTotalProgress = GetTrackProgress();
+    if (track_progress >= trackTotalProgress)
+        track_progress = trackTotalProgress - 1;


The track progress is capped here but the track progress of the vehicle is not updated accordingly, so the trackProgress getter now returns an out of bounds value if read after updating the trackLocation.

hmm looks like I didn't even validate for invalid value from GetTrackProgress(). Nice catch!

guysv · 2024-12-26T18:01:20Z

I moved the new functionality to a new API method, Car.moveToTrack({x,y},elementIndex). Easier than documenting how you should only really ever set trackLocation to a valid track piece.

tupaschoal · 2025-01-02T11:26:48Z

@duncanspumpkin and @Basssiiie can you double check this is ready to merge?

Basssiiie

I have tested it again and both the setter and the moveToTrack method still have some issues.

2025-01-02.13-44-13.mp4

Also wouldn't it be better to either have only moveToTrack and then trackLocation as a readonly getter, OR only having trackLocation getter and setter, instead of both the method and the setter?

Click here for my updated test script.

/// <reference path="../bin/openrct2.d.ts" />
// @ts-check

registerPlugin({
	name: "Test track location",
	version: "1",
	authors: ['Basssiiie'],
	targetApiVersion: 82,
	type: "local",
	licence: "MIT",
	main() {
		ui.registerMenuItem("Test track location", function() {
			ui.activateTool({
				id: 'test-pick-vehicle',
				cursor: 'cross_hair',
				filter: ["entity"],
				onDown: function(args) {
					var entityId = args.entityId;
					if (entityId === undefined) return;
					ui.tool.cancel();
					console.log("Entity "+entityId+" selected");
					var entity = map.getEntity(entityId);
					var window = ui.openWindow({
						classification: "test-track-location",
						title: "Test track location",
						width: 200,
						height: 150,
						onUpdate: function()
						{
							var trackLocation = entity.trackLocation;
							window.findWidget("info-label").text =
								"Entity id: "+entityId
								+"\nTile: "+[Math.floor(trackLocation.x / 32), Math.floor(trackLocation.y / 32)].join(", ")
								+"\nTrack: "+[trackLocation.x, trackLocation.y, trackLocation.z].join(", ")
								+"\nDirection: "+trackLocation.direction
								+"\nType: "+trackLocation.trackType
								+"\nProgress: "+entity.trackProgress+" / "+context.getTrackSegment(trackLocation.trackType).getSubpositionLength(entity.subposition, trackLocation.direction);
						},
						widgets: [
							{
								name: "info-label",
								type: "label",
								x: 10,
								y: 25,
								width: 180,
								height: 15,
							},
							{
								name: "pick-location-button",
								type: "button",
								x: 10,
								y: 105,
								width: 180,
								height: 15,
								text: "Set track location",
								onClick: function() {
									ui.activateTool({
										id: "test-set-track-location",
										cursor: "cross_hair",
										filter: ["ride"],
										onDown: function(args) {
											var coords = args.mapCoords;
											var index = args.tileElementIndex;
											if (!coords || index === undefined) return;
											ui.tool.cancel();
											var element = map.getTile(Math.floor(coords.x / 32), Math.floor(coords.y / 32)).getElement(index);
											var location = {
												x: coords.x,
												y: coords.y,
												z: element.baseZ,
												direction: element.direction,
												trackType: element.trackType
											}
											console.log("Set location to", location);
											entity.trackLocation = location;
										}
									})
								}
							},
							{
								name: "move-location-button",
								type: "button",
								x: 10,
								y: 125,
								width: 180,
								height: 15,
								text: "Move track location",
								onClick: function() {
									ui.activateTool({
										id: "test-move-track-location",
										cursor: "cross_hair",
										filter: ["ride"],
										onDown: function(args) {
											var coords = args.mapCoords;
											var index = args.tileElementIndex;
											if (!coords || index === undefined) return;
											ui.tool.cancel();
											var location = {
												x: coords.x,
												y: coords.y
											}
											console.log("Move location to", location, index);
											entity.moveToTrack(location, index);
										}
									})
								}
							},
						]
					})
				}
			})
		})
	}
});

And the park:
Six Flags flat train track.zip

Basssiiie · 2025-01-02T12:55:09Z

distribution/openrct2.d.ts

+        /**
+         * Moves the vehicle to the track piece specified in the parameters.
+         */
+        moveToTrack(coord: CoordsXY, elemIndex: number): void;


Suggested change

moveToTrack(coord: CoordsXY, elemIndex: number): void;

moveToTrack(x: number, y: number, trackElementIndex: number): void;

And also have x and y be tile coordinates instead of entity coordinates would probably be neater. 🙂

@guysv could you still look at this one?

github-actions · 2025-02-03T02:00:36Z

This pull request has been marked as stale and will be closed in 14 days if no action is taken. To keep it open, leave a comment or remove the stale-pr label. If you're awaiting feedback from a developer, please send us a reminder (either here or on Discord).

github-actions · 2025-03-18T02:05:45Z

This pull request has been marked as stale and will be closed in 14 days if no action is taken. To keep it open, leave a comment or remove the stale-pr label. If you're awaiting feedback from a developer, please send us a reminder (either here or on Discord).

Basssiiie

I had another test at this and it works great for the most part. All previous issues are resolved, except for one. The only thing that is still missing is calling this function in both travelBy() and moveToTrack() at the end, to prevent it from snapping back to the original position when "Uncap FPS" is enabled. 🙂

EntityTweener::Get().RemoveEntity(vehicle);

Basssiiie · 2025-03-25T20:22:32Z

distribution/openrct2.d.ts

@@ -2676,7 +2669,7 @@ declare global {
        /**
         * The location and direction of where the car is on the track.
         */
-        trackLocation: CarTrackLocation;
+        trackLocation: CoordsXYZD;


I think it's best to not revert this to the prior PR. Instead it'd be better to keep the getter as is, but only remove the setter as that's the broken one. Reading the vehicle's track type could still be useful in other scenarios.

Also make sure to make the properties on CarTrackLocation readonly as well, to avoid any confusion there. 🙂

Suggested change

trackLocation: CoordsXYZD;

readonly trackLocation: CarTrackLocation;

Basssiiie · 2025-03-25T20:23:41Z

distribution/changelog.txt

@@ -109,7 +110,7 @@
 - Fix: [#22742, #22793] In game console does not handle format tokens properly.
 - Fix: [#23135] Map generator tree placement has noticable patterns.
 - Fix: [#23286] Currency formatted incorrectly in the in game console.
- Fix: [#23348] Console set commands don’t print output properly.
+- Fix: [#23348] Console set commands don't print output properly.


I think this change is a mistake and should probably be reverted?

guysv · 2025-03-26T17:58:36Z

made a final push. I think its GTG!! @Basssiiie @tupaschoal

Basssiiie

Still missing two of my suggested changes unfortunately. 😥

One being that I suggested changing CarTrackLocation to this, to avoid people attempting to assign the properties (which does nothing):

    interface CarTrackLocation extends Readonly<CoordsXYZD> {
        readonly trackType: number;
    }

The other is an alternative signature for the moveToTrack() method, which I now have tagged you in again here @guysv

Edit: also needs a plugin api version increment.

Basssiiie

Looking all good to me. I have tested it again as well and it all works great now! Thank you for your time. 😃

A new function to move cars to tracks easier. Also redraws the car.

reverts 30a555d car.moveToTrack() achieves the same thing in a saner API.

added back tracklocation.Get with track type added EntityTweener call at the end of travelBy/moveToTrack

tupaschoal

At a glance it looks good to me.

- Feature: [#22646] New scenario files now contain a minimap image, shown in the scenario selection window. - Feature: [#23774] Climates can now be customised using objects. - Feature: [#23876] New park save files now contain a preview image, shown in the load/save window. - Improved: [#24078] Handrails on Wooden Roller Coaster station sprites with no platforms have been removed. - Improved: [objects#379] Add additional colour schemes to Mine Train. - Change: [#23932] The land rights window now checks “Land Owned” by default. - Change: [#23936] The ‘guests prefer less/more intense rides’ settings have been turned into a dropdown. - Change: [#24059] The ‘select other ride’ button is now available in the track designs manager. - Change: [#24067] [Plugin] Registered menu items are now listed alphabetically. - Change: [#24070] Footpath selection menus now show object names on hover using a tooltip. - Change: [#24101] Frozen peeps are no longer removed when using the 'remove all guests' cheat. - Fix: [#4225] Ride Construction window offers non-existent banked sloped to level curve (original bug). - Fix: [#5281] Missing supports on miniature railways built backwards. - Fix: [#7222] Transparent pixels in sloped path tunnels (original bug). - Fix: [#10379] Banners outside the park can be renamed and modified (original bug). - Fix: [#10582] Low clearance tunnels below water are drawn incorrectly (original bug). - Fix: [#17524, #23710] Station bases are drawn on many ride types when the “No entrance, no platform station” style is selected. - Fix: [#18169] CJK, Arabic and Vietnamese display all text as ‘???’ on Android. - Fix: [#18309] Flying and Multi Dimension trains glitch when changing between inverted and uninverted track when uncap fps is on. - Fix: [#19506] Queue paths can be placed on level crossings by replacing an existing regular path. - Fix: [#21803] The park fence is drawn differently in OpenGL compared to software rendering when zoomed out. - Fix: [#21824] Some sprites are drawn incorrectly when zoomed out in OpenGL rendering. - Fix: [#21908] Ride mode warnings when hovering track designs. - Fix: [#22820] OpenGL does not draw masked sprites correctly. - Fix: [#22961] Clicking on the construction preview places duplicate flat rides and stalls. - Fix: [#23359] Scripting: Add car.moveToTrack, an easier API than setting car.trackLocation directly. - Fix: [#23443] New GOG version of RCT2 is not extracted correctly. - Fix: [#23484] Stray coloured pixels on castle-themed stations and Roman-themed entrances/exits (original bug). - Fix: [#23486] Object selection minimum requirements can be bypassed with close window hotkey. - Fix: [#23743] Parks with guest goals over 32767 do not appear in the scenario list. - Fix: [#23844] Sound effects keep playing when loading another save. - Fix: [#23881] Compiling on Raspbian/arm-linux-gnueabihf fails. - Fix: [#23891] Inverted Hairpin Coaster track can draw over things above it (original bug). - Fix: [#23892] Gentle banked Wooden Roller Coaster track glitches as trains pass (original bug). - Fix: [#23897] Reverse Freefall Coaster slope up to vertical track piece does not draw a vertical tunnel. - Fix: [#23910] Heartline Twister Coaster track can draw over things above it (original bug). - Fix: [#23939] Incorrect assertion when trying to load heightmap. - Fix: [#23941] Underflow in “Repay loan and achieve a certain park value” objective when using Japanese. - Fix: [#23949] Walls draw over sloped rear water edges and those edge sprites are misaligned (original bug). - Fix: [#23960] Corner path fences can draw over adjacent sloped land (original bug). - Fix: [#23961] Lamps and queue line tvs draw incorrectly on paths with fences. - Fix: [#23983] Ordering files by size does not work and occasionally crashes the game. - Fix: [#24009] [Plugin] The object manager API does not identify recently introduced object types. - Fix: [#24028] Giga and LSM Launched Coaster booster sprites have pixels that draw over transparent pixels. - Fix: [#24077] Track Designer crashes when clicking the park fence.

guysv force-pushed the car-track-location-update branch from c08e648 to 3e8993d Compare December 9, 2024 13:30

guysv force-pushed the car-track-location-update branch 2 times, most recently from d272e08 to 9c15671 Compare December 9, 2024 13:35

duncanspumpkin reviewed Dec 9, 2024

View reviewed changes

guysv force-pushed the car-track-location-update branch 4 times, most recently from 892cfd2 to 214f33e Compare December 11, 2024 22:56

duncanspumpkin approved these changes Dec 11, 2024

View reviewed changes

Basssiiie reviewed Dec 15, 2024

View reviewed changes

Basssiiie mentioned this pull request Dec 15, 2024

Feature: Allow vehicle dragger tool to snap vehicles to track Basssiiie/OpenRCT2-RideVehicleEditor#124

Merged

guysv force-pushed the car-track-location-update branch from be4d0bb to 0f574f9 Compare December 26, 2024 17:59

guysv force-pushed the car-track-location-update branch from 0f574f9 to ab63f2b Compare December 26, 2024 19:33

guysv changed the title ~~Scripting: Redraw vehicle when setting track location~~ Scripting: Add Car.moveToTrack API Dec 29, 2024

tupaschoal requested a review from Basssiiie December 29, 2024 19:39

Basssiiie mentioned this pull request Dec 29, 2024

Fix #23496: missing spatial index update when paused #23505

Merged

guysv force-pushed the car-track-location-update branch 3 times, most recently from 9d12cc1 to 2308cd3 Compare January 1, 2025 17:08

Basssiiie reviewed Jan 2, 2025

View reviewed changes

github-actions bot added the stale-pr label Feb 3, 2025

github-actions bot removed the stale-pr label Feb 14, 2025

github-actions bot added the stale-pr label Mar 18, 2025

Basssiiie removed the stale-pr label Mar 18, 2025

guysv force-pushed the car-track-location-update branch from 2308cd3 to 71875c3 Compare March 22, 2025 09:13

Basssiiie suggested changes Mar 25, 2025

View reviewed changes

guysv force-pushed the car-track-location-update branch 2 times, most recently from 749402e to 90e9e46 Compare March 26, 2025 18:43

tupaschoal requested a review from Basssiiie March 27, 2025 10:00

Basssiiie suggested changes Mar 27, 2025

View reviewed changes

Basssiiie added the plugin api version Plugin API version needs updating - double check before merging! label Mar 27, 2025

guysv force-pushed the car-track-location-update branch from 4bf98ea to 8480ff5 Compare March 29, 2025 17:51

Basssiiie approved these changes Mar 30, 2025

View reviewed changes

Basssiiie removed the plugin api version Plugin API version needs updating - double check before merging! label Mar 30, 2025

Guy Sviry added 7 commits April 1, 2025 18:13

Scripting: Redraw vehicle when setting track location

2cca175

Scripting: introduce car.moveToTrack

27698b6

A new function to move cars to tracks easier. Also redraws the car.

Revert car.trackLocation to CoordsXYZD

2e0c66c

reverts 30a555d car.moveToTrack() achieves the same thing in a saner API.

Final fixes for vehicle.moveToTrack

aa6c974

added back tracklocation.Get with track type added EntityTweener call at the end of travelBy/moveToTrack

moveToTrack: final bassie review fixes.

6a81f50

moveToTrack: use tile coords

0787d1c

moveToTrack: api increment

866a69d

guysv force-pushed the car-track-location-update branch from 8480ff5 to 866a69d Compare April 1, 2025 15:13

tupaschoal approved these changes Apr 2, 2025

View reviewed changes

Merge branch 'develop' into car-track-location-update

8d89a2e

tupaschoal enabled auto-merge (squash) April 2, 2025 23:27

tupaschoal added this to the v0.4.21 milestone Apr 2, 2025

tupaschoal merged commit b92e05b into OpenRCT2:develop Apr 2, 2025
23 checks passed

AaronVanGeffen mentioned this pull request Apr 8, 2025

Purge leftover references to SetClimate game command #24104

Merged

	moveToTrack(coord: CoordsXY, elemIndex: number): void;
	moveToTrack(x: number, y: number, trackElementIndex: number): void;

	trackLocation: CoordsXYZD;
	readonly trackLocation: CarTrackLocation;

Scripting: Add Car.moveToTrack API #23359

Scripting: Add Car.moveToTrack API #23359

Uh oh!

Conversation

guysv commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

guysv commented Dec 9, 2024

Uh oh!

guysv commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

guysv commented Dec 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

duncanspumpkin commented Dec 11, 2024

Uh oh!

guysv commented Dec 12, 2024

Uh oh!

guysv commented Dec 12, 2024

Uh oh!

Basssiiie left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

guysv commented Dec 26, 2024

Uh oh!

tupaschoal commented Jan 2, 2025

Uh oh!

Basssiiie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 3, 2025

Uh oh!

github-actions bot commented Mar 18, 2025

Uh oh!

Basssiiie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

guysv commented Mar 26, 2025

Uh oh!

Basssiiie left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Basssiiie left a comment

Choose a reason for hiding this comment

Uh oh!

tupaschoal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

guysv commented Dec 9, 2024 •

edited

Loading

guysv commented Dec 9, 2024 •

edited

Loading

guysv commented Dec 9, 2024 •

edited

Loading

Basssiiie left a comment •

edited

Loading

Basssiiie left a comment •

edited

Loading