Error Codes Reference#
A variety of error codes are used throughout the engine. Various engine function calls will return one of these codes. In the event of an error, you'll see one of these referenced either in one of the report files or in the form of a dialog should there be a fatal error. The full list of error codes can be found here.
Warning/Non-Error Codes (>= 0
)#
Error Code | Name | Description |
---|---|---|
0 |
Success_OK | The operation was completed successfully. |
Error Codes (< 0
)#
Generic Errors (-1
to -39
)#
These are general-purpose error codes.
Error Code | Name | Description |
---|---|---|
-1 |
Error_Generic | A generic error code, indicating only the failure of an operation and nothing more. |
-2 |
Error_FileNotFound | Indicates that a required file could not be located. |
-3 |
Error_ResourceNotFound | Indicates that a Win32 resource could not be located within a given module. |
-4 |
Error_FileInvalid | Indicates that the file is invalid, usually due to containing improper or badly formatted data. |
-5 |
Error_ItemAlreadyExists | Indicates that an item tried to created, but it already exists. This is not specific to files, and can be any object. |
Initialization Errors (-40
to -79
)#
These errors are errors that occur during early engine initialization. In some cases, these may not be logged or displayed as they may occur before either of those systems are loaded and available (though this is rare).
Error Code | Name | Description |
---|---|---|
-40 |
Error_Init_SDL2_OpenGL_Failed | Indicates that SDL2 failed to initialize when using the OpenGL3 rendering backend. |
-41 |
Error_Init_ImGui_OpenGL_Failed | Indicates that ImGUI failed to initialize when using the OpenGL3 rendering backend. |
-42 |
Error_Init_SDL2_D3D_Failed | Indicates that SDL2 failed to initialize when using the Direct3D 11 rendering backend. |
-43 |
Error_Init_ImGui_D3D_Failed | Indicates that ImGUI failed to initialize when using the Direct3D 11 rendering backend. |
-44 |
Error_Reserved44 | Reserved for future use. |
-45 |
Error_Init_D3D11_Failed_Generic | Indicates a generic initialization error when using the Direct3D11 rendering backend. |
-46 |
Error_Init_OpenGL3_Failed_Generic | Indicates a generic initialization error when using the OpenGL3 rendering backend. |
-47 |
Error_Init_OpenGL3_CreateContext_Failed | Indicates that OpenGL3 failed to create the GL Context. |
Configuration Errors (-80
to -119
)#
These are errors that are specific to configuration files.
Error Code | Name | Description |
---|---|---|
-80 |
Error_Config_FileNotLoaded | Indicates that the configuration file was attempted to be accessed before the file was loaded. |
Module/Library Errors (-120
to -159
)#
These are errors that can occur when loading or interacting with dynamically-loaded modules or libraries.
Error Code | Name | Description |
---|---|---|
-120 |
Error_ModuleNotFound | Indicates that the specified module file could not be located. |
-121 |
Error_ModuleFunctionNotFound | Indicates that the specified function could not be located within the module. |
Plugin Errors#
These are errors that can occur when loading a plugin.
Error Code | Name | Description |
---|---|---|
-160 |
Error_Plugin_Generic | Indicates a generic error when loading a plugin. |
-161 |
Error_Plugin_MissingRequiredData | Indicates that the plugin is missing required data. This likely means that your plugins are unofficial, modified, corrupt, or were written for another program. |