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

Added PROFILE:GetHighScoreListIfExists for limiting memory footprint on searches. Added PROFILE:GetAllUsedHighScoreNames to provide a non-brute force way for obtaining a list of names. Added HighScoreList:GetHighestScoreOfName so the C++ side could do the iteration. Added HighScoreList:GetRankOfName for the same reason.

Browse Source
This commit is contained in:
Kyzentun
2014-05-13 13:34:38 -06:00
parent 80c741f175
commit 6db1199db5
5 changed files with 137 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Docs/Luadoc/Lua.xml
+4
View File
@@ -872,6 +872,8 @@
</Class>
<Class name='HighScoreList'>
<Function name='GetHighScores'/>
<Function name='GetHighestScoreOfName'/>
<Function name='GetRankOfName'/>
</Class>
<Class base='ActorFrame' name='HoldJudgment'>
<Function name='LoadFromMultiPlayer'/>
@@ -1133,6 +1135,7 @@
<Function name='SetPreferenceToDefault'/>
</Class>
<Class name='Profile'>
<Function name='GetAllUsedHighScoreNames'/>
<Function name='GetCaloriesBurnedToday'/>
<Function name='GetCharacter'/>
<Function name='GetCoursesActual'/>
@@ -1145,6 +1148,7 @@
<Function name='GetGoalSeconds'/>
<Function name='GetGoalType'/>
<Function name='GetHighScoreList'/>
<Function name='GetHighScoreListIfExists'/>
<Function name='GetLastPlayedCourse'/>
<Function name='GetLastPlayedSong'/>
<Function name='GetLastUsedHighScoreName'/>
Docs/Luadoc/LuaDocumentation.xml
+13
View File
@@ -2592,6 +2592,12 @@ save yourself some time, copy this for undocumented things:
<Function name='GetHighScores' return='{HighScore}' arguments=''>
Returns a table of the high scores.
</Function>
<Function name='GetHighestScoreOfName' return='HighScore' arguments='string name'>
Returns the highest score for name in the list. Returns nil if there is no score for name in the list.
</Function>
<Function name='GetRankOfName' return='int' arguments='string name'>
Returns the rank of the highest score for name in the list. Returns 0 if there is no score for name in the list. (returns 1 if name has the top score, 2 if name has the second place score, and so on)
</Function>
</Class>
<Class name='HoldJudgment'>
<Function name='LoadFromMultiPlayer' return='void' arguments='MultiPlayer mp'>
@@ -3208,6 +3214,9 @@ save yourself some time, copy this for undocumented things:
</Function>
</Class>
<Class name='Profile'>
<Function name='GetAllUsedHighScoreNames' return= '{string}' arguments='void'>
Returns a table of all high score names that have been used on this profile.
</Function>
<Function name='GetCaloriesBurnedToday' return='float' arguments=''>
Returns the number of calories burned during the current day.
</Function>
@@ -3247,6 +3256,10 @@ 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='GetHighScoreListIfExists' 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>)<br />
If the profile does not have a HighScoreList for the Song and Steps, returns nil. Use this to avoid increasing the memory footprint of the profile when checking the score lists for every song and steps.
</Function>
<Function name='GetLastPlayedCourse' return='Course' arguments=''>
Returns the last played Course for this profile.
</Function>