Difference between revisions of "Gps (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(Undo revision 2807 by 121.73.150.105 (talk))
Line 10: Line 10:
 
|-
 
|-
 
|gps.locate(timeout, debug)
 
|gps.locate(timeout, debug)
|Tries to retrieve the computer or turtle own location.<br />
+
|Tries to retrieve the computer or turtles own location.<br />
 
''@param'' '''timeout''' the amount of time, in seconds, to wait for a rednet response<br />
 
''@param'' '''timeout''' the amount of time, in seconds, to wait for a rednet response<br />
 
''@param'' '''debug''' if true, outputs debug messages<br />
 
''@param'' '''debug''' if true, outputs debug messages<br />

Revision as of 19:12, 4 September 2012

The gps API provides a method for turtles and computers to retrieve their own locations.

It broadcasts a PING message over rednet and wait for responses. In order for this system to work, there must be at least 4 computers used as gps hosts which will respond and allow trilateration. You can set up hosts using the gps program.

Note: When entering in the coordinates for the host you need to put in the x,y,z of the modem, not the computer.

Methods

Method name Description
gps.locate(timeout, debug) Tries to retrieve the computer or turtles own location.

@param timeout the amount of time, in seconds, to wait for a rednet response
@param debug if true, outputs debug messages
@return the location (x, y, z) of the modem attached to the computer or turtle or nil if it could not be determined