Travel ("travel") Module

These functions are mostly for manipulating travel exclusions items.

This list is taken from l_travel.cc.

Travel Exclusions

There should also be a function to test if there is a travel exclusion at a spot.

set_exclude

Syntax:

travel.set_exclude ( x, y, radius )

Parameters:

  • x (int, required): The x coordinate
  • y (int, required): The y coordinate
  • radius (int, default LOS): The radius for the travel exclusion

Returns: N/A

This function places a travel exclusion with radius radius at position (x, y). What does it do if there already is one?

del_exclude

Syntax:

travel.del_exclude ( x, y )

Parameters:

  • x (int, required): The x coordinate
  • y (int, required): The y coordinate

Returns: N/A

This function removes a travel exclusion at position (x, y). What does it do if there isn't one?

Querying Features

I believe these are duplicates of functions in the Features Module. If not, they should probably be in there.

They take a feature name as a parameter.

feature_traversable

feature_solid

Miscellaneous Functions

find_deepest_explored

It takes the branch name as a string as a parameter.

Logged in as: Anonymous (VIEWER)
dcss/help/maps/lua/modules/travel.txt · Last modified: 2014-10-04 06:54 by infiniplex
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki