dionmoustos/PokemonEmeraldSafariFrontier
1
0
Fork 0
Code Issues 21 Pull Requests Actions Packages Projects Releases Wiki Activity

Renaming Script Contexts

Browse Source 
- 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.
This commit is contained in:
tustin2121
2022-08-15 15:18:12 -04:00
parent 3dc3dc847f
commit 1cb659df8c
65 changed files with 438 additions and 409 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
src/field_screen_effect.c
View File

@@ -124,7 +124,7 @@ static void Task_WaitForUnionRoomFade(u8 taskId)
void FieldCB_ContinueScriptUnionRoom(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
Overworld_PlaySpecialMapMusic();
FadeInFromBlack();
CreateTask(Task_WaitForUnionRoomFade, 10);
@@ -135,13 +135,13 @@ static void Task_WaitForFadeAndEnableScriptCtx(u8 taskID)
if (WaitForWeatherFadeIn() == TRUE)
{
DestroyTask(taskID);
EnableBothScriptContexts();
ScriptContext_Enable();
}
}
void FieldCB_ContinueScriptHandleMusic(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
Overworld_PlaySpecialMapMusic();
FadeInFromBlack();
CreateTask(Task_WaitForFadeAndEnableScriptCtx, 10);
@@ -149,7 +149,7 @@ void FieldCB_ContinueScriptHandleMusic(void)
void FieldCB_ContinueScript(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
FadeInFromBlack();
CreateTask(Task_WaitForFadeAndEnableScriptCtx, 10);
}
@@ -174,7 +174,7 @@ static void Task_ReturnToFieldCableLink(u8 taskId)
case 2:
if (WaitForWeatherFadeIn() == TRUE)
{
ScriptContext2_Disable();
UnlockPlayerFieldControls();
DestroyTask(taskId);
}
break;
@@ -183,7 +183,7 @@ static void Task_ReturnToFieldCableLink(u8 taskId)
void FieldCB_ReturnToFieldCableLink(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
Overworld_PlaySpecialMapMusic();
FillPalBufferBlack();
CreateTask(Task_ReturnToFieldCableLink, 10);
@@ -215,7 +215,7 @@ static void Task_ReturnToFieldWirelessLink(u8 taskId)
if (WaitForWeatherFadeIn() == TRUE)
{
StartSendingKeysToLink();
ScriptContext2_Disable();
UnlockPlayerFieldControls();
DestroyTask(taskId);
}
break;
@@ -239,7 +239,7 @@ void Task_ReturnToFieldRecordMixing(u8 taskId)
case 2:
StartSendingKeysToLink();
ResetAllMultiplayerState();
ScriptContext2_Disable();
UnlockPlayerFieldControls();
DestroyTask(taskId);
break;
}
@@ -247,7 +247,7 @@ void Task_ReturnToFieldRecordMixing(u8 taskId)
void FieldCB_ReturnToFieldWirelessLink(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
Overworld_PlaySpecialMapMusic();
FillPalBufferBlack();
CreateTask(Task_ReturnToFieldWirelessLink, 10);
@@ -275,7 +275,7 @@ void FieldCB_DefaultWarpExit(void)
Overworld_PlaySpecialMapMusic();
WarpFadeInScreen();
SetUpWarpExitTask();
ScriptContext2_Enable();
LockPlayerFieldControls();
}
void FieldCB_WarpExitFadeFromWhite(void)
@@ -283,7 +283,7 @@ void FieldCB_WarpExitFadeFromWhite(void)
Overworld_PlaySpecialMapMusic();
FadeInFromWhite();
SetUpWarpExitTask();
ScriptContext2_Enable();
LockPlayerFieldControls();
}
void FieldCB_WarpExitFadeFromBlack(void)
@@ -292,7 +292,7 @@ void FieldCB_WarpExitFadeFromBlack(void)
Overworld_PlaySpecialMapMusic();
FadeInFromBlack();
SetUpWarpExitTask();
ScriptContext2_Enable();
LockPlayerFieldControls();
}
static void FieldCB_SpinEnterWarp(void)
@@ -301,7 +301,7 @@ static void FieldCB_SpinEnterWarp(void)
WarpFadeInScreen();
PlaySE(SE_WARP_OUT);
CreateTask(Task_SpinEnterWarp, 10);
ScriptContext2_Enable();
LockPlayerFieldControls();
}
static void FieldCB_MossdeepGymWarpExit(void)
@@ -310,7 +310,7 @@ static void FieldCB_MossdeepGymWarpExit(void)
WarpFadeInScreen();
PlaySE(SE_WARP_OUT);
CreateTask(Task_ExitNonDoor, 10);
ScriptContext2_Enable();
LockPlayerFieldControls();
SetObjectEventLoadFlag((~SKIP_OBJECT_EVENT_LOAD) & 0xF);
}
@@ -357,7 +357,7 @@ static void Task_ExitDoor(u8 taskId)
}
break;
case 4:
ScriptContext2_Disable();
UnlockPlayerFieldControls();
DestroyTask(taskId);
break;
}
@@ -395,7 +395,7 @@ static void Task_ExitNonAnimDoor(u8 taskId)
}
break;
case 3:
ScriptContext2_Disable();
UnlockPlayerFieldControls();
DestroyTask(taskId);
break;
}
@@ -407,14 +407,14 @@ static void Task_ExitNonDoor(u8 taskId)
{
case 0:
FreezeObjectEvents();
ScriptContext2_Enable();
LockPlayerFieldControls();
gTasks[taskId].tState++;
break;
case 1:
if (WaitForWeatherFadeIn())
{
UnfreezeObjectEvents();
ScriptContext2_Disable();
UnlockPlayerFieldControls();
DestroyTask(taskId);
}
break;
@@ -434,7 +434,7 @@ void ReturnToFieldOpenStartMenu(void)
{
FadeInFromBlack();
CreateTask(Task_WaitForFadeShowStartMenu, 0x50);
ScriptContext2_Enable();
LockPlayerFieldControls();
}
bool8 FieldCB_ReturnToFieldOpenStartMenu(void)
@@ -447,7 +447,7 @@ static void Task_ReturnToFieldNoScript(u8 taskId)
{
if (WaitForWeatherFadeIn() == 1)
{
ScriptContext2_Disable();
UnlockPlayerFieldControls();
DestroyTask(taskId);
ScriptUnfreezeObjectEvents();
}
@@ -455,14 +455,14 @@ static void Task_ReturnToFieldNoScript(u8 taskId)
void FieldCB_ReturnToFieldNoScript(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
FadeInFromBlack();
CreateTask(Task_ReturnToFieldNoScript, 10);
}
void FieldCB_ReturnToFieldNoScriptCheckMusic(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
Overworld_PlaySpecialMapMusic();
FadeInFromBlack();
CreateTask(Task_ReturnToFieldNoScript, 10);
@@ -483,7 +483,7 @@ static bool32 WaitForWeatherFadeIn(void)
void DoWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
TryFadeOutOldMapMusic();
WarpFadeOutScreen();
PlayRainStoppingSoundEffect();
@@ -494,7 +494,7 @@ void DoWarp(void)
void DoDiveWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
TryFadeOutOldMapMusic();
WarpFadeOutScreen();
PlayRainStoppingSoundEffect();
@@ -504,7 +504,7 @@ void DoDiveWarp(void)
void DoWhiteFadeWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
TryFadeOutOldMapMusic();
FadeScreen(FADE_TO_WHITE, 8);
PlayRainStoppingSoundEffect();
@@ -514,7 +514,7 @@ void DoWhiteFadeWarp(void)
void DoDoorWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
gFieldCallback = FieldCB_DefaultWarpExit;
CreateTask(Task_DoDoorWarp, 10);
}
@@ -527,19 +527,19 @@ void DoFallWarp(void)
void DoEscalatorWarp(u8 metatileBehavior)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
StartEscalatorWarp(metatileBehavior, 10);
}
void DoLavaridgeGymB1FWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
StartLavaridgeGymB1FWarp(10);
}
void DoLavaridgeGym1FWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
StartLavaridgeGym1FWarp(10);
}
@@ -548,7 +548,7 @@ void DoLavaridgeGym1FWarp(void)
// Used by teleporting tiles, e.g. in Aqua Hideout (For the move Teleport see FldEff_TeleportWarpOut)
void DoTeleportTileWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
TryFadeOutOldMapMusic();
WarpFadeOutScreen();
PlaySE(SE_WARP_IN);
@@ -559,7 +559,7 @@ void DoTeleportTileWarp(void)
void DoMossdeepGymWarp(void)
{
SetObjectEventLoadFlag(SKIP_OBJECT_EVENT_LOAD);
ScriptContext2_Enable();
LockPlayerFieldControls();
SaveObjectEvents();
TryFadeOutOldMapMusic();
WarpFadeOutScreen();
@@ -570,7 +570,7 @@ void DoMossdeepGymWarp(void)
void DoPortholeWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
WarpFadeOutScreen();
CreateTask(Task_WarpAndLoadMap, 10);
gFieldCallback = FieldCB_ShowPortholeView;
@@ -583,7 +583,7 @@ static void Task_DoCableClubWarp(u8 taskId)
switch (task->tState)
{
case 0:
ScriptContext2_Enable();
LockPlayerFieldControls();
task->tState++;
break;
case 1:
@@ -600,7 +600,7 @@ static void Task_DoCableClubWarp(u8 taskId)
void DoCableClubWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
TryFadeOutOldMapMusic();
WarpFadeOutScreen();
PlaySE(SE_EXIT);
@@ -651,7 +651,7 @@ static void Task_WarpAndLoadMap(u8 taskId)
{
case 0:
FreezeObjectEvents();
ScriptContext2_Enable();
LockPlayerFieldControls();
task->tState++;
break;
case 1:
@@ -735,7 +735,7 @@ static void Task_DoContestHallWarp(u8 taskId)
{
case 0:
FreezeObjectEvents();
ScriptContext2_Enable();
LockPlayerFieldControls();
task->tState++;
break;
case 1:
@@ -754,7 +754,7 @@ static void Task_DoContestHallWarp(u8 taskId)
void DoContestHallWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
TryFadeOutOldMapMusic();
WarpFadeOutScreen();
PlayRainStoppingSoundEffect();
@@ -916,7 +916,7 @@ static void Task_WaitForFlashUpdate(u8 taskId)
{
if (!FuncIsActiveTask(UpdateFlashLevelEffect))
{
EnableBothScriptContexts();
ScriptContext_Enable();
DestroyTask(taskId);
}
}
@@ -979,7 +979,7 @@ void AnimateFlash(u8 newFlashLevel)
fullBrightness = TRUE;
StartUpdateFlashLevelEffect(DISPLAY_WIDTH / 2, DISPLAY_HEIGHT / 2, sFlashLevelToRadius[curFlashLevel], sFlashLevelToRadius[newFlashLevel], fullBrightness, 1);
StartWaitForFlashUpdate();
ScriptContext2_Enable();
LockPlayerFieldControls();
}
void WriteFlashScanlineEffectBuffer(u8 flashLevel)
@@ -1003,7 +1003,7 @@ static void Task_SpinEnterWarp(u8 taskId)
{
case 0:
FreezeObjectEvents();
ScriptContext2_Enable();
LockPlayerFieldControls();
DoPlayerSpinEntrance();
gTasks[taskId].tState++;
break;
@@ -1011,7 +1011,7 @@ static void Task_SpinEnterWarp(u8 taskId)
if (WaitForWeatherFadeIn() && IsPlayerSpinEntranceActive() != TRUE)
{
UnfreezeObjectEvents();
ScriptContext2_Disable();
UnlockPlayerFieldControls();
DestroyTask(taskId);
}
break;
@@ -1026,7 +1026,7 @@ static void Task_SpinExitWarp(u8 taskId)
{
case 0:
FreezeObjectEvents();
ScriptContext2_Enable();
LockPlayerFieldControls();
PlaySE(SE_WARP_IN);
DoPlayerSpinExit();
task->tState++;
@@ -1054,7 +1054,7 @@ static void Task_SpinExitWarp(u8 taskId)
// DoTeleportTileWarp is used instead
void DoSpinEnterWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
CreateTask(Task_WarpAndLoadMap, 10);
gFieldCallback = FieldCB_SpinEnterWarp;
}
@@ -1063,7 +1063,7 @@ void DoSpinEnterWarp(void)
// Player exits current map by spinning up offscreen, enters new map with a fade in
void DoSpinExitWarp(void)
{
ScriptContext2_Enable();
LockPlayerFieldControls();
gFieldCallback = FieldCB_DefaultWarpExit;
CreateTask(Task_SpinExitWarp, 10);
}
@@ -1152,7 +1152,7 @@ static void Task_OrbEffect(u8 taskId)
case 2:
if (!FuncIsActiveTask(UpdateOrbFlashEffect))
{
EnableBothScriptContexts();
ScriptContext_Enable();
tState = 3;
}
break;
@@ -1200,7 +1200,7 @@ static void Task_OrbEffect(u8 taskId)
SetGpuReg(REG_OFFSET_BLDALPHA, tBldAlpha);
SetGpuReg(REG_OFFSET_WININ, tWinIn);
SetGpuReg(REG_OFFSET_WINOUT, tWinOut);
EnableBothScriptContexts();
ScriptContext_Enable();
DestroyTask(taskId);
break;
}
@@ -1263,6 +1263,6 @@ static void Task_EnableScriptAfterMusicFade(u8 taskId)
if (BGMusicStopped() == TRUE)
{
DestroyTask(taskId);
EnableBothScriptContexts();
ScriptContext_Enable();
}
}