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

update luadoc

Browse Source
This commit is contained in:
AJ Kelly
2011-02-20 12:58:38 -06:00
parent 035e0830d7
commit 00d137362f
2 changed files with 50 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+16 -6
View File
@@ -775,8 +775,6 @@
<Class base='ActorFrame' name='GrooveRadar'>
<Function name='SetEmpty'/>
<Function name='SetFromRadarValues'/>
<Function name='tweenoffscreen'/>
<Function name='tweenonscreen'/>
</Class>
<Class base='BitmapText' name='HelpDisplay'>
<Function name='SetSecsBetweenSwitches'/>
@@ -856,6 +854,15 @@
<Function name='LoadActor'/>
<Function name='LoadActorForNoteSkin'/>
</Class>
<Class base='ActorFrame' name='OptionRow'>
<Function name='FirstItemGoesDown'/>
<Function name='GetChoiceInRowWithFocus'/>
<Function name='GetName'/>
<Function name='GetNumChoices'/>
<Function name='GetRowTitle'/>
<Function name='HasFocus'/>
<Function name='OneChoiceForAllPlayers'/>
</Class>
<Class base='ActorFrame' name='PaneDisplay'>
<Function name='SetFromGameState'/>
</Class>
@@ -1074,9 +1081,11 @@
</Class>
<Class base='ScreenWithMenuElements' name='ScreenOptions'>
<Function name='AllAreOnLastRow'/>
<Function name='GetCurrentRow'/>
<Function name='FocusedItemEndsScreen'/>
<Function name='GetCurrentRowIndex'/>
<Function name='GetOptionRow'/>
</Class>
<Class base='ScreenWithMenuElements' name='ScreenPlayerOptions'>
<Class base='ScreenOptions' name='ScreenPlayerOptions'>
<Function name='GetGoToOptions'/>
</Class>
<Class base='ScreenWithMenuElements' name='ScreenProfileLoad'>
@@ -1236,8 +1245,8 @@
<Function name='Reset'/>
</Class>
<Class name='Steps'>
<Function name='GetDescription'/>
<Function name='GetAuthorCredit'/>
<Function name='GetDescription'/>
<Function name='GetDifficulty'/>
<Function name='GetFilename'/>
<Function name='GetHash'/>
@@ -1348,6 +1357,7 @@
<Function name='GetWheelItem'/>
<Function name='IsLocked'/>
<Function name='IsSettled'/>
<Function name='SetOpenSection'/>
</Class>
<Class base='ActorFrame' name='WorkoutGraph'>
<Function name='SetFromCurrentWorkout'/>
@@ -1955,5 +1965,5 @@
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>sm-ssc v1.2.1</Version>
<Date>2011-02-10</Date>
<Date>2011-02-20</Date>
</Lua>
Docs/Luadoc/LuaDocumentation.xml
+34 -2
View File
@@ -2038,6 +2038,29 @@
Returns a table of noteskin names for the current gametype.
</Function>
</Class>
<Class name='OptionRow'>
<Function name='FirstItemGoesDown' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the first item in the row goes down.
</Function>
<Function name='GetChoiceInRowWithFocus' sm-ssc='true' return='int' arguments='PlayerNumber pn'>
Returns an index of the choice in the row that player <code>pn</code> is on.
</Function>
<Function name='GetName' sm-ssc='true' return='string' arguments=''>
Returns the name of the OptionRow.
</Function>
<Function name='GetNumChoices' sm-ssc='true' return='int' arguments=''>
Returns the number of choices in this OptionRow.
</Function>
<Function name='GetRowTitle' sm-ssc='true' return='string' arguments=''>
Returns the row title string.
</Function>
<Function name='HasFocus' sm-ssc='true' return='bool' arguments='PlayerNumber pn'>
Returns <code>true</code> if this row is focused by player <code>pn</code>.
</Function>
<Function name='OneChoiceForAllPlayers' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if this row forces one choice on all players.
</Function>
</Class>
<Class name='PaneDisplay'>
<Function name='SetFromGameState' return='void' arguments=''>
Sets the PaneDisplay from the GameState.
@@ -2604,8 +2627,14 @@
<Function name='AllAreOnLastRow' return='bool' sm-ssc='true' arguments=''>
Returns <code>true</code> if all active players are on the last options row.
</Function>
<Function name='GetCurrentRow' return='int' arguments='PlayerNumber pn'>
Returns the current row that player <code>pn</code> is on.
<Function name='FocusedItemEndsScreen' return='bool' sm-ssc='true' arguments='PlayerNumber pn'>
Returns <code>true</code> if the specified player is on an items that ends the screen.
</Function>
<Function name='GetCurrentRowIndex' renamed='true' return='int' arguments='PlayerNumber pn'>
Returns the current row that player <code>pn</code> is on. (Was previously <code>GetCurrentRow</code>.)
</Function>
<Function name='GetOptionRow' sm-ssc='true' return='OptionRow' arguments='int iRow'>
Returns the specified OptionRow.
</Function>
</Class>
<Class name='ScreenPlayerOptions'>
@@ -3325,6 +3354,9 @@
<Function name='Move' sm-ssc='true' return='void' arguments='int n'>
Moves the wheel by <code>n</code>.
</Function>
<Function name='SetOpenSection' sm-ssc='true' return='void' arguments='string sSection'>
Attempts to set the open section to <code>sSection</code>.
</Function>
</Class>
<Class name='WorkoutGraph'>
<Function name='SetFromCurrentWorkout' return='void' arguments=''>