update luadocs

This commit is contained in:
AJ Kelly
2012-02-20 17:56:38 -06:00
parent f280c7165c
commit 9cf9e3449c
3 changed files with 41 additions and 7 deletions
+19 -3
View File
@@ -10,7 +10,6 @@
<Function name='BoostColor'/>
<Function name='Brightness'/>
<Function name='Center1Player'/>
<Function name='ClearEnterMappedKeys'/>
<Function name='CloseConnection'/>
<Function name='ColorDarkTone'/>
<Function name='ColorLightTone'/>
@@ -834,11 +833,14 @@
<Function name='GetDate'/>
<Function name='GetGrade'/>
<Function name='GetHoldNoteScore'/>
<Function name='GetMaxCombo'/>
<Function name='GetModifiers'/>
<Function name='GetName'/>
<Function name='GetPeakComboAward'/>
<Function name='GetPercentDP'/>
<Function name='GetRadarValues'/>
<Function name='GetScore'/>
<Function name='GetStageAward'/>
<Function name='GetSurvivalSeconds'/>
<Function name='GetTapNoteScore'/>
<Function name='IsFillInMarker'/>
@@ -1248,6 +1250,7 @@
<Function name='GetDescriptions'/>
</Class>
<Class name='RageSound'>
<Function name='SetParam'/>
<Function name='SetProperty'/>
<Function name='pitch'/>
<Function name='speed'/>
@@ -1382,6 +1385,7 @@
<Function name='GetMusicPath'/>
<Function name='GetOneSteps'/>
<Function name='GetOrigin'/>
<Function name='GetPreviewVidPath'/>
<Function name='GetSampleLength'/>
<Function name='GetSampleStart'/>
<Function name='GetSongDir'/>
@@ -1404,6 +1408,7 @@
<Function name='HasJacket'/>
<Function name='HasLyrics'/>
<Function name='HasMusic'/>
<Function name='HasPreviewVid'/>
<Function name='HasSignificantBPMChangesOrStops'/>
<Function name='HasStepsType'/>
<Function name='HasStepsTypeAndDifficulty'/>
@@ -2281,6 +2286,17 @@
<EnumValue name='&apos;VertAlign_Middle&apos;' value='1'/>
<EnumValue name='&apos;VertAlign_Bottom&apos;' value='2'/>
</Enum>
<Enum name='WheelItemDataType'>
<EnumValue name='&apos;WheelItemDataType_Generic&apos;' value='0'/>
<EnumValue name='&apos;WheelItemDataType_Section&apos;' value='1'/>
<EnumValue name='&apos;WheelItemDataType_Song&apos;' value='2'/>
<EnumValue name='&apos;WheelItemDataType_Roulette&apos;' value='3'/>
<EnumValue name='&apos;WheelItemDataType_Random&apos;' value='4'/>
<EnumValue name='&apos;WheelItemDataType_Portal&apos;' value='5'/>
<EnumValue name='&apos;WheelItemDataType_Course&apos;' value='6'/>
<EnumValue name='&apos;WheelItemDataType_Sort&apos;' value='7'/>
<EnumValue name='&apos;WheelItemDataType_Custom&apos;' value='8'/>
</Enum>
<Enum name='ZTestMode'>
<EnumValue name='&apos;ZTestMode_Off&apos;' value='0'/>
<EnumValue name='&apos;ZTestMode_WriteOnPass&apos;' value='1'/>
@@ -2310,6 +2326,6 @@
<Constant name='right' value='&apos;HorizAlign_Right&apos;'/>
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>StepMania v5.0 alpha 1</Version>
<Date>2012-01-12</Date>
<Version>StepMania v5.0 alpha 1a</Version>
<Date>2012-02-19</Date>
</Lua>
+1 -1
View File
@@ -233,7 +233,7 @@
<div>
<fieldset>
<legend>Function Colors</legend>
<div class="descriptionCell">Available in sm-ssc and StepMania 5</div>
<div class="descriptionCell">Available in StepMania 5</div>
<div class="renamed">Renamed or changed from StepMania 4 alphas</div>
<div class="fallbackTheme">Defined in the _fallback theme</div>
<div class="defaultTheme">Defined in the default theme</div>
+21 -3
View File
@@ -2409,12 +2409,18 @@ save yourself some time, copy this for undocumented things:
<Function name='GetHoldNoteScore' return='int' arguments='HoldNoteScore hns'>
Return the number of HoldNoteScores that match <code>hns</code>.
</Function>
<Function name='GetMaxCombo' return='int' arguments=''>
Returns the Max Combo of this high score.
</Function>
<Function name='GetModifiers' return='string' arguments=''>
Returns the modifiers used for this HighScore.
</Function>
<Function name='GetName' return='string' arguments=''>
Returns the name associated with the high score.
</Function>
<Function name='GetPeakComboAward' return='PeakComboAward' arguments=''>
Returns the Peak Combo Award for this high score.
</Function>
<Function name='GetPercentDP' return='float' arguments=''>
Returns the percentage of dance points associated with the high score.
</Function>
@@ -2424,6 +2430,9 @@ save yourself some time, copy this for undocumented things:
<Function name='GetScore' return='int' arguments=''>
Returns the score associated with the high score.
</Function>
<Function name='GetStageAward' return='StageAward' arguments=''>
Retrns the Stage Award for this high score.
</Function>
<Function name='GetSurvivalSeconds' return='float' arguments=''>
Returns the number of seconds survived associated with the high score.
</Function>
@@ -3561,8 +3570,11 @@ save yourself some time, copy this for undocumented things:
<Description>
See <Link class='ActorSound' /> for loading a sound.
</Description>
<Function name='SetParam' return='void' arguments='string sProperty, float fVal'>
Actually sets the value of <code>sProperty</code> to <code>fVal</code>. The supported properties depend on how the associated <Link class='ActorSound' /> was loaded.
</Function>
<Function name='SetProperty' return='void' arguments='string sProperty, float fVal'>
Sets the value of <code>sProperty</code> to <code>fVal</code>. The supported properties depend on how the associated <Link class='ActorSound' /> was loaded.
Attempts (and typically fails) to set the value of <code>sProperty</code> to <code>fVal</code>. The supported properties depend on how the associated <Link class='ActorSound' /> was loaded.
</Function>
<Function name='pitch' return='void' arguments='float fPitch'>
Sets the pitch to <code>fPitch</code>. The associated <Link class='ActorSound' /> have <code>SupportsRateChanging = true</code> on load.
@@ -3868,6 +3880,9 @@ save yourself some time, copy this for undocumented things:
<Function name='GetOrigin' return='string' arguments=''>
Gets the Song's origin.
</Function>
<Function name='GetPreviewVidPath' return='string' arguments=''>
Returns the path to the Song's preview video, if it exists. (Returns <code>nil</code> otherwise.)
</Function>
<Function name='GetSampleLength' return='float' arguments=''>
Gets the length of a song's sample time in seconds.
</Function>
@@ -3937,6 +3952,9 @@ save yourself some time, copy this for undocumented things:
<Function name='HasMusic' return='bool' arguments=''>
Returns <code>true</code> if the song has music.
</Function>
<Function name='HasPreviewVid' return='bool' arguments=''>
Returns <code>true</code> if the song has a preview video.
</Function>
<Function name='HasSignificantBPMChangesOrStops' return='bool' arguments=''>
Returns <code>true</code> if the song has significant BPM changes or stops.
</Function>
@@ -4705,8 +4723,8 @@ save yourself some time, copy this for undocumented things:
<Function name='GetNumItems' return='int' arguments=''>
Returns the total number of items in the wheel.
</Function>
<Function name='GetSelectedType' return='int' arguments=''>
<Function name='GetSelectedType' return='WheelItemDataType' arguments=''>
Returns the WheelItemDataType of the selected item.
</Function>
<Function name='GetWheelItem' return='WheelItemBase' arguments='int iIndex'>
Returns the WheelItem at index <code>iIndex</code>.