Merge pull request #2700 from secondlife/maxim/lua-autopilot-dev

Lua api for autopilot functions

5 files changed, 98 insertions, 13 deletions

diff --git a/indra/newview/scripts/lua/require/LLAgent.lua b/indra/newview/scripts/lua/require/LLAgent.lua
index 5cee998fcd..4a1132fe7e 100644
--- a/indra/newview/scripts/lua/require/LLAgent.lua
+++ b/indra/newview/scripts/lua/require/LLAgent.lua
@@ -80,4 +80,64 @@ function LLAgent.teleport(...)
     return leap.request('LLTeleportHandler', args).message
 end
 
+-- Call with no arguments to sit on the ground.
+-- Otherwise specify "obj_uuid" to sit on,
+-- or region "position" {x, y, z} where to find closest object to sit on.
+-- For example: LLAgent.requestSit{position=LLAgent.getRegionPosition()}
+-- Your avatar should be close enough to the object you want to sit on
+function LLAgent.requestSit(...)
+    local args = mapargs('obj_uuid,position', ...)
+    args.op = 'requestSit'
+    return leap.request('LLAgent', args)
+end
+
+function LLAgent.requestStand()
+    leap.send('LLAgent', {op = 'requestStand'})
+end
+
+-- ***************************************************************************
+--  Autopilot
+-- ***************************************************************************
+LLAgent.autoPilotPump = "LLAutopilot"
+
+-- Start the autopilot to move to "target_global" location using specified parameters
+-- LLAgent.startAutoPilot{ target_global       array of target global {x, y, z} position
+--                      [, allow_flying]       allow flying during autopilot [default: true]
+--                      [, stop_distance]      target maximum distance from target [default: autopilot guess]
+--                      [, behavior_name]      name of the autopilot behavior [default: (script name)]
+--                      [, target_rotation]    array of [x, y, z, w] quaternion values [default: no target]
+--                      [, rotation_threshold] target maximum angle from target facing rotation [default: 0.03 radians]
+-- an event with "success" flag is sent to "LLAutopilot" event pump, when auto pilot is terminated
+function LLAgent.startAutoPilot(...)
+    local args = mapargs('target_global,allow_flying,stop_distance,behavior_name,target_rotation,rotation_threshold', ...)
+    args.op = 'startAutoPilot'
+    leap.send('LLAgent', args)
+end
+
+-- Update target location for currently running autopilot
+function LLAgent.setAutoPilotTarget(target_global)
+    leap.send('LLAgent', {op = 'setAutoPilotTarget', target_global=target_global})
+end
+
+-- Start the autopilot to move to the specified target location
+-- either "leader_id" (uuid of target) or "avatar_name" (avatar full name: use just first name for 'Resident') should be specified
+-- "allow_flying" [default: true], "stop_distance" [default: autopilot guess]
+function LLAgent.startFollowPilot(...)
+    local args = mapargs('leader_id,avatar_name,allow_flying,stop_distance', ...)
+    args.op = 'startFollowPilot'
+    return leap.request('LLAgent', args)
+end
+
+-- Stop the autopilot system: "user_cancel" indicates whether or not to act as though user canceled autopilot [default: false]
+function LLAgent.stopAutoPilot(...)
+    local args = mapargs('user_cancel', ...)
+    args.op = 'stopAutoPilot'
+    leap.send('LLAgent', args)
+end
+
+-- Get information about current state of the autopilot
+function LLAgent.getAutoPilot()
+    return leap.request('LLAgent', {op = 'getAutoPilot'})
+end
+
 return LLAgent
diff --git a/indra/newview/scripts/lua/require/LLChat.lua b/indra/newview/scripts/lua/require/LLChat.lua
index bc0fc86d22..3ac3bab746 100644
--- a/indra/newview/scripts/lua/require/LLChat.lua
+++ b/indra/newview/scripts/lua/require/LLChat.lua
@@ -5,6 +5,7 @@ local LLChat = {}
 -- ***************************************************************************
 --  Nearby chat
 -- ***************************************************************************
+LLChat.nearbyChatPump = "LLNearbyChat"
 
 -- 0 is public nearby channel, other channels are used to communicate with LSL scripts
 function LLChat.sendNearby(msg, channel)
diff --git a/indra/newview/scripts/lua/require/LLChatListener.lua b/indra/newview/scripts/lua/require/LLListener.lua
index 82b28966ce..b05f966097 100644
--- a/indra/newview/scripts/lua/require/LLChatListener.lua
+++ b/indra/newview/scripts/lua/require/LLListener.lua
@@ -3,29 +3,31 @@ local inspect = require 'inspect'
 local leap = require 'leap'
 local util = require 'util'
 
-local LLChatListener = {}
+local LLListener = {}
 local waitfor = {}
 local listener_name = {}
 
-function LLChatListener:new()
+function LLListener:new(pump_name)
     local obj = setmetatable({}, self)
     self.__index = self
-    obj.name = 'Chat_listener'
+    obj.name = 'Listener:' .. pump_name
+    obj._pump = pump_name
 
     return obj
 end
 
-util.classctor(LLChatListener)
+util.classctor(LLListener)
 
-function LLChatListener:handleMessages(event_data)
+function LLListener:handleMessages(event_data)
     print(inspect(event_data))
     return true
 end
 
-function LLChatListener:start()
+function LLListener:start()
+    _pump = self._pump
     waitfor = leap.WaitFor(-1, self.name)
     function waitfor:filter(pump, data)
-        if pump == "LLNearbyChat" then
+        if _pump == pump then
           return data
         end
     end
@@ -37,12 +39,12 @@ function LLChatListener:start()
         end
     end)
 
