Merge pull request #2026 from quietly-turning/more-Luadoc-updates-take2

More Luadoc Updates

Docs/Luadoc/Lua.xml

@@ -9,6 +9,8 @@
 		<Function name='AreStagePlayerModsForced'/>
 		<Function name='AreStageSongModsForced'/>
 		<Function name='ArgsIfPlayerJoinedOrNil'/>
+		<Function name='BGFitChoiceExample'/>
+		<Function name='BGFitInputActor'/>
 		<Function name='Basename'/>
 		<Function name='BoostColor'/>
 		<Function name='Brightness'/>
@@ -24,6 +26,11 @@
 		<Function name='ComboPerRow'/>
 		<Function name='ComboTransformCommand'/>
 		<Function name='ComboUnderField'/>
+		<Function name='ConfAspectRatio'/>
+		<Function name='ConfDisplayMode'/>
+		<Function name='ConfDisplayResolution'/>
+		<Function name='ConfFullscreenType'/>
+		<Function name='ConfRefreshRate'/>
 		<Function name='ConnectToServer'/>
 		<Function name='CourseDifficultyToLocalizedString'/>
 		<Function name='CourseTypeToLocalizedString'/>
@@ -42,11 +49,13 @@
 		<Function name='FormatNumberAndSuffix'/>
 		<Function name='FormatPercentScore'/>
 		<Function name='GameCompatibleModes'/>
-		<Function name='GamePrefDefaultFail'/>
+		<Function name='GameOverOrContinue'/>
+		<Function name='GameplayMargins'/>
 		<Function name='GetCodeForGame'/>
 		<Function name='GetCoursesToShowRanking'/>
 		<Function name='GetCustomDifficulty'/>
 		<Function name='GetDefaultOptionLines'/>
+		<Function name='GetDisplayRatesForResolution'/>
 		<Function name='GetEditModeSubScreens'/>
 		<Function name='GetExtraColorThreshold'/>
 		<Function name='GetGamePref'/>
@@ -55,6 +64,7 @@
 		<Function name='GetGamePrefN'/>
 		<Function name='GetGradeFromPercent'/>
 		<Function name='GetLifeDifficulty'/>
+		<Function name='GetOptionsListMapping'/>
 		<Function name='GetPlayerOrMachineProfile'/>
 		<Function name='GetProTiming'/>
 		<Function name='GetRandomSongBackground'/>
@@ -63,6 +73,7 @@
 		<Function name='GetScreenAspectRatio'/>
 		<Function name='GetServerName'/>
 		<Function name='GetSongBackground'/>
+		<Function name='GetSpeedModeAndValueFromPoptions'/>
 		<Function name='GetTapPosition'/>
 		<Function name='GetThemeAspectRatio'/>
 		<Function name='GetThemePref'/>
@@ -87,6 +98,7 @@
 		<Function name='InitGamePrefs'/>
 		<Function name='InitUserPrefs'/>
 		<Function name='IsArcade'/>
+		<Function name='IsCourse'/>
 		<Function name='IsFreePlay'/>
 		<Function name='IsGame'/>
 		<Function name='IsHome'/>
@@ -118,12 +130,14 @@
 		<Function name='OldStyleStringToDifficulty'/>
 		<Function name='OptionRowProTiming'/>
 		<Function name='OptionRowScreenFilter'/>
+		<Function name='OptionsNavigationMode'/>
 		<Function name='OptionsRandomJukebox'/>
 		<Function name='OptionsRowTest'/>
 		<Function name='OptionsWeight'/>
 		<Function name='PeakComboAwardToLocalizedString'/>
 		<Function name='PlayModeToLocalizedString'/>
 		<Function name='PlayerColor'/>
+		<Function name='PlayerDarkColor'/>
 		<Function name='PlayerNumberToLocalizedString'/>
 		<Function name='PlayerNumberToString'/>
 		<Function name='PlayerScoreColor'/>
@@ -137,7 +151,6 @@
 		<Function name='ReadGamePrefFromFile'/>
 		<Function name='ReadPrefFromFile'/>
 		<Function name='ReportStyle'/>
-		<Function name='ResetDefaultFail'/>
 		<Function name='ResolveRelativePath'/>
 		<Function name='RoutineSkinP1'/>
 		<Function name='RoutineSkinP2'/>
@@ -146,7 +159,10 @@
 		<Function name='SaveProfileCustom'/>
 		<Function name='SaveScreenshot'/>
 		<Function name='ScoreKeeperClass'/>
+		<Function name='ScreenColor'/>
 		<Function name='ScreenMetric'/>
+		<Function name='ScreenSelectStyleChoices'/>
+		<Function name='ScreenSelectStylePositions'/>
 		<Function name='ScreenString'/>
 		<Function name='Second'/>
 		<Function name='SecondsToHHMMSS'/>
