Railway crossing behaviour for peeps and vehicles #6998

JeroenDStout · 2018-01-11T01:52:24Z

This is the code from my experimental branch which handles the vehicles and peeps interacting with crossings:

This works by having vehicles 'reserve' tiles by giving path elements a flag (that is normally never set), while peeps check whether the path they are about to walk on has that flag.

I cannot work too much on this myself, so here are my thoughts:

Right now the debug 'grey' overlay is on by default to clarify which tiles are reserved
Crossings that are small enough are reserved together, but long stretches (like a city tram) are reserved with a maximum ahead of the train
Vehicles claxon when reserving a new crossing, although erroneously for long stretches the claxon is repeated every tile
Peeps prevent themselves 'stalling' by being allowed to keep moving when already on the tile that would block them, but while moving along a crossing (not orthogonal to it) they become blocked
Peeps can be given a better current action to prevent them being in the 'half step' sprite; although the current look feels more dynamic than the 'standing straight' queue sprite
Multiple vehicles in close succession may break one-another's reserves. This can be fixed by doing the vehicle update in two passes; remove reserves before updating all vehicles (checking the same progression variable), the other in the current place to re-reserve the tiles.
Reserving/freeing is not perfect and probably can be refined

I see two directions for fixing peep behaviour for city tram style crossings:

Make peeps leave a track when a vehicle reserves it, meaning they may break their current pathing but at least will get out of the way. This can be done by cheekily changing their target.
Do not allow peeps to walk 'along' multiple tracks. I.e., if they are on a tile with a crossing, do not allow the pathfinding to walk in the direction following that track. This may break AI pathing and does not mimic IRL city behaviour too well.

janisozaur · 2018-01-11T16:27:39Z

src/openrct2/peep/Peep.cpp

+    rct_tile_element * path_element = map_get_path_element_at(peep->destination_x / 32, peep->destination_y / 32, peep->next_z);
+    if (path_element && path_element->flags & TILE_ELEMENT_FLAG_BLOCKED_BY_VEHICLE)
+    {
+        if (!(peep->x >> 5 == peep->destination_x >> 5 &&


What are the lower 5 bits? Can they differ? In the line above you also divide destination_[xy] by 32 already, so you could just reuse the value here.

These are "big"/"sprite" coordinates, which are 32 times as big as regular coordinates. This code checks if both refer to the same tile, rather than the exact same spot within that tile.

Indeed. I suppose it depends on coding conventions whether to re-use,, I usually prefer to leave it to the compiler to do optimisations on that scale.

@Gymnasiast unless (x & 0x1f) != (destination_x & 0x1f), x >> 5 == destination_x >> 5 implies x == destination_x and you've just wasted 4 instructions shifting things for no reason. Hence my question:

What are the lower 5 bits? Can they differ?

@JeroenDStout leaving it to the compiler is absolutely fine, but a) you make it harder for the compiler to deduce the meaning of it by using / and >> b) you still pay the full price in unoptimised builds

@janisozaur That is a very good point!

janisozaur · 2018-01-11T16:29:36Z

src/openrct2/ride/Vehicle.cpp

+    }
+}
+
+void vehicle_claxon(rct_vehicle * vehicle)


argument should be const

janisozaur · 2018-01-11T16:29:43Z

src/openrct2/ride/Vehicle.cpp

+{
+    rct_ride_entry* rideEntry = get_ride_entry(vehicle->ride_subtype);
+    audio_play_sound_at_location((rideEntry->vehicles[0].sound_range == 3)? SOUND_TRAIN_WHISTLE : SOUND_TRAM, vehicle->x, vehicle->y, vehicle->z);
+}


missing newline

janisozaur · 2018-01-11T16:31:18Z

src/openrct2/ride/Vehicle.cpp

@@ -9890,3 +9899,150 @@ void vehicle_invalidate_window(rct_vehicle * vehicle)

    window_invalidate(w);
 }
+
+void vehicle_update_crossings(rct_vehicle * vehicle)


Looks like the argument could be const? It's passed down to vehicle_get_{head|tail}() which should be const already and vehicle_claxon() which I don't know

duncanspumpkin · 2018-01-11T16:32:35Z

src/openrct2/ride/Vehicle.cpp

