#ifndef POKEPLATINUM_TRAINER_DATA_H
#define POKEPLATINUM_TRAINER_DATA_H

#include "generated/trainer_message_types.h"

#include "struct_defs/trainer.h"

#include "field_battle_data_transfer.h"
#include "savedata.h"
#include "string_gf.h"

enum TrainerDataParam {
    TRDATA_TYPE = 0,
    TRDATA_CLASS,
    TRDATA_SPRITE,
    TRDATA_PARTY_SIZE,
    TRDATA_ITEM_1,
    TRDATA_ITEM_2,
    TRDATA_ITEM_3,
    TRDATA_ITEM_4,
    TRDATA_AI_MASK,
    TRDATA_BATTLE_TYPE,
};

/**
 * @brief Initialize the Trainer structs within the FieldBattleDTO struct.
 *
 * This routine is responsible for loading the name of a trainer and building
 * their party from the data archives.
 *
 * @param dto  The parent FieldBattleDTO struct for the encounter.
 * @param save          Save data; used to pull out the rival's name, if needed.
 * @param heapID        Heap on which to allocate message bank access.
 */
void Trainer_Encounter(FieldBattleDTO *dto, const SaveData *saveData, enum HeapID heapID);

/**
 * @brief Get a parameter for the given trainer ID from the data archive.
 *
 * @param trainerID     ID of the trainer whose data should be retrieved.
 * @param paramID       ID of the data field to be retrieved.
 * @return Value of the trainer's data field in the archive.
 */
u32 Trainer_LoadParam(int trainerID, enum TrainerDataParam paramID);

/**
 * @brief Check if the given trainer has a message of the specified type.
 *
 * @param trainerID     ID of the trainer being queried.
 * @param msgType       The type of message for which we are looking.
 * @param heapID        Heap on which to allocate archive access.
 * @return TRUE if the trainer has a message of the given type; FALSE if not.
 */
BOOL Trainer_HasMessageType(int trainerID, enum TrainerMessageType msgType, enum HeapID heapID);

/**
 * @brief Load the trainer's message of a given type into the provided String.
 *
 * If no such message exists, then the String will be cleared.
 *
 * @param trainerID     ID of the trainer being queried.
 * @param msgType       The type of message for which we are looking.
 * @param[out] string   String which will contain the result message.
 * @param heapID        Heap on which to allocate archive access.
 */
void Trainer_LoadMessage(int trainerID, enum TrainerMessageType msgType, String *string, enum HeapID heapID);

/**
 * @brief Load data for the requested trainer.
 *
 * @param trainerID     ID of the trainer to be loaded.
 * @param[out] trdata   Struct which will contain the loaded trainer data.
 */
void Trainer_Load(int trainerID, Trainer *trdata);

/**
 * @brief Load data for the requested trainer's party.
 *
 * The struct pointer passed to this function will determine exactly how much
 * data is loaded; see the definitions of the various TrainerMon... structs in
 * struct_defs/trainer.h for exact specifications.
 *
 * @param trainerID     ID of the trainer whose party is to be loaded.
 * @param[out] trparty  Struct which will contain the loaded trainer party data.
 */
void Trainer_LoadParty(int trainerID, void *trparty);

/**
 * @brief Get the gender for a particular trainer class.
 *
 * @param trclass       Class of the trainer.
 * @return Gender identifier for the trainer class; see: enum Gender.
 */
u8 TrainerClass_Gender(int trclass);

#endif // POKEPLATINUM_TRAINER_DATA_H