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

update lua documentation, fix formatting on PlayerStageStats

Browse Source
This commit is contained in:
AJ Kelly
2012-06-08 00:14:08 -05:00
parent e3537af385
commit d46ddd5331
3 changed files with 40 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+13 -2
View File
@@ -7,6 +7,7 @@
<Function name='Alpha'/>
<Function name='AreStagePlayerModsForced'/>
<Function name='AreStageSongModsForced'/>
<Function name='ArgsIfPlayerJoinedOrNil'/>
<Function name='Basename'/>
<Function name='BoostColor'/>
<Function name='Brightness'/>
@@ -34,6 +35,7 @@
<Function name='DeepCopy'/>
<Function name='EvalUsesCheckpointsWithJudgments'/>
<Function name='FailCombo'/>
<Function name='FinalizeScoreKeepers'/>
<Function name='FindSelection'/>
<Function name='FindValue'/>
<Function name='FormatNumSongsPlayed'/>
@@ -54,6 +56,7 @@
<Function name='GetGamePrefN'/>
<Function name='GetGradeFromPercent'/>
<Function name='GetLifeDifficulty'/>
<Function name='GetNumReadiedScoreKeepers'/>
<Function name='GetPlayerOrMachineProfile'/>
<Function name='GetProTiming'/>
<Function name='GetRandomSongBackground'/>
@@ -84,6 +87,7 @@
<Function name='Hour'/>
<Function name='Hue'/>
<Function name='InitGamePrefs'/>
<Function name='InitScoreKeepers'/>
<Function name='InitUserPrefs'/>
<Function name='IsArcade'/>
<Function name='IsFreePlay'/>
@@ -184,6 +188,7 @@
<Function name='URLEncode'/>
<Function name='UndocumentedFeature'/>
<Function name='UnlockRewardTypeToLocalizedString'/>
<Function name='UpdateScoreKeepers'/>
<Function name='UserPrefScoringMode'/>
<Function name='Var'/>
<Function name='VersionDate'/>
@@ -591,6 +596,7 @@
<Function name='LoadMultiPlayer'/>
</Class>
<Class name='Course'>
<Function name='AllSongsAreFixed'/>
<Function name='GetAllTrails'/>
<Function name='GetBackgroundPath'/>
<Function name='GetBannerPath'/>
@@ -820,6 +826,7 @@
<Class base='ActorFrame' name='GrooveRadar'>
<Function name='SetEmpty'/>
<Function name='SetFromRadarValues'/>
<Function name='SetFromValues'/>
</Class>
<Class base='BitmapText' name='HelpDisplay'>
<Function name='SetSecsBetweenSwitches'/>
@@ -1097,6 +1104,7 @@
<Function name='UsingReverse'/>
</Class>
<Class name='PlayerStageStats'>
<Function name='FailPlayer'/>
<Function name='FullCombo'/>
<Function name='FullComboOfScore'/>
<Function name='GetActualDancePoints'/>
@@ -1139,6 +1147,7 @@
<Function name='GetCurrentPlayerOptions'/>
<Function name='GetHealthState'/>
<Function name='GetMultiPlayerNumber'/>
<Function name='GetPlayerController'/>
<Function name='GetPlayerNumber'/>
<Function name='GetPlayerOptions'/>
<Function name='GetPlayerOptionsArray'/>
@@ -1165,6 +1174,8 @@
<Function name='GetGoalSeconds'/>
<Function name='GetGoalType'/>
<Function name='GetHighScoreList'/>
<Function name='GetLastPlayedCourse'/>
<Function name='GetLastPlayedSong'/>
<Function name='GetLastUsedHighScoreName'/>
<Function name='GetMostPopularCourse'/>
<Function name='GetMostPopularSong'/>
@@ -1418,6 +1429,7 @@
<Function name='IsEnabled'/>
<Function name='IsLong'/>
<Function name='IsMarathon'/>
<Function name='IsStepsUsingDifferentTiming'/>
<Function name='IsTutorial'/>
<Function name='MusicLengthSeconds'/>
<Function name='NormallyDisplayed'/>
@@ -1552,7 +1564,6 @@
<Function name='IsDisplayBpmRandom'/>
<Function name='IsDisplayBpmSecret'/>
<Function name='PredictMeter'/>
<Function name='UsesSplitTiming'/>
</Class>
<Class base='ActorFrame' name='StepsDisplay'>
<Function name='Load'/>
@@ -2341,5 +2352,5 @@
<Constant name='top' value='&apos;VertAlign_Top&apos;'/>
</Constants>
<Version>StepMania v5.0 alpha 2</Version>
<Date>2012-04-02</Date>
<Date>2012-06-08</Date>
</Lua>
Docs/Luadoc/LuaDocumentation.xml
+22 -10
View File
@@ -1272,7 +1272,7 @@ save yourself some time, copy this for undocumented things:
[02 Actor.lua] A customized version of pulse that is more appealing for on-beat effects.
</Function>
<Function name='xy' theme='_fallback' return='void' arguments='float actorX, float actorY'>
[02 Actor.lua] Sets the x and y location of the Actor in one command.
Sets the x and y location of the Actor in one command.
</Function>
</Class>
<Class name='ActorFrame'>
@@ -1731,6 +1731,9 @@ save yourself some time, copy this for undocumented things:
</Function>
</Class>
<Class name='Course'>
<Function name='AllSongsAreFixed' return='bool' arguments=''>
Returns <code>true</code> if all of the songs in the course have been defined (as opposed to random songs).
</Function>
<Function name='GetAllTrails' return='{Trail}' arguments=''>
Returns a table of all the Trails in the Course.
</Function>
@@ -1981,12 +1984,9 @@ 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=''>
<Function name='GetSortOrder' return='SortOrder' arguments=''>
Returns the sort order, if the GameCommand has set one.
</Function>
<Function name='GetStageResult' return='StageResult' arguments='PlayerNumber pn'>
Returns the StageResult for player <code>pn</code>.
</Function>
<Function name='GetStageModifiers' return='string' arguments=''>
Returns any stage modifiers that may have been set.
</Function>
@@ -2258,6 +2258,9 @@ save yourself some time, copy this for undocumented things:
<Function name='GetSortOrder' return='SortOrder' arguments=''>
Returns the current SortOrder.
</Function>
<Function name='GetStageResult' return='StageResult' arguments='PlayerNumber pn'>
Returns the StageResult for player <code>pn</code>.
</Function>
<Function name='GetStageIndex' return='int' arguments=''>
Returns the current stage index.
</Function>
@@ -2407,11 +2410,8 @@ save yourself some time, copy this for undocumented things:
<Function name='SetFromRadarValues' return='void' arguments='PlayerNumber pn, RadarValues rv'>
Sets the GrooveRadar values for Player <code>pn</code> from RadarValues <code>rv</code>
</Function>
<Function name='tweenoffscreen' return='void' arguments=''>
Tweens the GrooveRadar off screen.
</Function>
<Function name='tweenonscreen' return='void' arguments=''>
Tweens the GrooveRadar on screen.
<Function name='SetFromValues' return='void' arguments='PlayerNumber pn, {float vals}'>
Sets the GrooveRadar values for Player <code>pn</code> to the specified values in the table.
</Function>
</Class>
<Class name='HelpDisplay'>
@@ -3176,6 +3176,9 @@ save yourself some time, copy this for undocumented things:
</Function>
</Class>
<Class name='PlayerStageStats'>
<Function name='FailPlayer' return='bool' arguments=''>
Fails the player.
</Function>
<Function name='FullCombo' return='bool' arguments=''>
Returns <code>true</code> if a full combo (TNS_W3 and up) was obtained.
</Function>
@@ -3371,6 +3374,12 @@ save yourself some time, copy this for undocumented things:
<Function name='GetHighScoreList' return='HighScoreList' arguments='Song s, Steps st'>
Gets the profile's HighScoreList for a specified Song and Steps. (Alternate arguments for Courses: <code>Course c, Trail t</code>)
</Function>
<Function name='GetLastPlayedCourse' return='Course' arguments=''>
Returns the last played Course for this profile.
</Function>
<Function name='GetLastPlayedSong' return='Song' arguments=''>
Returns the last played Song for this profile.
</Function>
<Function name='GetLastUsedHighScoreName' return='string' arguments=''>
Returns the last used high score name.
</Function>
@@ -4014,6 +4023,9 @@ save yourself some time, copy this for undocumented things:
<Function name='IsMarathon' return='bool' arguments=''>
Returns <code>true</code> if the song meets the criteria for &quot;Marathon&quot; length.
</Function>
<Function name='IsStepsUsingDifferentTiming' return='bool' arguments='Steps s'>
Returns <code>true</code> if the song and the specified steps have different timing.
</Function>
<Function name='IsTutorial' return='bool' arguments=''>
Returns <code>true</code> if the song only has Beginner steps.
</Function>
src/PlayerStageStats.cpp
+5 -5
View File
@@ -761,11 +761,11 @@ public:
return 0;
}
static int FailPlayer( T* p, lua_State *L )
{
p->m_bFailed = true;
return 0;
}
static int FailPlayer( T* p, lua_State *L )
{
p->m_bFailed = true;
return 0;
}
LunaPlayerStageStats()
{