Fix #12236: Ship pathfinder causes crash when ship is already at destination #12238
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
Fixes #12236
Description
A call to chooseShipTrack is pointless when already at the destination, but it can happen in certain edge cases. Whether these situations should occur in the first place is debatable, and #11862 is an example of such a situation. However, the PF should be able to deal with such strange requests. It certainly shouldn't crash.
I opted for just returning a single random trackdir that can be reached, or INVALID_DIR otherwise, which in turn causes the ship to turn around. This should hopefully get nudge the ship out of the current situation and find a correct path ont he next PF call.
I also decided to not report the ship as lost (by not setting path_found = false), since the destination is technically found and the ship is not really lost. It's a strange situation so the solution is maybe a little strange as well.
Limitations
While this will make the PF more robust, the issue causing these situations is not fixed.
Checklist for review
Some things are not automated, and forgotten often. This list is a reminder for the reviewers.