Clarify that PathFinder is enabled by default
Opened this issue · 0 comments
The PathFinder
module became enabled-by-default in 2016. However, the API documentation for PathFinder
does not say so. PathFinder.use
is still presented as if it enables an optional feature---now a deprecated optional feature.
I would suggest adding a sentence to the PathFinder
module header:
This module exports the path-finding algorithm used internally by
Creep.moveTo
and other methods. It can be disabled to use an older, slower algorithm (although doing so is not recommended).
And a sentence to PathFinder.use
:
PathFinder
is enabled by default. This method can be used to disable or re-enable it.
And adjust the wording of places that reference PathFinder
, such as Room.findPath
:
This is only used when the new PathFinder is enabled.This option is ignored ifPathFinder
has been disabled.
This option cannot be used when the new PathFinder is enabled (use costCallback option instead).This option can only be used ifPathFinder
has been disabled. IfPathFinder
is enabled (which is the default), use thecostCallback
option instead.