From 954a5d50725dafaac9015b39f254dcdac8c4a679 Mon Sep 17 00:00:00 2001
From: AJ Kelly <aj187@ajworld.net>
Date: Thu, 6 Oct 2011 12:39:32 -0500
Subject: [PATCH] update lua docs

---
 Docs/Luadoc/Lua.xml              | 35 +++++++++---
 Docs/Luadoc/LuaDocumentation.xml | 93 ++++++++++++++++++++++----------
 2 files changed, 93 insertions(+), 35 deletions(-)

diff --git a/Docs/Luadoc/Lua.xml b/Docs/Luadoc/Lua.xml
index 79b0ddb7f9..2956478b72 100644
--- a/Docs/Luadoc/Lua.xml
+++ b/Docs/Luadoc/Lua.xml
@@ -119,6 +119,7 @@
 		<Function name='MultiPlayerToLocalizedString'/>
 		<Function name='MultiPlayerToString'/>
 		<Function name='OptionRowProTiming'/>
+		<Function name='OptionRowScreenFilter'/>
 		<Function name='OptionsRandomJukebox'/>
 		<Function name='OptionsRowTest'/>
 		<Function name='PeakComboAwardToLocalizedString'/>
@@ -202,6 +203,7 @@
 		<Function name='UserPrefNotePosition'/>
 		<Function name='UserPrefScoringMode'/>
 		<Function name='UserPrefShowLotsaOptions'/>
+		<Function name='UserPrefTimingDisplay'/>
 		<Function name='Var'/>
 		<Function name='VersionDate'/>
 		<Function name='VersionTime'/>
@@ -216,7 +218,6 @@
 		<Function name='clamp'/>
 		<Function name='collectgarbage'/>
 		<Function name='color'/>
-		<Function name='date'/>
 		<Function name='dofile'/>
 		<Function name='error'/>
 		<Function name='fapproach'/>
@@ -663,10 +664,15 @@
 		<Class base='ActorFrame' name='FadingBanner'>
 			<Function name='GetLatestIndex'/>
 			<Function name='LoadCardFromCharacter'/>
+			<Function name='LoadCourseFallback'/>
+			<Function name='LoadFallback'/>
 			<Function name='LoadFromCourse'/>
 			<Function name='LoadFromSong'/>
 			<Function name='LoadFromSongGroup'/>
+			<Function name='LoadFromSortOrder'/>
 			<Function name='LoadIconFromCharacter'/>
+			<Function name='LoadRandom'/>
+			<Function name='LoadRoulette'/>
 			<Function name='ScaleToClipped'/>
 			<Function name='scaletoclipped'/>
 		</Class>
@@ -698,9 +704,13 @@
 			<Function name='PlayOnce'/>
 		</Class>
 		<Class name='GameState'>
+			<Function name='AddStageToPlayer'/>
 			<Function name='AnyPlayerHasRankingFeats'/>
 			<Function name='ApplyGameCommand'/>
+			<Function name='ApplyPreferredModifiers'/>
+			<Function name='ApplyStageModifiers'/>
 			<Function name='ClearStageModifiersIllegalForCourse'/>
+			<Function name='CurrentOptionsDisqualifyPlayer'/>
 			<Function name='Dopefish'/>
 			<Function name='EnoughCreditsToJoin'/>
 			<Function name='Env'/>
@@ -720,6 +730,7 @@
 			<Function name='GetCurrentStyle'/>
 			<Function name='GetCurrentTrail'/>
 			<Function name='GetDefaultSongOptions'/>
+			<Function name='GetEarnedExtraStage'/>
 			<Function name='GetEasiestStepsDifficulty'/>
 			<Function name='GetEditCourseEntryIndex'/>
 			<Function name='GetEditLocalProfile'/>
@@ -855,9 +866,12 @@
 		</Class>
 		<Class base='ActorFrame' name='MenuTimer'>
 			<Function name='GetSeconds'/>
