Gps (API) - Revision history

Smiley43210: Changed "axises" to "axes", changed formatting

2015-08-14T12:07:25Z

Changed "axises" to "axes", changed formatting

Smiley43210: Changed "MineCraft" to "Minecraft"

2015-03-20T05:59:46Z

Changed "MineCraft" to "Minecraft"

Smiley43210: Changed to use API table template

2015-03-20T04:22:36Z

Changed to use API table template

Turkey: Adding a note about arrangement of the computers

2014-08-29T03:46:33Z

Adding a note about arrangement of the computers

Bubba at 21:37, 23 May 2014

2014-05-23T21:37:49Z

Cranium: tostring() doesn't work that way

2014-03-10T17:37:01Z

tostring() doesn't work that way

Bomb Bloke: Correction of my previous edit.

2014-02-12T00:52:26Z

Correction of my previous edit.

Bomb Bloke: In MineCraft, "y" represents height, but here "z" does.

2014-01-16T19:48:11Z

In MineCraft, "y" represents height, but here "z" does.

Watcher7: Int -> {{type|number}}, Float -> {{type|number}}

2013-07-12T00:55:13Z

Int -> {{type|number}}, Float -> {{type|number}}

AfterLifeLochie: goes around the `[`s. Also, greetings IRC from the middle of nowhere!

2013-05-04T07:17:52Z

<nowiki> goes *around* the `[`s. Also, greetings IRC from the middle of nowhere!

@@ Line 3: / Line 3: @@
 It broadcasts a PING message over [[Rednet_(API)|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 [[Wikipedia:Trilateration|trilateration]]. Three of these hosts should be in a plane, and the fourth should be either above or below the other three. The three in a plane should not be in a line with each other. You can set up hosts using the [[Gps (program)|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.
+Note:  When entering in the coordinates for the ''host'' you need to put in the x, y, and z coordinates of the '''computer''', not the modem, as all rednet distances are measured from the block the computer is in.
-Also note that you may ''choose'' which axises x, y or z refers to - so long as your systems have the same definition as any GPS servers that're in range, it works just the same. For example, you might build a GPS cluster according to [http://www.computercraft.info/forums2/index.php?/topic/3088-how-to-guide-gps-global-position-system/ this tutorial], using z to account for height, or you might use y to account for height in the way that Minecraft's debug screen displays.
+Also note that you may ''choose'' which axes x, y, or z refers to - so long as your systems have the same definition as any GPS servers that're in range, it works just the same. For example, you might build a GPS cluster according to [http://www.computercraft.info/forums2/index.php?/topic/3088-how-to-guide-gps-global-position-system/ this tutorial], using z to account for height, or you might use y to account for height in the way that Minecraft's debug screen displays.
 <!-- do not edit this without actually testing it yourself -->
@@ Line 21: / Line 21: @@
      print("Failed to get my location!")
    else
-     print("I am at (" .. x .. ", " .. y .. ", " .. z .. ")") --This prints 'I am at (1,2,3)' or whatever your coordinates are
+     print("I am at (" .. x .. ", " .. y .. ", " .. z .. ")") --This prints 'I am at (1, 2, 3)' or whatever your coordinates are
    end

@@ Line 5: / Line 5: @@
 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.
-Also note that you may ''choose'' which axises x, y or z refers to - so long as your systems have the same definition as any GPS servers that're in range, it works just the same. For example, you might build a GPS cluster according to [http://www.computercraft.info/forums2/index.php?/topic/3088-how-to-guide-gps-global-position-system/ this tutorial], using z to account for height, or you might use y to account for height in the way that MineCraft's debug screen displays.
+Also note that you may ''choose'' which axises x, y or z refers to - so long as your systems have the same definition as any GPS servers that're in range, it works just the same. For example, you might build a GPS cluster according to [http://www.computercraft.info/forums2/index.php?/topic/3088-how-to-guide-gps-global-position-system/ this tutorial], using z to account for height, or you might use y to account for height in the way that Minecraft's debug screen displays.
 <!-- do not edit this without actually testing it yourself -->

@@ Line 9: / Line 9: @@
 <!-- do not edit this without actually testing it yourself -->
-<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
+{{API table|Gps|image=Grid_disk.png|2=
-<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
-[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
-Gps (API)
-</td></tr>
-<tr><td style="width: 100px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
+{{API table/row|gps.locate(<nowiki>[</nowiki>{{type|number}} timeout [, {{Type|boolean}} debug]])|({{Type|number}} x, {{Type|number}} y, {{Type|number}} z) or {{Type|nil}}|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 {{Type|nil}}. If <var>debug</var> is <code>true</code>, debug messages are printed.|odd}}
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">({{Type|number}} x, {{Type|number}} y, {{Type|number}} z), or [[nil]]</td>
+}}
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">gps.locate(<nowiki>[</nowiki>{{Type|number}} 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.</td></tr></table>
 == Example ==

@@ Line 1: / Line 1: @@
 The GPS API provides a method for turtles and computers to retrieve their own locations.
-It broadcasts a PING message over [[Rednet_(API)|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 [[Wikipedia:Trilateration|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)|gps program]].
+It broadcasts a PING message over [[Rednet_(API)|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 [[Wikipedia:Trilateration|trilateration]]. Three of these hosts should be in a plane, and the fourth should be either above or below the other three. The three in a plane should not be in a line with each other. You can set up hosts using the [[Gps (program)|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.

@@ Line 24: / Line 24: @@
    print("Man I am so lost right now!")
    local x, y, z = gps.locate(5)
-   if x == nil then
+   if not x then --If gps.locate didn't work, it won't return anything. So check to see if it did.
-     print("Nope, still lost :(")
+     print("Failed to get my location!")
    else
-     print("I am at ",x," ",y," ",z)
+     print("I am at (" .. x .. ", " .. y .. ", " .. z .. ")") --This prints 'I am at (1,2,3)' or whatever your coordinates are
    end

@@ Line 37: / Line 37: @@
    local displacement = position - home
-   print("I am ", displacement.tostring(), " away from home!!!")
+   print("I am ", tostring(displacement), " away from home!!!")
 [[Category:APIs]]

← Older revision		Revision as of 19:48, 16 January 2014
Line 4:		Line 4:

	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.		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.
		+
		+	Also note that "z", not "y", represents the turtle's height above the bottom of the world.
		+
	<!-- do not edit this without actually testing it yourself -->		<!-- do not edit this without actually testing it yourself -->

@@ 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>
-<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;">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.</td></tr></table>