Murl Engine Lua Addon API  Version 1.0 beta
Common

A collection of system-wide constant enumerations.

All enumerations can be accessed by a corresponding Enum accessor.


Group members

Enumerations


TouchAreaShape

Shapes of touch areas used in the input handler.

Murl.IEnums.TOUCH_AREA_SHAPE_RECTANGLEA rectangular touch area.
Murl.IEnums.TOUCH_AREA_SHAPE_ELLIPSEAn elliptical touch area.
Murl.IEnums.TOUCH_AREA_SHAPE_MESHA generic triangle mesh used for capturing input touches.
Murl.IEnums.NUM_TOUCH_AREA_SHAPES

ProjectionType

Projection types used for both rendering and input handling.

Murl.IEnums.PROJECTION_TYPE_PERSPECTIVEPerspective projection.
Murl.IEnums.PROJECTION_TYPE_ORTHOGRAPHICOrthographic (i.e. parallel) projection.
Murl.IEnums.NUM_PROJECTION_TYPES

ResultCode

Globally defined result codes.

Murl.IEnums.RESULT_CODE_OKNo error (success).
Murl.IEnums.RESULT_CODE_UNSPECIFIED_ERRORAn unspecified (generic) error occurred.
Murl.IEnums.RESULT_CODE_VERSION_ERRORA version error.
Murl.IEnums.RESULT_CODE_PARSING_ERRORError during parsing a resource or file.
Murl.IEnums.RESULT_CODE_FILE_ERRORA general file error (not existing or read error).
Murl.IEnums.RESULT_CODE_UNSPECIFIED_WARNINGAn unspecified (generic) warning occurred.
Murl.IEnums.NUM_RESULT_CODES

FileAccessMode

Definition of the file access modes.

Murl.IEnums.FILE_ACCESS_MODE_READ_ONLYRead only access. The file must exist.
Murl.IEnums.FILE_ACCESS_MODE_WRITE_ONLYWrite only access. Create an empty file or erase an already existing file.
Murl.IEnums.FILE_ACCESS_MODE_READ_AND_WRITERead and write access. Create an empty file or erase an already existing file.
Murl.IEnums.FILE_ACCESS_MODE_APPEND_ONLYAppend 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_APPENDRead 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

AuthorizationStatus

Authorization status enumeration.

Murl.IEnums.AUTHORIZATION_NOT_DETERMINEDAuthorization not determined.
Murl.IEnums.AUTHORIZATION_RESTRICTEDAuthorization is restricted by the system.
Murl.IEnums.AUTHORIZATION_DENIEDAuthorization is denied by user.
Murl.IEnums.AUTHORIZATION_AUTHORIZEDAuthorization is authorized.
Murl.IEnums.NUM_AUTHORIZATIONS

SocketError

Socket error status enumeration.

Murl.IEnums.SOCKET_ERROR_NONENo error.
Murl.IEnums.SOCKET_ERROR_NOT_CONNECTEDSocket is not connected.
Murl.IEnums.SOCKET_ERROR_RESET_BY_PEERConnection was reset by peer.
Murl.IEnums.SOCKET_ERROR_SEND_FAILEDLast send operation failed.
Murl.IEnums.SOCKET_ERROR_RECEIVE_FAILEDLast receive operation failed.
Murl.IEnums.SOCKET_ERROR_WOULD_BLOCKResource temporarily unavailable.
Murl.IEnums.SOCKET_ERROR_IN_PROGRESSOperation is in progress.
Murl.IEnums.SOCKET_ERROR_FAILEDLast operation failed.
Murl.IEnums.NUM_SOCKET_ERRORS

ResourceType

Available resource types