+			<Function name='SetSeconds'/>
+			<Function name='disable'/>
 			<Function name='pause'/>
 			<Function name='setseconds'/>
 			<Function name='silent'/>
+			<Function name='start'/>
 			<Function name='stealth'/>
 			<Function name='stop'/>
 		</Class>
@@ -871,6 +885,7 @@
 			<Function name='Load'/>
 		</Class>
 		<Class base='Actor' name='Model'>
+			<Function name='GetDefaultAnimation'/>
 			<Function name='GetNumStates'/>
 			<Function name='SetDefaultAnimation'/>
 			<Function name='loop'/>
@@ -1572,10 +1587,10 @@
 			<Function name='GetStepsUnlockedByEntryID'/>
 			<Function name='GetUnlockEntry'/>
 			<Function name='GetUnlockEntryIndexToCelebrate'/>
+			<Function name='IsSongLocked'/>
 			<Function name='PreferUnlockEntryID'/>
 			<Function name='UnlockEntryID'/>
 			<Function name='UnlockEntryIndex'/>
-			<Function name='IsSongLocked'/>
 		</Class>
 		<Class base='ActorFrame' name='WheelBase'>
 			<Function name='GetCurrentIndex'/>
@@ -1585,6 +1600,10 @@
 			<Function name='IsSettled'/>
 			<Function name='SetOpenSection'/>
 		</Class>
+		<Class base='ActorFrame' name='WheelItemBase'>
+			<Function name='GetColor'/>
+			<Function name='GetText'/>
+		</Class>
 		<Class base='ActorFrame' name='WorkoutGraph'>
 			<Function name='SetFromCurrentWorkout'/>
 			<Function name='SetFromGameStateAndHighlightSong'/>
@@ -2177,16 +2196,16 @@
 		</Enum>
 	</Enums>
 	<Constants>
-		<Constant name='ASPECT_SCALE_FACTOR' value='640'/>
+		<Constant name='ASPECT_SCALE_FACTOR' value='854'/>
 		<Constant name='NUM_PLAYERS' value='2'/>
 		<Constant name='SCREEN_BOTTOM' value='480'/>
-		<Constant name='SCREEN_CENTER_X' value='320'/>
+		<Constant name='SCREEN_CENTER_X' value='427'/>
 		<Constant name='SCREEN_CENTER_Y' value='240'/>
 		<Constant name='SCREEN_HEIGHT' value='480'/>
 		<Constant name='SCREEN_LEFT' value='0'/>
-		<Constant name='SCREEN_RIGHT' value='640'/>
+		<Constant name='SCREEN_RIGHT' value='854'/>
 		<Constant name='SCREEN_TOP' value='0'/>
-		<Constant name='SCREEN_WIDTH' value='640'/>
+		<Constant name='SCREEN_WIDTH' value='854'/>
 		<Constant name='PLAYER_1' value='&apos;PlayerNumber_P1&apos;'/>
 		<Constant name='PLAYER_2' value='&apos;PlayerNumber_P2&apos;'/>
 		<Constant name='_VERSION' value='&apos;Lua 5.1&apos;'/>
@@ -2198,6 +2217,6 @@
 		<Constant name='sGame' value='&apos;dance&apos;'/>
 		<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
 	</Constants>
-	<Version>StepMania v5.0 Preview 3</Version>
-	<Date>2011-08-27</Date>
+	<Version>StepMania v5.0 Preview 4</Version>
+	<Date>2011-10-06</Date>
 </Lua>
diff --git a/Docs/Luadoc/LuaDocumentation.xml b/Docs/Luadoc/LuaDocumentation.xml
index ba09931dfd..16edaced56 100644
--- a/Docs/Luadoc/LuaDocumentation.xml
+++ b/Docs/Luadoc/LuaDocumentation.xml
@@ -1580,7 +1580,7 @@
 		Gets the CourseEntry at <code>iIndex</code> from the Course.
 	</Function>
 	<Function name='GetCourseType' renamed='true' return='CourseType' arguments=''>
