actions/itgmania212121
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update luadoc

Browse Source
This commit is contained in:
AJ Kelly
2011-02-10 21:38:30 -06:00
parent a3eb18931c
commit 46a84acc5b
2 changed files with 48 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+22 -10
View File
@@ -10,6 +10,7 @@
<Function name='Brightness'/> <Function name='Brightness'/>
<Function name='Center1Player'/> <Function name='Center1Player'/>
<Function name='CheckpointsTapsSeparateJudgment'/> <Function name='CheckpointsTapsSeparateJudgment'/>
<Function name='CloseConnection'/>
<Function name='Color'/> <Function name='Color'/>
<Function name='ColorDarkTone'/> <Function name='ColorDarkTone'/>
<Function name='ColorLightTone'/> <Function name='ColorLightTone'/>
@@ -47,6 +48,7 @@
<Function name='GetCustomDifficulty'/> <Function name='GetCustomDifficulty'/>
<Function name='GetDefaultArrowSpacing'/> <Function name='GetDefaultArrowSpacing'/>
<Function name='GetDefaultOptionLines'/> <Function name='GetDefaultOptionLines'/>
<Function name='GetDirectRadar'/>
<Function name='GetEditModeSubScreens'/> <Function name='GetEditModeSubScreens'/>
<Function name='GetExtraColorThreshold'/> <Function name='GetExtraColorThreshold'/>
<Function name='GetGamePref'/> <Function name='GetGamePref'/>
@@ -67,6 +69,7 @@
<Function name='GetThemeAspectRatio'/> <Function name='GetThemeAspectRatio'/>
<Function name='GetThemePref'/> <Function name='GetThemePref'/>
<Function name='GetTimingDifficulty'/> <Function name='GetTimingDifficulty'/>
<Function name='GetTotalItems'/>
<Function name='GetUnlockEntryIndexToCelebrate'/> <Function name='GetUnlockEntryIndexToCelebrate'/>
<Function name='GetUserPref'/> <Function name='GetUserPref'/>
<Function name='GetUserPrefB'/> <Function name='GetUserPrefB'/>
@@ -94,6 +97,7 @@
<Function name='IsRoutine'/> <Function name='IsRoutine'/>
<Function name='IsSMOnlineLoggedIn'/> <Function name='IsSMOnlineLoggedIn'/>
<Function name='IsUsingWideScreen'/> <Function name='IsUsingWideScreen'/>
<Function name='IsW1Allowed'/>
<Function name='JudgmentLineToColor'/> <Function name='JudgmentLineToColor'/>
<Function name='JudgmentLineToLocalizedString'/> <Function name='JudgmentLineToLocalizedString'/>
<Function name='JudgmentLineToStrokeColor'/> <Function name='JudgmentLineToStrokeColor'/>
@@ -558,6 +562,7 @@
<Function name='GetCharacterDir'/> <Function name='GetCharacterDir'/>
<Function name='GetCharacterID'/> <Function name='GetCharacterID'/>
<Function name='GetDanceAnimationPath'/> <Function name='GetDanceAnimationPath'/>
<Function name='GetDisplayName'/>
<Function name='GetIconPath'/> <Function name='GetIconPath'/>
<Function name='GetModelPath'/> <Function name='GetModelPath'/>
<Function name='GetRestAnimationPath'/> <Function name='GetRestAnimationPath'/>
@@ -989,6 +994,7 @@
<Function name='Open'/> <Function name='Open'/>
<Function name='PutLine'/> <Function name='PutLine'/>
<Function name='Read'/> <Function name='Read'/>
<Function name='ReadBytes'/>
<Function name='Seek'/> <Function name='Seek'/>
<Function name='Tell'/> <Function name='Tell'/>
<Function name='Write'/> <Function name='Write'/>
@@ -1047,6 +1053,7 @@
<Class name='ScreenManager'> <Class name='ScreenManager'>
<Function name='AddNewScreenToTop'/> <Function name='AddNewScreenToTop'/>
<Function name='GetTopScreen'/> <Function name='GetTopScreen'/>
<Function name='ReloadOverlayScreens'/>
<Function name='ScreenClassExists'/> <Function name='ScreenClassExists'/>
<Function name='ScreenIsPrepped'/> <Function name='ScreenIsPrepped'/>
<Function name='SetNewScreen'/> <Function name='SetNewScreen'/>
@@ -1094,6 +1101,9 @@
<Function name='GetProfileIndex'/> <Function name='GetProfileIndex'/>
<Function name='SetProfileIndex'/> <Function name='SetProfileIndex'/>
</Class> </Class>
<Class base='ScreenWithMenuElements' name='ScreenTextEntry'>
<Function name='Load'/>
</Class>
<Class base='Screen' name='ScreenWithMenuElements'> <Class base='Screen' name='ScreenWithMenuElements'>
<Function name='Cancel'/> <Function name='Cancel'/>
</Class> </Class>
@@ -1136,6 +1146,7 @@
<Function name='HasStepsType'/> <Function name='HasStepsType'/>
<Function name='HasStepsTypeAndDifficulty'/> <Function name='HasStepsTypeAndDifficulty'/>
<Function name='IsDisplayBpmConstant'/> <Function name='IsDisplayBpmConstant'/>
<Function name='IsDisplayBpmRandom'/>
<Function name='IsDisplayBpmSecret'/> <Function name='IsDisplayBpmSecret'/>
<Function name='IsEasy'/> <Function name='IsEasy'/>
<Function name='IsEnabled'/> <Function name='IsEnabled'/>
@@ -1848,10 +1859,11 @@
<EnumValue name='&apos;StepsType_Techno_Single8&apos;' value='25'/> <EnumValue name='&apos;StepsType_Techno_Single8&apos;' value='25'/>
<EnumValue name='&apos;StepsType_Techno_Double4&apos;' value='26'/> <EnumValue name='&apos;StepsType_Techno_Double4&apos;' value='26'/>
<EnumValue name='&apos;StepsType_Techno_Double5&apos;' value='27'/> <EnumValue name='&apos;StepsType_Techno_Double5&apos;' value='27'/>
<EnumValue name='&apos;StepsType_Pnm_Five&apos;' value='28'/> <EnumValue name='&apos;StepsType_Techno_Double8&apos;' value='28'/>
<EnumValue name='&apos;StepsType_Pnm_Nine&apos;' value='29'/> <EnumValue name='&apos;StepsType_Pnm_Five&apos;' value='29'/>
<EnumValue name='&apos;StepsType_Guitar_Five&apos;' value='30'/> <EnumValue name='&apos;StepsType_Pnm_Nine&apos;' value='30'/>
<EnumValue name='&apos;StepsType_Lights_Cabinet&apos;' value='31'/> <EnumValue name='&apos;StepsType_Guitar_Five&apos;' value='31'/>
<EnumValue name='&apos;StepsType_Lights_Cabinet&apos;' value='32'/>
</Enum> </Enum>
<Enum name='StyleType'> <Enum name='StyleType'>
<EnumValue name='&apos;StyleType_OnePlayerOneSide&apos;' value='0'/> <EnumValue name='&apos;StyleType_OnePlayerOneSide&apos;' value='0'/>
@@ -1920,16 +1932,16 @@
</Enum> </Enum>
</Enums> </Enums>
<Constants> <Constants>
<Constant name='ASPECT_SCALE_FACTOR' value='854'/> <Constant name='ASPECT_SCALE_FACTOR' value='640'/>
<Constant name='NUM_PLAYERS' value='2'/> <Constant name='NUM_PLAYERS' value='2'/>
<Constant name='SCREEN_BOTTOM' value='480'/> <Constant name='SCREEN_BOTTOM' value='480'/>
<Constant name='SCREEN_CENTER_X' value='427'/> <Constant name='SCREEN_CENTER_X' value='320'/>
<Constant name='SCREEN_CENTER_Y' value='240'/> <Constant name='SCREEN_CENTER_Y' value='240'/>
<Constant name='SCREEN_HEIGHT' value='480'/> <Constant name='SCREEN_HEIGHT' value='480'/>
<Constant name='SCREEN_LEFT' value='0'/> <Constant name='SCREEN_LEFT' value='0'/>
<Constant name='SCREEN_RIGHT' value='854'/> <Constant name='SCREEN_RIGHT' value='640'/>
<Constant name='SCREEN_TOP' value='0'/> <Constant name='SCREEN_TOP' value='0'/>
<Constant name='SCREEN_WIDTH' value='854'/> <Constant name='SCREEN_WIDTH' value='640'/>
<Constant name='PLAYER_1' value='&apos;PlayerNumber_P1&apos;'/> <Constant name='PLAYER_1' value='&apos;PlayerNumber_P1&apos;'/>
<Constant name='PLAYER_2' value='&apos;PlayerNumber_P2&apos;'/> <Constant name='PLAYER_2' value='&apos;PlayerNumber_P2&apos;'/>
<Constant name='_VERSION' value='&apos;Lua 5.1&apos;'/> <Constant name='_VERSION' value='&apos;Lua 5.1&apos;'/>
@@ -1941,6 +1953,6 @@
<Constant name='sGame' value='&apos;dance&apos;'/> <Constant name='sGame' value='&apos;dance&apos;'/>
<Constant name='top' value='&apos;VertAlign_Top&apos;'/> <Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants> </Constants>
<Version>sm-ssc v1.2</Version> <Version>sm-ssc v1.2.1</Version>
<Date>2011-01-08</Date> <Date>2011-02-10</Date>
</Lua> </Lua>
Docs/Luadoc/LuaDocumentation.xml
+26 -4
View File
@@ -20,7 +20,6 @@
<Link class='ENUM' function='CoinMode' /> -> CoinMode <Link class='ENUM' function='CoinMode' /> -> CoinMode
--> -->
<Documentation xmlns='http://www.stepmania.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.stepmania.com Lua.xsd'> <Documentation xmlns='http://www.stepmania.com' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.stepmania.com Lua.xsd'>
<!-- Global functions --> <!-- Global functions -->
<GlobalFunctions> <GlobalFunctions>
@@ -48,6 +47,9 @@
<Function name='clamp' return='float' arguments='float fValue, float fLow, float fHigh'> <Function name='clamp' return='float' arguments='float fValue, float fLow, float fHigh'>
CLAMP is an all-female Japanese mangaka group that formed in the mid 1980s. Erm, I mean... Clamps <code>fValue</code> between <code>fLow</code> and <code>fHigh</code>. CLAMP is an all-female Japanese mangaka group that formed in the mid 1980s. Erm, I mean... Clamps <code>fValue</code> between <code>fLow</code> and <code>fHigh</code>.
</Function> </Function>
<Function name='CloseConnection' sm-ssc='true' return='void' arguments=''>
Closes any connection to an online server.
</Function>
<Function name='collectgarbage' return='void' arguments='string opt, float arg'> <Function name='collectgarbage' return='void' arguments='string opt, float arg'>
A generic interface to Lua's garbage collector. Performs different functions based on the value of <code>opt</code>. A generic interface to Lua's garbage collector. Performs different functions based on the value of <code>opt</code>.
</Function> </Function>
@@ -618,7 +620,7 @@
<Function name='effectperiod' return='void' arguments='float fTime'> <Function name='effectperiod' return='void' arguments='float fTime'>
Set the Actor's effect period to <code>fTime</code>. Set the Actor's effect period to <code>fTime</code>.
</Function> </Function>
<Function name='effecttiming' return='void' arguments='float fRampUp, float fHoldAtHalf, float fRampDown, float fHoldAtZero'> <Function name='effecttiming' return='void' arguments='float fRampUp, float fAtHalf, float fRampDown, float fAtZero'>
Set the Actor's effect timing. Set the Actor's effect timing.
</Function> </Function>
<Function name='fadebottom' return='void' arguments='float percent'> <Function name='fadebottom' return='void' arguments='float percent'>
@@ -1253,6 +1255,9 @@
<Function name='GetDanceAnimationPath' sm-ssc='true' return='string' arguments=''> <Function name='GetDanceAnimationPath' sm-ssc='true' return='string' arguments=''>
Returns the path of the dancing animation of this character. Returns the path of the dancing animation of this character.
</Function> </Function>
<Function name='GetDisplayName' sm-ssc='true' return='string' arguments=''>
Returns the character's display name.
</Function>
<Function name='GetIconPath' return='string' arguments=''> <Function name='GetIconPath' return='string' arguments=''>
Returns the path to the character's icon. Returns the path to the character's icon.
</Function> </Function>
@@ -2413,6 +2418,9 @@
<Function name='Read' return='string' arguments=''> <Function name='Read' return='string' arguments=''>
Returns a string containing the entire contents of the file. Returns a string containing the entire contents of the file.
</Function> </Function>
<Function name='ReadBytes' sm-ssc='true' return='string' arguments='int length'>
Returns <code>length</code> bytes from the RageFile's current position.
</Function>
<Function name='Seek' return='int' arguments=''> <Function name='Seek' return='int' arguments=''>
Seeks to a position in the file and returns the new position. Seeks to a position in the file and returns the new position.
</Function> </Function>
@@ -2543,6 +2551,9 @@
<Function name='GetTopScreen' return='Screen' arguments=''> <Function name='GetTopScreen' return='Screen' arguments=''>
Gets the screen at the top of the screen stack. Gets the screen at the top of the screen stack.
</Function> </Function>
<Function name='ReloadOverlayScreens' sm-ssc='true' return='void' arguments=''>
Reloads any loaded overlay screens.
</Function>
<Function name='ScreenClassExists' return='bool' arguments='string s'> <Function name='ScreenClassExists' return='bool' arguments='string s'>
Returns <code>true</code> if screen class <code>s</code> exists. Returns <code>true</code> if screen class <code>s</code> exists.
</Function> </Function>
@@ -2649,6 +2660,14 @@
Sets the profile index of Player <code>pn</code> to <code>iProfileIndex</code>. Sets the profile index of Player <code>pn</code> to <code>iProfileIndex</code>.
</Function> </Function>
</Class> </Class>
<Class name='ScreenTextEntry'>
<Description>
See the Changelog for details on TextEntrySetting's format.
</Description>
<Function name='Load' sm-ssc='true' return='void' arguments='TextEntrySettings args'>
Sets up a ScreenTextEntry's values.
</Function>
</Class>
<Class name='ScreenWithMenuElements'> <Class name='ScreenWithMenuElements'>
<Function name='Cancel' return='void' arguments=''> <Function name='Cancel' return='void' arguments=''>
Tells the screen to go to the previous screen. Tells the screen to go to the previous screen.
@@ -2748,8 +2767,8 @@
<Function name='HasCDTitle' sm-ssc='true' return='bool' arguments=''> <Function name='HasCDTitle' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song has a CDTitle. Returns <code>true</code> if the song has a CDTitle.
</Function> </Function>
<Function name='HasEdits' sm-ssc='true' return='bool' arguments='StepsType st'> <Function name='HasEdits' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song has edits for the specified StepsType. Returns <code>true</code> if the song has edits.
</Function> </Function>
<Function name='HasLyrics' sm-ssc='true' return='bool' arguments=''> <Function name='HasLyrics' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song has lyrics. Returns <code>true</code> if the song has lyrics.
@@ -2766,6 +2785,9 @@
<Function name='IsDisplayBpmConstant' sm-ssc='true' return='bool' arguments=''> <Function name='IsDisplayBpmConstant' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song's DisplayBPM is constant. Returns <code>true</code> if the song's DisplayBPM is constant.
</Function> </Function>
<Function name='IsDisplayBpmRandom' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song's DisplayBPM is random.
</Function>
<Function name='IsDisplayBpmSecret' sm-ssc='true' return='bool' arguments=''> <Function name='IsDisplayBpmSecret' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the song's DisplayBPM is secret. Returns <code>true</code> if the song's DisplayBPM is secret.
</Function> </Function>