Changes between Version 2 and Version 3 of Ruby Client Tutorial

Timestamp:

Aug 18, 2011 11:24:27 AM (13 years ago)

Author:

kedwar10

Comment:

--

Ruby Client Tutorial

@@ -28 +28 @@
 ev jo 1 quagent
 }}}
- 
-
-
 
 ----
@@ -41 +38 @@
 ----
 = Defining Commands =
+When a Quagent is instantiated via the 'new' method, it connects to the ioquake server.  The 'write' method can be used to issue commands through the socket. (Notice that protocol zero op codes have been mapped to more user-friendly strings.)
+
+{{{
+def whereis (quagent)
+  quagent.write("now",                          # scheduling
+                "location",                     # op
+                "",                             # args
+                nil,                            # initial value
+                lambda { |prev, data|           # reduction function
+                   return data_to_doubles(data)
+                   })
+end
+}}}
+
+The write method takes the arguments "now", "location", and "" and sends the string "n lc #" (where # is an integer) to the server.  It then creates a separate thread that reads replies from the socket.  When the reply is of type "rs", 'write' calls its last argument on the accumulator (initially the penultimate argument) and the data from the last response (an array of strings).  When the reply is of type "cp", 'write' terminates the thread and returns the accumulator. In the previous example, there was no need to specify an initial value since the server only sends data once.  The radar op, however, sends data for every object it finds.  The 'scan' function uses a hash map as the initial value and then builds a list of (relative) locations for each item type.
+
+{{{
+def scan (quagent, radius)
+  quagent.write("now",
+                "radar",
+                "#{radius}",
+                {},
+                lambda { |prev, data|
+                  id, type, dist, yaw, pitch = data
+                  if prev[type] == nil
+                    return prev.merge({type => [data_to_doubles [dist, yaw, pitch]]})
+                  end
+                  return prev.merge({type => prev[type].concat([data_to_doubles [dist, yaw, pitch]])})
+                })
+end
+}}}
 
 ----