Add Luadocs for Group

This commit is contained in:
Crash Cringle
2025-03-04 01:20:10 -05:00
committed by teejusb
parent dbbcc57112
commit 17e4953d54
2 changed files with 51 additions and 0 deletions
+12
View File
@@ -1001,6 +1001,17 @@
<Function name='StoreRankingName'/>
<Function name='UnjoinPlayer'/>
<Function name='prepare_song_for_gameplay'/>
</Class>
<Class name='Group'>
<Function name='GetGroupName'/>
<Function name='GetSortTitle'/>
<Function name='GetDisplayTitle'/>
<Function name='GetTranslitTitle'/>
<Function name='GetSeries'/>
<Function name='GetSyncOffset'/>
<Function name='HasPackIni'/>
<Function name='GetBannerPath'/>
<Function name='GetYearReleased'/>
</Class>
<Class base='ActorFrame' name='GradeDisplay'>
<Function name='Load'/>
@@ -1868,6 +1879,7 @@
<Function name='GetSongGroupBannerPath'/>
<Function name='GetSongGroupColor'/>
<Function name='GetSongGroupNames'/>
<Function name='GetGroup'/>
<Function name='GetSongRank'/>
<Function name='GetSongsInGroup'/>
<Function name='SetPreferredCourses'/>
+39
View File
@@ -3411,6 +3411,42 @@ end
Sets the GrooveRadar values for Player <code>pn</code> to the specified (floating point) values in the table.
</Function>
</Class>
<Class name='Group'>
<Function name='GetGroupName' return='string' arguments='' since='ITGmania 1.0.0'>
Returns <code>sGroupDirName</code>, the actual name of the group folder on disk.
</Function>
<Function name='GetSortTitle' return='string' arguments='' since='ITGmania 1.0.0'>
Returns the value considered when sorting the group by its title.
If this is not set in the <code>Pack.ini</code>, the <code>sGroupDirName</code> is used instead.
</Function>
<Function name='GetDisplayTitle' return='string' arguments='' since='ITGmania 1.0.0'>
Returns the display title of the group as its displayed to the user in the MusicWheel
If this is not set in the <code>Pack.ini</code>, the <code>sGroupDirName</code> is used instead.
</Function>
<Function name='GetTranslitTitle' return='string' arguments='' since='ITGmania 1.0.0'>
Returns the transliterated title of the group.
If this is not set in the <code>Pack.ini</code>, the Display Title is used instead.
</Function>
<Function name='GetSeries' return='string' arguments='' since='ITGmania 1.0.0'>
Returns the series the group belongs to.
If this is not set in the <code>Pack.ini</code>, returns an empty string.
</Function>
<Function name='GetSyncOffset' return='float' arguments='' since='ITGmania 1.0.0'>
Returns the sync bias offset to be applied to this group. Returns -0.0009 if <code>ITG</code> or 0 (0ms) if <code>NULL</code>
If this is not set in the <code>Pack.ini</code>, the <code>fMachineSyncBias</code> preference is used instead.
</Function>
<Function name='HasPackIni' return='bool' arguments='' since='ITGmania 1.0.0'>
Returns <code>true</code> if the group has a Pack.ini file, <code>false</code> otherwise.
</Function>
<Function name='GetBannerPath' return='string' arguments='' since='ITGmania 1.0.0'>
Returns the path to the group's banner.
If this is not set in the <code>Pack.ini</code>, returns an empty string.
</Function>
<Function name='GetYearReleased' return='int' arguments='' since='ITGmania 1.0.0'>
Returns the year the group was released.
If this is not set in the <code>Pack.ini</code>, returns 0.
</Function>
</Class>
<Class name='HelpDisplay' grouping='Actor'>
<Function name='gettips' return='{string}' arguments=''>
Returns two tables representing the tips and alternate tips in the HelpDisplay.
@@ -5899,6 +5935,9 @@ local args = {
<Function name='GetSongGroupNames' return='{string}' arguments=''>
Returns a table containing all of the song group names.
</Function>
<Function name='GetGroup' return='Group' arguments='Song s' since='ITGmania 1.0.0'>
Returns the group of the specified song. This holds the Pack.ini information.
</Function>
<Function name='GetSongRank' return='int' arguments='Song s'>
Returns the rank (popularity) of Song <code>s</code>.
</Function>