Fix: Don't show train waiting for unbunching as waiting for free path #12515
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation / Problem
When multiple trains waiting to unbunch all try to leave at once, but are blocked because the PBS block leaving the depot is occupied, they call
MarkTrainAsStuck(v);
to set their status bar toWaiting for free path
.When a train successfully leaves, it assigns the next departure time to the others, which go back to waiting for unbunching.
In the status bar GUI, this status is checked before the unbunching status is checked, so that a train waiting for unbunching is incorrectly marked as awaiting a free path. This is confusing to the player, who sees nothing blocking its path.
Description
Alter the order that the string is chosen, so that a train waiting for unbunching is indicated accordingly in its status bar, regardless of if it has the stuck flag.
To test this:
Waiting for free path
but are actually unbunching. In this PR, the statusbar will go back toWaiting to unbunch
.Limitations
Checklist for review
Some things are not automated, and forgotten often. This list is a reminder for the reviewers.