Method ScriptError

Source/script.cpp:11711–11762

ResultType Script::ScriptError(char *aErrorText, char *aExtraInfo) //, ResultType aErrorType)
// Even though this is a Script method, including it here since it shares
// a common theme with the other error-displaying functions:
{
	if (mCurrLine)
		// If a line is available, do LineError instead since it's more specific.
		// If an error occurs before the script is ready to run, assume it's always critical
		// in the sense that the program will exit rather than run the script.
		// Update: It's okay to return FAIL in this case.  CRITICAL_ERROR should
		// be avoided whenever OK and FAIL are sufficient by themselves, because
		// otherwise, callers can't use the NOT operator to detect if a function
		// failed (since FAIL is value zero, but CRITICAL_ERROR is non-zero):
		return mCurrLine->LineError(aErrorText, FAIL, aExtraInfo);
	// Otherwise: The fact that mCurrLine is NULL means that the line currently being loaded
	// has not yet been successfully added to the linked list.  Such errors will always result
	// in the program exiting.
	if (!aErrorText)
		aErrorText = "Unknown Error";
	if (!aExtraInfo) // In case the caller explicitly called it with NULL.
		aExtraInfo = "";

	if (g_script.mErrorStdOut && !g_script.mIsReadyToExecute) // i.e. runtime errors are always displayed via dialog.
	{
		// See LineError() for details.
		printf("%s (%d): ==> %s\n", Line::sSourceFile[mCurrFileNumber], mCurrLineNumber, aErrorText);
		if (*aExtraInfo)
			printf("     Specifically: %s\n", aExtraInfo);
	}
	else
	{
		char source_file[MAX_PATH * 2];
		if (mCurrFileNumber)
			snprintf(source_file, sizeof(source_file), " in #include file \"%s\"", Line::sSourceFile[mCurrFileNumber]);
		else
			*source_file = '\0'; // Don't bother cluttering the display if it's the main script file.

		char buf[MSGBOX_TEXT_SIZE];
		snprintf(buf, sizeof(buf), "Error at line %u%s%s." // Don't call it "critical" because it's usually a syntax error.
			"\n\nLine Text: %-1.100s%s"
			"\nError: %-1.500s"
			"\n\n%s"
			, mCurrLineNumber, source_file, mCurrLineNumber ? "" : " (unknown)"
			, aExtraInfo // aExtraInfo defaults to "" so this is safe.
			, strlen(aExtraInfo) > 100 ? "..." : ""
			, aErrorText
			, mIsRestart ? OLD_STILL_IN_EFFECT : WILL_EXIT
			);
		//ShowInEditor();
		MsgBox(buf);
	}
	return FAIL; // See above for why it's better to return FAIL than CRITICAL_ERROR.
}