update luadoc

2011-08-27 17:44:20 -05:00
parent cdca3d61d6
commit 68ac5fa87c
2 changed files with 94 additions and 14 deletions
@@ -177,6 +177,7 @@
 		<Function name='StepsOrTrailToColor'/>
 		<Function name='StepsOrTrailToCustomDifficulty'/>
 		<Function name='StepsToCustomDifficulty'/>
+		<Function name='StringToBlend'/>
 		<Function name='TableStringLookup'/>
 		<Function name='TapNoteScoreToLocalizedString'/>
 		<Function name='TextBannerAfterSet'/>
@@ -443,10 +444,13 @@
 			<Function name='zwrite'/>
 		</Class>
 		<Class base='Actor' name='ActorFrame'>
+			<Function name='AddChildFromPath'/>
 			<Function name='GetChild'/>
 			<Function name='GetChildren'/>
 			<Function name='GetDrawFunction'/>
 			<Function name='GetNumChildren'/>
+			<Function name='RemoveAllChildren'/>
+			<Function name='RemoveChild'/>
 			<Function name='RunCommandsOnChildren'/>
 			<Function name='SetAmbientLightColor'/>
 			<Function name='SetDiffuseLightColor'/>
@@ -643,6 +647,7 @@
 			<Function name='IsSecret'/>
 		</Class>
 		<Class name='CryptManager'>
+			<Function name='GenerateRandomUUID'/>
 			<Function name='MD5File'/>
 			<Function name='MD5String'/>
 			<Function name='SHA1File'/>
@@ -1084,7 +1089,7 @@
 			<Function name='GetTotalStepsWithTopGrade'/>
 			<Function name='GetTotalTapsAndHolds'/>
 			<Function name='GetTotalTrailsWithTopGrade'/>
-			<Function name='GetUserData'/>
+			<Function name='GetUserTable'/>
 			<Function name='GetWeightPounds'/>
 			<Function name='HasPassedAnyStepsInSong'/>
 			<Function name='IsCodeUnlocked'/>
@@ -1255,7 +1260,9 @@
 			<Function name='GetAllSteps'/>
 			<Function name='GetBackgroundPath'/>
 			<Function name='GetBannerPath'/>
+			<Function name='GetCDImagePath'/>
 			<Function name='GetCDTitlePath'/>
+			<Function name='GetDiscPath'/>
 			<Function name='GetDisplayArtist'/>
 			<Function name='GetDisplayBpms'/>
 			<Function name='GetDisplayFullTitle'/>
@@ -1265,6 +1272,7 @@
 			<Function name='GetFirstSecond'/>
 			<Function name='GetGenre'/>
 			<Function name='GetGroupName'/>
+			<Function name='GetJacketPath'/>
 			<Function name='GetLastBeat'/>
 			<Function name='GetLastSecond'/>
 			<Function name='GetLyricsPath'/>
@@ -1284,8 +1292,11 @@
 			<Function name='HasBGChanges'/>
 			<Function name='HasBackground'/>
 			<Function name='HasBanner'/>
+			<Function name='HasCDImage'/>
 			<Function name='HasCDTitle'/>
+			<Function name='HasDisc'/>
 			<Function name='HasEdits'/>
+			<Function name='HasJacket'/>
 			<Function name='HasLyrics'/>
 			<Function name='HasMusic'/>
 			<Function name='HasSignificantBPMChangesOrStops'/>
@@ -1304,12 +1315,16 @@
 			<Function name='ShowInDemonstrationAndRanking'/>
 		</Class>
 		<Class name='SongManager'>
+			<Function name='DoesCourseGroupExist'/>
+			<Function name='DoesSongGroupExist'/>
 			<Function name='FindCourse'/>
 			<Function name='FindSong'/>
 			<Function name='GetAllCourses'/>
 			<Function name='GetAllSongs'/>
 			<Function name='GetCourseColor'/>
+			<Function name='GetCourseGroupBannerPath'/>
 			<Function name='GetCourseGroupNames'/>
+			<Function name='GetCoursesInGroup'/>
 			<Function name='GetExtraStageInfo'/>
 			<Function name='GetNumAdditionalCourses'/>
 			<Function name='GetNumAdditionalSongs'/>
@@ -1319,10 +1334,15 @@
 			<Function name='GetNumSongGroups'/>
 			<Function name='GetNumSongs'/>
 			<Function name='GetNumUnlockedSongs'/>
+			<Function name='GetPopularCourses'/>
+			<Function name='GetPopularSongs'/>
+			<Function name='GetPreferredSortCourses'/>
+			<Function name='GetPreferredSortSongs'/>
 			<Function name='GetRandomCourse'/>
 			<Function name='GetRandomSong'/>
 			<Function name='GetSongColor'/>
 			<Function name='GetSongFromSteps'/>
+			<Function name='GetSongGroupBannerPath'/>
 			<Function name='GetSongGroupColor'/>
 			<Function name='GetSongGroupNames'/>
 			<Function name='GetSongRank'/>