@@ -158,18 +174,13 @@
 		<Function name='SelectMusicOrCourse'/>
 		<Function name='SelectProfileKeys'/>
 		<Function name='Serialize'/>
-		<Function name='SetFail'/>
 		<Function name='SetGamePref'/>
 		<Function name='SetThemePref'/>
 		<Function name='SetUserPref'/>
 		<Function name='ShowHoldJudgments'/>
 		<Function name='ShowStandardDecoration'/>
-		<Function name='SongMeterDisplayCommand'/>
-		<Function name='SongMeterDisplayX'/>
-		<Function name='SongMeterDisplayY'/>
-		<Function name='SongPrefFail'/>
 		<Function name='SortOrderToLocalizedString'/>
-		<Function name='SpeedModIncMultiple'/>
+		<Function name='SpeedModIncLarge'/>
 		<Function name='SpeedModIncSize'/>
 		<Function name='SpeedMods'/>
 		<Function name='StageAwardToLocalizedString'/>
@@ -190,9 +201,9 @@
 		<Function name='ToEnumShortString'/>
 		<Function name='Trace'/>
 		<Function name='TrailToCustomDifficulty'/>
+		<Function name='TwoPartSelection'/>
 		<Function name='URLEncode'/>
 		<Function name='UnlockRewardTypeToLocalizedString'/>
-		<Function name='update_centering'/>
 		<Function name='Var'/>
 		<Function name='VersionDate'/>
 		<Function name='VersionTime'/>
@@ -203,25 +214,33 @@
 		<Function name='WriteGamePrefToFile'/>
 		<Function name='WritePrefToFile'/>
 		<Function name='Year'/>
+		<Function name='alias_one'/>
+		<Function name='alias_set'/>
 		<Function name='approach'/>
 		<Function name='assert'/>
+		<Function name='check_stop_course_early'/>
 		<Function name='clamp'/>
 		<Function name='class'/>
 		<Function name='collectgarbage'/>
 		<Function name='color'/>
 		<Function name='commify'/>
+		<Function name='convert_text_to_indented_lines'/>
 		<Function name='convert_xml_bgs'/>
+		<Function name='create_bezier'/>
+		<Function name='create_spline'/>
 		<Function name='dofile'/>
 		<Function name='error'/>
 		<Function name='fapproach'/>
 		<Function name='find_missing_strings_in_theme_translations'/>
+		<Function name='force_to_range'/>
+		<Function name='foreach_by_sorted_keys'/>
 		<Function name='foreach_ordered'/>
 		<Function name='gcinfo'/>
+		<Function name='get_music_file_length'/>
+		<Function name='get_sound_driver_list'/>
 		<Function name='getenv'/>
 		<Function name='getfenv'/>
 		<Function name='getmetatable'/>
-		<Function name='get_music_file_length'/>
-		<Function name='get_sound_driver_list'/>
 		<Function name='ipairs'/>
 		<Function name='ivalues'/>
 		<Function name='join'/>
@@ -230,23 +249,29 @@
 		<Function name='load'/>
 		<Function name='loadfile'/>
 		<Function name='loadstring'/>
+		<Function name='make_camel_aliases'/>
 		<Function name='mbstrlen'/>
 		<Function name='module'/>
 		<Function name='multiapproach'/>
+		<Function name='new_numpad_entry'/>
 		<Function name='newproxy'/>
 		<Function name='next'/>
+		<Function name='oitg_zoom_mode_actor'/>
 		<Function name='pairs'/>
+		<Function name='pause_controller_actor'/>
 		<Function name='pcall'/>
 		<Function name='pname'/>
 		<Function name='print'/>
 		<Function name='rawequal'/>
 		<Function name='rawget'/>
 		<Function name='rawset'/>
+		<Function name='rec_count_children'/>
 		<Function name='rec_print_children'/>
 		<Function name='rec_print_table'/>
 		<Function name='require'/>
 		<Function name='round'/>
 		<Function name='scale'/>
+		<Function name='scale_to_fit'/>
 		<Function name='select'/>
 		<Function name='setenv'/>
 		<Function name='setfenv'/>
@@ -254,12 +279,18 @@
 		<Function name='split'/>
 		<Function name='tableshuffle'/>
 		<Function name='tableslice'/>
+		<Function name='thified_curstage_index'/>
 		<Function name='tobool'/>
 		<Function name='tonumber'/>
 		<Function name='tostring'/>
 		<Function name='type'/>
 		<Function name='unpack'/>
