Error Codes ​
Almost all functions of the API can throw an error if an argument is invalid or certain conditions are not met. Each error has a specific error code and may provide additional information in the form of an error message. All possible error codes are listed and described on this page. To handle error codes and messages, use FxError.
Overview ​
| Code | Name | Description |
|---|---|---|
| 0 | FX_NO_ERROR | No error occured. |
| 101 | FX_FILE_FORMAT_UNSUPPORTED | A file format was unsupported for an import/export operation. |
| 102 | FX_FILE_NOT_FOUND | A specified file wasn't found by the file manager. |
| 103 | FX_FILE_OPERATION_FAILED | An OS file operation was unsuccessful. |
| 201 | FX_ITEM_INDEX_INVALID | An item index was out of range. |
| 202 | FX_ITEM_UNAVAILABLE | A specified item was unavailable. |
| 301 | FX_NODE_NOT_FOUND | Specified node of required type wasn't found in the open asset. |
| 401 | FX_PROJECT_NOT_FOUND | Specified project was not found. |
| 501 | FX_PROPERTY_INVALID | A specified property was either invalid or unavailable. |
| 502 | FX_TYPE_INVALID | A specified type was invalid or unsupported in the context. |
| 503 | FX_VALUE_INVALID | One of the arguments was an invalid value. |
| 601 | FX_REQUIRED_ASSET_UNAVAILABLE | A required open asset file was unavailable. |
| 602 | FX_REQUIRED_CHANNEL_UNAVAILABLE | A required animation channel was unavailable. |
| 603 | FX_REQUIRED_GRID_UNAVAILABLE | A required active pixel or voxel grid was unavailable. |
| 604 | FX_REQUIRED_FILE_UNAVAILABLE | A required open file was unavailable. |
| 605 | FX_REQUIRED_PROJECT_UNAVAILABLE | A required open project was unavailable. |
| 801 | FX_CUSTOM_ERROR | A custom error message was logged by the user. |
| 901 | FX_SYSTEM_ERROR | An unexpected error occured. |
FX_NO_ERROR 0 ​
No error occured.
Analysis ​
All good.
FX_FILE_FORMAT_UNSUPPORTED 101 ​
A file format was unsupported for an import/export operation.
Analysis ​
The file format for a file exchange operation is automatically determined by the passed filename. If emitted during an import operation then the import target doesn't support the file format. If emitted during an export operation then the export source can't be exported using the file format. Try to select a supported file format or use third party conversion.
FX_FILE_NOT_FOUND 102 ​
The specified file couldn't be found by the file manager.
Analysis ​
For most file operations the FileType is needed in addition to the FileID. The file manager only searches for FileIDs of given FileType. It's therefore crucial to pass the correct FileType.
If the FileID was a list, wildcard or filter then a file query may return no matching file. E.g. if you use the wildcard /s and no file is selected then this error will be emitted.
FX_FILE_OPERATION_FAILED 103 ​
An OS system level file operation was unsuccessful.
Analysis ​
Typical causes for file operation fails are missing file permissions or that the file is opened by another program.
FX_ITEM_INDEX_INVALID_INVALID 201 ​
The specified item index was out of range.
Analysis ​
For Color Palettes and Mini Sets the valid range is [0..255], for Material Sets it's [0..127].
FX_ITEM_UNAVAILABLE 202 ​
The specified item was unavailable.
Analysis ​
An item of a map is unavailable when it is empty. Items need to be made available by using the Add function of the corresponding module first.
FX_NODE_NOT_FOUND 301 ​
The specified node wasn't found in the open asset or didn't have the required type.
Analysis ​
If the NodeID was a list, wildcard or filter then the query for it may return no matching node. E.g. if you use the wildcard /s and no node is selected then this error will be emitted.
The required node type can be determined by the module name. E.g. while functions of the FxNode module support all node types the functions of the FxObject3D module only support nodes that inherit from Object3D. Refer to the Node Reference to learn about node type inheritance.
FX_PROJECT_NOT_FOUND 401 ​
The specified project couldn't be found or the project is invalid.
Analysis ​
This error occurs when no subfolder with the name passed to ProjectID is found in the projects folder or that subfolder isn't a valid project folder.
FX_PROPERTY_INVALID 501 ​
The specified property either didn't match a valid property name or it wasn't supported by the target.
Analysis ​
To check what properties are supported by files and nodes of a certain type check the [File Reference] and Node Reference.
FX_TYPE_INVALID 502 ​
The specified type was either an invalid value or the called function wasn't allowed to use it.
Analysis ​
Select a valid NodeType or FileType.
FX_VALUE_INVALID 503 ​
One of the arguments was an invalid value.
Analysis ​
Check the error message to learn what value was invalid and fix the offending call.
FX_REQUIRED_CHANNEL_UNAVAILABLE 601 ​
A function call required an animation channel for the specified node property but there was none.
Analysis ​
To animate a node's property an animation channel is required. Add the animation channel for the property and try again.
FX_REQUIRED_ASSET_UNAVAILABLE 602 ​
A function call required an open asset but there was none.
Analysis ​
Open an asset before using the function.
FX_REQUIRED_GRID_UNAVAILABLE 603 ​
A function call required an active pixel or voxel grid but there was none.
Analysis ​
Activate a pixel or voxel grid before using the function.
FX_REQUIRED_FILE_UNAVAILABLE 604 ​
A function call required an open file but there was none.
Analysis ​
Open a file before using the function.
FX_REQUIRED_PROJECT_UNAVAILABLE 605 ​
A function call required an open project but there was none.
Analysis ​
Open a project before using the function.
FX_CUSTOM_ERROR 801 ​
An error was logged by the user with the function FxLog.LogError.
Analysis ​
Your call.
FX_SYSTEM_ERROR 901 ​
An unexpected error occured.
Analysis ​
Unexpected errors are caused by bugs in the source code and not by the user.