Module travel
Functions related to (auto)traveling.
Functions
| clear_travel_trail () | Clears the travel trail. |
| del_exclude (x, y) | Remove an exclusion. |
| feature_solid (featurename) | Is this feature solid? |
| feature_traversable (featurename, assume_flight) | Can we move onto this feature? |
| find_deepest_explored (branch) | What's the deepest floor we've reached in this branch? |
| is_excluded (x, y) | Test for exclusion. |
| set_exclude (x, y[, r=LOS_RADIUS]) | Set an exclusion. |
| set_travel_trail (x, y) | Set traveltrail on a cell Call crawl.redrawscreen afterward to see changes. |
| set_waypoint (waynum, x, y) | Set a numbered waypoint. |
| waypoint_delta () | Deltas to a given waypoint. |
Functions
- clear_travel_trail ()
- Clears the travel trail. Call crawl.redraw_screen afterward to see changes.
- del_exclude (x, y)
-
Remove an exclusion.
Uses player-centered coordinates
Parameters:
- x int
- y int
- feature_solid (featurename)
-
Is this feature solid?
Parameters:
- featurename string
Returns:
-
boolean
- feature_traversable (featurename, assume_flight)
-
Can we move onto this feature? Considers player properties like
amphibiousness and permanent (but not temporary) flight, and also considers
travelavoidterrain.
Parameters:
- featurename string
- assume_flight
boolean
If true, assume the player has permanent
flight.
Returns:
-
boolean
- find_deepest_explored (branch)
-
What's the deepest floor we've reached in this branch?
Parameters:
- branch string
Returns:
-
int
depth
- is_excluded (x, y)
-
Test for exclusion.
Uses player-centered coordinates
Parameters:
- x int
- y int
Returns:
-
boolean
- set_exclude (x, y[, r=LOS_RADIUS])
-
Set an exclusion.
Uses player-centered coordinates
Parameters:
- x int
- y int
- r int (default LOS_RADIUS)
- set_travel_trail (x, y)
-
Set traveltrail on a cell
Call crawl.redrawscreen afterward to see changes.
Uses player-centered coordinates.
Parameters:
- x int
- y int
- set_waypoint (waynum, x, y)
-
Set a numbered waypoint.
Uses player-centered coordinates
Parameters:
- waynum int
- x int
- y int
- waypoint_delta ()
-
Deltas to a given waypoint.
Returns:
- nil if the waypoint is not on the current floor
- int,int the x and y deltas to the waypoint