mirror of
https://github.com/pret/pokeplatinum.git
synced 2026-03-21 17:55:13 -05:00
131 lines
4.4 KiB
C
131 lines
4.4 KiB
C
#ifndef POKEPLATINUM_SAVEDATA_LOAD_HELPERS_H
|
|
#define POKEPLATINUM_SAVEDATA_LOAD_HELPERS_H
|
|
|
|
#include "constants/savedata/save_table.h"
|
|
|
|
#include "struct_decls/struct_020308A0_decl.h"
|
|
#include "struct_defs/struct_0202440C.h"
|
|
#include "struct_defs/struct_0202F264.h"
|
|
|
|
#include "hall_of_fame_entries.h"
|
|
#include "mystery_gift.h"
|
|
#include "pc_boxes.h"
|
|
#include "savedata.h"
|
|
#include "unk_0202EEC0.h"
|
|
|
|
typedef int (*SaveEntrySizeFunc)(void);
|
|
typedef void (*SaveEntryInitFunc)(void *);
|
|
|
|
typedef struct SaveTableEntry {
|
|
int dataID; //< Canonical ID for the entry. Used by external functions to retrieve it from the table.
|
|
u32 blockID; //< Block ID for the entry. Specifies what block of the save data the entry is stored in.
|
|
SaveEntrySizeFunc sizeFunc; //< Function for determining how large the entry is.
|
|
SaveEntryInitFunc initFunc; //< Function for initializing an empty entry.
|
|
} SaveTableEntry;
|
|
|
|
extern const SaveTableEntry gSaveTable[];
|
|
extern const int gSaveTableSize;
|
|
extern const SaveTableEntry gExtraSaveTable[];
|
|
extern const int gExtraSaveTableSize;
|
|
|
|
/**
|
|
* @brief Loads the TVBroadcast sector of the save data.
|
|
*
|
|
* This routine also performs a standard CRC of the sector before loading it.
|
|
*
|
|
* @param saveData
|
|
* @return Address of the TVBroadcast sector of the save data.
|
|
*/
|
|
TVBroadcast *SaveData_GetTVBroadcast(SaveData *saveData);
|
|
|
|
/**
|
|
* @brief Loads the PCBoxes sector of the save data.
|
|
*
|
|
* This routine does NOT perform any CRC on the sectors before loading them.
|
|
*
|
|
* @param saveData
|
|
* @return Address of the PCBoxes sector of the save data.
|
|
*/
|
|
PCBoxes *SaveData_GetPCBoxes(SaveData *saveData);
|
|
|
|
/**
|
|
* @brief Loads the MysteryGift sector of the save data.
|
|
*
|
|
* This routine also performs a standard CRC of the sector before loading it.
|
|
*
|
|
* @param saveData
|
|
* @return Address of the MysteryGift sector of the save data.
|
|
*/
|
|
MysteryGift *SaveData_GetMysteryGift(SaveData *saveData);
|
|
|
|
/**
|
|
* @brief Loads the MigratedPokemon sector of the save data.
|
|
*
|
|
* This routine does NOT perform any CRC on the sectors before loading them.
|
|
*
|
|
* @param saveData
|
|
* @return Address of the MigratedPokemon sector of the save data.
|
|
*/
|
|
MigratedPokemon *SaveData_GetPalParkTransfer(SaveData *saveData);
|
|
|
|
/**
|
|
* @brief Loads the HallOfFame sector from the extended save data.
|
|
*
|
|
* @param saveData The save data.
|
|
* @param heapID Heap on which to allocate the HallOfFame sector.
|
|
* @param resultCode Load-result opcode output.
|
|
* @return Address of the allocated HallOfFame data.
|
|
*/
|
|
HallOfFame *SaveData_HallOfFame(SaveData *saveData, enum HeapID heapID, int *resultCode);
|
|
|
|
/**
|
|
* @brief Saves a mirror of the given HallOfFame data into the extended save.
|
|
*
|
|
* @param saveData The save data.
|
|
* @param hof The hall-of-fame data to save.
|
|
* @return Save-result opcode.
|
|
*/
|
|
int SaveData_SaveHallOfFame(SaveData *saveData, HallOfFame *hof);
|
|
|
|
/**
|
|
* @brief Loads the BattleRecording sector from the extended save data.
|
|
*
|
|
* @param saveData The save data.
|
|
* @param heapID Heap on which to allocate the BattleRecording sector.
|
|
* @param resultCode Load-result opcode output.
|
|
* @param recNum Which recording slot to load.
|
|
* @return Address of the allocated BattleRecording data.
|
|
*/
|
|
BattleRecording *SaveData_BattleRecording(SaveData *saveData, enum HeapID heapID, int *resultCode, int recNum);
|
|
|
|
/**
|
|
* @brief Saves a mirror of the given BattleRecording data into the extended save.
|
|
*
|
|
* @param saveData The save data.
|
|
* @param rec The battle recording data to save.
|
|
* @param recNum Which recording slot to save.
|
|
* @return Save-result opcode.
|
|
*/
|
|
int SaveData_SaveBattleRecording(SaveData *saveData, BattleRecording *rec, int recNum);
|
|
|
|
/**
|
|
* @brief Loads the BattleFrontierStage sector from the extended save data.
|
|
*
|
|
* @param saveData The save data.
|
|
* @param heapID Heap on which to allocate the BattleRecording sector.
|
|
* @param resultCode Load-result opcode output.
|
|
* @return Address of the allocated BattleFrontierStage data.
|
|
*/
|
|
BattleFrontierStage *SaveData_BattleFrontierStage(SaveData *saveData, enum HeapID heapID, int *resultCode);
|
|
|
|
/**
|
|
* @brief Saves a mirror of the given BattleRecording data into the extended save.
|
|
*
|
|
* @param saveData The save data.
|
|
* @param frontier The battle frontier data to save.
|
|
* @return Save-result opcode.
|
|
*/
|
|
int SaveData_SaveBattleFrontierStage(SaveData *saveData, BattleFrontierStage *frontier);
|
|
|
|
#endif // POKEPLATINUM_SAVEDATA_LOAD_HELPERS_H
|