assert( r >= 0 )
where r is the returned value is sufficient to pinpoint where the configuration failed.
If a function failed during the configuration, the Build()
method will always fail with a return code of asINVALID_CONFIGURATION. And unless you already verified the error codes for all the configuration calls, it will not be possible to determine what the error was.
// Verifying the return code with an assert is simple and won't pollute the code r = engine->RegisterGlobalFunction("void func()", asFUNCTION(func), asCALL_CDECL); assert( r >= 0 );
assert()
can safely be used with engine registrations, since the engine will set the internal state to invalid configuration if a function fails. Even in release mode the failure is discovered when a script is built.
Build()
, and ExecuteString()
, can only tell you that something was wrong, not what it was. To help identify the exact problem the message callback should be used. The script library will then send messages explaining the error or warning in clear text.For your convenience the library has been designed so that when there are no errors or warnings, nothing will be output to the stream.
// Implement a simple message callback function void MessageCallback(const asSMessageInfo *msg, void *param) { const char *type = "ERR "; if( msg->type == asMSGTYPE_WARNING ) type = "WARN"; else if( msg->type == asMSGTYPE_INFORMATION ) type = "INFO"; printf("%s (%d, %d) : %s : %s\n", msg->section, msg->row, msg->col, type, msg->message); } // Set the message callback when creating the engine asIScriptEngine *engine = asCreateScriptEngine(ANGELSCRIPT_VERSION); engine->SetMessageCallback(asFUNCTION(MessageCallback), 0, asCALL_CDECL);