sovereignx/include/apprentice.h

#ifndef GUARD_APPRENTICE_H
#define GUARD_APPRENTICE_H

#include "constants/apprentice.h"

struct ApprenticeTrainer
{
    u8 name[NUM_LANGUAGES - 1][PLAYER_NAME_LENGTH + 1]; // For all languages except the unused one.
    u16 otId;
    u8 facilityClass;
    u16 species[APPRENTICE_SPECIES_COUNT];
    u8 id;
    u16 speechLost[EASY_CHAT_BATTLE_WORDS_COUNT];
};

extern const struct ApprenticeTrainer gApprentices[];

void BufferApprenticeChallengeText(u8 saveApprenticeId);
void Apprentice_ScriptContext_Enable(void);
void ResetApprenticeStruct(struct Apprentice *apprentice);
void ResetAllApprenticeData(void);
void CallApprenticeFunction(void);
const u8 *GetApprenticeNameInLanguage(u32 apprenticeId, s32 language);

#endif // GUARD_APPRENTICE_H
Merge record mixing, pokemon and global with apprentice 2018-10-13 19:38:46 +01:00			`#ifndef GUARD_APPRENTICE_H`
			`#define GUARD_APPRENTICE_H`

WIP Document apprentice 2019-11-14 23:56:18 +00:00			`#include "constants/apprentice.h"`
Merge record mixing, pokemon and global with apprentice 2018-10-13 19:38:46 +01:00
			`struct ApprenticeTrainer`
			`{`
Document Apprentice 2019-11-20 22:36:52 +00:00			`u8 name[NUM_LANGUAGES - 1][PLAYER_NAME_LENGTH + 1]; // For all languages except the unused one.`
Merge record mixing, pokemon and global with apprentice 2018-10-13 19:38:46 +01:00			`u16 otId;`
Decompile apprentice 2018-10-14 10:37:44 +01:00			`u8 facilityClass;`
Merge record mixing, pokemon and global with apprentice 2018-10-13 19:38:46 +01:00			`u16 species[APPRENTICE_SPECIES_COUNT];`
Make frontier util compile 2018-10-30 21:17:03 +00:00			`u8 id;`
WIP Document Apprentice 2019-11-19 16:36:38 +00:00			`u16 speechLost[EASY_CHAT_BATTLE_WORDS_COUNT];`
Merge record mixing, pokemon and global with apprentice 2018-10-13 19:38:46 +01:00			`};`

			`extern const struct ApprenticeTrainer gApprentices[];`

Document Apprentice 2019-11-20 22:36:52 +00:00			`void BufferApprenticeChallengeText(u8 saveApprenticeId);`
Renaming Script Contexts - Determined how the various script contexts were used and renamed accordingly. - ScriptContext2_Enable/Disable => Lock/UnlockPlayerFieldControls - The sole purpose of the flag is to make sure the player can't move around in the overworld. It has nothing to do with script contexts. - ScriptContext1 => ScriptContext - It is the global script context used to set up scripts which run over many frames. - ScriptContext2_RunNewScript => RunScriptImmediately - ScriptContext2's sole purpose was to run scripts immediately and in a separate context, usually while the global context is waiting for things like map loads or screen changes. 2022-08-15 20:18:12 +01:00			`void Apprentice_ScriptContext_Enable(void);`
Finish documenting apprentice for now 2018-10-14 16:00:41 +01:00			`void ResetApprenticeStruct(struct Apprentice *apprentice);`
			`void ResetAllApprenticeData(void);`
			`void CallApprenticeFunction(void);`
Decompile apprentice 2018-10-14 10:37:44 +01:00			`const u8 *GetApprenticeNameInLanguage(u32 apprenticeId, s32 language);`

Merge record mixing, pokemon and global with apprentice 2018-10-13 19:38:46 +01:00			`#endif // GUARD_APPRENTICE_H`