Murl Engine Lua Addon API  Version 1.0 beta
Murl.IPlatformConfiguration

The platform configuration interface defines the immutable platform-specific settings.


Table members

Methods


GetEngineConfiguration()

Get the engine configuration object.

Murl.IEngineConfiguration GetEngineConfiguration()

Returns
Murl.IEngineConfiguration The engine configuration object.

GetAppConfiguration()

Get the application configuration object.

Murl.IAppConfiguration GetAppConfiguration()

Returns
Murl.IAppConfiguration The application configuration object.

SetLaunchArguments(arguments)

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)

Parameters
argumentsA string array containing all launch arguments.

GetLaunchArguments()

Get the application's launch arguments. On platforms that do not support launch arguments, this simply returns an empty array.

Murl.Array.String GetLaunchArguments()

Returns
Murl.Array.String A constant string array containing all launch arguments.

SetUniqueDeviceId(id)

Set the unique device identifier string. Removes all '-' characters from the identifier string.

SetUniqueDeviceId(String id)

Parameters
idThe unique device identifier string.

GetUniqueDeviceId()

Get the unique device identifier string. On multiuser platforms each user gets an own unique identifier.

String GetUniqueDeviceId()

Returns
String The unique device identifier string or 32 x '0' characters if not set by the platform implementation.

SetUniqueInstallId(id)

Set the unique install identifier string. Removes all '-' characters from the identifier string.

SetUniqueInstallId(String id)

Parameters
idThe unique install identifier string.

GetUniqueInstallId()

Get the unique install identifier string. On multiuser platforms each user gets an own unique identifier.

String GetUniqueInstallId()

Returns
String The unique install identifier string or 32 x '0' characters if not set by the platform implementation.

SetCountryCode(code)

Set the country code string.

SetCountryCode(String code)

Parameters
codeThe country code string.

GetCountryCode()

Get the country code string. The country code string is provided in the ISO 3166-1-alpha-2 code.

String GetCountryCode()

Returns
String The country code string or "??" if not set by the platform implementation.

SetTargetManufacturerName(name)

Set the manufacturer name.

SetTargetManufacturerName(String name)

Parameters
nameThe manufacturer name.

GetTargetManufacturerName()

Get the manufacturer name.

String GetTargetManufacturerName()

Returns
String The manufacturer name or "N/A" if not set by the platform implementation.

SetTargetDeviceName(name)

Set the target device name.

SetTargetDeviceName(String name)

Parameters
nameThe target device name.

GetTargetDeviceName()

Get the target device name.

String GetTargetDeviceName()

Returns
String THe target device name or "N/A" if not set by the platform implementation.

SetTargetModelName(name)

Set the target model name.

SetTargetModelName(String name)

Parameters
nameThe target model name.

GetTargetModelName()

Get the target model name.

String GetTargetModelName()

Returns
String The target model name or "N/A" if not set by the platform implementation.

SetTargetProductName(name)

Set the target product name.

SetTargetProductName(String name)

Parameters
nameThe target product name.

GetTargetProductName()

Get the target product name.

String GetTargetProductName()

Returns
String The target product name or "N/A" if not set by the platform implementation.

SetSystemVersionName(name)

Set the system version name.

SetSystemVersionName(String name)

Parameters
nameThe system version name.

GetSystemVersionName()

Get the system version name.

String GetSystemVersionName()

Returns
String The system version name or "N/A" if not set by the platform implementation.

SetTargetClass(targetClass)

Set the target class enumeration value.

SetTargetClass(Murl.IEnums.TargetClass targetClass)

Parameters
targetClassThe target class enumeration value.

GetTargetClass()

Get the target class enumeration value.

Murl.IEnums.TargetClass GetTargetClass()

Returns
Murl.IEnums.TargetClass The target class enumeration value or IEnums::TARGET_CLASS_DEFAULT if not set by the platform implementation.

IsTargetClassMatching(targetClass)

Check if the target class is matching a specified value.

Boolean IsTargetClassMatching(Murl.IEnums.TargetClass targetClass)

Parameters
targetClassThe target class enumeration value.
Returns
Boolean true if the target class is matching the parameter value.

SetTargetDevice(targetDevice)

Set the target device enumeration value.

SetTargetDevice(Murl.IEnums.TargetDevice targetDevice)

Parameters
targetDeviceThe target device enumeration value.

GetTargetDevice()

Get the target device enumeration value.

Murl.IEnums.TargetDevice GetTargetDevice()

Returns
Murl.IEnums.TargetDevice The target device enumeration value or IEnums::TARGET_DEVICE_DEFAULT if not set by the platform implementation.

IsTargetDeviceMatching(targetDevice)

Check if the target device is matching a specified value.

Boolean IsTargetDeviceMatching(Murl.IEnums.TargetDevice targetDevice)

