pietervdvn/AspectedRouting
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs

Browse source
This commit is contained in:
Pieter Vander Vennet 2022-10-12 13:37:27 +02:00
parent 035b30517e
commit 1b0258f149
1 changed files with 2 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

5
Examples/Format.md
View file

@ -48,14 +48,13 @@ The first property for this is `obstacleaccess` which calculates wether or not a
The possible values are:
- "no" of "false": the current vehicle _cannot_ pass this obstacle and should take a different route
- "yes" or "true": the current vehicle _can_ pass this obstacle. The turn cost will be calculated
- `null`: same as 'yes'
- "yes", "true", `null` or any other value: the current vehicle _can_ pass this obstacle. The turn cost will be calculated
If `obstacleaccess` is not `no` or `false`, then `obstaclecost` will be triggered. This possible return values are:
- a positive number, indicating the cost for passing this obstacle
- 0: there is no cost to cross this obstacle
- null: this profile has no knowledge of a cost, will be interpreted as `0`
- null: this profile has no knowledge of a cost. Use the default implementation to check for turn restrictions
If the resulting cost is null, the default implementation will be used.