![]() |
Murl Engine Lua Addon API
Version 1.0 beta
|
The platform configuration interface defines the immutable platform-specific settings.
Get the engine configuration object.
Murl.IEngineConfiguration GetEngineConfiguration()
Get the application configuration object.
Murl.IAppConfiguration GetAppConfiguration()
Set the application's launch arguments, if existing. When supported by the specific platform, the first argument in the list represents the path and file name to the application executable itself, followed by individual optional strings for each argument given at launch.
SetLaunchArguments(Murl.Array.String arguments)
arguments | A string array containing all launch arguments. |
Get the application's launch arguments. On platforms that do not support launch arguments, this simply returns an empty array.
Murl.Array.String GetLaunchArguments()
Set the unique device identifier string. Removes all '-' characters from the identifier string.
SetUniqueDeviceId(String id)
id | The unique device identifier string. |
Get the unique device identifier string. On multiuser platforms each user gets an own unique identifier.
String GetUniqueDeviceId()
Set the unique install identifier string. Removes all '-' characters from the identifier string.
SetUniqueInstallId(String id)
id | The unique install identifier string. |
Get the unique install identifier string. On multiuser platforms each user gets an own unique identifier.
String GetUniqueInstallId()
Set the country code string.
SetCountryCode(String code)
code | The country code string. |
Get the country code string. The country code string is provided in the ISO 3166-1-alpha-2 code.
String GetCountryCode()
Set the manufacturer name.
SetTargetManufacturerName(String name)
name | The manufacturer name. |
Get the manufacturer name.
String GetTargetManufacturerName()
Set the target device name.
SetTargetDeviceName(String name)
name | The target device name. |
Get the target device name.
String GetTargetDeviceName()
Set the target model name.
SetTargetModelName(String name)
name | The target model name. |
Get the target model name.
String GetTargetModelName()
Set the target product name.
SetTargetProductName(String name)
name | The target product name. |
Get the target product name.
String GetTargetProductName()
Set the system version name.
SetSystemVersionName(String name)
name | The system version name. |
Get the system version name.
String GetSystemVersionName()
Set the target class enumeration value.
SetTargetClass(Murl.IEnums.TargetClass targetClass)
targetClass | The target class enumeration value. |
Get the target class enumeration value.
Murl.IEnums.TargetClass GetTargetClass()
Check if the target class is matching a specified value.
Boolean IsTargetClassMatching(Murl.IEnums.TargetClass targetClass)
targetClass | The target class enumeration value. |
Set the target device enumeration value.
SetTargetDevice(Murl.IEnums.TargetDevice targetDevice)
targetDevice | The target device enumeration value. |
Get the target device enumeration value.
Murl.IEnums.TargetDevice GetTargetDevice()
Check if the target device is matching a specified value.
Boolean IsTargetDeviceMatching(Murl.IEnums.TargetDevice targetDevice)
targetDevice | The target device enumeration value. |
Set the target host enumeration value.
SetTargetHost(Murl.IEnums.TargetHost targetHost)
targetHost | The target host enumeration value. |
Get the target host enumeration value.
Murl.IEnums.TargetHost GetTargetHost()
Check if the target host is matching a specified value.
Boolean IsTargetHostMatching(Murl.IEnums.TargetHost targetHost)
targetHost | The target host enumeration value. |
Set the operating system enumeration value.
SetOperatingSystem(Murl.IEnums.OperatingSystem operatingSystem)
operatingSystem | The operating system enumeration value. |
Get the operating system enumeration value.
Murl.IEnums.OperatingSystem GetOperatingSystem()
Check if the operating system is matching a specified value.
Boolean IsOperatingSystemMatching(Murl.IEnums.OperatingSystem operatingSystem)
operatingSystem | The operating system enumeration value. |
Set the graphics processing unit enumeration value.
SetGpu(Murl.IEnums.Gpu gpu)
gpu | The graphics processing unit enumeration value. |
Get the graphics processing unit enumeration value.
Murl.IEnums.Gpu GetGpu()
Check if the graphics processing unit is matching a specified value.
Boolean IsGpuMatching(Murl.IEnums.Gpu gpu)
gpu | The graphics processing unit enumeration value. |
Set the back buffer's bit depths for a single color value.
SetNumberOfBackBufferColorBits(Integer numRedBits, Integer numGreenBits, Integer numBlueBits, Integer numAlphaBits)
numRedBits | The number of bits for the red component. |
numGreenBits | The number of bits for the green component. |
numBlueBits | The number of bits for the blue component. |
numAlphaBits | The number of bits for the alpha component. |
Get the back buffer's bit depth for the red component.
Integer GetNumberOfBackBufferRedBits()
Get the back buffer's bit depth for the green component.
Integer GetNumberOfBackBufferGreenBits()
Get the back buffer's bit depth for the blue component.
Integer GetNumberOfBackBufferBlueBits()
Get the back buffer's bit depth for the alpha component.
Integer GetNumberOfBackBufferAlphaBits()
Set the back buffer's depth buffer bit depth.
SetNumberOfBackBufferDepthBits(Integer numDepthBits)
numDepthBits | The number of bits for a single depth buffer fragment. |
Get the back buffer's depth buffer bit depth.
Integer GetNumberOfBackBufferDepthBits()
Set the back buffer's stencil buffer bit depth.
SetNumberOfBackBufferStencilBits(Integer numStencilBits)
numStencilBits | The number of bits for a single stencil buffer fragment. |
Get the back buffer's stencil buffer bit depth.
Integer GetNumberOfBackBufferStencilBits()
Set the physical screen size.
SetPhysicalScreenSize(Number mmSizeX, Number mmSizeY)
mmSizeX | The screen width in millimeters. |
mmSizeY | The screen height in millimeters. |
Get the physical screen width.
Number GetPhysicalScreenSizeX()
Get the physical screen height.
Number GetPhysicalScreenSizeY()
Set the physical pixel size.
SetPhysicalPixelSize(Number mmSizeX, Number mmSizeY)
mmSizeX | The pixel width in millimeters. |
mmSizeY | The pixel height in millimeters. |
Get the physical pixel width.
Number GetPhysicalPixelSizeX()
Get the physical pixel height.
Number GetPhysicalPixelSizeY()
Set the pixel scale factor.
SetPixelScaleFactor(Number sizeXFactor, Number sizeYFactor)
sizeXFactor | The pixel width scale factor. |
sizeYFactor | The pixel height scale factor. |
Set the pixel width scale factor.
Number GetPixelScaleFactorX()
Set the pixel height scale factor.
Number GetPixelScaleFactorY()
Get the number of pixels from a specified width and unit.
Number GetNumberOfPixelsFromSizeX(Number sizeValue, Murl.IEnums.LengthMeasure unit)
sizeValue | The width value. |
unit | The unit enumeration value. |
Get the number of pixels from a specified height and unit.
Number GetNumberOfPixelsFromSizeY(Number sizeValue, Murl.IEnums.LengthMeasure unit)
sizeValue | The height value. |
unit | The unit enumeration value. |
Get the width in a specified unit from a specified number of pixels.
Number GetSizeXFromNumberOfPixels(Number numberOfPixels, Murl.IEnums.LengthMeasure unit)
numberOfPixels | The number of pixels value. |
unit | The unit enumeration value. |
Get the height in a specified unit from a specified number of pixels.
Number GetSizeYFromNumberOfPixels(Number numberOfPixels, Murl.IEnums.LengthMeasure unit)
numberOfPixels | The number of pixels value. |
unit | The unit enumeration value. |
Set the name of the In-App Billing provider.
SetInAppBillingProviderName(String name)
name | The IAB provider name. |
Get the In-App Billing provider name.
String GetInAppBillingProviderName()
Enable/disable multithreading support.
SetMultithreadingSupported(Boolean supported)
supported | If true, multithreading is supported. |
Check if multithreading is supported.
Boolean IsMultithreadingSupported()