@@ -1330,6 +1350,9 @@
 			<Function name='SetPreferredCourses'/>
 			<Function name='SetPreferredSongs'/>
 			<Function name='ShortenGroupName'/>
+			<Function name='SongToPreferredSortSectionName'/>
+			<Function name='WasLoadedFromAdditionalCourses'/>
+			<Function name='WasLoadedFromAdditionalSongs'/>
 		</Class>
 		<Class name='SongPosition'>
 			<Function name='GetCurBPS'/>
@@ -1443,7 +1466,10 @@
 			<Function name='SetFromString'/>
 		</Class>
 		<Class name='ThemeManager'>
+			<Function name='DoesLanguageExist'/>
+			<Function name='DoesThemeExist'/>
 			<Function name='GetCurLanguage'/>
+			<Function name='GetCurThemeName'/>
 			<Function name='GetCurrentThemeDirectory'/>
 			<Function name='GetMetric'/>
 			<Function name='GetNumSelectableThemes'/>
@@ -1457,6 +1483,9 @@
 			<Function name='GetString'/>
 			<Function name='GetThemeAuthor'/>
 			<Function name='GetThemeDisplayName'/>
+			<Function name='HasMetric'/>
+			<Function name='HasString'/>
+			<Function name='IsThemeSelectable'/>
 			<Function name='ReloadMetrics'/>
 			<Function name='RunLuaScripts'/>
 		</Class>
@@ -1514,12 +1543,14 @@
 			<Function name='GetRequirement'/>
 			<Function name='GetSong'/>
 			<Function name='GetStepByStepsType'/>
+			<Function name='GetStepOfAllTypes'/>
 			<Function name='GetUnlockRewardType'/>
 			<Function name='IsLocked'/>
 			<Function name='code'/>
 			<Function name='course'/>
 			<Function name='mod'/>
 			<Function name='require'/>
+			<Function name='requirepasschallengesteps'/>
 			<Function name='requirepasshardsteps'/>
 			<Function name='roulette'/>
 			<Function name='song'/>
@@ -1567,6 +1598,10 @@
 			<Function name='GetName'/>
 			<Function name='Reverse'/>
 		</Namespace>
+		<Namespace name='MersenneTwister'>
+			<Function name='Random'/>
+			<Function name='Seed'/>
+		</Namespace>
 		<Namespace name='RageFileUtil'>
 			<Function name='CreateRageFile'/>
 		</Namespace>
@@ -1687,17 +1722,6 @@
 			<EnumValue name='&apos;EditState_RecordPaused&apos;' value='2'/>
 			<EnumValue name='&apos;EditState_Playing&apos;' value='3'/>
 		</Enum>
-		<Enum name='EffectMode'>
-			<EnumValue name='&apos;EffectMode_Normal&apos;' value='0'/>
-			<EnumValue name='&apos;EffectMode_Unpremultiply&apos;' value='1'/>
-			<EnumValue name='&apos;EffectMode_ColorBurn&apos;' value='2'/>
-			<EnumValue name='&apos;EffectMode_ColorDodge&apos;' value='3'/>
-			<EnumValue name='&apos;EffectMode_VividLight&apos;' value='4'/>
-			<EnumValue name='&apos;EffectMode_HardMix&apos;' value='5'/>
-			<EnumValue name='&apos;EffectMode_Overlay&apos;' value='6'/>
-			<EnumValue name='&apos;EffectMode_Screen&apos;' value='7'/>
-			<EnumValue name='&apos;EffectMode_YUYV422&apos;' value='8'/>
-		</Enum>
 		<Enum name='FileType'>
 			<EnumValue name='&apos;FileType_Bitmap&apos;' value='0'/>
 			<EnumValue name='&apos;FileType_Sound&apos;' value='1'/>
@@ -2171,5 +2195,5 @@
 		<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
 	</Constants>
 	<Version>StepMania v5.0 Preview 3</Version>
-	<Date>2011-08-20</Date>
+	<Date>2011-08-27</Date>
 </Lua>
@@ -1676,6 +1676,9 @@
 	</Function>
 </Class>
 <Class name='CryptManager'>
+	<Function name='GenerateRandomUUID' return='string' arguments=''>
+		Generates a random UUID (version 4).
+	</Function>
 	<Function name='MD5File' return='string' arguments='string sPath'>
 		Returns the MD5 hash for the file at <code>sPath</code>.
 	</Function>
@@ -3456,6 +3459,12 @@
 	</Function>
 </Class>
 <Class name='SongManager'>
+	<Function name='DoesCourseGroupExist' return='bool' arguments='string sGroup'>
+		Returns <code>true</code> if the specified course group exists.
+	</Function>
+	<Function name='DoesSongGroupExist' return='bool' arguments='string sGroup'>
+		Returns <code>true</code> if the specified song group exists.
+	</Function>
 	<Function name='FindCourse' return='Course' arguments='string sCourse'>
 		Returns a Course if one matching <code>sCourse</code> is found.
 	</Function>
@@ -3471,9 +3480,15 @@
 	<Function name='GetCourseColor' return='color' arguments='Course c'>
 		Returns the course color of Course <code>c</code>.
 	</Function>