Murl.IEnums.RESOURCE_TYPE_DEFAULTDefault resource type, use any suitable.
Murl.IEnums.RESOURCE_TYPE_BINARYGeneric resource type, exposing raw binary contents.
Murl.IEnums.RESOURCE_TYPE_ANIMATIONAnimation resource.
Murl.IEnums.RESOURCE_TYPE_ATLASAtlas resource.
Murl.IEnums.RESOURCE_TYPE_FONTFont resource.
Murl.IEnums.RESOURCE_TYPE_GRAPHGraph resource.
Murl.IEnums.RESOURCE_TYPE_IMAGEImage resource.
Murl.IEnums.RESOURCE_TYPE_MESHMesh resource.
Murl.IEnums.RESOURCE_TYPE_SHADERShader resource.
Murl.IEnums.RESOURCE_TYPE_AUDIOAudio resource.
Murl.IEnums.RESOURCE_TYPE_ARCHIVEGeneric resource type storing compressed binary contents.
Murl.IEnums.RESOURCE_TYPE_VIDEOVideo resource.
Murl.IEnums.RESOURCE_TYPE_SCRIPTScript resource.
Murl.IEnums.RESOURCE_TYPE_UNKNOWNUnknown resource.
Murl.IEnums.RESOURCE_TYPE_PACKAGEPackage containing multiple resources and/or sub-packages.
Murl.IEnums.RESOURCE_TYPE_DICTIONARYDictionary resource containing multiple key/value pairs.
Murl.IEnums.RESOURCE_TYPE_GRIDGrid resource.
Murl.IEnums.RESOURCE_TYPE_TEXTText resource.
Murl.IEnums.NUM_RESOURCE_TYPES

FileType

Available file types

Murl.IEnums.FILE_TYPE_DEFAULTDefault file type, use any suitable.
Murl.IEnums.FILE_TYPE_UNKNOWNUnknown file type.
Murl.IEnums.FILE_TYPE_TXTA text file.
Murl.IEnums.FILE_TYPE_XMLXML file type.
Murl.IEnums.FILE_TYPE_MURLNative Murl binary.
Murl.IEnums.FILE_TYPE_PNGPNG image.
Murl.IEnums.FILE_TYPE_JPGJPEG image.
Murl.IEnums.FILE_TYPE_WEBPWEBP image.
Murl.IEnums.FILE_TYPE_DDSDDS (DirectX) image.
Murl.IEnums.FILE_TYPE_ETC1ETC1 compressed image.
Murl.IEnums.FILE_TYPE_PVRPVRTC compressed image.
Murl.IEnums.FILE_TYPE_TGATGA image.
Murl.IEnums.FILE_TYPE_TIFTIFF image.
Murl.IEnums.FILE_TYPE_WAVMicrosoft WAVE audio.
Murl.IEnums.FILE_TYPE_OGGOGG/Vorbis audio.
Murl.IEnums.FILE_TYPE_MP3MP3 audio.
Murl.IEnums.FILE_TYPE_MP4MP4 audio/video.
Murl.IEnums.FILE_TYPE_WMVWMV audio/video.
Murl.IEnums.FILE_TYPE_GLSLGLSL shader source.
Murl.IEnums.FILE_TYPE_HLSLHLSL shader source or binary.
Murl.IEnums.FILE_TYPE_BLENDBlender scene.
Murl.IEnums.FILE_TYPE_DAECollada scene.
Murl.IEnums.FILE_TYPE_FBXAutodesk FBX scene.
Murl.IEnums.FILE_TYPE_C4DMaxon Cinema4D scene.
Murl.IEnums.FILE_TYPE_3DS3D Studio scene.
Murl.IEnums.FILE_TYPE_ASE3D Studio Max ASCII export scene.
Murl.IEnums.FILE_TYPE_OBJWavefront object.
Murl.IEnums.FILE_TYPE_MTLWavefront material.
Murl.IEnums.FILE_TYPE_LWOLightwave object.
Murl.IEnums.FILE_TYPE_LWSLightwave scene.
Murl.IEnums.FILE_TYPE_XDirectX 3D object.
Murl.IEnums.FILE_TYPE_MDLQuake model.
Murl.IEnums.FILE_TYPE_MD2Quake II model.
Murl.IEnums.FILE_TYPE_MD3Quake III model.
Murl.IEnums.FILE_TYPE_MD5Doom 3 model.
Murl.IEnums.FILE_TYPE_PK3Quake III compressed Map/BSP package.
Murl.IEnums.FILE_TYPE_BSPQuake III BSP file.
Murl.IEnums.FILE_TYPE_MAPQuake III Map file.
Murl.IEnums.FILE_TYPE_TTFTrueType font.
Murl.IEnums.FILE_TYPE_OTFOpenType font.
Murl.IEnums.FILE_TYPE_ZIPZIP archive.
Murl.IEnums.FILE_TYPE_TGZTAR/GZ archive.
Murl.IEnums.FILE_TYPE_BZ2BZIP2 archive.
Murl.IEnums.FILE_TYPE_CSVCSV file.
Murl.IEnums.FILE_TYPE_KTXKTX (Khronos texture) file.
Murl.IEnums.FILE_TYPE_PKMPKM image file.
Murl.IEnums.FILE_TYPE_ASTCASTC image file.
Murl.IEnums.FILE_TYPE_HDRRadiance HDR image file.
Murl.IEnums.FILE_TYPE_PFMPFM (Portable Float Map) image file.
Murl.IEnums.FILE_TYPE_EXREXR image file.
Murl.IEnums.NUM_FILE_TYPES

