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

update lua docs; still need help on the new SongPosition stuff

Browse Source
This commit is contained in:
AJ Kelly
2011-05-19 04:08:52 -05:00
parent dd0abb01ee
commit f2c9819814
1 changed files with 63 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/LuaDocumentation.xml
+63
View File
@@ -1466,6 +1466,20 @@
Blanks the DifficultyIcon.
</Function>
</Class>
<Class name='FadingBanner'>
<Function name='GetLatestIndex' sm-ssc='true' return='int' arguments=''>
Returns the index of the last banner loaded.
</Function>
<Function name='LoadFromCourse' return='void' arguments='Course c'>
Loads a Banner from a specified Course.
</Function>
<Function name='LoadFromSong' return='void' arguments='Song s'>
Loads a Banner from a specified Song.
</Function>
<Function name='LoadFromSongGroup' return='void' arguments='string s'>
Loads a Banner from a specified Song Group.
</Function>
</Class>
<Class name='StepsDisplayList'>
<Function name='setfromgamestate' return='void' arguments=''>
Sets the StepsDisplayList from the GameState.
@@ -1725,6 +1739,9 @@
<Function name='GetSongPercent' sm-ssc='true' return='float' arguments='float fBeat'>
Returns how much of the song is through at beat <code>fBeat</code>.
</Function>
<Function name='GetSongPosition' sm-ssc='true' return='SongPosition' arguments=''>
<!-- todo -->
</Function>
<Function name='GetSortOrder' return='SortOrder' arguments=''>
Returns the current SortOrder.
</Function>
@@ -1936,6 +1953,8 @@
</Function>
</Class>
<Class name='InputFilter'>
<Function name='GetMouseWheel' sm-ssc='true' return='float' arguments=''>
</Function>
<Function name='GetMouseX' sm-ssc='true' return='float' arguments=''>
Returns the X position of the mouse.
</Function>
@@ -2374,6 +2393,9 @@
<Function name='GetCaloriesBurned' return='float' arguments=''>
Returns the number of calories burned.
</Function>
<Function name='GetCurMaxScore' sm-ssc='true' return='int' arguments=''>
Returns the current possible maximum score.
</Function>
<Function name='GetCurrentCombo' return='int' arguments=''>
Returns the player's current combo.
</Function>
@@ -2466,6 +2488,9 @@
<Function name='IsDisqualified' return='bool' arguments=''>
Returns <code>true</code> if the player was disqualified from ranking.
</Function>
<Function name='SetCurMaxScore' sm-ssc='true' return='int' arguments=''>
Sets the current possible maximum score.
</Function>
<Function name='SetScore' sm-ssc='true' return='void' arguments='int iScore'>
Sets the Player's score to <code>iScore</code>.
</Function>
@@ -2495,6 +2520,9 @@
<Function name='GetPlayerOptionsArray' return='{string}' arguments='ModsLevel ml'>
Returns a table of strings, containing the player options for the specified ModsLevel.
</Function>
<Function name='GetSongPosition' sm-ssc='true' return='SongPosition' arguments=''>
Returns the SongPosition for this PlayerState.
</Function>
<Function name='SetPlayerOptions' return='string' arguments='ModsLevel ml, string sPlayerOptions'>
Sets the player options to <code>sPlayerOptions</code> for the specified ModsLevel.
</Function>
@@ -3213,6 +3241,38 @@
Loads preferred songs from <code>{theme}/Other/SongManager sListName.txt</code>.
</Function>
</Class>
<Class name='SongPosition'>
<Function name='GetCurBPS' sm-ssc='true' return='float' arguments=''>
Returns the current beats per second.
</Function>
<Function name='GetDelay' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if a Delay is active.
</Function>
<Function name='GetFreeze' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if a Freeze is active.
</Function>
<Function name='GetMusicSeconds' sm-ssc='true' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetMusicSecondsVisible' sm-ssc='true' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetSongBeat' sm-ssc='true' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetSongBeatNoOffset' sm-ssc='true' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetSongBeatVisible' sm-ssc='true' return='float' arguments=''>
<!-- todo -->
</Function>
<Function name='GetWarpBeginRow' sm-ssc='true' return='int' arguments=''>
Returns the row where a warp appears.
</Function>
<Function name='GetWarpDestination' sm-ssc='true' return='float' arguments=''>
Returns the warp destination length.
</Function>
</Class>
<Class name='Sprite'>
<Function name='GetAnimationLengthSeconds' return='float' arguments=''>
Returns the length of the animation in seconds.
@@ -3382,6 +3442,9 @@
<Function name='GetStepsType' return='StepsType' arguments=''>
Returns the Steps type.
</Function>
<Function name='GetTimingData' sm-ssc='true' return='TimingData' arguments=''>
Returns the TimingData for the Steps.
</Function>
<Function name='IsAnEdit' sm-ssc='true' return='bool' arguments=''>
Returns <code>true</code> if the Steps are an edit.
</Function>