Class SongManager
Song management singleton accessed via SONGMAN
This is responsible for Song related information accessing.
Methods
| songmanager:DoesSongGroupExist (string, sGroup) | Returns true if the specified song group exists. |
| songmanager:GetAllSongs () | Returns an array of all the installed songs. |
| songmanager:GetNumAdditionalSongs () | Returns the number of songs loaded via Additional folders. |
| songmanager:GetNumSongGroups () | Returns the number of song groups. |
| songmanager:GetNumSongs () | Returns the number of songs. |
| songmanager:GetPopularSongs () | Returns a table of popular songs. |
| 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: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:WasLoadedFromAdditionalSongs (Song, s) | Returns true if the specified song was loaded from AdditionalSongs. |
| songmanager:DifferentialReload () | Scan all song directories and load new Songs if found. |
| songmanager:GetSongByChartKey (chartkey) | Get a Song based on a given chartkey. |
| songmanager:GetStepsByChartKey (chartkey) | Get a Steps based on a given chartkey. |
| songmanager:GetActivePlaylist () | When an active Playlist is set, return it. |
| songmanager:SetActivePlaylist (playlistName) | Set the active Playlist by its name. |
| songmanager:NewPlaylist () | Open the ScreenTextEntry dialogue to create a new Playlist. |
| songmanager:NewPlaylistNoDialog (playlistName) | Create a new Playlist without using a baked in dialogue, using the given name. |
| songmanager:RenamePlaylistNoDialog (nameBefore, nameAfter) | Rename an existing Playlist. |
| songmanager:GetPlaylists () | Get the list of Playlists loaded for the current Profile. |
| songmanager:DeletePlaylist (playlistName) | Delete a particular Playlist from the currently loaded Profile and immediately save said Profile. |
Methods
- songmanager:DoesSongGroupExist (string, sGroup)
-
Returns
trueif the specified song group exists.Parameters:
- string
- sGroup
Returns:
-
bool
- songmanager:GetAllSongs ()
-
Returns an array of all the installed songs.
Returns:
-
{Song}
- songmanager:GetNumAdditionalSongs ()
-
Returns the number of songs loaded via Additional folders.
Returns:
-
int
- songmanager:GetNumSongGroups ()
-
Returns the number of song groups.
Returns:
-
int
- songmanager:GetNumSongs ()
-
Returns the number of songs.
Returns:
-
int
- songmanager:GetPopularSongs ()
-
Returns a table of popular songs.
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: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:WasLoadedFromAdditionalSongs (Song, s)
-
Returns
trueif the specified song was loaded from AdditionalSongs.Parameters:
- Song
- s
Returns:
-
bool
- songmanager:DifferentialReload ()
-
Scan all song directories and load new Songs if found.
Returns:
-
nil
- songmanager:GetSongByChartKey (chartkey)
-
Get a Song based on a given chartkey. For chartkeys that are not unique,
the behavior is undefined. A Song will be returned which contains the Steps for
the chartkey, but the Song may not be the one intended.
Parameters:
Returns:
- songmanager:GetStepsByChartKey (chartkey)
-
Get a Steps based on a given chartkey.
Parameters:
Returns:
-
Steps
The Steps for the given chart key
- songmanager:GetActivePlaylist ()
-
When an active Playlist is set, return it.
Setting a Playlist means to have it queued and ready to play in Gameplay, or to have it
opened for modification in the Playlist related menus.
Returns:
-
Playlist
The currently set Playlist
See also:
- songmanager:SetActivePlaylist (playlistName)
-
Set the active Playlist by its name.
Setting a Playlist means to have it queued and ready to play in Gameplay, or to have it
opened for modification in the Playlist related menus.
Parameters:
- playlistName string The name of the Playlist to set active.
Returns:
-
nil
See also:
- songmanager:NewPlaylist ()
-
Open the ScreenTextEntry dialogue to create a new Playlist.
There is very little error handling here.
Returns:
-
nil
See also:
- songmanager:NewPlaylistNoDialog (playlistName)
-
Create a new Playlist without using a baked in dialogue, using the given name.
Parameters:
- playlistName string The name of the new Playlist
Returns:
-
bool
A status on whether or not a new Playlist could be created successfully
- songmanager:RenamePlaylistNoDialog (nameBefore, nameAfter)
-
Rename an existing Playlist.
Parameters:
Returns:
-
bool
A status on whether or not the Playlist could be renamed successfully
- songmanager:GetPlaylists ()
-
Get the list of Playlists loaded for the current Profile.
Returns:
-
{Playlist,...}
A table of Playlists in no particular order
- songmanager:DeletePlaylist (playlistName)
-
Delete a particular Playlist from the currently loaded Profile and immediately save said Profile.
Parameters:
- playlistName string The name of the playlist to attempt to delete
Returns:
-
nil