-		Returns the Course's <Link class='ENUM' function='CourseType' />. (Returns CourseType in sm-ssc; integer in SM4)
+		Returns the Course's <Link class='ENUM' function='CourseType' />. (Returns CourseType in SM5; integer in SM4)
 	</Function>
 	<Function name='GetDescription' return='string' arguments=''>
 		Returns the description for this Course.
@@ -1598,7 +1598,7 @@
 		Returns the Course's group name.
 	</Function>
 	<Function name='GetPlayMode' renamed='true' return='PlayMode' arguments=''>
-		Returns the Course's <Link class='ENUM' function='PlayMode' />. (Returns PlayMode in sm-ssc; integer in SM4)
+		Returns the Course's <Link class='ENUM' function='PlayMode' />. (Returns PlayMode in SM5; integer in SM4)
 	</Function>
 	<Function name='GetScripter' return='string' arguments=''>
 		Returns the name of the person who scripted the Course.
@@ -1807,6 +1807,15 @@
 	</Function>
 </Class>
 <Class name='GameState'>
+	<Function name='AddStageToPlayer' return='void' arguments='PlayerNumber pn'>
+		Adds another stage to the specifed player.
+	</Function>
+	<Function name='ApplyPreferredModifiers' return='void' arguments='PlayerNumber pn, string mods'>
+		Applies the specified modifiers for the specified player's preferred modifier set.
+	</Function>
+	<Function name='ApplyStageModifiers' return='void' arguments='PlayerNumber pn, string mods'>
+		Applies the specified modifiers for the specified player for the current stage.
+	</Function>
 	<Function name='AnyPlayerHasRankingFeats' return='bool' arguments=''>
 		Returns <code>true</code> if any player has performed a feat worthy of ranking.
 	</Function>
@@ -1817,6 +1826,9 @@
 	<Function name='ClearStageModifiersIllegalForCourse' return='void' arguments=''>
 		Removes any stage modifiers that are illegal for course play.
 	</Function>
+	<Function name='CurrentOptionsDisqualifyPlayer' return='bool' arguments='PlayerNumber pn'>
+		Returns <code>true</code> if <code>pn</code>'s options will disqualify them for ranking.
+	</Function>
 	<Function name='EnoughCreditsToJoin' return='bool' arguments=''>
 		Returns <code>true</code> if enough credits have been inserted to join.
 	</Function>
@@ -1884,6 +1896,9 @@
 	<Function name='GetDefaultSongOptions' return='string' arguments=''>
 		Return a string representation of the default song options.
 	</Function>
+	<Function name='GetEarnedExtraStage' return='EarnedExtraStage' arguments=''>
+		Returns the <Link enum='EarnedExtraStage' /> value.
+	</Function>
 	<Function name='GetEasiestStepsDifficulty' return='Difficulty' arguments=''>
 		Return the easiest <Link class='ENUM' function='Difficulty' /> of the
 		currently selected steps by all players. For example, if player 1 has
@@ -1976,22 +1991,22 @@
 		Returns the smallest number of stages left for any human player.
 	</Function>
 	<Function name='GetSongBeat' theme='_fallback' return='float' arguments=''>
-		[01 compat.lua] Returns the current beat of the song.
+		[01 alias.lua] Returns the current beat of the song.
 	</Function>
 	<Function name='GetSongBeatNoOffset' theme='_fallback' return='float' arguments=''>
-		[01 compat.lua] Returns the current beat of the song without an offset.
+		[01 alias.lua] Returns the current beat of the song without an offset.
 	</Function>
 	<Function name='GetSongBeatVisible' return='float' arguments=''>
 		Returns the current visible beat of the song.
 	</Function>
 	<Function name='GetSongBPS' theme='_fallback' return='float' arguments=''>
-		[01 compat.lua] Returns the song's current beats per second.
+		[01 alias.lua] Returns the song's current beats per second.
 	</Function>
 	<Function name='GetSongDelay' theme='_fallback' return='bool' arguments=''>