+		<Function name='update_centering'/>
+		<Function name='width_clip_limit_text'/>
+		<Function name='width_clip_text'/>
+		<Function name='width_limit_text'/>
 		<Function name='wrap'/>
+		<Function name='wrapped_index'/>
 		<Function name='xpcall'/>
 	</GlobalFunctions>
 	<Classes>
@@ -752,6 +783,8 @@
 			<Function name='get_dirty'/>
 			<Function name='destroy'/>
 		</Class>
+		<Class base='BitmapText' name='DeviceList'>
+		</Class>
 		<Class name='DisplayMode'>
 			<Function name='GetWidth'/>
 			<Function name='GetHeight'/>
@@ -1013,6 +1046,8 @@
 			<Function name='GetMouseX'/>
 			<Function name='GetMouseY'/>
 		</Class>
+		<Class base='BitmapText' name='InputList'>
+		</Class>
 		<Class base='ActorFrame' name='LifeMeter'>
 			<Function name='GetLife'/>
 			<Function name='IsFailing'/>
@@ -1503,6 +1538,8 @@
 			<Function name='SaveProfile'/>
 			<Function name='SetStatsPrefix'/>
 		</Class>
+		<Class base='Sprite' name='Quad'>
+		</Class>
 		<Class name='RadarValues'>
 			<Function name='GetValue'/>
 		</Class>
@@ -1839,6 +1876,8 @@
 			<Function name='WasLoadedFromAdditionalCourses'/>
 			<Function name='WasLoadedFromAdditionalSongs'/>
 		</Class>
+		<Class base='MeterDisplay' name='SongMeterDisplay'>
+		</Class>
 		<Class name='SongOptions'>
 			<Function name='AssistClap'/>
 			<Function name='AssistMetronome'/>
@@ -2330,6 +2369,18 @@
 			<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'/>
+			<EnumValue name='&apos;EffectMode_DistanceField&apos;' value='9'/>
+		</Enum>
 		<Enum name='FailType'>
 			<EnumValue name='&apos;FailType_Immediate&apos;' value='0'/>
 			<EnumValue name='&apos;FailType_ImmediateContinue&apos;' value='1'/>
@@ -2930,6 +2981,6 @@
 		<Constant name='right' value='&apos;HorizAlign_Right&apos;'/>
 		<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
 	</Constants>
-	<Version>StepMania5.1-git-d03ec2658f</Version>
-	<Date>2020-05-11</Date>
+	<Version>StepMania5.1-git-89229ed915</Version>
+	<Date>2020-06-25</Date>
 </Lua>

Docs/Luadoc/Lua.xsd

@@ -89,6 +89,7 @@
 			<xs:element name="Link" type="Link" />
 			<!-- HTML elements we want to let through. -->
 			<xs:element name="code" />
+			<xs:element name="pre" />
 			<xs:element name="br" />
 			<xs:element name="del" />
 		</xs:choice>

Docs/Luadoc/Lua.xsl

@@ -106,7 +106,7 @@
 				font-family: monospace;
 			}
 			.descriptionText {
-				text-indent: 2em;
+				padding-left: 2em;
 				margin-top: 0;
 				margin-bottom: 0;
 			}
@@ -169,7 +169,7 @@
 				var listid = 'list_' + id;
 				var img = document.getElementById( imgid );
 				var list = document.getElementById( listid );
-			
+
 				img.setAttribute( 'src', 'open.gif' );
 				list.style.display = 'block';
 			}
@@ -184,7 +184,7 @@
 				var listid = 'list_' + id;
 				var img = document.getElementById( imgid );
 				var list = document.getElementById( listid );
-				
+
 				if( img.getAttribute('src') == 'closed.gif' )
 				{
 					img.setAttribute( 'src', 'open.gif' );
@@ -200,7 +200,7 @@
 		<link rel="icon" type="image/vnd.microsoft.icon" href="./favicon.ico"/>
 		</head>
 		<body>
-			<xsl:apply-templates />
+			<xsl:apply-templates />\
 		</body>
 	</html>
 </xsl:template>
@@ -648,7 +648,7 @@
 				<xsl:sort select="@name" />
 				<tr class="code">
 					<td>
-					
+
 					<xsl:value-of select="@name" />
 					</td>
 					<td><xsl:value-of select="@value" /></td>
@@ -670,6 +670,14 @@
 		</xsl:apply-templates>
 	</code>
 </xsl:template>
+<xsl:template match="sm:pre">
+	<xsl:param name="curclass" />
+	<pre>
+		<xsl:apply-templates>
+			<xsl:with-param name="curclass" select="$curclass" />
+		</xsl:apply-templates>
+	</pre>
+</xsl:template>
 <xsl:template match="sm:br"><br /></xsl:template>
 <xsl:template match="sm:del">
 	<del>