@@ -8249,6 +8254,8 @@ static bool vehicle_update_track_motion_forwards(rct_vehicle * vehicle, rct_ride
    uint16 trackTotalProgress = vehicle_get_move_info_size(vehicle->var_CD, vehicle->track_type);
    if (regs.ax >= trackTotalProgress)
    {
+        vehicle_update_crossings(vehicle);


Is this the correct place to put this. Should this not be after a movement to a new track piece? I would also like to see this guarded by a flag so that only transport rides enter this code. There is no point having rollercoasters enter this code.

That is a good point, moving it to after moving would mean doing one offset calculation for the reservation fewer. The ordering here is an artefact from me snipping the code out of other things.

duncanspumpkin · 2018-01-11T16:33:01Z

src/openrct2/ride/Vehicle.cpp

@@ -8594,6 +8601,8 @@ loc_6DBA33:;
    regs.ax = vehicle->track_progress - 1;
    if (regs.ax == -1)
    {
+        vehicle_update_crossings(vehicle);


duncanspumpkin · 2018-01-11T16:35:23Z

src/openrct2/ride/Vehicle.cpp

+            {
+                if (!playedClaxon && 0 == (tileElement->flags & TILE_ELEMENT_FLAG_BLOCKED_BY_VEHICLE))
+                {
+                    vehicle_claxon(vehicle);


vehicle_claxon or is it a crossing claxon? I've not actually tested this so it might be a silly question.

duncanspumpkin · 2018-01-11T16:37:30Z

src/openrct2/ride/Vehicle.cpp

+void vehicle_claxon(rct_vehicle * vehicle)
+{
+    rct_ride_entry* rideEntry = get_ride_entry(vehicle->ride_subtype);
+    audio_play_sound_at_location((rideEntry->vehicles[0].sound_range == 3)? SOUND_TRAIN_WHISTLE : SOUND_TRAM, vehicle->x, vehicle->y, vehicle->z);


Most vehicle sound effects are performed by the vehicle sound code rather than played directly. I'm not sure if that is the approach that should be done here but if it is I suggest using the sound2_flags (a param that is labelled in my PR).

I did not know about the flags while writing this - letting the flags handle it sounds much more consistent. The function was mostly meant as a general way to just get a sound played for any reason.

It's okay i only found them yesterday :)

duncanspumpkin · 2018-01-11T16:39:19Z

What happens when you double close the ride with the crossing turned on? Will it be constantly locked out. I see your using the indistructable flag to do this. Will that effect destructing the ride?

Gymnasiast · 2018-01-11T18:31:30Z

@duncanspumpkin When destructing the ride, it will check a flag on the Ride itself. The indestructible flags on the track elements themselves are not checked in that case.

As for reusing the flag: as long as crossings stay confined to non-roller coasters, it's acceptable to use them - as long they don't linger.

duncanspumpkin · 2018-01-11T18:34:37Z

Yeah sorry made a mistake there the indistructable flag is a red herring as the flag is put on the path element. The question still stands what happens when you remove the ride when it is blocking the path as i see nothing that would reset it.

JeroenDStout · 2018-01-11T19:14:39Z

@duncanspumpkin The bits are never used for paths, only for tracked (?) rides. I did name the same bit-flag a different (TILE_ELEMENT_FLAG_BLOCKED_BY_VEHICLE) to differentiate between the two use cases.

You are very right about the ride being closed/removed leaving the paths blocked. It's my mistake not adding that to the to-do notes :). I suppose in these cases a function would need to be called (remove blocked tiles for ride or so) that just once loops through the entire ride to release all the paths.

tobyhinloopen · 2018-04-19T07:16:21Z

Is this still being worked on? It looks like a great feature!

AaronVanGeffen · 2018-05-11T09:58:28Z

I've rebased this PR to account for the recent peep refactor. This will still need to be finished, however. It hasn't been updated since its initial publication…

RobertWHurst · 2018-05-24T01:07:24Z

Any chance this will get added at some point soon?

AaronVanGeffen · 2018-05-24T08:40:59Z

Absolutely, but someone will need to finish it first, as I noted in my comment two weeks ago.

tobyhinloopen · 2018-05-24T08:42:38Z

@JeroenDStout Need some help fixing things?

tobyhinloopen · 2018-06-07T17:50:22Z

Thank you, @IntelOrca ! Excited to see progress 👍

AaronVanGeffen · 2018-06-07T17:53:17Z

src/openrct2/peep/Guest.cpp

+    // Check if vehicle is blocking the destination tile
+    auto curPos = TileCoordsXYZ(CoordsXYZ { x, y, z });
+    auto dstPos = TileCoordsXYZ(CoordsXY { destination_x, destination_y }, next_z);
+    if (curPos.x != dstPos.x || curPos.y != dstPos.y)


We should probably overload the == operator for TileCoordsXYZ so we can compare them directly.

IntelOrca · 2018-06-07T18:24:12Z

I have resolved the following issues:

Added a debug paint option to show blocked tiles.
Unblock all blocked tiles for a ride when its vehicles are removed.

All other issues still remain but can be fixed separately. Separate issues can be also be made for them. I suggest this is merged as soon as we release 0.2.0.

…ing a tile

Replace old unused original drawing code toggle options with new option to show which tiles are blocked by vehicles.

- Feature: [#5993] Ride window prices can now be set via text input. - Feature: [#6998] Guests now wait for passing vehicles before crossing railway tracks. - Feature: [#7658] Add option to always use system file browsing window. - Feature: [#7694] Debug option to visualize paths that the game detects as wide. - Feature: [#7713] The virtual floor now takes land ownership rights into account. - Feature: [#7771] Danish translation. - Feature: [#7797, #7802, #7821, #7830] Add sprite font glyphs for Danish, Norwegian, Russian, Turkish, Catalan and Romanian. - Feature: [#7848] Add a master volume slider to audio options screen. - Feature: [#7868] Placing scenery while holding shift now scales appropriately with zoom levels. - Feature: [#7882] Auto-detect Steam and GOG installations of RCT1. - Feature: [#7885] Turkish translation. - Fix: [#3177] Wrong keys displayed in shortcut menu. - Fix: [#4039] No sprite font glyph for German opening quotation mark. - Fix: [#5548] platform_get_locale_date_format is not implemented for Linux. - Fix: [#7204] Object source filters do not work for RCT1, AA and LL. - Fix: [#7440] Memory leak. All system memory used. - Fix: [#7462] Guest window goes beyond the map edge on a spiral slide. - Fix: [#7533] Screenshot is incorrectly named/file is not generated in CJK language. - Fix: [#7628] Always-researched items can be modified in the inventory list. - Fix: [#7643] No Money scenarios with funding set to zero. - Fix: [#7653] Finances money spinner is too narrow for big loans. - Fix: [#7673] Vehicle names are cut off in invention list. - Fix: [#7674] Rides show up as random numbers in guest's ride list. - Fix: [#7678] Crash when loading or starting a new game while having object selection window open. - Fix: [#7683] 'Arbitrary ride type' dropdown state is shared between windows. - Fix: [#7697] Some scenery groups in RCT1 saves are never invented. - Fix: [#7711] Inverted Hairpin Coaster allows building invisible banked pieces. - Fix: [#7734] Title sequence not included in macOS builds as of 0.2.0 release. - Fix: [#7756] Steam RCT2 path not correctly checked on macOS and Linux. - Fix: [#7765] Crash when opening ride list window on Windows Vista. - Fix: [#7773] Once research has been completed, player is still charged for research. - Fix: [#7786] Crash when importing a track design. - Fix: [#7793] Duplicate private keys generated. - Fix: [#7817] No sprite font glyph for interpunct. - Fix: [#7823] You can build mazes in pause mode. - Fix: [#7804] Russian ride descriptions are cut off. - Fix: [#7872] CJK tooltips are often cut off. - Fix: [#7895] Import of Mega Park and the RCT1 title music do not work on some RCT1 sources. - Improved: [#7899] Timestamps in the load/save screen are now displayed using local timezone instead of GMT. - Improved: [#7918] Better RCT2 detection if both disc and GOG/Steam versions are installed.

janisozaur reviewed Jan 11, 2018

View reviewed changes

src/openrct2/ride/Vehicle.cpp Outdated

}

}

void vehicle_claxon(rct_vehicle * vehicle)

Copy link

Member

janisozaur Jan 11, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

argument should be const

janisozaur reviewed Jan 11, 2018

View reviewed changes

duncanspumpkin reviewed Jan 11, 2018

View reviewed changes

AaronVanGeffen force-pushed the railway-crossings-wait branch from a7d579a to 410fbfe Compare May 11, 2018 09:55

AaronVanGeffen added the pending improvement label May 11, 2018

AaronVanGeffen force-pushed the railway-crossings-wait branch from 410fbfe to 8b469c9 Compare May 19, 2018 09:37

IntelOrca force-pushed the railway-crossings-wait branch from 8b469c9 to 2e4ef69 Compare June 7, 2018 16:46

AaronVanGeffen reviewed Jun 7, 2018

View reviewed changes

IntelOrca removed the pending improvement label Jun 7, 2018

Gymnasiast added this to the Post v0.2.0 milestone Jun 7, 2018

AaronVanGeffen added the network version Network version needs updating - double check before merging! label Jun 8, 2018

JeroenDStout added 3 commits June 10, 2018 22:59

Add 'blocked by vehicle' flag for tile elements

f4c94c4

Debug-show tiles which are blocked by vehicles as coloured

1f7dbe1

Add vehicle_update_crossings for validating crossing tiles upon enter…

244209d

…ing a tile

JeroenDStout and others added 9 commits June 10, 2018 22:59

Add check for peep walking update to prevent walking onto blocked tiles

5479730

Limit amount of path being reserved at single crossing

299d2e8

Prevent peep from being blocked while already on blocked tile

1301756

Add claxon to vehicle reserving initial crossing tile

ad684b1

Add const qualifiers

e9069e4

Refactor peep check for vehicle

c300f87

Add debug drawing option for blocked tiles

d1d9f0a

Replace old unused original drawing code toggle options with new option to show which tiles are blocked by vehicles.

Unblock tiles when vehicles are removed from ride

b4d3806

Increment network version

fac0960

IntelOrca force-pushed the railway-crossings-wait branch from 027aa64 to fac0960 Compare June 10, 2018 22:01

AaronVanGeffen added the changelog This issue/PR deserves a changelog entry. label Jun 10, 2018

Update changelog

b2bb87f

IntelOrca merged commit b043428 into OpenRCT2:develop Jun 11, 2018

This was referenced Jun 11, 2018

Large portions of the screen do not invalidate properly #7655

Closed

Rides are making tram sounds #7657

Closed

deurklink mentioned this pull request Jun 15, 2018

Feature: Debug option that shows paths where wide path flag is set #7694

Closed

Umdlye mentioned this pull request Jun 15, 2018

String 6260 OpenRCT2/Localisation#1510

Closed

16 tasks

rik-smeets mentioned this pull request Sep 19, 2022

Add railway crossing behaviour for staff #18057

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Railway crossing behaviour for peeps and vehicles #6998

Railway crossing behaviour for peeps and vehicles #6998

JeroenDStout commented Jan 11, 2018

janisozaur Jan 11, 2018

Gymnasiast Jan 11, 2018

JeroenDStout Jan 11, 2018

janisozaur Jan 11, 2018

JeroenDStout Jan 11, 2018

janisozaur Jan 11, 2018

janisozaur Jan 11, 2018

janisozaur Jan 11, 2018

duncanspumpkin Jan 11, 2018

JeroenDStout Jan 11, 2018

duncanspumpkin Jan 11, 2018

duncanspumpkin Jan 11, 2018

duncanspumpkin Jan 11, 2018

JeroenDStout Jan 11, 2018

duncanspumpkin Jan 11, 2018

duncanspumpkin commented Jan 11, 2018

Gymnasiast commented Jan 11, 2018

duncanspumpkin commented Jan 11, 2018

JeroenDStout commented Jan 11, 2018 •

edited

Loading

tobyhinloopen commented Apr 19, 2018

AaronVanGeffen commented May 11, 2018

RobertWHurst commented May 24, 2018

AaronVanGeffen commented May 24, 2018

tobyhinloopen commented May 24, 2018

tobyhinloopen commented Jun 7, 2018

AaronVanGeffen Jun 7, 2018

IntelOrca commented Jun 7, 2018

Railway crossing behaviour for peeps and vehicles #6998

Railway crossing behaviour for peeps and vehicles #6998

Conversation

JeroenDStout commented Jan 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

duncanspumpkin commented Jan 11, 2018

Gymnasiast commented Jan 11, 2018

duncanspumpkin commented Jan 11, 2018

JeroenDStout commented Jan 11, 2018 • edited Loading

tobyhinloopen commented Apr 19, 2018

AaronVanGeffen commented May 11, 2018

RobertWHurst commented May 24, 2018

AaronVanGeffen commented May 24, 2018

tobyhinloopen commented May 24, 2018

tobyhinloopen commented Jun 7, 2018

Choose a reason for hiding this comment

IntelOrca commented Jun 7, 2018

JeroenDStout commented Jan 11, 2018 •

edited

Loading