+	<Function name='GetCourseGroupBannerPath' return='string' arguments='string sGroup'>
+		Returns the path to the specified course group's banner.
+	</Function>
 	<Function name='GetCourseGroupNames' return='{string}' arguments=''>
 		Returns a table containing all of the course group names.
 	</Function>
+	<Function name='GetCoursesInGroup' return='{Course}' arguments='string sGroup'>
+		Returns a table with all of the courses in the specified group.
+	</Function>
 	<Function name='GetExtraStageInfo' return='various' arguments='bool bExtra2, Style s'>
 		Returns the extra stage info (Song, Steps) for the specified Style <code>s</code>. (If <code>bExtra2</code> is true, it will use the second Extra Stage data instead of the first. Again, Lua.xsd sucks)
 	</Function>
@@ -3501,6 +3516,18 @@
 	<Function name='GetNumUnlockedSongs' return='int' arguments=''>
 		Returns the number of unlocked songs.
 	</Function>
+	<Function name='GetPopularCourses' return='{Course}' arguments='CourseType ct'>
+		Returns a table of popular courses for the specified CourseType.
+	</Function>
+	<Function name='GetPopularSongs' return='{Song}' arguments=''>
+		Returns a table of popular songs.
+	</Function>
+	<Function name='GetPreferredSortCourses' return='' arguments='CourseType ct, bool bIncludeAutogen'>
+		Returns a table of courses as they'd appear in preferred sort.
+	</Function>
+	<Function name='GetPreferredSortSongs' return='{Song}' arguments=''>
+		Returns a table of songs as they'd appear in preferred sort.
+	</Function>
 	<Function name='GetRandomCourse' return='Course' arguments=''>
 		Returns a random course.
 	</Function>
@@ -3513,10 +3540,12 @@
 	<Function name='GetSongFromSteps' return='Song' arguments='Steps st'>
 		Returns a Song given a set of Steps <code>st</code>.
 	</Function>
+	<Function name='GetSongGroupBannerPath' return='string' arguments='string sGroup'>
+		Returns the path to the specified song group's banner.
+	</Function>
 	<Function name='GetSongGroupColor' return='color' arguments='string sGroupName'>
 		Returns the song group color of <code>sGroupName</code>.
 	</Function>
-	<!-- sm-ssc additions: -->
 	<Function name='GetSongGroupNames' return='{string}' arguments=''>
 		Returns a table containing all of the song group names.
 	</Function>
@@ -3535,6 +3564,15 @@
 	<Function name='SetPreferredSongs' return='void' arguments='string sListName'>
 		Loads preferred songs from <code>{theme}/Other/SongManager sListName.txt</code>.
 	</Function>
+	<Function name='SongToPreferredSortSectionName' return='string' arguments='Song s'>
+		Returns the preferred sort section name for the specified Song.
+	</Function>
+	<Function name='WasLoadedFromAdditionalCourses' return='bool' arguments='Course c'>
+		Returns <code>true</code> if the specified course was loaded from AdditionalCourses.
+	</Function>
+	<Function name='WasLoadedFromAdditionalSongs' return='bool' arguments='Song s'>
+		Returns <code>true</code> if the specified song was loaded from AdditionalSongs.
+	</Function>
 </Class>
 <Class name='SongPosition'>
 	<Function name='GetCurBPS' return='float' arguments=''>
@@ -3829,12 +3867,21 @@
 	</Function>
 </Class>
 <Class name='ThemeManager'>
+	<Function name='DoesLanguageExist' return='bool' arguments='string langName'>
+		Returns <code>true</code> if the specified language exists in the current theme.
+	</Function>
+	<Function name='DoesThemeExist' return='bool' arguments='string themeName'>
+		Returns <code>true</code> if the specified theme exists.
+	</Function>
 	<Function name='GetCurLanguage' return='string' arguments=''>
 		Returns the current language.
 	</Function>
 	<Function name='GetCurrentThemeDirectory' return='string' arguments=''>
 		Returns the theme's current directory.
 	</Function>
+	<Function name='GetCurThemeName' return='string' arguments=''>
+		Returns the name of the current theme.
+	</Function>
 	<Function name='GetMetric' return='string' arguments='string ClassName, string Element'>
 		Returns the value of <code>Element</code> in <code>Class</code> from metrics.ini.
 	</Function>
@@ -3871,6 +3918,15 @@
 	<Function name='GetThemeDisplayName' return='string' arguments=''>
 		Returns the display name of the current theme.
 	</Function>
+	<Function name='HasMetric' return='bool' arguments='string section, string value'>
+		Returns <code>true</code> if the theme has the specified metric.
+	</Function>
+	<Function name='HasString' return='bool' arguments='string section, string value'>
+		Returns <code>true</code> if the theme has the specified string. 
+	</Function>
+	<Function name='IsThemeSelectable' return='bool' arguments='string theme'>
+		Returns <code>true</code> if the specified theme is selectable.
+	</Function>
 	<Function name='ReloadMetrics' return='void' arguments=''>
 		Reloads the current theme's metrics.
 	</Function>