Parameters
targetDeviceThe target device enumeration value.
Returns
Boolean true if the target device is matching the parameter value.

SetTargetHost(targetHost)

Set the target host enumeration value.

SetTargetHost(Murl.IEnums.TargetHost targetHost)

Parameters
targetHostThe target host enumeration value.

GetTargetHost()

Get the target host enumeration value.

Murl.IEnums.TargetHost GetTargetHost()

Returns
Murl.IEnums.TargetHost The target host enumeration value or IEnums::TARGET_HOST_DEFAULT if not set by the platform implementation.

IsTargetHostMatching(targetHost)

Check if the target host is matching a specified value.

Boolean IsTargetHostMatching(Murl.IEnums.TargetHost targetHost)

Parameters
targetHostThe target host enumeration value.
Returns
Boolean true if the target host is matching the parameter value.

SetOperatingSystem(operatingSystem)

Set the operating system enumeration value.

SetOperatingSystem(Murl.IEnums.OperatingSystem operatingSystem)

Parameters
operatingSystemThe operating system enumeration value.

GetOperatingSystem()

Get the operating system enumeration value.

Murl.IEnums.OperatingSystem GetOperatingSystem()

Returns
Murl.IEnums.OperatingSystem The operating system enumeration value or IEnums::OPERATING_SYSTEM_DEFAULT if not set by the platform implementation.

IsOperatingSystemMatching(operatingSystem)

Check if the operating system is matching a specified value.

Boolean IsOperatingSystemMatching(Murl.IEnums.OperatingSystem operatingSystem)

Parameters
operatingSystemThe operating system enumeration value.
Returns
Boolean true if the operating system is matching the parameter value.

SetGpu(gpu)

Set the graphics processing unit enumeration value.

SetGpu(Murl.IEnums.Gpu gpu)

Parameters
gpuThe graphics processing unit enumeration value.

GetGpu()

Get the graphics processing unit enumeration value.

Murl.IEnums.Gpu GetGpu()

Returns
Murl.IEnums.Gpu The graphics processing unit enumeration value or IEnums::GPU_DEFAULT if not set by the platform implementation.

IsGpuMatching(gpu)

Check if the graphics processing unit is matching a specified value.

Boolean IsGpuMatching(Murl.IEnums.Gpu gpu)

Parameters
gpuThe graphics processing unit enumeration value.
Returns
Boolean true if the graphics processing unit is matching the parameter value.

SetNumberOfBackBufferColorBits(numRedBits, numGreenBits, numBlueBits, numAlphaBits)

Set the back buffer's bit depths for a single color value.

SetNumberOfBackBufferColorBits(Integer numRedBits, Integer numGreenBits, Integer numBlueBits, Integer numAlphaBits)

Parameters
numRedBitsThe number of bits for the red component.
numGreenBitsThe number of bits for the green component.
numBlueBitsThe number of bits for the blue component.
numAlphaBitsThe number of bits for the alpha component.

GetNumberOfBackBufferRedBits()

Get the back buffer's bit depth for the red component.

Integer GetNumberOfBackBufferRedBits()

Returns
Integer The bit depth.

GetNumberOfBackBufferGreenBits()

Get the back buffer's bit depth for the green component.

Integer GetNumberOfBackBufferGreenBits()

Returns
Integer The bit depth.

GetNumberOfBackBufferBlueBits()

Get the back buffer's bit depth for the blue component.

Integer GetNumberOfBackBufferBlueBits()

Returns
Integer The bit depth.

GetNumberOfBackBufferAlphaBits()

Get the back buffer's bit depth for the alpha component.

Integer GetNumberOfBackBufferAlphaBits()

Returns
Integer The bit depth.

SetNumberOfBackBufferDepthBits(numDepthBits)

Set the back buffer's depth buffer bit depth.

SetNumberOfBackBufferDepthBits(Integer numDepthBits)

Parameters
numDepthBitsThe number of bits for a single depth buffer fragment.

GetNumberOfBackBufferDepthBits()

Get the back buffer's depth buffer bit depth.

Integer GetNumberOfBackBufferDepthBits()

Returns
Integer The number of bits for a single depth buffer fragment.

SetNumberOfBackBufferStencilBits(numStencilBits)

Set the back buffer's stencil buffer bit depth.

SetNumberOfBackBufferStencilBits(Integer numStencilBits)

Parameters
numStencilBitsThe number of bits for a single stencil buffer fragment.

GetNumberOfBackBufferStencilBits()

Get the back buffer's stencil buffer bit depth.

Integer GetNumberOfBackBufferStencilBits()

Returns
Integer The number of bits for a single stencil buffer fragment.

SetPhysicalScreenSize(mmSizeX, mmSizeY)

Set the physical screen size.

