FindPathExplanation - Revision history

Octalot: Update after merging the nearest_by PR

2019-09-11T09:41:59Z

Update after merging the nearest_by PR

Octalot: Add the proposed nearest_by key

2019-07-27T09:30:04Z

Add the proposed nearest_by key

Pentarctagon at 11:49, 22 July 2019

2019-07-22T11:49:19Z

Octalot: Illustration of [find_path]'s results, with image hotlinked from Github

2019-07-22T11:32:18Z

Illustration of [find_path]'s results, with image hotlinked from Github

New page

An illustrated example of the '''[[InternalActionsWML#.5Bfind_path.5D|[find_path]]]''' WML tag's results.

https://user-images.githubusercontent.com/101462/61628440-92323280-ac82-11e9-87b3-a6fc4e5442cc.png

Imagine an Elvish Scout standing on the Player 1 start, this unit has 9MP and needs 3MP for each shallow water tile, so it can reach every village without needing a multi-turn move.

If '''[find_path]''' is used with a terrain filter that matches villages, each of these villages might be considered to be the "nearest":

* "lake" is 3 hexes, 7 MP and 4 steps away
* "spur" is 5 hexes, 5 MP and 6 steps away
* "u_turn" is 2 hexes, 8 MP and 9 steps away

The '''hexes''' is best explained by the U-turn village - although it needs a lot of movement points, the village is only 2 hexes away from Player 1's start.

The '''steps''' is the length of the path.step array, which always includes the starting hex.

@@ Line 27: / Line 27: @@
 == Which village will '''[find_path]''' choose? ==
-If '''[find_path]''' is used with a Standard Location Filter that matches multiple hexes, it will return a path to one of them. For example, when using a SLF that matches villages there are 3 possible destination hexes, and each one is "nearest" by one type of measurement.
+If '''[find_path]''' is used with a Standard Location Filter that matches multiple hexes, it will return a path to one of them. For example, when using an SLF that matches villages there are 3 possible destination hexes, and each one is "nearest" by one type of measurement.
 In 1.14, it's unclear which of the three will be chosen.
-[[https://github.com/wesnoth/wesnoth/pull/4189 Proposal for 1.15]]: add an optional key to '''[find_path]''':
+{{DevFeature1.15|2}} the option '''nearest_by''' chooses between "movement_cost" (default), "steps" and "hexes".

@@ Line 3: / Line 3: @@
 [[File:Find-path-demo.png]]
-Imagine an Elvish Scout standing on the Player 1 start, this unit has 9MP and needs 3MP for each shallow water tile, so it can reach every village without needing a multi-turn move.
+Imagine an Elvish Scout standing on the Player 1 start, this unit has 9 MP and needs 3 MP for each shallow water tile, so it can reach every village without needing a multi-turn move. Each of the villages might be considered to be the "nearest", because:
 * "lake" is 3 hexes, 7 MP and 4 steps away
 * "spur" is 5 hexes, 5 MP and 6 steps away
 * "u_turn" is 2 hexes, 8 MP and 9 steps away
 The '''hexes''' is best explained by the U-turn village - although it needs a lot of movement points, the village is only 2 hexes away from Player 1's start.
-The '''steps''' is the length of the path.step array, which always includes the starting hex.
+The '''steps''' is the length of the path.step array. This always includes the starting hex.

@@ Line 1: / Line 1: @@
 An illustrated example of the '''[[InternalActionsWML#.5Bfind_path.5D|[find_path]]]''' WML tag's results.
-https://user-images.githubusercontent.com/101462/61628440-92323280-ac82-11e9-87b3-a6fc4e5442cc.png
+[[File:Find-path-demo.png]]
 Imagine an Elvish Scout standing on the Player 1 start, this unit has 9MP and needs 3MP for each shallow water tile, so it can reach every village without needing a multi-turn move.