Game-Decompilation/pmd-red
1
0
Fork 0
mirror of https://github.com/pret/pmd-red.git synced 2024-11-23 21:19:53 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Document script engine return values

Browse Source
This commit is contained in:
Mateusz Naściszewski 2024-07-23 09:07:58 +02:00
parent a2791c6dcf
commit 3ac1edf535
No known key found for this signature in database
GPG Key ID: 6A6067123E4CAF6E
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/ground_script_1.c
View File

@ -210,6 +210,19 @@ extern char gUnknown_81166D8[];
extern DebugLocation gUnknown_81166B4;
// Return values:
// This function returns what's likely an enum, which controls the state of the script engine state machine, and possibly provides information to code calling the engine.
// The enum is shared at least with HandleAction.
// This value is saved into the state field of the Action when returned from this function.
// - Value 0 indicates a RET on script engine level, HandleAction copies action->scriptData2 onto action->scriptData, and reinitializes scriptData2.
// If there is no active scriptData2 it clears and reinits scriptData.
// Ultimately returns code 3 to the script engine caller.
// Caveat: If the scripting engine is in state 0, HandleAction will immediately return 0 without performing any work.
// - Value 1 is a terminal state (script success? error?), no further scripting progress will happen. This code is always returned to the caller from now on.
// - Value 2 gives control back to the HandleAction function (entry point into the scripting engine state machine)
// This is the only return value that does not return to the script engine caller
// - Value 3 returns to the caller, but will give control back to ExecuteScriptCommand when reentering the script ("script not finished")
// - Value 4 is some kind of fatal error state, no further scripting progress will happen. This code is always returned to the caller from now on.
s32 ExecuteScriptCommand(Action *action) {
ScriptCommand curCmd;
ScriptData *scriptData = &action->scriptData;
@ -1839,18 +1852,18 @@ s32 ExecuteScriptCommand(Action *action) {
}
case 0xee: { // RESTORE_SAVED
if (scriptData->savedScript.ptr == NULL) {
return 0; // huh?
return 0;
}
scriptData->script = scriptData->savedScript;
scriptData->savedScript.ptr = NULL;
scriptData->savedScript.ptr2 = NULL;
break;
}
case 0xef: // RETURN_FALSE
return 0; // success
case 0xf0: // RETURN_TRUE
return 1; // error?
case 0xf1: // RETURN_ERROR
case 0xef:
return 0;
case 0xf0:
return 1;
case 0xf1:
return 4; // fatal error?
case 0xf2: case 0xf3: case 0xf4: case 0xf5: case 0xf6: {
// Debug, not in release ROM