jurjen.ladeniusandClaude Opus 4.8
f3340e86c6
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
87 lines
12 KiB
HTML
87 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>disk_save.h</title><link rel="stylesheet" type="text/css" href="../../styles/main.css" /><script type="text/javascript" src="../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../styles/");</script></head>
|
|
|
|
<!-- Generated by Natural Docs, version 2.2 -->
|
|
|
|
<!-- saved from url=(0016)http://localhost -->
|
|
|
|
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
|
|
|
|
<a name="Functions"></a><a name="Topic395"></a><div class="CTopic TGroup LC first">
|
|
<div class="CTitle">Functions</div>
|
|
</div>
|
|
|
|
<a name="DiskSave_Initialize"></a><a name="Topic396"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_Initialize</div>
|
|
<div id="NDPrototype396" class="NDPrototype"><div class="PSection PPlainSection">u8 DiskSave_Initialize()</div></div>
|
|
<div class="CBody"><p>Detect if a disk drive is present and valid disk is inserted</p><div class="CHeading">Return</div><p>SAVEDATA_NODRIVE if no disk drive is present SAVEDATA_NODISK if no disk is present SAVEDATA_VALID if a valid disk is present</p></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_SetName"></a><a name="Topic397"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_SetName</div>
|
|
<div id="NDPrototype397" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> DiskSave_SetName(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">name</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the base name of the save data file</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">name<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Pointer to the ASCIIZ string with the name (must be 6 characters max) The name will be used as the base for the save data file, e.g. "GAME" will create files like "GAME00.SAV", "GAME01.SAV", etc.</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_SetExtension"></a><a name="Topic398"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_SetExtension</div>
|
|
<div id="NDPrototype398" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> DiskSave_SetExtension(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">ext</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the extension of the save data file</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">ext<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Pointer to the ASCIIZ string with the extension (must be 3 characters max) The extension will be used for the save data file, e.g. "SAV" will create files like "GAME00.SAV", "GAME01.SAV", etc.</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_BuildFilename"></a><a name="Topic399"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_BuildFilename</div>
|
|
<div id="NDPrototype399" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> DiskSave_BuildFilename(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">entry,</td></tr><tr><td class="PType first">c8* </td><td class="PName last">buffer,</td></tr><tr><td class="PType first"><span class="SHKeyword">bool</span> </td><td class="PName last">pad</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Build the filename for a given save data entry</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">entry<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Save data entry</p></td></tr><tr><td class="CDLEntry">buffer<div class="CDLParameterType">c8*</div></td><td class="CDLDefinition"><p>Pointer to the buffer where the filename will be stored (must be at least 13 bytes long)</p></td></tr><tr><td class="CDLEntry">pad<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>If TRUE, the filename will be padded with spaces to fill 8 characters</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_Check"></a><a name="Topic400"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_Check</div>
|
|
<div id="NDPrototype400" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters">u8 DiskSave_Check(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">entry</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Check if a save data entry is valid</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">entry<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Save data entry</p></td></tr></table><div class="CHeading">Return</div><ul><li><p>SAVEDATA_NODISK if no disk is present</p></li><li><p>SAVEDATA_NOTFOUND if no save data is found</p></li><li><p>SAVEDATA_INVALID if save data is present but invalid</p></li><li><p>SAVEDATA_VALID if save data is valid</p></li></ul></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_Save"></a><a name="Topic401"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_Save</div>
|
|
<div id="NDPrototype401" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">bool</span> DiskSave_Save(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">u8 </td><td class="PName last">entry,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">data,</td></tr><tr><td class="first"></td><td class="PType">u16 </td><td class="PName last">size</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Save data to a file</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">entry<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Save data entry</p></td></tr><tr><td class="CDLEntry">data<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to the data to save</p></td></tr><tr><td class="CDLEntry">size<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Size of the data to save in bytes</p></td></tr></table><div class="CHeading">Return</div><p>FALSE if the save data could not be saved</p></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_Load"></a><a name="Topic402"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_Load</div>
|
|
<div id="NDPrototype402" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">bool</span> DiskSave_Load(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">entry,</td></tr><tr><td class="PType first">u8* </td><td class="PName last">data,</td></tr><tr><td class="PType first">u16 </td><td class="PName last">size</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Load saved data from a file</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">entry<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Save data entry</p></td></tr><tr><td class="CDLEntry">data<div class="CDLParameterType">u8*</div></td><td class="CDLDefinition"><p>Pointer to the buffer where the data will be loaded</p></td></tr><tr><td class="CDLEntry">size<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Size of the data to load in bytes</p></td></tr></table><div class="CHeading">Return</div><p>FALSE if the save data could not be loaded</p></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_Delete"></a><a name="Topic403"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_Delete</div>
|
|
<div id="NDPrototype403" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">bool</span> DiskSave_Delete(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">entry</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Delete saved data from a file</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">entry<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Save data entry</p></td></tr></table><div class="CHeading">Return</div><p>FALSE if the save data could not be deleted</p></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_GetFreeEntries"></a><a name="Topic404"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_GetFreeEntries</div>
|
|
<div id="NDPrototype404" class="NDPrototype"><div class="PSection PPlainSection">u8 DiskSave_GetFreeEntries()</div></div>
|
|
<div class="CBody"><p>Get the number of free save data entries available on the disk (for 1024 bytes max per entry)</p><div class="CHeading">Return</div><p>Number of free save data entries available on the current disk</p></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_AvailableDrives"></a><a name="Topic405"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_AvailableDrives</div>
|
|
<div id="NDPrototype405" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 DiskSave_AvailableDrives()</div></div>
|
|
<div class="CBody"><p>Get a bit field of all available disk drives</p><div class="CHeading">Return</div><p>Bit field of available drives (bit 0 for A, bit 1 for B, ..., bit 7 for H)</p></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_SelectDrive"></a><a name="Topic406"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DiskSave_SelectDrive</div>
|
|
<div id="NDPrototype406" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 DiskSave_SelectDrive(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">drive</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Select disk drive number</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">drive<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Disk drive number (0 for A, 1 for B, ..., 7 for H)</p></td></tr></table><div class="CHeading">Return</div><p>Number of available drives</p></div>
|
|
</div>
|
|
|
|
<a name="DiskSave_GetCurrentDrive"></a><a name="Topic407"></a><div class="CTopic TFunction LC last">
|
|
<div class="CTitle">DiskSave_GetCurrentDrive</div>
|
|
<div id="NDPrototype407" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 DiskSave_GetCurrentDrive()</div></div>
|
|
<div class="CBody"><p>Get current disk drive number</p><div class="CHeading">Return</div><p>Current drive number (0 for A, 1 for B, ..., 7 for H)</p></div>
|
|
</div>
|
|
|
|
</body></html> |