Class SongManager
SongManager singleton
Methods
| SongManager:DoesCourseGroupExist (string, sGroup) | Returns true if the specified course group exists. |
| SongManager:DoesSongGroupExist (string, sGroup) | Returns true if the specified song group exists. |
| SongManager:FindCourse (string, sCourse) | Returns a Course if one matching sCourse is found. |
| SongManager:FindSong (string, sSong) | Returns a Song if one matching sSong is found. |
| SongManager:GetAllCourses (bool, bIncludeAutogen) | Returns an array of all the installed courses. |
| SongManager:GetAllSongs () | Returns an array of all the installed songs. |
| SongManager:GetCourseColor (Course, c) | Returns the course color of Course c. |
| SongManager:GetCourseGroupBannerPath (string, sGroup) | Returns the path to the specified course group's banner. |
| SongManager:GetCourseGroupNames () | Returns a table containing all of the course group names. |
| SongManager:GetCoursesInGroup (string, sGroup, bool, bIncludeAutogen) | Returns a table with all of the courses in the specified group. |
| SongManager:GetExtraStageInfo (bool, bExtra2, Style, s) | Returns the extra stage info (Song, Steps) for the specified Style s. |
| SongManager:GetNumAdditionalCourses () | Returns the number of courses loaded via Additional folders. |
| SongManager:GetNumAdditionalSongs () | Returns the number of songs loaded via Additional folders. |
| SongManager:GetNumCourseGroups () | Returns the number of course groups. |
| SongManager:GetNumCourses () | Returns the number of courses. |
| SongManager:GetNumSelectableAndUnlockedSongs () | Returns the number of selectable and unlocked songs. |
| SongManager:GetNumSongGroups () | Returns the number of song groups. |
| SongManager:GetNumSongs () | Returns the number of songs. |
| SongManager:GetNumLockedSongs () | Returns the number of locked songs, regardless of reason for locking. |
| SongManager:GetNumUnlockedSongs () | Returns the number of unlocked songs. |
| SongManager:GetPopularCourses (CourseType, ct) | Returns a table of popular courses for the specified CourseType. |
| SongManager:GetPopularSongs () | Returns a table of popular songs. |
| SongManager:GetPreferredSortCourses (CourseType, ct, bool, bIncludeAutogen) | Returns a table of courses as they'd appear in preferred sort. |
| SongManager:GetPreferredSortSongs () | Returns a table of songs as they'd appear in preferred sort. |
| SongManager:GetRandomCourse () | Returns a random course. |
| SongManager:GetRandomSong () | Returns a random song. |
| SongManager:GetSongColor (Song, s) | Returns the song color of Song s. |
| SongManager:GetSongFromSteps (Steps, st) | Returns a Song given a set of Steps st. |
| SongManager:GetSongGroupBannerPath (string, sGroup) | Returns the path to the specified song group's banner. |
| SongManager:GetSongGroupColor (string, sGroupName) | Returns the song group color of sGroupName. |
| SongManager:GetSongGroupNames () | Returns a table containing all of the song group names. |
| SongManager:GetSongRank (Song, s) | Returns the rank (popularity) of Song s. |
| SongManager:GetSongsInGroup (string, sGroupName) | Returns a table containing all of the songs in group sGroupName. |
| SongManager:ShortenGroupName (string, sGroupName) | Returns the shortened group name (based on entries in Translations.xml). |
| SongManager:SetPreferredCourses (string, sListName) | Loads preferred courses from {theme}/Other/SongManager sListName.txt. |
| SongManager:SetPreferredSongs (string, sListName) | Loads preferred songs from {theme}/Other/SongManager sListName.txt. |
| SongManager:SongToPreferredSortSectionName (Song, s) | Returns the preferred sort section name for the specified Song. |
| SongManager:WasLoadedFromAdditionalCourses (Course, c) | Returns true if the specified course was loaded from AdditionalCourses. |
| SongManager:WasLoadedFromAdditionalSongs (Song, s) | Returns true if the specified song was loaded from AdditionalSongs. |
Methods
- SongManager:DoesCourseGroupExist (string, sGroup)
-
Returns
trueif the specified course group exists.Parameters:
- string
- sGroup
Returns:
-
bool
- SongManager:DoesSongGroupExist (string, sGroup)
-
Returns
trueif the specified song group exists.Parameters:
- string
- sGroup
Returns:
-
bool
- SongManager:FindCourse (string, sCourse)
-
Returns a Course if one matching
sCourseis found.Parameters:
- string
- sCourse
Returns:
-
Course
- SongManager:FindSong (string, sSong)
-
Returns a Song if one matching
sSongis found.Parameters:
- string
- sSong
Returns:
-
Song
- SongManager:GetAllCourses (bool, bIncludeAutogen)
-
Returns an array of all the installed courses.
Parameters:
- bool
- bIncludeAutogen
Returns:
-
{Course}
- SongManager:GetAllSongs ()
-
Returns an array of all the installed songs.
Returns:
-
{Song}
- SongManager:GetCourseColor (Course, c)
-
Returns the course color of Course
c.Parameters:
- Course
- c
Returns:
-
color
- SongManager:GetCourseGroupBannerPath (string, sGroup)
-
Returns the path to the specified course group's banner.
Parameters:
- string
- sGroup
Returns:
-
string
- SongManager:GetCourseGroupNames ()
-
Returns a table containing all of the course group names.
Returns:
-
{string}
- SongManager:GetCoursesInGroup (string, sGroup, bool, bIncludeAutogen)
-
Returns a table with all of the courses in the specified group.
Parameters:
- string
- sGroup
- bool
- bIncludeAutogen
Returns:
-
{Course}
- SongManager:GetExtraStageInfo (bool, bExtra2, Style, s)
-
Returns the extra stage info (Song, Steps) for the specified Style
s. (IfbExtra2is true, it will use the second Extra Stage data instead of the first. Again, Lua.xsd sucks)Parameters:
- bool
- bExtra2
- Style
- s
Returns:
-
various
- SongManager:GetNumAdditionalCourses ()
-
Returns the number of courses loaded via Additional folders.
Returns:
-
int
- SongManager:GetNumAdditionalSongs ()
-
Returns the number of songs loaded via Additional folders.
Returns:
-
int
- SongManager:GetNumCourseGroups ()
-
Returns the number of course groups.
Returns:
-
int
- SongManager:GetNumCourses ()
-
Returns the number of courses.
Returns:
-
int
- SongManager:GetNumSelectableAndUnlockedSongs ()
-
Returns the number of selectable and unlocked songs.
Returns:
-
int
- SongManager:GetNumSongGroups ()
-
Returns the number of song groups.
Returns:
-
int
- SongManager:GetNumSongs ()
-
Returns the number of songs.
Returns:
-
int
- SongManager:GetNumLockedSongs ()
-
Returns the number of locked songs, regardless of reason for locking.
Returns:
-
int
- SongManager:GetNumUnlockedSongs ()
-
Returns the number of unlocked songs.
Returns:
-
int
- SongManager:GetPopularCourses (CourseType, ct)
-
Returns a table of popular courses for the specified CourseType.
Parameters:
- CourseType
- ct
Returns:
-
{Course}
- SongManager:GetPopularSongs ()
-
Returns a table of popular songs.
Returns:
-
{Song}
- SongManager:GetPreferredSortCourses (CourseType, ct, bool, bIncludeAutogen)
-
Returns a table of courses as they'd appear in preferred sort.
Parameters:
- CourseType
- ct
- bool
- bIncludeAutogen
Returns:
-
{Course}
- SongManager:GetPreferredSortSongs ()
-
Returns a table of songs as they'd appear in preferred sort.
Returns:
-
{Song}
- SongManager:GetRandomCourse ()
-
Returns a random course.
Returns:
-
Course
- SongManager:GetRandomSong ()
-
Returns a random song.
Returns:
-
Song
- SongManager:GetSongColor (Song, s)
-
Returns the song color of Song
s.Parameters:
- Song
- s
Returns:
-
color
- SongManager:GetSongFromSteps (Steps, st)
-
Returns a Song given a set of Steps
st.Parameters:
- Steps
- st
Returns:
-
Song
- SongManager:GetSongGroupBannerPath (string, sGroup)
-
Returns the path to the specified song group's banner.
Parameters:
- string
- sGroup
Returns:
-
string
- SongManager:GetSongGroupColor (string, sGroupName)
-
Returns the song group color of
sGroupName.Parameters:
- string
- sGroupName
Returns:
-
color
- SongManager:GetSongGroupNames ()
-
Returns a table containing all of the song group names.
Returns:
-
{string}
- SongManager:GetSongRank (Song, s)
-
Returns the rank (popularity) of Song
s.Parameters:
- Song
- s
Returns:
-
int
- SongManager:GetSongsInGroup (string, sGroupName)
-
Returns a table containing all of the songs in group
sGroupName.Parameters:
- string
- sGroupName
Returns:
-
{Song}
- SongManager:ShortenGroupName (string, sGroupName)
-
Returns the shortened group name (based on entries in Translations.xml).
Parameters:
- string
- sGroupName
Returns:
-
string
- SongManager:SetPreferredCourses (string, sListName)
-
Loads preferred courses from
{theme}/Other/SongManager sListName.txt.Parameters:
- string
- sListName
Returns:
-
void
- SongManager:SetPreferredSongs (string, sListName)
-
Loads preferred songs from
{theme}/Other/SongManager sListName.txt.Parameters:
- string
- sListName
Returns:
-
void
- SongManager:SongToPreferredSortSectionName (Song, s)
-
Returns the preferred sort section name for the specified Song.
Parameters:
- Song
- s
Returns:
-
string
- SongManager:WasLoadedFromAdditionalCourses (Course, c)
-
Returns
trueif the specified course was loaded from AdditionalCourses.Parameters:
- Course
- c
Returns:
-
bool
- SongManager:WasLoadedFromAdditionalSongs (Song, s)
-
Returns
trueif the specified song was loaded from AdditionalSongs.Parameters:
- Song
- s
Returns:
-
bool