From d27f18b7010c001edce8b864ba369c4856e34236 Mon Sep 17 00:00:00 2001
From: Josh Holtrop <jholtrop+git@gmail.com>
Date: Sun, 21 Feb 2010 22:29:46 +0000
Subject: [PATCH] added documentation for ag.pickObjects()

git-svn-id: svn://anubis/anaglym/trunk@256 99a6e188-d820-4881-8870-2d33a10e2619
---
 .todo          |  1 -
 doc/index.html | 13 +++++++++++++
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/.todo b/.todo
index e53b7f5..27e10dd 100644
--- a/.todo
+++ b/.todo
@@ -1,2 +1 @@
-add API documentation for ag.pickObjects()
 add audio capabilities
diff --git a/doc/index.html b/doc/index.html
index b551ef6..cc5d43b 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -406,6 +406,19 @@ Textures are searched for relative to the folder containing the
 hosted script first, then relative to the engine library folder.
 </p>
 
+<a name="ag_pickObjects" />
+<h3>pickObjects</h3>
+<p><tt>objects = ag.pickObjects(x, y)</tt></p>
+<p>
+This function allows for 3D object "picking."
+<tt>x</tt> and <tt>y</tt> should be the 2D screen coordinates of the
+"pick point."
+<tt>pickObjects</tt> returns a Lua array of the objects in the
+"pick line" (the line from the camera through the "pick point" on the
+screen.
+Upon error, <tt>pickObjects</tt> returns <tt>nil</tt>.
+</p>
+
 <a name="ag_print" />
 <h3>print</h3>
 <p><tt>ag.print(args...)</tt></p>