-		[01 compat.lua] Returns <code>true</code> if a delay is active in the song.
+		[01 alias.lua] Returns <code>true</code> if a delay is active in the song.
 	</Function>
 	<Function name='GetSongFreeze' theme='_fallback' return='bool' arguments=''>
-		[01 compat.lua] Returns <code>true</code> if the song is currently in a freeze.
+		[01 alias.lua] Returns <code>true</code> if the song is currently in a freeze.
 	</Function>
 	<Function name='GetSongOptions' return='string' arguments='ModsLevel ml'>
 		Returns the song options for the specified ModsLevel as a string.
@@ -2268,6 +2283,9 @@
 	</Function>
 </Class>
 <Class name='MenuTimer'>
+	<Function name='disable' return='void' arguments=''>
+		Stops the MenuTimer by setting it to 99.99 and pausing.
+	</Function>
 	<Function name='GetSeconds' return='float' arguments=''>
 		Returns the current MenuTimer's value.
 	</Function>
@@ -2275,11 +2293,17 @@
 		Pauses the MenuTimer, stopping it from counting down.
 	</Function>
 	<Function name='setseconds' return='void' arguments='float fSeconds'>
+		Compatibility alias for SetSeconds.
+	</Function>
+	<Function name='SetSeconds' return='void' arguments='float fSeconds'>
 		Sets the MenuTimer's value to <code>fSeconds</code>.
 	</Function>
 	<Function name='silent' return='void' arguments='bool bSilent'>
 		Sets the MenuTimer's silent setting to <code>bSilent</code>.
 	</Function>
+	<Function name='start' return='void' arguments=''>
+		Starts up the timer.
+	</Function>
 	<Function name='stealth' return='void' arguments='bool bStealth'>
 		Sets the MenuTimer's stealth setting to <code>bStealth</code>. If
 		<code>true</code>, the timer will be invisible and silent.
@@ -2301,6 +2325,9 @@
 	</Function>
 </Class>
 <Class name='Model'>
+	<Function name='GetDefaultAnimation' return='string' arguments=''>
+		Returns the model's default animation.
+	</Function>
 	<Function name='loop' return='void' arguments='bool bLoop'>
 		Controls if the model should loop or not.
 	</Function>
@@ -2740,20 +2767,6 @@
 	<Function name='GetTapNoteScores' return='int' arguments='TapNoteScore tns'>
 		Returns the number of judgments for a specified TapNoteScore.
 	</Function>
-	<!-- removed:
-	<Function name='IsFullComboW1' renamed='true' return='bool' arguments=''>
-		[01 compat.lua] Returns <code>true</code> if the player got a full combo of all W1s.
-	</Function>
-	<Function name='IsFullComboW2' renamed='true' return='bool' arguments=''>
-		[01 compat.lua] Returns <code>true</code> if the player got a full combo of all W2s.
-	</Function>
-	<Function name='IsFullComboW3' renamed='true' return='bool' arguments=''>
-		[01 compat.lua] Returns <code>true</code> if the player got a full combo of all W3s.
-	</Function>
-	<Function name='IsFullComboW4' renamed='true' return='bool' arguments=''>
-		[01 compat.lua] Returns <code>true</code> if the player got a full combo of all W4s.
-	</Function>
-	-->
 	<Function name='MaxCombo' return='int' arguments=''>
 		Returns the max combo for this performance.
 	</Function>
@@ -3316,9 +3329,15 @@
 	<Function name='GetBannerPath' return='string' arguments=''>
 		Returns the path to the song's banner.
 	</Function>
+	<Function name='GetCDImagePath' return='string' arguments=''>
+		Returns the path to the song's CD image.
+	</Function>
 	<Function name='GetCDTitlePath' return='string' arguments=''>
 		Gets the path to the CDTitle.
 	</Function>
