josh/anaglym
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

added documentation for ag.pickObjects()

Browse Source 
git-svn-id: svn://anubis/anaglym/trunk@256 99a6e188-d820-4881-8870-2d33a10e2619
This commit is contained in:
Josh Holtrop 2010-02-21 22:29:46 +00:00
parent 83d6c60fea
commit d27f18b701
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.todo
View File

@ -1,2 +1 @@
add API documentation for ag.pickObjects()
add audio capabilities

13
doc/index.html
View File

@ -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>