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

update luadocs

Browse Source
This commit is contained in:
AJ Kelly
2012-03-20 19:47:50 -05:00
parent e0a8bc81b0
commit 7d820efbb6
2 changed files with 43 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+18 -1
View File
@@ -676,15 +676,22 @@
<Function name='GetName'/>
</Class>
<Class name='GameCommand'>
<Function name='GetAnnouncer'/>
<Function name='GetCharacter'/>
<Function name='GetCourse'/>
<Function name='GetCourseDifficulty'/>
<Function name='GetDifficulty'/>
<Function name='GetIndex'/>
<Function name='GetMultiPlayer'/>
<Function name='GetName'/>
<Function name='GetPlayMode'/>
<Function name='GetPreferredModifiers'/>
<Function name='GetProfileID'/>
<Function name='GetScreen'/>
<Function name='GetSong'/>
<Function name='GetSongGroup'/>
<Function name='GetSortOrder'/>
<Function name='GetStageModifiers'/>
<Function name='GetSteps'/>
<Function name='GetStyle'/>
<Function name='GetText'/>
@@ -1569,6 +1576,7 @@
<Function name='GetName'/>
<Function name='GetStepsType'/>
<Function name='GetStyleType'/>
<Function name='LockedDifficulty'/>
<Function name='NeedsZoomOutWith2Players'/>
</Class>
<Class base='ActorFrame' name='TextBanner'>
@@ -2297,6 +2305,15 @@
<EnumValue name='&apos;WheelItemDataType_Sort&apos;' value='7'/>
<EnumValue name='&apos;WheelItemDataType_Custom&apos;' value='8'/>
</Enum>
<Enum name='WheelState'>
<EnumValue name='&apos;WheelState_Selecting&apos;' value='0'/>
<EnumValue name='&apos;WheelState_FlyingOffBeforeNextSort&apos;' value='1'/>
<EnumValue name='&apos;WheelState_FlyingOnAfterNextSort&apos;' value='2'/>
<EnumValue name='&apos;WheelState_RouletteSpinning&apos;' value='3'/>
<EnumValue name='&apos;WheelState_RouletteSlowingDown&apos;' value='4'/>
<EnumValue name='&apos;WheelState_RandomSpinning&apos;' value='5'/>
<EnumValue name='&apos;WheelState_Locked&apos;' value='6'/>
</Enum>
<Enum name='ZTestMode'>
<EnumValue name='&apos;ZTestMode_Off&apos;' value='0'/>
<EnumValue name='&apos;ZTestMode_WriteOnPass&apos;' value='1'/>
@@ -2327,5 +2344,5 @@
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>StepMania v5.0 alpha 1a</Version>
<Date>2012-02-19</Date>
<Date>2012-03-20</Date>
</Lua>
Docs/Luadoc/LuaDocumentation.xml
+25 -1
View File
@@ -1931,12 +1931,21 @@ save yourself some time, copy this for undocumented things:
</Function>
</Class>
<Class name='GameCommand'>
<Function name='GetAnnouncer' return='string' arguments=''>
Returns any announcer that may have been set.
</Function>
<Function name='GetCharacter' return='Character' arguments=''>
Returns any Character associated with this item (or <code>nil</code> if there isn't one).
</Function>
<Function name='GetCourse' return='Course' arguments=''>
Returns any Course that may have been set.
</Function>
<Function name='GetCourseDifficulty' return='Difficulty' arguments=''>
Returns a course difficulty, if one is set in the GameCommand.
</Function>
<Function name='GetDifficulty' return='Difficulty' arguments=''>
Returns a difficulty, if one is set in the GameCommand.
</Function>
<Function name='GetIndex' return='int' arguments=''>
Returns the index of this item.
</Function>
@@ -1946,6 +1955,12 @@ save yourself some time, copy this for undocumented things:
<Function name='GetName' return='string' arguments=''>
Returns the choice name.
</Function>
<Function name='GetPlayMode' return='PlayMode' arguments=''>
Returns the PlayMode associated with this GameCommand.
</Function>
<Function name='GetPreferredModifiers' return='string' arguments=''>
Returns any preferred modifiers that may have been set.
</Function>
<Function name='GetProfileID' return='string' arguments=''>
Returns any Profile ID that may have been set.
</Function>
@@ -1958,6 +1973,12 @@ save yourself some time, copy this for undocumented things:
<Function name='GetSongGroup' return='string' arguments=''>
Returns the name of any song group that may have been set.
</Function>
<Function name='GetSortOrder' return='SortOder' arguments=''>
Returns the sort order, if the GameCommand has set one.
</Function>
<Function name='GetStageModifiers' return='string' arguments=''>
Returns any stage modifiers that may have been set.
</Function>
<Function name='GetSteps' return='Steps' arguments=''>
Returns any Steps that may have been set.
</Function>
@@ -4380,7 +4401,7 @@ save yourself some time, copy this for undocumented things:
</Class>
<Class name='Style'>
<Function name='ColumnsPerPlayer' return='int' arguments=''>
Returns the number of total tracks this Style contains (e.g. 4 for dance-versus, but 8 for dance-double).
Returns the number of total tracks per player this Style contains (e.g. 4 for dance-versus, but 8 for dance-double).
</Function>
<Function name='GetName' return='string' arguments=''>
Returns the name of the Style.
@@ -4391,6 +4412,9 @@ save yourself some time, copy this for undocumented things:
<Function name='GetStyleType' return='StyleType' arguments=''>
Returns the StyleType for this Style.
</Function>
<Function name='LockedDifficulty' return='bool' arguments=''>
Returns <code>true</code> if this style locks the difficulty for both players.
</Function>
<Function name='NeedsZoomOutWith2Players' return='bool' arguments=''>
Returns <code>true</code> if the Style needs to be zoomed out with two players.
</Function>