![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
A collection of system-wide constant enumerations.
All enumerations can be accessed by a corresponding Enum accessor.
Shapes of touch areas used in the input handler.
Murl.IEnums.TOUCH_AREA_SHAPE_RECTANGLE | A rectangular touch area. |
Murl.IEnums.TOUCH_AREA_SHAPE_ELLIPSE | An elliptical touch area. |
Murl.IEnums.TOUCH_AREA_SHAPE_MESH | A generic triangle mesh used for capturing input touches. |
Murl.IEnums.NUM_TOUCH_AREA_SHAPES |
Projection types used for both rendering and input handling.
Murl.IEnums.PROJECTION_TYPE_PERSPECTIVE | Perspective projection. |
Murl.IEnums.PROJECTION_TYPE_ORTHOGRAPHIC | Orthographic (i.e. parallel) projection. |
Murl.IEnums.NUM_PROJECTION_TYPES |
Globally defined result codes.
Murl.IEnums.RESULT_CODE_NONE | No error (success). |
Murl.IEnums.RESULT_CODE_UNSPECIFIED_ERROR | An unspecified (generic) error. |
Murl.IEnums.RESULT_CODE_VERSION_ERROR | A version error. |
Murl.IEnums.RESULT_CODE_PARSING_ERROR | Error during parsing a resource or file. |
Murl.IEnums.RESULT_CODE_FILE_ERROR | A general file error (not existing or read error). |
Murl.IEnums.RESULT_CODE_ATTRIBUTE_NUMBER_CONVERSION_ERROR | Error converting a numeric attribute value. |
Murl.IEnums.RESULT_CODE_ATTRIBUTE_ENUM_CONVERSION_ERROR | Error converting a attribute enum value. |
Murl.IEnums.RESULT_CODE_ATTRIBUTE_UNKNOWN_ERROR | Unknown attribute value. |
Murl.IEnums.RESULT_CODE_GRAPH_NODE_NOT_FOUND_ERROR | Referenced graph node not found. |
Murl.IEnums.RESULT_CODE_GRAPH_NODE_WRONG_INTERFACE_ERROR | Referenced graph node has wrong interface. |
Murl.IEnums.RESULT_CODE_RESOURCE_OBJECT_NOT_FOUND_ERROR | Referenced resource object not found. |
Murl.IEnums.RESULT_CODE_RESOURCE_OBJECT_WRONG_INTERFACE_ERROR | Referenced resource object has wrong interface. |
Murl.IEnums.RESULT_CODE_UNSPECIFIED_WARNING | An unspecified (generic) warning. |
Murl.IEnums.RESULT_CODE_UNSPECIFIED_INFO | An unspecified (generic) information message. |
Murl.IEnums.NUM_RESULT_CODES |
Possible actions to perform on a specific result code.
Murl.IEnums.RESULT_ACTION_UNDEFINED | Undefined action. |
Murl.IEnums.RESULT_ACTION_IGNORE | Ignore the result (do not warn and keep running). |
Murl.IEnums.RESULT_ACTION_WARN | Report a message, but keep running. |
Murl.IEnums.RESULT_ACTION_ABORT | Report a message and abort. |
Murl.IEnums.NUM_RESULT_ACTIONS |
Definition of the file access modes.
Murl.IEnums.FILE_ACCESS_MODE_READ_ONLY | Read only access. The file must exist. |
Murl.IEnums.FILE_ACCESS_MODE_WRITE_ONLY | Write only access. Create an empty file or erase an already existing file. |
Murl.IEnums.FILE_ACCESS_MODE_READ_AND_WRITE | Read and write access. Create an empty file or erase an already existing file. |
Murl.IEnums.FILE_ACCESS_MODE_APPEND_ONLY | Append access. Create an empty file if the file does not exist. All writing operations are performed at the end of the file. |
Murl.IEnums.FILE_ACCESS_MODE_READ_AND_APPEND | Read and append access. Create an empty file if the file does not exist. All writing operations are performed at the end of the file, the file position can be set to anywhere in the file for reading, writing operations will move the file position back to the end of file. |
Murl.IEnums.NUM_FILE_ACCESS_MODES |
Authorization status enumeration.
Murl.IEnums.AUTHORIZATION_NOT_DETERMINED | Authorization not determined. |
Murl.IEnums.AUTHORIZATION_RESTRICTED | Authorization is restricted by the system. |
Murl.IEnums.AUTHORIZATION_DENIED | Authorization is denied by user. |
Murl.IEnums.AUTHORIZATION_AUTHORIZED | Authorization is authorized. |
Murl.IEnums.NUM_AUTHORIZATIONS |
Socket error status enumeration.
Murl.IEnums.SOCKET_ERROR_NONE | No error. |
Murl.IEnums.SOCKET_ERROR_NOT_CONNECTED | Socket is not connected. |
Murl.IEnums.SOCKET_ERROR_RESET_BY_PEER | Connection was reset by peer. |
Murl.IEnums.SOCKET_ERROR_SEND_FAILED | Last send operation failed. |
Murl.IEnums.SOCKET_ERROR_RECEIVE_FAILED | Last receive operation failed. |
Murl.IEnums.SOCKET_ERROR_WOULD_BLOCK | Resource temporarily unavailable. |
Murl.IEnums.SOCKET_ERROR_IN_PROGRESS | Operation is in progress. |
Murl.IEnums.SOCKET_ERROR_FAILED | Last operation failed. |
Murl.IEnums.NUM_SOCKET_ERRORS |
Available resource types
Murl.IEnums.RESOURCE_TYPE_DEFAULT | Default resource type, use any suitable. |
Murl.IEnums.RESOURCE_TYPE_BINARY | Generic resource type, exposing raw binary contents. |
Murl.IEnums.RESOURCE_TYPE_ANIMATION | Animation resource. |
Murl.IEnums.RESOURCE_TYPE_ATLAS | Atlas resource. |
Murl.IEnums.RESOURCE_TYPE_FONT | Font resource. |
Murl.IEnums.RESOURCE_TYPE_GRAPH | Graph resource. |
Murl.IEnums.RESOURCE_TYPE_IMAGE | Image resource. |
Murl.IEnums.RESOURCE_TYPE_MESH | Mesh resource. |
Murl.IEnums.RESOURCE_TYPE_SHADER | Shader resource. |
Murl.IEnums.RESOURCE_TYPE_AUDIO | Audio resource. |
Murl.IEnums.RESOURCE_TYPE_ARCHIVE | Generic resource type storing compressed binary contents. |
Murl.IEnums.RESOURCE_TYPE_VIDEO | Video resource. |
Murl.IEnums.RESOURCE_TYPE_SCRIPT | Script resource. |
Murl.IEnums.RESOURCE_TYPE_UNKNOWN | Unknown resource. |
Murl.IEnums.RESOURCE_TYPE_PACKAGE | Package containing multiple resources and/or sub-packages. |
Murl.IEnums.RESOURCE_TYPE_DICTIONARY | Dictionary resource containing multiple key/value pairs. |
Murl.IEnums.RESOURCE_TYPE_GRID | Grid resource. |
Murl.IEnums.RESOURCE_TYPE_TEXT | Text resource. |
Murl.IEnums.NUM_RESOURCE_TYPES |
Available file types
Murl.IEnums.FILE_TYPE_DEFAULT | Default file type, use any suitable. |
Murl.IEnums.FILE_TYPE_UNKNOWN | Unknown file type. |
Murl.IEnums.FILE_TYPE_TXT | A text file. |
Murl.IEnums.FILE_TYPE_XML | XML file type. |
Murl.IEnums.FILE_TYPE_MURL | Native Murl binary. |
Murl.IEnums.FILE_TYPE_PNG | PNG image. |
Murl.IEnums.FILE_TYPE_JPG | JPEG image. |
Murl.IEnums.FILE_TYPE_WEBP | WEBP image. |
Murl.IEnums.FILE_TYPE_DDS | DDS (DirectX) image. |
Murl.IEnums.FILE_TYPE_ETC1 | ETC1 compressed image. |
Murl.IEnums.FILE_TYPE_PVR | PVRTC compressed image. |
Murl.IEnums.FILE_TYPE_TGA | TGA image. |
Murl.IEnums.FILE_TYPE_TIF | TIFF image. |
Murl.IEnums.FILE_TYPE_WAV | Microsoft WAVE audio. |
Murl.IEnums.FILE_TYPE_OGG | OGG/Vorbis audio. |
Murl.IEnums.FILE_TYPE_MP3 | MP3 audio. |
Murl.IEnums.FILE_TYPE_MP4 | MP4 audio/video. |
Murl.IEnums.FILE_TYPE_WMV | WMV audio/video. |
Murl.IEnums.FILE_TYPE_GLSL | GLSL shader source. |
Murl.IEnums.FILE_TYPE_HLSL | HLSL shader source or binary. |
Murl.IEnums.FILE_TYPE_BLEND | Blender scene. |
Murl.IEnums.FILE_TYPE_DAE | Collada scene. |
Murl.IEnums.FILE_TYPE_FBX | Autodesk FBX scene. |
Murl.IEnums.FILE_TYPE_C4D | Maxon Cinema4D scene. |
Murl.IEnums.FILE_TYPE_3DS | 3D Studio scene. |
Murl.IEnums.FILE_TYPE_ASE | 3D Studio Max ASCII export scene. |
Murl.IEnums.FILE_TYPE_OBJ | Wavefront object. |
Murl.IEnums.FILE_TYPE_MTL | Wavefront material. |
Murl.IEnums.FILE_TYPE_LWO | Lightwave object. |
Murl.IEnums.FILE_TYPE_LWS | Lightwave scene. |
Murl.IEnums.FILE_TYPE_X | DirectX 3D object. |
Murl.IEnums.FILE_TYPE_MDL | Quake model. |
Murl.IEnums.FILE_TYPE_MD2 | Quake II model. |
Murl.IEnums.FILE_TYPE_MD3 | Quake III model. |
Murl.IEnums.FILE_TYPE_MD5 | Doom 3 model. |
Murl.IEnums.FILE_TYPE_PK3 | Quake III compressed Map/BSP package. |
Murl.IEnums.FILE_TYPE_BSP | Quake III BSP file. |
Murl.IEnums.FILE_TYPE_MAP | Quake III Map file. |
Murl.IEnums.FILE_TYPE_TTF | TrueType font. |
Murl.IEnums.FILE_TYPE_OTF | OpenType font. |
Murl.IEnums.FILE_TYPE_ZIP | ZIP archive. |
Murl.IEnums.FILE_TYPE_TGZ | TAR/GZ archive. |
Murl.IEnums.FILE_TYPE_BZ2 | BZIP2 archive. |
Murl.IEnums.FILE_TYPE_CSV | CSV file. |
Murl.IEnums.FILE_TYPE_KTX | KTX (Khronos texture) file. |
Murl.IEnums.FILE_TYPE_PKM | PKM image file. |
Murl.IEnums.FILE_TYPE_ASTC | ASTC image file. |
Murl.IEnums.FILE_TYPE_HDR | Radiance HDR image file. |
Murl.IEnums.FILE_TYPE_PFM | PFM (Portable Float Map) image file. |
Murl.IEnums.FILE_TYPE_EXR | EXR image file. |
Murl.IEnums.FILE_TYPE_LUA | LUA script file. |
Murl.IEnums.NUM_FILE_TYPES |
Available font types
Murl.IEnums.FONT_TYPE_UNDEFINED | Undefined font type. |
Murl.IEnums.FONT_TYPE_BITMAP | Bitmap font, composed of a set of glyph descriptors and a bitmap image. |
Murl.IEnums.FONT_TYPE_OUTLINE | Outline font, containing individual vector outlines for each glyph. |
Murl.IEnums.FONT_TYPE_SYSTEM | System font, to be retrieved and rendered via the OS. |
Murl.IEnums.NUM_FONT_TYPES |
Available property semantics
Murl.IEnums.PROPERTY_SEMANTIC_NONE | No semantic (property is not used). |
Murl.IEnums.PROPERTY_SEMANTIC_VALUE | A generic value. |
Murl.IEnums.PROPERTY_SEMANTIC_ANGLE | An angle value. |
Murl.IEnums.PROPERTY_SEMANTIC_MASK | A bit mask. |
Murl.IEnums.PROPERTY_SEMANTIC_OBJECT | A generic object. |
Murl.IEnums.PROPERTY_SEMANTIC_ID | An ID string. |
Murl.IEnums.PROPERTY_SEMANTIC_FILE_NAME | A string representing a single file name. |
Murl.IEnums.PROPERTY_SEMANTIC_FILE_PATH | A string representing a path to a single file. |
Murl.IEnums.PROPERTY_SEMANTIC_FOLDER_NAME | A string representing a single folder name. |
Murl.IEnums.PROPERTY_SEMANTIC_FOLDER_PATH | A string representing a path to a single folder. |
Murl.IEnums.NUM_PROPERTY_SEMANTICS |
The ZLib compression levels
Murl.IEnums.COMPRESSION_LEVEL_DEFAULT | Default compression (ZLib Z_DEFAULT_COMPRESSION). |
Murl.IEnums.COMPRESSION_LEVEL_NONE | No compression (ZLib Z_NO_COMPRESSION). |
Murl.IEnums.COMPRESSION_LEVEL_SPEED | Fastest compression (ZLib Z_BEST_SPEED). |
Murl.IEnums.COMPRESSION_LEVEL_2 | Compression level 2. |
Murl.IEnums.COMPRESSION_LEVEL_3 | Compression level 3. |
Murl.IEnums.COMPRESSION_LEVEL_4 | Compression level 4. |
Murl.IEnums.COMPRESSION_LEVEL_5 | Compression level 5. |
Murl.IEnums.COMPRESSION_LEVEL_6 | Compression level 6 (default ZLib compression). |
Murl.IEnums.COMPRESSION_LEVEL_7 | Compression level 7. |
Murl.IEnums.COMPRESSION_LEVEL_8 | Compression level 8. |
Murl.IEnums.COMPRESSION_LEVEL_BEST | Best compression (ZLib Z_BEST_COMPRESSION). |
Definition of the image file format types.
Murl.IEnums.IMAGE_FORMAT_UNKNOWN | Unknown image file format. |
Murl.IEnums.IMAGE_FORMAT_PNG | The PNG image file format. |
Murl.IEnums.IMAGE_FORMAT_JPG | The JPG image file format. |
Murl.IEnums.IMAGE_FORMAT_WEBP | The WEBP image file format. |
Murl.IEnums.IMAGE_FORMAT_DDS | The DDS image file format. |
Murl.IEnums.IMAGE_FORMAT_TGA | The TGA image file format. |
Murl.IEnums.IMAGE_FORMAT_RAW | Raw image data. |
Murl.IEnums.IMAGE_FORMAT_KTX | The KTX image file format. |
Murl.IEnums.IMAGE_FORMAT_PVR | The PVR image file format. |
Murl.IEnums.IMAGE_FORMAT_PKM | The PKM (ETC1) image file format. |
Murl.IEnums.IMAGE_FORMAT_ASTC | The ASTC image file format. |
Murl.IEnums.IMAGE_FORMAT_HDR | The Radiance HDR image file format. |
Murl.IEnums.IMAGE_FORMAT_PFM | The PFM (Portable Float Map) image file format. |
Murl.IEnums.NUM_IMAGE_FORMATS |