The SSCLoader handles all of the parsing needed for .ssc files. More...

#include <NotesLoaderSSC.h>

Inheritance diagram for SSCLoader:

Collaboration diagram for SSCLoader:

Public Member Functions
bool	LoadFromSimfile (const std::string &sPath, Song &out, bool bFromCache=false) override
	Attempt to load the specified ssc file.

bool	LoadNoteDataFromSimfile (const std::string &cachePath, Steps &out) override
	Retrieve the specific NoteData from the file.

void	ProcessCombos (TimingData &, const std::string &line, const int=-1) override

Public Member Functions inherited from SMLoader
	SMLoader (std::string ext)

virtual bool	LoadFromDir (const std::string &sPath, Song &out)
	Attempt to load a song from a specified path.

virtual void	GetApplicableFiles (const std::string &sPath, std::vector< std::string > &out)
	Retrieve the list of .sm files.

virtual bool	LoadFromBGChangesString (BackgroundChange &change, const std::string &sBGChangeExpression)

void	ParseBPMs (std::vector< std::pair< float, float > > &out, const std::string &line, const int rowsPerBeat=-1)
	Parse BPM Changes data from a string.

void	ProcessBPMs (TimingData &out, const std::vector< std::pair< float, float > > &vBPMChanges)
	Process the BPM Segments from the string.

void	ParseStops (std::vector< std::pair< float, float > > &out, const std::string &line, const int rowsPerBeat=-1)
	Parse Stops data from a string.

void	ProcessStops (TimingData &out, const std::vector< std::pair< float, float > > &vStops)
	Process the Stop Segments from the data.

void	ProcessBPMsAndStops (TimingData &out, std::vector< std::pair< float, float > > &vBPMs, std::vector< std::pair< float, float > > &vStops)
	Process BPM and stop segments from the data.

void	ProcessDelays (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
	Process the Delay Segments from the string.

void	ProcessTimeSignatures (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
	Process the Time Signature Segments from the string.

void	ProcessTickcounts (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
	Process the Tickcount Segments from the string.

virtual void	ProcessSpeeds (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
	Process the Speed Segments from the string.

virtual void	ProcessFakes (TimingData &out, const std::string &line, const int rowsPerBeat=-1)
	Process the Fake Segments from the string.

virtual void	ProcessBGChanges (Song &out, const std::string &sValueName, const std::string &sPath, const std::string &sParam)

void	ProcessInstrumentTracks (Song &out, const std::string &sParam)

virtual void	SetSongTitle (const std::string &title)
	Set the song title.

virtual std::string	GetSongTitle () const
	Get the song title.

Static Public Member Functions
static void	ProcessBPMs (TimingData &, const std::string &sParam, const std::string &songName)

static void	ProcessStops (TimingData &, const std::string &sParam, const std::string &songName)

static void	ProcessWarps (TimingData &, const std::string &sParam, const float, const std::string &songName)

static void	ProcessLabels (TimingData &out, const std::string &sParam, const std::string &songName)

static void	ProcessCombos (TimingData &, const std::string &line, const std::string &songName, const int=-1)

static void	ProcessScrolls (TimingData &, const std::string sParam, const std::string &songName)

Static Public Member Functions inherited from SMLoader
static void	TidyUpData (Song &song, bool bFromCache)
	Perform some cleanup on the loaded song.

static void	ProcessDelays (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)

static void	ProcessTimeSignatures (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)

static void	ProcessTickcounts (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)

static void	ProcessSpeeds (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)

static void	ProcessFakes (TimingData &out, const std::string &line, const std::string &songname, const int rowsPerBeat=-1)

static float	RowToBeat (const std::string &line, const int rowsPerBeat)
	Convert a row value to the proper beat value.

Additional Inherited Members
Protected Member Functions inherited from SMLoader
virtual void	LoadFromTokens (std::string sStepsType, std::string sDescription, std::string sDifficulty, std::string sMeter, std::string sNoteData, Steps &out)
	Process the different tokens we have available to get NoteData.

std::string	GetFileExtension () const
	Retrieve the file extension associated with this loader.

std::string	GetChartPath () const
	Get the chart path.

Detailed Description

The SSCLoader handles all of the parsing needed for .ssc files.

Member Function Documentation

◆ LoadFromSimfile()

bool SSCLoader::LoadFromSimfile	(	const std::string &	sPath,
		Song &	out,
		bool	bFromCache = `false`
	)

overridevirtual

Attempt to load the specified ssc file.

Parameters

sPath	a const reference to the path on the hard drive to check.
out	a reference to the Song that will retrieve the song information.
bFromCache	a check to see if we are getting certain information from the cache file.

Returns: its success or failure.

Reimplemented from SMLoader.

◆ LoadNoteDataFromSimfile()

bool SSCLoader::LoadNoteDataFromSimfile	(	const std::string &	cachePath,
		Steps &	out
	)

overridevirtual

Retrieve the specific NoteData from the file.

Parameters

cachePath	the path to the cache file.
out	the Steps to receive just the particular notedata.

Returns: true if successful, false otherwise.

Reimplemented from SMLoader.

◆ ProcessCombos()

void SSCLoader::ProcessCombos	(	TimingData &	out,
		const std::string &	line,
		const int	rowsPerBeat = `-1`
	)

overridevirtual

Reimplemented from SMLoader.

The documentation for this struct was generated from the following files:

/home/runner/work/etterna/etterna/src/Etterna/Models/NoteLoaders/NotesLoaderSSC.h
/home/runner/work/etterna/etterna/src/Etterna/Models/NoteLoaders/NotesLoaderSSC.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ LoadFromSimfile()

◆ LoadNoteDataFromSimfile()

◆ ProcessCombos()