From a6b69f91dd0169e62d954afc4f36f367c1cb0bb6 Mon Sep 17 00:00:00 2001
From: Steve Checkoway <stevecheckoway@users.sourceforge.net>
Date: Mon, 6 Aug 2007 00:06:35 +0000
Subject: [PATCH] Add documentation for a few random Actor functions for
 examples of using Link.

---
 stepmania/Docs/LuaDocumentation.xml | 31 ++++++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

diff --git a/stepmania/Docs/LuaDocumentation.xml b/stepmania/Docs/LuaDocumentation.xml
index 0ac0f9f379..fcc2d38c53 100644
--- a/stepmania/Docs/LuaDocumentation.xml
+++ b/stepmania/Docs/LuaDocumentation.xml
@@ -4,6 +4,19 @@
      going to http://tools.decisionsoft.com/schemaValidate/ and using
      Lua.xsd for the XML Schema and this file for the XML Instanace. -->
 
+<!-- Using Link:
+     To add a link to a function in the current class:
+     <Link function='addx'>See addx()</Link>
+     To add a link to a function in another class:
+     <Link class='ActorFrame' function='propogate'>ActorFrame:propogate()</Link>
+     To add a link to a class:
+     <Link class='ActorFrame'>ActorFrame</Link>
+     To add a link to a global function:
+     <Link class='GLOBAL' function='Basename'>Basename()</Link>
+     To add a link to an Enum:
+     <Link class='ENUM' function='CoinMode'>CoinMode</Link> -->
+
+
 <Documentation xmlns='http://www.stepmania.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.stepmania.com Lua.xsd'>
 <!-- Global functions -->
 <GlobalFunctions>
@@ -18,14 +31,26 @@
 <!-- Classes -->
 <Classes>
 <Class name='Actor'>
+	<Function name='halign' return='void' arguments='fAlign'>
+		Set the fractional horizontal alignment of the Actor according to fAlign which should be a float in the range 0..1. An alignment of 0 is left aligned while an alignment of 1 is right aligned. See <Link function='horizalign'>horizalign()</Link> for the common case.
+	</Function>
+	<Function name='horizalign' return='void' arguments='align'>
+		Set the horizontal alignment of the Actor according to align which should be one of <Link class='ENUM' function='HorizAlign'>HorizAlign</Link>. See <Link function='halign'>halign()</Link> for fractional alignment.
+	</Function>
+	<Function name='valign' return='void' arguments='fAlign'>
+		Set the fractional vertical alignment of the Actor according to fAlign which should be a float in the range 0..1. An alignment of 0 is top aligned while an alignment of 1 is bottom aligned. See <Link function="vertalign">vertalign</Link> for the common case.
+	</Function>
+	<Function name='vertalign' return='void' arguments='align'>
+		Set the vertical alignment of the Actor according to align which should be one of <Link class="ENUM" function="VertAlign">VertAlign</Link>. See <Link function="valign">valign()</Link> for fractional alignment.
+	</Function>
 	<Function name='x' return='void' arguments='xPos'>
-		Set the x position of the Actor.
+		Set the x position of the Actor to xPos.
 	</Function>
 	<Function name='y' return='void' arguments='yPos'>
-		Set the y position of the Actor.
+		Set the y position of the Actor to yPos.
 	</Function>
 	<Function name='z' return='void' arguments='zPos'>
-		Set the z position of the Actor.
+		Set the z position of the Actor to zPos.
 	</Function>
 </Class>
 <Class name='Song'>