From 10cf5cfad05e2ed6c9af30337838ccf5ffd48134 Mon Sep 17 00:00:00 2001
From: AJ Kelly <aj187@ajworld.net>
Date: Mon, 2 Apr 2012 15:14:48 -0500
Subject: [PATCH] update lua documentation. also, the schema validator moved;
 updated its location

---
 Docs/Luadoc/Lua.xml              | 21 +++++++++------------
 Docs/Luadoc/LuaDocumentation.xml | 17 ++++++++++++++---
 2 files changed, 23 insertions(+), 15 deletions(-)

diff --git a/Docs/Luadoc/Lua.xml b/Docs/Luadoc/Lua.xml
index e8d3beeec8..6ac827b91f 100644
--- a/Docs/Luadoc/Lua.xml
+++ b/Docs/Luadoc/Lua.xml
@@ -3,6 +3,7 @@
 
 <Lua xmlns='http://www.stepmania.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.stepmania.com Lua.xsd'>
 	<GlobalFunctions>
+		<Function name='AllowOptionsMenu'/>
 		<Function name='Alpha'/>
 		<Function name='AreStagePlayerModsForced'/>
 		<Function name='AreStageSongModsForced'/>
@@ -39,7 +40,6 @@
 		<Function name='FormatNumberAndSuffix'/>
 		<Function name='FormatPercentScore'/>
 		<Function name='GameCompatibleModes'/>
-		<Function name='GamePrefComboOnRolls'/>
 		<Function name='GamePrefDefaultFail'/>
 		<Function name='GetCodeForGame'/>
 		<Function name='GetCoursesToShowRanking'/>
@@ -184,16 +184,7 @@
 		<Function name='URLEncode'/>
 		<Function name='UndocumentedFeature'/>
 		<Function name='UnlockRewardTypeToLocalizedString'/>
-		<Function name='UserPrefAutoSetStyle'/>
-		<Function name='UserPrefComboUnderField'/>
-		<Function name='UserPrefFlashyCombo'/>
-		<Function name='UserPrefGameplayFooter'/>
-		<Function name='UserPrefGameplayShowScore'/>
-		<Function name='UserPrefGameplayShowStepsDisplay'/>
-		<Function name='UserPrefLongFail'/>
-		<Function name='UserPrefNotePosition'/>
 		<Function name='UserPrefScoringMode'/>
-		<Function name='UserPrefShowLotsaOptions'/>
 		<Function name='Var'/>
 		<Function name='VersionDate'/>
 		<Function name='VersionTime'/>
@@ -776,6 +767,7 @@
 			<Function name='GetSongPercent'/>
 			<Function name='GetSongPosition'/>
 			<Function name='GetSortOrder'/>
+			<Function name='GetStageResult'/>
 			<Function name='GetStageSeed'/>
 			<Function name='GetWorkoutGoalComplete'/>
 			<Function name='HasEarnedExtraStage'/>
@@ -2196,6 +2188,11 @@
 			<EnumValue name='&apos;StageAward_90PercentW3&apos;' value='8'/>
 			<EnumValue name='&apos;StageAward_100PercentW3&apos;' value='9'/>
 		</Enum>
+		<Enum name='StageResult'>
+			<EnumValue name='&apos;StageResult_Win&apos;' value='0'/>
+			<EnumValue name='&apos;StageResult_Lose&apos;' value='1'/>
+			<EnumValue name='&apos;StageResult_Draw&apos;' value='2'/>
+		</Enum>
 		<Enum name='StepsType'>
 			<EnumValue name='&apos;StepsType_Dance_Single&apos;' value='0'/>
 			<EnumValue name='&apos;StepsType_Dance_Double&apos;' value='1'/>
@@ -2343,6 +2340,6 @@
 		<Constant name='right' value='&apos;HorizAlign_Right&apos;'/>
 		<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
 	</Constants>
-	<Version>StepMania v5.0 alpha 1a</Version>
-	<Date>2012-03-20</Date>
+	<Version>StepMania v5.0 alpha 2</Version>
+	<Date>2012-04-02</Date>
 </Lua>
diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml
index c53362e4be..44188db9a2 100644
--- a/Docs/Luadoc/LuaDocumentation.xml
+++ b/Docs/Luadoc/LuaDocumentation.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
 <!-- Before checking the documentation in, make sure that it validates by
-     going to http://tools.decisionsoft.com/schemaValidate/ and using
+     going to http://www.corefiling.com/opensource/schemaValidate.html and using
      Lua.xsd for the XML Schema and this file for the XML Instance. -->
 
 <!-- Using Link:
@@ -697,6 +697,14 @@ save yourself some time, copy this for undocumented things:
 		a warning. Aliased by <Link class='GLOBAL' function='Warn' />.
 	</Function>
 </Namespace>
+<Namespace name='MersenneTwister'>
+	<Function name='Random' return='float' arguments='...'>
+		Returns a random number. Without arguments, the number is in the range <code>0..1</code>. With a single argument (<code>n</code>), the number is in the range of <code>1..n</code>. With two arguments (<code>lower</code>, <code>upper</code>), the number is in the range of <code>l..u</code>.
+	</Function>
+	<Function name='Seed' return='void' arguments='int seed'>
+		Sets the seed of the random number generator to <code>seed</code>.
+	</Function>
+</Namespace>
 <Namespace name='RageFileUtil'>
 	<Function name='CreateRageFile' return='RageFile' arguments=''>
 		Creates a RageFile handle with which one can use the commands in <Link class='RageFile' />.
@@ -1976,6 +1984,9 @@ save yourself some time, copy this for undocumented things:
 	<Function name='GetSortOrder' return='SortOder' arguments=''>
 		Returns the sort order, if the GameCommand has set one.
 	</Function>
+	<Function name='GetStageResult' return='StageResult' arguments='PlayerNumber pn'>
+		Returns the StageResult for player <code>pn</code>.
+	</Function>
 	<Function name='GetStageModifiers' return='string' arguments=''>
 		Returns any stage modifiers that may have been set.
 	</Function>
@@ -3297,7 +3308,7 @@ save yourself some time, copy this for undocumented things:
 		Returns a PlayerOptions object for the specified ModsLevel.
 	</Function>
 	<Function name='GetPlayerOptionsString' return='string' arguments='ModsLevel ml'>
-		Returns a string of player options for the specified ModsLevel. (was GetPlayerOptions in v1.2.2 and prior)
+		Returns a string of player options for the specified ModsLevel. (was <code>GetPlayerOptions</code> before sm-ssc v1.2.3)
 	</Function>
 	<Function name='GetPlayerOptionsArray' return='{string}' arguments='ModsLevel ml'>
 		Returns a table of strings, containing the player options for the specified ModsLevel.
@@ -3823,7 +3834,7 @@ save yourself some time, copy this for undocumented things:
 </Class>
 <Class name='ScreenTextEntry'>
 	<Description>
-		See the Changelog for details on TextEntrySetting's format.
+		TextEntrySettings is implemented similar to the Attributes in BitmapText. Formatting issues prevent the sample from being properly shown here; please see Changelog_sm-ssc.txt for the TextEntrySettings format.
 	</Description>
 	<Function name='Load' return='void' arguments='TextEntrySettings args'>
 		Sets up a ScreenTextEntry's values.