wavelength 1.0.0
Loading...
Searching...
No Matches
MCLoadSettingsTask Class Reference

Work that loads the GameOptions from the settings file of the directory at g_MemcardPath: read the card information, then load the file. More...

#include <mcloadsettingstask.h>

Inheritance diagram for MCLoadSettingsTask:
Collaboration diagram for MCLoadSettingsTask:

Public Member Functions

 ~MCLoadSettingsTask () override=default
 Destroy the object.
 MCLoadSettingsTask ()
 Construct the steps.
void Set (int nPort, GameOptions *pSettings)
 Prepare the work.
void OnFileLoaded () override
 Decode the loaded file into mSettings.
Public Member Functions inherited from MemcardSerialTask
 ~MemcardSerialTask () override=default
 Destroy the object.
int GetResult ()
 Report the outcome of the work.
virtual void OnDirListed ()
 Learn that a directory listing step ended.
virtual void OnCardInfo ()
 Learn that a card information step ended.
Public Member Functions inherited from SerialTasks
 ~SerialTasks () override
 Release the list and every task in it.
void Add (Task *pTask)
 Append a task, which the list then manages.
Public Member Functions inherited from Task
 Task ()
 Construct an idle task.
virtual ~Task ()
 Release the task.
int Poll ()
 Report the state after giving a running task one poll.
void Start ()
 Enter the running state and call OnStart(), unless the task is already running.
void Stop ()
 Call OnStop() when the task is running, and return to the idle state.
void Finish (bool bSucceeded)
 End the task from outside its poll, and call OnStop() when it was running.
int GetState () const
 Report mState.

Additional Inherited Members

Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...
Protected Member Functions inherited from MemcardSerialTask
void OnStop () override
 Record MemcardTask::sStatus in mResult.
Protected Member Functions inherited from SerialTasks
void OnStart () override
 Start the first task, or finish with success when the list is empty.
void OnStop () override
 Stop the task that runs now.
void OnPoll () override
 Poll the task that runs now, start the next one after it is done, and finish after the last one or after a failure.
const std::vector< std::unique_ptr< Task > > & GetTasks () const

Detailed Description

Work that loads the GameOptions from the settings file of the directory at g_MemcardPath: read the card information, then load the file.

The RTTI records the class as deriving from MemcardSerialTask. The object is 0x2c bytes.

Constructor & Destructor Documentation

◆ ~MCLoadSettingsTask()

MCLoadSettingsTask::~MCLoadSettingsTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003538f8
Ghidra address:
PAL: 0x003c0c00

◆ MCLoadSettingsTask()

MCLoadSettingsTask::MCLoadSettingsTask ( )

Construct the steps.

Ghidra address:
NTSC-U/C: 0x00162260
Ghidra address:
PAL: 0x00164f70

Member Function Documentation

◆ Set()

void MCLoadSettingsTask::Set ( int nPort,
GameOptions * pSettings )

Prepare the work.

Parameters
nPortThe memory card slot.
pSettingsReceives the settings.
Ghidra address:
NTSC-U/C: 0x001622f8
Ghidra address:
PAL: 0x00165008

◆ OnFileLoaded()

void MCLoadSettingsTask::OnFileLoaded ( )
overridevirtual

Decode the loaded file into mSettings.

Ghidra address:
NTSC-U/C: 0x00162398
Ghidra address:
PAL: 0x001650a8

Reimplemented from MemcardSerialTask.


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