SetPhysicalScreenSize(Number mmSizeX, Number mmSizeY)

Parameters
mmSizeXThe screen width in millimeters.
mmSizeYThe screen height in millimeters.

GetPhysicalScreenSizeX()

Get the physical screen width.

Number GetPhysicalScreenSizeX()

Returns
Number The physical screen width in millimeters or (1680 pixels x (25.4 mm / 96 dpi)) if not set by the platform implementation.

GetPhysicalScreenSizeY()

Get the physical screen height.

Number GetPhysicalScreenSizeY()

Returns
Number The physical screen height in millimeters or (1050 pixels x (25.4 mm / 96 dpi)) if not set by the platform implementation.

SetPhysicalPixelSize(mmSizeX, mmSizeY)

Set the physical pixel size.

SetPhysicalPixelSize(Number mmSizeX, Number mmSizeY)

Parameters
mmSizeXThe pixel width in millimeters.
mmSizeYThe pixel height in millimeters.

GetPhysicalPixelSizeX()

Get the physical pixel width.

Number GetPhysicalPixelSizeX()

Returns
Number The physical pixel width in millimeters or (25.4 mm / 96 dpi) if not set by the platform implementation.

GetPhysicalPixelSizeY()

Get the physical pixel height.

Number GetPhysicalPixelSizeY()

Returns
Number The physical pixel height in millimeters or (25.4 mm / 96 dpi) if not set by the platform implementation.

SetPixelScaleFactor(sizeXFactor, sizeYFactor)

Set the pixel scale factor.

SetPixelScaleFactor(Number sizeXFactor, Number sizeYFactor)

Parameters
sizeXFactorThe pixel width scale factor.
sizeYFactorThe pixel height scale factor.

GetPixelScaleFactorX()

Set the pixel width scale factor.

Number GetPixelScaleFactorX()

Returns
Number The pixel width scale factor or 1.0 if not set by the platform implementation.

GetPixelScaleFactorY()

Set the pixel height scale factor.

Number GetPixelScaleFactorY()

Returns
Number The pixel height scale factor or 1.0 if not set by the platform implementation.

GetNumberOfPixelsFromSizeX(sizeValue, unit)

Get the number of pixels from a specified width and unit.

Number GetNumberOfPixelsFromSizeX(Number sizeValue, Murl.IEnums.LengthMeasure unit)

Parameters
sizeValueThe width value.
unitThe unit enumeration value.
Returns
Number The number of pixels from the specified width and unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.

GetNumberOfPixelsFromSizeY(sizeValue, unit)

Get the number of pixels from a specified height and unit.

Number GetNumberOfPixelsFromSizeY(Number sizeValue, Murl.IEnums.LengthMeasure unit)

Parameters
sizeValueThe height value.
unitThe unit enumeration value.
Returns
Number The number of pixels from the specified height and unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.

GetSizeXFromNumberOfPixels(numberOfPixels, unit)

Get the width in a specified unit from a specified number of pixels.

Number GetSizeXFromNumberOfPixels(Number numberOfPixels, Murl.IEnums.LengthMeasure unit)

Parameters
numberOfPixelsThe number of pixels value.
unitThe unit enumeration value.
Returns
Number The width in the specified unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.

GetSizeYFromNumberOfPixels(numberOfPixels, unit)

Get the height in a specified unit from a specified number of pixels.

Number GetSizeYFromNumberOfPixels(Number numberOfPixels, Murl.IEnums.LengthMeasure unit)

Parameters
numberOfPixelsThe number of pixels value.
unitThe unit enumeration value.
Returns
Number The height in the specified unit or zero if the unit is IEnums::LENGTH_MEASURE_VIRTUAL or unknown.

SetInAppBillingProviderName(name)

Set the name of the In-App Billing provider.

SetInAppBillingProviderName(String name)

Parameters
nameThe IAB provider name.

GetInAppBillingProviderName()

Get the In-App Billing provider name.

  • "N/A" if the provider name has not been set
  • "none" if In-App Billing is not supported
  • "apple-ios" for Apple iOS In-App Purchasing
  • "apple-osx" for Apple OSX In-App Purchasing
  • "google" for Google Play In-App Billing
  • "amazon" for Amazon In-App Purchasing
  • "samsung" for Samsung In-App Purchasing
  • "ouya" for OUYA In-App Purchasing

String GetInAppBillingProviderName()

Returns
String The In-App Billing provider name or "N/A" if not set by the platform implementation.

SetMultithreadingSupported(supported)

Enable/disable multithreading support.

SetMultithreadingSupported(Boolean supported)

Parameters
supportedIf true, multithreading is supported.

IsMultithreadingSupported()

Check if multithreading is supported.

Boolean IsMultithreadingSupported()

Returns
Boolean true if supported