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

Work that saves the GameOptions to the settings file of the Freq directory. More...

#include <mcsavesettingstask.h>

Inheritance diagram for MCSaveSettingsTask:
Collaboration diagram for MCSaveSettingsTask:

Public Member Functions

 ~MCSaveSettingsTask () override=default
 Destroy the object.
 MCSaveSettingsTask ()
 Construct the steps.
void Set (int nPort, GameOptions *pSettings, int nOverwrite)
 Prepare the work, and serialise the settings into g_pMemcardBuffer.
int GetNeeded ()
 Report the space a save that did not fit needed.
void OnSaveSpace (int nNeeded) override
 Prepare the directory and the file steps when the save fits, and otherwise fail the measurement.
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.
virtual void OnFileLoaded ()
 Learn that a file load 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 saves the GameOptions to the settings file of the Freq directory.

The RTTI records the class as deriving from MemcardSerialTask and from SaveSpaceUser at +0x20. The object is 0x50 bytes. The steps measure the space, create the directory, and save the file. A save that does not fit fails after the measurement, and GetNeeded() then reports the space it needed.

Constructor & Destructor Documentation

◆ ~MCSaveSettingsTask()

MCSaveSettingsTask::~MCSaveSettingsTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x003537f8
Ghidra address:
PAL: 0x003c0b00

◆ MCSaveSettingsTask()

MCSaveSettingsTask::MCSaveSettingsTask ( )

Construct the steps.

Ghidra address:
NTSC-U/C: 0x00162000
Ghidra address:
PAL: 0x00164d10

Member Function Documentation

◆ Set()

void MCSaveSettingsTask::Set ( int nPort,
GameOptions * pSettings,
int nOverwrite )

Prepare the work, and serialise the settings into g_pMemcardBuffer.

Parameters
nPortThe memory card slot.
pSettingsThe settings.
nOverwriteNon-zero when saved settings may be replaced.
Ghidra address:
NTSC-U/C: 0x001620c0
Ghidra address:
PAL: 0x00164dd0

◆ GetNeeded()

int MCSaveSettingsTask::GetNeeded ( )

Report the space a save that did not fit needed.

Returns
The kilobytes, or zero.
Ghidra address:
NTSC-U/C: 0x00162188
Ghidra address:
PAL: 0x00164e98

◆ OnSaveSpace()

void MCSaveSettingsTask::OnSaveSpace ( int nNeeded)
overridevirtual

Prepare the directory and the file steps when the save fits, and otherwise fail the measurement.

Parameters
nNeededThe kilobytes the save needs.
Ghidra address:
NTSC-U/C: 0x00162190
Ghidra address:
PAL: 0x00164ea0

Implements SaveSpaceUser.


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