+	<Function name='GetDiscPath' return='string' arguments=''>
+		Returns the path to the song's disc image (different from CD, think Pump).
+	</Function>
 	<Function name='GetDisplayArtist' return='string' arguments=''>
 		Returns the displayed artist of the song.
 	</Function>
@@ -3346,6 +3365,9 @@
 	<Function name='GetGroupName' return='string' arguments=''>
 		Returns the group name that the song is in.
 	</Function>
+	<Function name='GetJacketPath' return='string' arguments=''>
+		Returns the path to the song's jacket image.
+	</Function>
 	<Function name='GetLastBeat' return='float' arguments=''>
 		Returns the last beat of the song.
 	</Function>
@@ -3412,12 +3434,21 @@
 	<Function name='HasBGChanges' return='bool' arguments=''>
 		Returns <code>true</code> if the song has BGChanges.
 	</Function>
+	<Function name='HasCDImage' return='bool' arguments=''>
+		Returns <code>true</code> if the song has a CD image.
+	</Function>
 	<Function name='HasCDTitle' return='bool' arguments=''>
 		Returns <code>true</code> if the song has a CDTitle.
 	</Function>
+	<Function name='HasDisc' return='bool' arguments=''>
+		Returns <code>true</code> if the song has a Disc graphic.
+	</Function>
 	<Function name='HasEdits' return='bool' arguments='StepsType st'>
 		Returns <code>true</code> if the song has edits.
 	</Function>
+	<Function name='HasCDJacket' return='bool' arguments=''>
+		Returns <code>true</code> if the song has a jacket graphic.
+	</Function>
 	<Function name='HasLyrics' return='bool' arguments=''>
 		Returns <code>true</code> if the song has lyrics.
 	</Function>
@@ -3425,10 +3456,10 @@
 		Returns <code>true</code> if the song has music.
 	</Function>
 	<Function name='HasSignificantBPMChangesOrStops' return='bool' arguments=''>
-		Returns <code>true</code> if the song has significant elephants or bison.
+		Returns <code>true</code> if the song has significant BPM changes or stops.
 	</Function>
-	<Function name='HasStepsType' return='bool' arguments=''>
-		Returns <code>true</code> if the song has .
+	<Function name='HasStepsType' return='bool' arguments='StepsType st'>
+		Returns <code>true</code> if the song has the specified StepsType.
 	</Function>
 	<Function name='IsDisplayBpmConstant' return='bool' arguments=''>
 		Returns <code>true</code> if the song's DisplayBPM is constant.
@@ -3814,13 +3845,13 @@
 	<Function name='IsAutogen' return='bool' arguments=''>
 		Returns <code>true</code> if the steps were automatically generated.
 	</Function>
-	<Function name='IsDisplayBpmConstant' return='' arguments=''>
+	<Function name='IsDisplayBpmConstant' return='bool' arguments=''>
 		Returns <code>true</code> if the DisplayBPM is constant.
 	</Function>
-	<Function name='IsDisplayBpmRandom' return='' arguments=''>
+	<Function name='IsDisplayBpmRandom' return='bool' arguments=''>
 		Returns <code>true</code> if the DisplayBPM is random.
 	</Function>
-	<Function name='IsDisplayBpmSecret' return='' arguments=''>
+	<Function name='IsDisplayBpmSecret' return='bool' arguments=''>
 		Returns <code>true</code> if the DisplayBPM is secret.
 	</Function>
 	<Function name='PredictMeter' return='float' arguments=''>
@@ -4197,6 +4228,14 @@
 		Attempts to set the open section to <code>sSection</code>.
 	</Function>
 </Class>
+<Class name='WheelItemBase'>
+	<Function name='GetColor' return='color' arguments=''>
+		Returns the color of this wheel item.
+	</Function>
+	<Function name='GetText' return='string' arguments=''>
+		Returns the text of this wheel item.
+	</Function>
+</Class>
 <Class name='WorkoutGraph'>
 	<Function name='SetFromCurrentWorkout' return='void' arguments=''>
 		Sets the WorkoutGraph from the current Workout.