update lua documentation

This commit is contained in:
AJ Kelly
2011-11-26 05:37:14 -06:00
parent 16a7d5bab7
commit e78f25d6d3
2 changed files with 24 additions and 6 deletions
+7 -6
View File
@@ -95,8 +95,6 @@
<Function name='IsNetSMOnline'/> <Function name='IsNetSMOnline'/>
<Function name='IsRoutine'/> <Function name='IsRoutine'/>
<Function name='IsSMOnlineLoggedIn'/> <Function name='IsSMOnlineLoggedIn'/>
<Function name='IsUsingTwoScreens'/>
<Function name='IsUsingWideScreen'/>
<Function name='IsW1Allowed'/> <Function name='IsW1Allowed'/>
<Function name='JudgmentLineToColor'/> <Function name='JudgmentLineToColor'/>
<Function name='JudgmentLineToLocalizedString'/> <Function name='JudgmentLineToLocalizedString'/>
@@ -945,8 +943,8 @@
<Class name='PlayerOptions'> <Class name='PlayerOptions'>
<Function name='GetAlternate'/> <Function name='GetAlternate'/>
<Function name='GetAttackMines'/> <Function name='GetAttackMines'/>
<Function name='GetBackwards'/>
<Function name='GetBMRize'/> <Function name='GetBMRize'/>
<Function name='GetBackwards'/>
<Function name='GetBeat'/> <Function name='GetBeat'/>
<Function name='GetBig'/> <Function name='GetBig'/>
<Function name='GetBlind'/> <Function name='GetBlind'/>
@@ -1035,12 +1033,14 @@
<Function name='GetCurrentMissCombo'/> <Function name='GetCurrentMissCombo'/>
<Function name='GetCurrentPossibleDancePoints'/> <Function name='GetCurrentPossibleDancePoints'/>
<Function name='GetCurrentScoreMultiplier'/> <Function name='GetCurrentScoreMultiplier'/>
<Function name='GetFailed'/>
<Function name='GetGrade'/> <Function name='GetGrade'/>
<Function name='GetHoldNoteScores'/> <Function name='GetHoldNoteScores'/>
<Function name='GetLessonScoreActual'/> <Function name='GetLessonScoreActual'/>
<Function name='GetLessonScoreNeeded'/> <Function name='GetLessonScoreNeeded'/>
<Function name='GetLifeRemainingSeconds'/> <Function name='GetLifeRemainingSeconds'/>
<Function name='GetMachineHighScoreIndex'/> <Function name='GetMachineHighScoreIndex'/>
<Function name='GetNumControllerSteps'/>
<Function name='GetPeakComboAward'/> <Function name='GetPeakComboAward'/>
<Function name='GetPercentDancePoints'/> <Function name='GetPercentDancePoints'/>
<Function name='GetPercentageOfTaps'/> <Function name='GetPercentageOfTaps'/>
@@ -1140,11 +1140,11 @@
<Function name='GetValue'/> <Function name='GetValue'/>
</Class> </Class>
<Class name='RageDisplay'> <Class name='RageDisplay'>
<Function name='GetCumFPS'/>
<Function name='GetDisplayHeight'/> <Function name='GetDisplayHeight'/>
<Function name='GetDisplayWidth'/> <Function name='GetDisplayWidth'/>
<Function name='GetFPS'/> <Function name='GetFPS'/>
<Function name='GetVPF'/> <Function name='GetVPF'/>
<Function name='GetCumFPS'/>
</Class> </Class>
<Class name='RageFile'> <Class name='RageFile'>
<Function name='AtEOF'/> <Function name='AtEOF'/>
@@ -1497,7 +1497,7 @@
<Class name='ThemeManager'> <Class name='ThemeManager'>
<Function name='DoesLanguageExist'/> <Function name='DoesLanguageExist'/>
<Function name='DoesThemeExist'/> <Function name='DoesThemeExist'/>
<Function name='GetAbsolutePath' /> <Function name='GetAbsolutePath'/>
<Function name='GetCurLanguage'/> <Function name='GetCurLanguage'/>
<Function name='GetCurThemeName'/> <Function name='GetCurThemeName'/>
<Function name='GetCurrentThemeDirectory'/> <Function name='GetCurrentThemeDirectory'/>
@@ -1667,6 +1667,7 @@
<Singleton class='RageFileManager' name='FILEMAN'/> <Singleton class='RageFileManager' name='FILEMAN'/>
<Singleton class='GameManager' name='GAMEMAN'/> <Singleton class='GameManager' name='GAMEMAN'/>
<Singleton class='GameState' name='GAMESTATE'/> <Singleton class='GameState' name='GAMESTATE'/>
<Singleton class='ArchHooks' name='HOOKS'/>
<Singleton class='NoteSkinManager' name='NOTESKIN'/> <Singleton class='NoteSkinManager' name='NOTESKIN'/>
<Singleton class='PrefsManager' name='PREFSMAN'/> <Singleton class='PrefsManager' name='PREFSMAN'/>
<Singleton class='ThemeManager' name='THEME'/> <Singleton class='ThemeManager' name='THEME'/>
@@ -2230,5 +2231,5 @@
<Constant name='top' value='&apos;VertAlign_Top&apos;'/> <Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants> </Constants>
<Version>StepMania v5.0 Preview 4</Version> <Version>StepMania v5.0 Preview 4</Version>
<Date>2011-10-06</Date> <Date>2011-11-26</Date>
</Lua> </Lua>
+17
View File
@@ -1156,6 +1156,8 @@
</Function> </Function>
</Class> </Class>
<Class name='ActorFrame'> <Class name='ActorFrame'>
<Function name='AddChildFromPath' return='bool' arguments='string sPath'>
</Function>
<Function name='fov' return='void' arguments='float fFOV'> <Function name='fov' return='void' arguments='float fFOV'>
Sets the field of view for the ActorFrame. Sets the field of view for the ActorFrame.
</Function> </Function>
@@ -1183,6 +1185,12 @@
<Function name='propagatecommand' theme='_fallback' return='void' arguments='LuaReference cmd'> <Function name='propagatecommand' theme='_fallback' return='void' arguments='LuaReference cmd'>
[02 Actor.lua] Propagates a command to the ActorFrame's children. [02 Actor.lua] Propagates a command to the ActorFrame's children.
</Function> </Function>
<Function name='RemoveAllChildren' return='void' arguments=''>
Removes all the children from the ActorFrame.
</Function>
<Function name='RemoveChild' return='void' arguments='string sChild'>
Removes the specified child from the ActorFrame.
</Function>
<Function name='RunCommandsOnChildren' return='void' arguments='LuaReference cmds'> <Function name='RunCommandsOnChildren' return='void' arguments='LuaReference cmds'>
Runs the commands in <code>cmds</code> on the ActorFrame's children. Runs the commands in <code>cmds</code> on the ActorFrame's children.
</Function> </Function>
@@ -2760,6 +2768,9 @@
<Function name='GetCurrentScoreMultiplier' return='int' arguments=''> <Function name='GetCurrentScoreMultiplier' return='int' arguments=''>
Returns the player's current score multiplier. Returns the player's current score multiplier.
</Function> </Function>
<Function name='GetFailed' return='bool' arguments=''>
Returns <code>true</code> if the player failed.
</Function>
<Function name='GetGrade' return='Grade' arguments=''> <Function name='GetGrade' return='Grade' arguments=''>
Returns the player's grade. Returns the player's grade.
</Function> </Function>
@@ -2778,6 +2789,9 @@
<Function name='GetMachineHighScoreIndex' return='int' arguments=''> <Function name='GetMachineHighScoreIndex' return='int' arguments=''>
Returns the machine high score index for this performance. Returns the machine high score index for this performance.
</Function> </Function>
<Function name='GetNumControllerSteps' return='int' arguments=''>
Returns the number of controller steps.
</Function>
<Function name='GetPeakComboAward' return='PeakComboAward' arguments=''> <Function name='GetPeakComboAward' return='PeakComboAward' arguments=''>
Returns the peak combo award for this performance. Returns the peak combo award for this performance.
</Function> </Function>
@@ -3972,6 +3986,9 @@
<Function name='DoesThemeExist' return='bool' arguments='string themeName'> <Function name='DoesThemeExist' return='bool' arguments='string themeName'>
Returns <code>true</code> if the specified theme exists. Returns <code>true</code> if the specified theme exists.
</Function> </Function>
<Function name='GetAbsolutePath' theme='_fallback' return='string' arguments='string sPath'>
[03 ProductivityHelpers.lua] Returns the absolute path of a file in the theme.
</Function>
<Function name='GetCurLanguage' return='string' arguments=''> <Function name='GetCurLanguage' return='string' arguments=''>
Returns the current language. Returns the current language.
</Function> </Function>