FontType

Available font types

Murl.IEnums.FONT_TYPE_UNDEFINEDUndefined font type.
Murl.IEnums.FONT_TYPE_BITMAPBitmap font, composed of a set of glyph descriptors and a bitmap image.
Murl.IEnums.FONT_TYPE_OUTLINEOutline font, containing individual vector outlines for each glyph.
Murl.IEnums.FONT_TYPE_SYSTEMSystem font, to be retrieved and rendered via the OS.
Murl.IEnums.NUM_FONT_TYPES

PropertySemantic

Available property semantics

Murl.IEnums.PROPERTY_SEMANTIC_NONENo semantic (property is not used).
Murl.IEnums.PROPERTY_SEMANTIC_VALUEA generic value.
Murl.IEnums.PROPERTY_SEMANTIC_ANGLEAn angle value.
Murl.IEnums.PROPERTY_SEMANTIC_MASKA bit mask.
Murl.IEnums.PROPERTY_SEMANTIC_OBJECTA generic object.
Murl.IEnums.PROPERTY_SEMANTIC_IDAn ID string.
Murl.IEnums.PROPERTY_SEMANTIC_FILE_NAMEA string representing a single file name.
Murl.IEnums.PROPERTY_SEMANTIC_FILE_PATHA string representing a path to a single file.
Murl.IEnums.PROPERTY_SEMANTIC_FOLDER_NAMEA string representing a single folder name.
Murl.IEnums.PROPERTY_SEMANTIC_FOLDER_PATHA string representing a path to a single folder.
Murl.IEnums.NUM_PROPERTY_SEMANTICS

CompressionLevel

The ZLib compression levels

Murl.IEnums.COMPRESSION_LEVEL_DEFAULTDefault compression (ZLib Z_DEFAULT_COMPRESSION).
Murl.IEnums.COMPRESSION_LEVEL_NONENo compression (ZLib Z_NO_COMPRESSION).
Murl.IEnums.COMPRESSION_LEVEL_SPEEDFastest compression (ZLib Z_BEST_SPEED).
Murl.IEnums.COMPRESSION_LEVEL_2Compression level 2.
Murl.IEnums.COMPRESSION_LEVEL_3Compression level 3.
Murl.IEnums.COMPRESSION_LEVEL_4Compression level 4.
Murl.IEnums.COMPRESSION_LEVEL_5Compression level 5.
Murl.IEnums.COMPRESSION_LEVEL_6Compression level 6 (default ZLib compression).
Murl.IEnums.COMPRESSION_LEVEL_7Compression level 7.
Murl.IEnums.COMPRESSION_LEVEL_8Compression level 8.
Murl.IEnums.COMPRESSION_LEVEL_BESTBest compression (ZLib Z_BEST_COMPRESSION).

ImageFormat

Definition of the image file format types.

Murl.IEnums.IMAGE_FORMAT_UNKNOWNUnknown image file format.
Murl.IEnums.IMAGE_FORMAT_PNGThe PNG image file format.
Murl.IEnums.IMAGE_FORMAT_JPGThe JPG image file format.
Murl.IEnums.IMAGE_FORMAT_WEBPThe WEBP image file format.
Murl.IEnums.IMAGE_FORMAT_DDSThe DDS image file format.
Murl.IEnums.IMAGE_FORMAT_TGAThe TGA image file format.
Murl.IEnums.IMAGE_FORMAT_RAWRaw image data.
Murl.IEnums.IMAGE_FORMAT_KTXThe KTX image file format.
Murl.IEnums.IMAGE_FORMAT_PVRThe PVR image file format.
Murl.IEnums.IMAGE_FORMAT_PKMThe PKM (ETC1) image file format.
Murl.IEnums.IMAGE_FORMAT_ASTCThe ASTC image file format.
Murl.IEnums.IMAGE_FORMAT_HDRThe Radiance HDR image file format.
Murl.IEnums.IMAGE_FORMAT_PFMThe PFM (Portable Float Map) image file format.
Murl.IEnums.NUM_IMAGE_FORMATS