Contains methods for adding, removing, and getting songs from the game data. More...

Static Public Member Functions
static Task< AggregateException >	ValidateSongAsync (string path, string name=null, bool throwError=false)
	Validates a song More...

static AggregateException	ValidateSong (string path, string name=null, bool throwError=false)
	Validates a song More...

static Task	ImportSongAsync (string unpackedPath, string moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (string unpackedPath, string moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (string unpackedPath, DirectoryInfo moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (string unpackedPath, DirectoryInfo moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (string unpackedPath, FileInfo moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (string unpackedPath, FileInfo moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (DirectoryInfo unpackedPath, DirectoryInfo moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (DirectoryInfo unpackedPath, DirectoryInfo moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (DirectoryInfo unpackedPath, FileInfo moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	ImportSongAsync (DirectoryInfo unpackedPath, FileInfo moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (string unpackedPath, string moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (string unpackedPath, string moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (string unpackedPath, DirectoryInfo moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (string unpackedPath, DirectoryInfo moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (string unpackedPath, FileInfo moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (string unpackedPath, FileInfo moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (DirectoryInfo unpackedPath, DirectoryInfo moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (DirectoryInfo unpackedPath, DirectoryInfo moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (DirectoryInfo unpackedPath, FileInfo moggsong, bool replace, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static void	ImportSong (DirectoryInfo unpackedPath, FileInfo moggsong, bool replace, ConsoleType consoleType, ProgressAction Log=null)
	Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files. More...

static Task	AddAllSongsAsync (string unpackedPath, ProgressAction Log=null)
	Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddAllSongsAsync (string unpackedPath, ConsoleType consoleType, ProgressAction Log=null)
	Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddAllSongsAsync (DirectoryInfo unpackedPath, ProgressAction Log=null)
	Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddAllSongsAsync (DirectoryInfo unpackedPath, ConsoleType consoleType, ProgressAction Log=null)
	Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddAllSongs (string unpackedPath, ProgressAction Log=null)
	Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddAllSongs (string unpackedPath, ConsoleType consoleType, ProgressAction Log=null)
	Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddAllSongs (DirectoryInfo unpackedPath, ProgressAction Log=null)
	Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddAllSongs (DirectoryInfo unpackedPath, ConsoleType consoleType, ProgressAction Log=null)
	Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddSongAsync (string unpackedPath, string[] songNames, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddSongAsync (string unpackedPath, string songName, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddSongAsync (string unpackedPath, string[] songNames, ConsoleType consoleType, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddSongAsync (string unpackedPath, string songName, ConsoleType consoleType, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddSongAsync (DirectoryInfo unpackedPath, string[] songNames, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddSongAsync (DirectoryInfo unpackedPath, string songName, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddSongAsync (DirectoryInfo unpackedPath, string songName, ConsoleType consoleType, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	AddSongAsync (DirectoryInfo unpackedPath, string[] songNames, ConsoleType consoleType, ProgressAction Log=null)
	Adds a series of songs already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddSong (string unpackedPath, string[] songNames, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddSong (string unpackedPath, string songName, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddSong (string unpackedPath, string[] songNames, ConsoleType consoleType, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddSong (string unpackedPath, string songName, ConsoleType consoleType, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddSong (DirectoryInfo unpackedPath, string[] songNames, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddSong (DirectoryInfo unpackedPath, string songName, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddSong (DirectoryInfo unpackedPath, string songName, ConsoleType consoleType, ProgressAction Log=null)
	Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static void	AddSong (DirectoryInfo unpackedPath, string[] songNames, ConsoleType consoleType, ProgressAction Log=null)
	Adds a series of songs already present in the songs folder of the game files into the amp_config and amp_songs_config files. More...

static Task	RemoveSongAsync (string unpackedPath, string[] songNames, bool delete, ProgressAction Log=null)
	Renives a song from the game data. More...

static Task	RemoveSongAsync (string unpackedPath, string songName, bool delete, ProgressAction Log=null)
	Renives a song from the game data. More...

static Task	RemoveSongAsync (string unpackedPath, string[] songNames, bool delete, ConsoleType consoleType, ProgressAction Log=null)
	Renives a song from the game data. More...

static Task	RemoveSongAsync (string unpackedPath, string songName, bool delete, ConsoleType consoleType, ProgressAction Log=null)
	Renives a song from the game data. More...

static Task	RemoveSongAsync (DirectoryInfo unpackedPath, string[] songNames, bool delete, ProgressAction Log=null)
	Renives a song from the game data. More...

static Task	RemoveSongAsync (DirectoryInfo unpackedPath, string songName, bool delete, ProgressAction Log=null)
	Renives a song from the game data. More...

static Task	RemoveSongAsync (DirectoryInfo unpackedPath, string songName, bool delete, ConsoleType consoleType, ProgressAction Log=null)
	Renives a song from the game data. More...

static Task	RemoveSongAsync (DirectoryInfo unpackedPath, string[] songNames, bool delete, ConsoleType consoleType, ProgressAction Log=null)
	Renives a series of songs from the game data. More...

static void	RemoveSong (string unpackedPath, string[] songNames, bool delete, ProgressAction Log=null)
	Renives a song from the game data. More...

static void	RemoveSong (string unpackedPath, string songName, bool delete, ProgressAction Log=null)
	Renives a song from the game data. More...

static void	RemoveSong (string unpackedPath, string[] songNames, bool delete, ConsoleType consoleType, ProgressAction Log=null)
	Renives a song from the game data. More...

static void	RemoveSong (string unpackedPath, string songName, bool delete, ConsoleType consoleType, ProgressAction Log=null)
	Renives a song from the game data. More...

static void	RemoveSong (DirectoryInfo unpackedPath, string[] songNames, bool delete, ProgressAction Log=null)
	Renives a song from the game data. More...

static void	RemoveSong (DirectoryInfo unpackedPath, string songName, bool delete, ProgressAction Log=null)
	Renives a song from the game data. More...

static void	RemoveSong (DirectoryInfo unpackedPath, string songName, bool delete, ConsoleType consoleType, ProgressAction Log=null)
	Renives a song from the game data. More...

static void	RemoveSong (DirectoryInfo unpackedPath, string[] songNames, bool delete, ConsoleType consoleType, ProgressAction Log=null)
	Renives a series of songs from the game data. More...

static Task< MoggSong[]>	GetSongsAsync (string unpackedPath, ProgressAction Log=null)
	Gets a list of songs from the game data. More...

static Task< MoggSong[]>	GetSongsAsync (string unpackedPath, ConsoleType consoleType, ProgressAction Log=null)
	Gets a list of songs from the game data. More...

static Task< MoggSong[]>	GetSongsAsync (DirectoryInfo unpackedPath, ProgressAction Log=null)
	Gets a list of songs from the game data. More...

static Task< MoggSong[]>	GetSongsAsync (DirectoryInfo unpackedPath, ConsoleType consoleType, ProgressAction Log=null)
	Gets a list of songs from the game data. More...

static MoggSong[]	GetSongs (string unpackedPath, ProgressAction Log=null)
	Gets a list of songs from the game data. More...

static MoggSong[]	GetSongs (string unpackedPath, ConsoleType consoleType, ProgressAction Log=null)
	Gets a list of songs from the game data. More...

static MoggSong[]	GetSongs (DirectoryInfo unpackedPath, ProgressAction Log=null)
	Gets a list of songs from the game data. More...

static MoggSong[]	GetSongs (DirectoryInfo unpackedPath, ConsoleType consoleType, ProgressAction Log=null)
	Gets a list of songs from the game data. More...

Detailed Description

Contains methods for adding, removing, and getting songs from the game data.

Member Function Documentation

◆ AddAllSongs() [1/4]

static void AmpHelper.Song.AddAllSongs	(	DirectoryInfo	unpackedPath,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

inlinestatic

Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

◆ AddAllSongs() [2/4]

static void AmpHelper.Song.AddAllSongs	(	DirectoryInfo	unpackedPath,
		ProgressAction	Log = `null`
	)

static

Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
Log	A ProgressAction for tracking progress.

◆ AddAllSongs() [3/4]

static void AmpHelper.Song.AddAllSongs	(	string	unpackedPath,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

◆ AddAllSongs() [4/4]

static void AmpHelper.Song.AddAllSongs	(	string	unpackedPath,
		ProgressAction	Log = `null`
	)

static

Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
Log	A ProgressAction for tracking progress.

◆ AddAllSongsAsync() [1/4]

static Task AmpHelper.Song.AddAllSongsAsync	(	DirectoryInfo	unpackedPath,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

◆ AddAllSongsAsync() [2/4]

static Task AmpHelper.Song.AddAllSongsAsync	(	DirectoryInfo	unpackedPath,
		ProgressAction	Log = `null`
	)

static

Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
Log	A ProgressAction for tracking progress.

◆ AddAllSongsAsync() [3/4]

static Task AmpHelper.Song.AddAllSongsAsync	(	string	unpackedPath,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

◆ AddAllSongsAsync() [4/4]

static Task AmpHelper.Song.AddAllSongsAsync	(	string	unpackedPath,
		ProgressAction	Log = `null`
	)

static

Adds all missing songs present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
Log	A ProgressAction for tracking progress.

◆ AddSong() [1/8]

static void AmpHelper.Song.AddSong	(	DirectoryInfo	unpackedPath,
		string	songName,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to add.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSong() [2/8]

static void AmpHelper.Song.AddSong	(	DirectoryInfo	unpackedPath,
		string	songName,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to add.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSong() [3/8]

static void AmpHelper.Song.AddSong	(	DirectoryInfo	unpackedPath,
		string[]	songNames,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

inlinestatic

Adds a series of songs already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to add.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSong() [4/8]

static void AmpHelper.Song.AddSong	(	DirectoryInfo	unpackedPath,
		string[]	songNames,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to add.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSong() [5/8]

static void AmpHelper.Song.AddSong	(	string	unpackedPath,
		string	songName,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to add.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSong() [6/8]

static void AmpHelper.Song.AddSong	(	string	unpackedPath,
		string	songName,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to add.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSong() [7/8]

static void AmpHelper.Song.AddSong	(	string	unpackedPath,
		string[]	songNames,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to add.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSong() [8/8]

static void AmpHelper.Song.AddSong	(	string	unpackedPath,
		string[]	songNames,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to add.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSongAsync() [1/8]

static Task AmpHelper.Song.AddSongAsync	(	DirectoryInfo	unpackedPath,
		string	songName,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to add.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSongAsync() [2/8]

static Task AmpHelper.Song.AddSongAsync	(	DirectoryInfo	unpackedPath,
		string	songName,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to add.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSongAsync() [3/8]

static Task AmpHelper.Song.AddSongAsync	(	DirectoryInfo	unpackedPath,
		string[]	songNames,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds a series of songs already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to add.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSongAsync() [4/8]

static Task AmpHelper.Song.AddSongAsync	(	DirectoryInfo	unpackedPath,
		string[]	songNames,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to add.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSongAsync() [5/8]

static Task AmpHelper.Song.AddSongAsync	(	string	unpackedPath,
		string	songName,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to add.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSongAsync() [6/8]

static Task AmpHelper.Song.AddSongAsync	(	string	unpackedPath,
		string	songName,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to add.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSongAsync() [7/8]

static Task AmpHelper.Song.AddSongAsync	(	string	unpackedPath,
		string[]	songNames,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to add.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ AddSongAsync() [8/8]

static Task AmpHelper.Song.AddSongAsync	(	string	unpackedPath,
		string[]	songNames,
		ProgressAction	Log = `null`
	)

static

Adds a song already present in the songs folder of the game files into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to add.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ GetSongs() [1/4]

static MoggSong[] AmpHelper.Song.GetSongs	(	DirectoryInfo	unpackedPath,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

inlinestatic

Gets a list of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
consoleType	The console type
Log	A ProgressAction for tracking progress.

Returns: An array of MoggSong objects.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ GetSongs() [2/4]

static MoggSong[] AmpHelper.Song.GetSongs	(	DirectoryInfo	unpackedPath,
		ProgressAction	Log = `null`
	)

static

Gets a list of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
Log	A ProgressAction for tracking progress.

Returns: An array of MoggSong objects.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ GetSongs() [3/4]

static MoggSong[] AmpHelper.Song.GetSongs	(	string	unpackedPath,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Gets a list of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
consoleType	The console type
Log	A ProgressAction for tracking progress.

Returns: An array of MoggSong objects.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ GetSongs() [4/4]

static MoggSong[] AmpHelper.Song.GetSongs	(	string	unpackedPath,
		ProgressAction	Log = `null`
	)

static

Gets a list of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
Log	A ProgressAction for tracking progress.

Returns: An array of MoggSong objects.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ GetSongsAsync() [1/4]

static Task< MoggSong[]> AmpHelper.Song.GetSongsAsync	(	DirectoryInfo	unpackedPath,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Gets a list of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
consoleType	The console type
Log	A ProgressAction for tracking progress.

Returns: An array of MoggSong objects.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ GetSongsAsync() [2/4]

static Task< MoggSong[]> AmpHelper.Song.GetSongsAsync	(	DirectoryInfo	unpackedPath,
		ProgressAction	Log = `null`
	)

static

Gets a list of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
Log	A ProgressAction for tracking progress.

Returns: An array of MoggSong objects.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ GetSongsAsync() [3/4]

static Task< MoggSong[]> AmpHelper.Song.GetSongsAsync	(	string	unpackedPath,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Gets a list of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
consoleType	The console type
Log	A ProgressAction for tracking progress.

Returns: An array of MoggSong objects.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ GetSongsAsync() [4/4]

static Task< MoggSong[]> AmpHelper.Song.GetSongsAsync	(	string	unpackedPath,
		ProgressAction	Log = `null`
	)

static

Gets a list of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
Log	A ProgressAction for tracking progress.

Returns: An array of MoggSong objects.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException
DtxException

◆ ImportSong() [1/10]

static void AmpHelper.Song.ImportSong	(	DirectoryInfo	unpackedPath,
		DirectoryInfo	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [2/10]

static void AmpHelper.Song.ImportSong	(	DirectoryInfo	unpackedPath,
		DirectoryInfo	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [3/10]

static void AmpHelper.Song.ImportSong	(	DirectoryInfo	unpackedPath,
		FileInfo	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

inlinestatic

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [4/10]

static void AmpHelper.Song.ImportSong	(	DirectoryInfo	unpackedPath,
		FileInfo	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [5/10]

static void AmpHelper.Song.ImportSong	(	string	unpackedPath,
		DirectoryInfo	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The path to a directory containing the .moggsong file.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [6/10]

static void AmpHelper.Song.ImportSong	(	string	unpackedPath,
		DirectoryInfo	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The path to a directory containing the .moggsong file.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [7/10]

static void AmpHelper.Song.ImportSong	(	string	unpackedPath,
		FileInfo	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [8/10]

static void AmpHelper.Song.ImportSong	(	string	unpackedPath,
		FileInfo	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [9/10]

static void AmpHelper.Song.ImportSong	(	string	unpackedPath,
		string	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

inlinestatic

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song, or the directory containing it.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSong() [10/10]

static void AmpHelper.Song.ImportSong	(	string	unpackedPath,
		string	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

inlinestatic

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song, or the directory containing it.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [1/10]

static Task AmpHelper.Song.ImportSongAsync	(	DirectoryInfo	unpackedPath,
		DirectoryInfo	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [2/10]

static Task AmpHelper.Song.ImportSongAsync	(	DirectoryInfo	unpackedPath,
		DirectoryInfo	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [3/10]

static Task AmpHelper.Song.ImportSongAsync	(	DirectoryInfo	unpackedPath,
		FileInfo	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [4/10]

static Task AmpHelper.Song.ImportSongAsync	(	DirectoryInfo	unpackedPath,
		FileInfo	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [5/10]

static Task AmpHelper.Song.ImportSongAsync	(	string	unpackedPath,
		DirectoryInfo	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The path to a directory containing the .moggsong file.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [6/10]

static Task AmpHelper.Song.ImportSongAsync	(	string	unpackedPath,
		DirectoryInfo	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The path to a directory containing the .moggsong file.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [7/10]

static Task AmpHelper.Song.ImportSongAsync	(	string	unpackedPath,
		FileInfo	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [8/10]

static Task AmpHelper.Song.ImportSongAsync	(	string	unpackedPath,
		FileInfo	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [9/10]

static Task AmpHelper.Song.ImportSongAsync	(	string	unpackedPath,
		string	moggsong,
		bool	replace,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song, or the directory containing it.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ImportSongAsync() [10/10]

static Task AmpHelper.Song.ImportSongAsync	(	string	unpackedPath,
		string	moggsong,
		bool	replace,
		ProgressAction	Log = `null`
	)

static

Copies the song into the songs folder of the game, and adds it into the amp_config and amp_songs_config files.

Parameters

unpackedPath	Path to the unpacked files.
moggsong	The .moggsong file of the song, or the directory containing it.
replace	If any existing song with the same name should be replaced. An exception will be thrown if one exists and this is false.
Log	A ProgressAction for tracking progress.

Exceptions

FormatException	Thrown when the song file name does not have a .moggsong extension.
ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSong() [1/8]

static void AmpHelper.Song.RemoveSong	(	DirectoryInfo	unpackedPath,
		string	songName,
		bool	delete,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to remove.
delete	If the song path should be deleted from the game files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSong() [2/8]

static void AmpHelper.Song.RemoveSong	(	DirectoryInfo	unpackedPath,
		string	songName,
		bool	delete,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to remove.
delete	If the song path should be deleted from the game files.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSong() [3/8]

static void AmpHelper.Song.RemoveSong	(	DirectoryInfo	unpackedPath,
		string[]	songNames,
		bool	delete,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

inlinestatic

Renives a series of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The namse of the songs to remove.
delete	If the song path should be deleted from the game files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSong() [4/8]

static void AmpHelper.Song.RemoveSong	(	DirectoryInfo	unpackedPath,
		string[]	songNames,
		bool	delete,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to remove.
delete	If the song path should be deleted from the game files.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSong() [5/8]

static void AmpHelper.Song.RemoveSong	(	string	unpackedPath,
		string	songName,
		bool	delete,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to remove.
delete	If the song path should be deleted from the game files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSong() [6/8]

static void AmpHelper.Song.RemoveSong	(	string	unpackedPath,
		string	songName,
		bool	delete,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to remove.
delete	If the song path should be deleted from the game files.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSong() [7/8]

static void AmpHelper.Song.RemoveSong	(	string	unpackedPath,
		string[]	songNames,
		bool	delete,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to remove.
delete	If the song path should be deleted from the game files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSong() [8/8]

static void AmpHelper.Song.RemoveSong	(	string	unpackedPath,
		string[]	songNames,
		bool	delete,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to remove.
delete	If the song path should be deleted from the game files.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSongAsync() [1/8]

static Task AmpHelper.Song.RemoveSongAsync	(	DirectoryInfo	unpackedPath,
		string	songName,
		bool	delete,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to remove.
delete	If the song path should be deleted from the game files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSongAsync() [2/8]

static Task AmpHelper.Song.RemoveSongAsync	(	DirectoryInfo	unpackedPath,
		string	songName,
		bool	delete,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to remove.
delete	If the song path should be deleted from the game files.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSongAsync() [3/8]

static Task AmpHelper.Song.RemoveSongAsync	(	DirectoryInfo	unpackedPath,
		string[]	songNames,
		bool	delete,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Renives a series of songs from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The namse of the songs to remove.
delete	If the song path should be deleted from the game files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSongAsync() [4/8]

static Task AmpHelper.Song.RemoveSongAsync	(	DirectoryInfo	unpackedPath,
		string[]	songNames,
		bool	delete,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to remove.
delete	If the song path should be deleted from the game files.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSongAsync() [5/8]

static Task AmpHelper.Song.RemoveSongAsync	(	string	unpackedPath,
		string	songName,
		bool	delete,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to remove.
delete	If the song path should be deleted from the game files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSongAsync() [6/8]

static Task AmpHelper.Song.RemoveSongAsync	(	string	unpackedPath,
		string	songName,
		bool	delete,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songName	The name of the song to remove.
delete	If the song path should be deleted from the game files.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSongAsync() [7/8]

static Task AmpHelper.Song.RemoveSongAsync	(	string	unpackedPath,
		string[]	songNames,
		bool	delete,
		ConsoleType	consoleType,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to remove.
delete	If the song path should be deleted from the game files.
consoleType	The console type.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ RemoveSongAsync() [8/8]

static Task AmpHelper.Song.RemoveSongAsync	(	string	unpackedPath,
		string[]	songNames,
		bool	delete,
		ProgressAction	Log = `null`
	)

static

Renives a song from the game data.

Parameters

unpackedPath	Path to the unpacked files.
songNames	The names of the songs to remove.
delete	If the song path should be deleted from the game files.
Log	A ProgressAction for tracking progress.

Exceptions

ArgumentNullException
DirectoryNotFoundException
FileNotFoundException

◆ ValidateSong()

static AggregateException AmpHelper.Song.ValidateSong	(	string	path,
		string	name = `null`,
		bool	throwError = `false`
	)

inlinestatic

Validates a song

Parameters

path	The path to the song.
name	The name of the song, this is usually the same as the folder containing it.
throwError	Throw errors, or return them.

Returns: An AggregateException of FileNotFoundException exceptions encountered during validation, or null if there are none.

Exceptions

AggregateException Only thrown if throwError == true.

◆ ValidateSongAsync()

static Task< AggregateException > AmpHelper.Song.ValidateSongAsync	(	string	path,
		string	name = `null`,
		bool	throwError = `false`
	)

static

Validates a song

Parameters

path	The path to the song.
name	The name of the song, this is usually the same as the folder containing it.
throwError	Throw errors, or return them.

Returns: An AggregateException of FileNotFoundException exceptions encountered during validation, or null if there are none.

Exceptions

AggregateException Only thrown if throwError == true.

The documentation for this class was generated from the following file:

AmpHelper.Library/Song.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddAllSongs() [1/4]

◆ AddAllSongs() [2/4]

◆ AddAllSongs() [3/4]

◆ AddAllSongs() [4/4]

◆ AddAllSongsAsync() [1/4]

◆ AddAllSongsAsync() [2/4]

◆ AddAllSongsAsync() [3/4]

◆ AddAllSongsAsync() [4/4]

◆ AddSong() [1/8]

◆ AddSong() [2/8]

◆ AddSong() [3/8]

◆ AddSong() [4/8]

◆ AddSong() [5/8]

◆ AddSong() [6/8]

◆ AddSong() [7/8]

◆ AddSong() [8/8]

◆ AddSongAsync() [1/8]

◆ AddSongAsync() [2/8]

◆ AddSongAsync() [3/8]

◆ AddSongAsync() [4/8]

◆ AddSongAsync() [5/8]

◆ AddSongAsync() [6/8]

◆ AddSongAsync() [7/8]

◆ AddSongAsync() [8/8]

◆ GetSongs() [1/4]

◆ GetSongs() [2/4]

◆ GetSongs() [3/4]

◆ GetSongs() [4/4]

◆ GetSongsAsync() [1/4]

◆ GetSongsAsync() [2/4]

◆ GetSongsAsync() [3/4]

◆ GetSongsAsync() [4/4]

◆ ImportSong() [1/10]

◆ ImportSong() [2/10]

◆ ImportSong() [3/10]

◆ ImportSong() [4/10]

◆ ImportSong() [5/10]

◆ ImportSong() [6/10]

◆ ImportSong() [7/10]

◆ ImportSong() [8/10]

◆ ImportSong() [9/10]

◆ ImportSong() [10/10]

◆ ImportSongAsync() [1/10]

◆ ImportSongAsync() [2/10]

◆ ImportSongAsync() [3/10]

◆ ImportSongAsync() [4/10]

◆ ImportSongAsync() [5/10]

◆ ImportSongAsync() [6/10]

◆ ImportSongAsync() [7/10]

◆ ImportSongAsync() [8/10]

◆ ImportSongAsync() [9/10]

◆ ImportSongAsync() [10/10]

◆ RemoveSong() [1/8]

◆ RemoveSong() [2/8]

◆ RemoveSong() [3/8]

◆ RemoveSong() [4/8]

◆ RemoveSong() [5/8]

◆ RemoveSong() [6/8]

◆ RemoveSong() [7/8]

◆ RemoveSong() [8/8]

◆ RemoveSongAsync() [1/8]

◆ RemoveSongAsync() [2/8]

◆ RemoveSongAsync() [3/8]

◆ RemoveSongAsync() [4/8]

◆ RemoveSongAsync() [5/8]

◆ RemoveSongAsync() [6/8]

◆ RemoveSongAsync() [7/8]

◆ RemoveSongAsync() [8/8]

◆ ValidateSong()

◆ ValidateSongAsync()