update luadocs

This commit is contained in:
AJ Kelly
2010-04-26 11:19:01 -05:00
parent 0447edcd99
commit b488d85302
2 changed files with 30 additions and 1 deletions
+8 -1
View File
@@ -539,7 +539,14 @@
<Function name='SetFromGameState'/>
</Class>
<Class name='CourseEntry'>
<Function name='GetGainLives'/>
<Function name='GetGainSeconds'/>
<Function name='GetNormalModifiers'/>
<Function name='GetNumModChanges'/>
<Function name='GetSong'/>
<Function name='GetTextDescription'/>
<Function name='IsFixedSong'/>
<Function name='IsSecret'/>
</Class>
<Class name='CryptManager'>
<Function name='MD5File'/>
@@ -1819,5 +1826,5 @@
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>sm-ssc v1.0 beta 2</Version>
<Date>2010-04-24</Date>
<Date>2010-04-26</Date>
</Lua>
+22
View File
@@ -1098,6 +1098,28 @@
<Function name='GetSong' return='Song' arguments=''>
Returns the Song that this CourseEntry corresponds to.
</Function>
<!-- sm-ssc additions -->
<Function name='GetGainLives' sm-ssc='true' return='int' arguments=''>
Returns the number of lives gained after completing the song.
</Function>
<Function name='GetGainSeconds' sm-ssc='true' return='float' arguments=''>
Returns the number of seconds gained after completing the song.
</Function>
<Function name='GetNormalModifiers' sm-ssc='true' return='string' arguments=''>
Returns any stage (non-timed) modifiers.
</Function>
<Function name='GetNumModChanges' sm-ssc='true' return='int' arguments=''>
Returns the number of modifier changes in this CourseEntry.
</Function>
<Function name='GetTextDescription' sm-ssc='true' return='string' arguments=''>
Returns a comma-delimited string representing various facts about the CourseEntry.
</Function>
<Function name='IsFixedSong' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if this CourseEntry is a fixed song.
</Function>
<Function name='IsSecret' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if this CourseEntry is secret.
</Function>
</Class>
<Class name='CryptManager'>
<Function name='MD5File' sm-ssc='true' return='string' arguments='string sPath'>