Difference between revisions of "Gps (API)"
From ComputerCraft Wiki
(Add return column to table, shift types over into return and method name columns, and reduce description by removing that information) |
Smiley43210 (Talk | contribs) m (Simplified source, properly closed <td> and <tr> tags) |
||
| Line 15: | Line 15: | ||
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">({{Type|int}} x, {{Type|int}} y, {{Type|int}} z), or [[nil]]</td> | <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">({{Type|int}} x, {{Type|int}} y, {{Type|int}} z), or [[nil]]</td> | ||
| − | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">gps.locate(<nowiki> | + | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">gps.locate([<nowiki></nowiki>{{Type|float}} timeout [, {{Type|boolean}} debug]])</td> |
| − | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Tries to retrieve the computer or turtles own location. On success, returns the location of the turtle’s modem. On failure (if no responses are received for <var>timeout</var> seconds, by default 2), returns [[nil]]. If <var>debug</var> is <code>true</code>, debug messages are printed.</table> | + | <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Tries to retrieve the computer or turtles own location. On success, returns the location of the turtle’s modem. On failure (if no responses are received for <var>timeout</var> seconds, by default 2), returns [[nil]]. If <var>debug</var> is <code>true</code>, debug messages are printed.</td></tr></table> |
== Example == | == Example == | ||
| Line 37: | Line 37: | ||
| − | |||
code>true | code>true | ||
| + | |||
| + | [[Category:APIs]] | ||
Revision as of 15:50, 2 May 2013
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. Three of these hosts should be in a plane, and the fourth should be either above or below the other three. 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 computer, not the modem, as all rednet distances are measured from the block the computer is in.
|
| ||
| Return | Method Name | Description |
| (int x, int y, int z), or nil | gps.locate([float timeout [, boolean debug]]) | Tries to retrieve the computer or turtles own location. On success, returns the location of the turtle’s modem. On failure (if no responses are received for timeout seconds, by default 2), returns nil. If debug is true, debug messages are printed. |
Example
print("Man I am so lost right now!")
local x, y, z = gps.locate(5)
if x == nil then
print("Nope, still lost :(")
else
print("I am at ",x," ",y," ",z)
end
Vector Example
GPS position and navigation can be handled more easily using a vector.
local home = vector.new(45, 85, 20)
local position = vector.new(gps.locate(5))
local displacement = position - home
print("I am ", displacement.tostring(), " away from home!!!")
code>true