-    listener_name = leap.request(leap.cmdpump(), {op='listen', source='LLNearbyChat', listener="ChatListener", tweak=true}).listener
+    listener_name = leap.request(leap.cmdpump(), {op='listen', source=_pump, listener="LLListener", tweak=true}).listener
 end
 
-function LLChatListener:stop()
-    leap.send(leap.cmdpump(), {op='stoplistening', source='LLNearbyChat', listener=listener_name})
+function LLListener:stop()
+    leap.send(leap.cmdpump(), {op='stoplistening', source=self._pump, listener=listener_name})
     waitfor:close()
 end
 
-return LLChatListener
+return LLListener
diff --git a/indra/newview/scripts/lua/test_LLChatListener.lua b/indra/newview/scripts/lua/test_LLChatListener.lua
index 4a4d40bee5..0f269b54e6 100644
--- a/indra/newview/scripts/lua/test_LLChatListener.lua
+++ b/indra/newview/scripts/lua/test_LLChatListener.lua
@@ -1,4 +1,4 @@
-local LLChatListener = require 'LLChatListener'
+local LLListener = require 'LLListener'
 local LLChat = require 'LLChat'
 local UI = require 'UI'
 
@@ -22,7 +22,7 @@ function openOrEcho(message)
     end
 end
 
-local listener = LLChatListener()
+local listener = LLListener(LLChat.nearbyChatPump)
 
 function listener:handleMessages(event_data)
     if string.find(event_data.message, '[LUA]') then
diff --git a/indra/newview/scripts/lua/test_autopilot.lua b/indra/newview/scripts/lua/test_autopilot.lua
new file mode 100644
index 0000000000..09c85c140a
--- /dev/null
+++ b/indra/newview/scripts/lua/test_autopilot.lua
@@ -0,0 +1,22 @@
+local LLAgent = require 'LLAgent'
+local LLListener = require 'LLListener'
+
+local pos = LLAgent.getGlobalPosition()
+pos[1]+=10 -- delta x
+pos[2]+=5  -- delta y
+LLAgent.requestStand()
+LLAgent.startAutoPilot{target_global=pos,allow_flying=false,stop_distance=1}
+
+local listener = LLListener(LLAgent.autoPilotPump)
+
+function listener:handleMessages(event_data)
+    if event_data.success then
+      print('Destination is reached')
+      LLAgent.requestSit()
+    else
+      print('Failed to reach destination')
+    end
+    return false
+end
+
+listener:start()