Murl Engine Lua Addon API  Version 1.0 beta
Murl.IAppConfiguration

The application configuration interface defines the application-specific settings which can be modified during runtime.

(!) Specific platform implementations may not react on all modifications.


Table members

Methods


GetPlatformConfiguration()

Get the const platform configuration object.

Murl.IPlatformConfiguration GetPlatformConfiguration()

Returns
Murl.IPlatformConfiguration The platform configuration object.

GetEngineConfiguration()

Get the const engine configuration object.

Murl.IEngineConfiguration GetEngineConfiguration()

Returns
Murl.IEngineConfiguration The engine configuration object.

HasChanged(inspector)

Check is any configuration setting has changed.

Boolean, Murl.ChangeInspector HasChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if any configuration setting has changed.
Murl.ChangeInspector inspector The change inspector.

RegisterApp(app)

Register the app with this configuration.

Boolean RegisterApp(Murl.IApp app)

Parameters
appThe app to register.
Returns
Boolean true if successful.

UnregisterApp(app)

Unregister the app from this configuration.

Boolean UnregisterApp(Murl.IApp app)

Parameters
appThe app to unregister.
Returns
Boolean true if successful.

IsUserConfigurationMatching(userConfigId)

Check if the current user-defined configuration is matching a given ID.

Boolean IsUserConfigurationMatching(String userConfigId)

Parameters
userConfigIdThe ID of the user-defined config to check.
Returns
Boolean true if the current language is the language to check.

SetWindowTitle(title)

Set the window title. The window title is displayed on desktop platforms only. The window title can be modified during runtime.

The OSX platform uses the window title to replace "%@" in the interface builder's main window title.

The default window title is "Murl Engine". On OSX and iOS the window title is set to the CFBundleExecutable identifier.

SetWindowTitle(String title)

Parameters
titleThe window title string.

GetWindowTitle()

Get the window title.

String GetWindowTitle()

Returns
String The window title string.

HasWindowTitleChanged(inspector)

Check if the window title has changed.

Boolean, Murl.ChangeInspector HasWindowTitleChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the window title has changed.
Murl.ChangeInspector inspector The change inspector.

SetLanguage(language)

Set the current language. The current language can be modified during runtime.
The default current language is IEnums::LANGUAGE_ENGLISH.

SetLanguage(Murl.IEnums.Language language)

Parameters
languageThe current language.

GetLanguage()

Get the current language.

Murl.IEnums.Language GetLanguage()

Returns
Murl.IEnums.Language The current language.

IsLanguageMatching(language)

Check if the current language is matching a given one.

Boolean IsLanguageMatching(Murl.IEnums.Language language)

Parameters
languageThe language to check.
Returns
Boolean true if the current language is the language to check.

HasLanguageChanged(inspector)

Check if the current language has changed.

Boolean, Murl.ChangeInspector HasLanguageChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the current language has changed.
Murl.ChangeInspector inspector The change inspector.

SetCurrencySymbol(currencySymbol)

Set the current currency symbol.

SetCurrencySymbol(String currencySymbol)

Parameters
currencySymbolThe current currency symbol.

GetCurrencySymbol()

Get the current currency symbol.

String GetCurrencySymbol()

Returns
String The current currency symbol.

HasCurrencySymbolChanged(inspector)

Check if the current currency symbol has changed.

Boolean, Murl.ChangeInspector HasCurrencySymbolChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the current currency symbol has changed.
Murl.ChangeInspector inspector The change inspector.

SetCurrencyCode(currencyCode)

Set the current currency code.

SetCurrencyCode(String currencyCode)

Parameters
currencyCodeThe current currency code.

GetCurrencyCode()

Get the current international currency symbol. A country typically has a local currency symbol and an international currency symbol.
The local symbol is used within the country, while the international currency symbol is used in international contexts to specify that country’s currency unambiguously.

String GetCurrencyCode()

Returns
String The current international currency symbol.

HasCurrencyCodeChanged(inspector)

Check if the current currency code has changed.

Boolean, Murl.ChangeInspector HasCurrencyCodeChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the current currency code has changed.
Murl.ChangeInspector inspector The change inspector.

SetDecimalSeparator(decimalSeparator)

Set the current decimal separator.

SetDecimalSeparator(String decimalSeparator)

Parameters
decimalSeparatorThe current decimal separator.

GetDecimalSeparator()

Get the current decimal separator.

String GetDecimalSeparator()

Returns
String The current decimal separator.

HasDecimalSeparatorChanged(inspector)

Check if the current decimal separator has changed.

Boolean, Murl.ChangeInspector HasDecimalSeparatorChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the current decimal separator has changed.
Murl.ChangeInspector inspector The change inspector.

SetGroupingSeparator(groupingSeparator)

Set the current grouping separator.

SetGroupingSeparator(String groupingSeparator)

Parameters
groupingSeparatorThe current grouping separator.

GetGroupingSeparator()

Get the current grouping separator.

String GetGroupingSeparator()

Returns
String The current grouping separator.

HasGroupingSeparatorChanged(inspector)

Check if the current grouping separator has changed.

Boolean, Murl.ChangeInspector HasGroupingSeparatorChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the current grouping separator has changed.
Murl.ChangeInspector inspector The change inspector.

SetAppRunState(appRunState)

Set the current application run state. The current application run state is typically modified by the platform depending on the IEngineConfiguration::SetDeactivatedAppRunState().

Run state changes are reported to the application by calling the Logic::IEngineProcessor::RunStateChanged() method which calls Logic::IAppProcessor::OnRunStateChanged() for all child processors.

SetAppRunState(Murl.IEnums.AppRunState appRunState)

Parameters
appRunStateThe current application run state.

GetAppRunState()

Get the current application run state.

Murl.IEnums.AppRunState GetAppRunState()

Returns
Murl.IEnums.AppRunState The current application run state.

HasAppRunStateChanged(inspector)

Check if the current application run state has changed.

Boolean, Murl.ChangeInspector HasAppRunStateChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the current application run state has changed.
Murl.ChangeInspector inspector The change inspector.

SetMemoryWarning(warn)

Set the memory warning state. The memory warning state is typically set by the iOS platform to signal low memory from ApplicationDidReceiveMemoryWarning. On Android this state is set/cleared if the ActivityManager.MemoryInfo() lowMemory member changes (updated each frame).

SetMemoryWarning(Boolean warn)

Parameters
warnThe memory warning state.

GetMemoryWarning()

Get the memory warning state.

Boolean GetMemoryWarning()

Returns
Boolean true if the a memory warning occured.

HasMemoryWarningChanged(inspector)

Check if the memory warning state has changed.

Boolean, Murl.ChangeInspector HasMemoryWarningChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the memory warning state has changed.
Murl.ChangeInspector inspector The change inspector.

SetAutomaticResourceEvictionEnabled(enabled)

Enable/disable automatic resource eviction. If enabled, all nodes in the scene graph for which automatic swapping is enabled (set via Graph::INode::SetAutomaticSwappingEnabled() or via the node's "enableAutomaticSwapping" XML attribute) will also try to evict any additional resources (e.g. texture memory surfaces) to save memory. However, when these nodes are restored later on, there may be an extra performance cost for re-creating these resources at run time. By default, automatic eviction is disabled; it is considered good practice to only enable it once a memory warning occurred (see GetMemoryWarning()). Note that when manual swapping is enabled on a node (via "enableManualSwapping" or Graph::INode::SetManualSwappingEnabled()), the engine always tries to evict the node's resources when manual swapping is triggered via Graph::IRoot::TriggerSwapping().

SetAutomaticResourceEvictionEnabled(Boolean enabled)

Parameters
enabledIf true, automatic resource eviction is enabled.

IsAutomaticResourceEvictionEnabled()

Check if automatic resource eviction is enabled.

Boolean IsAutomaticResourceEvictionEnabled()

Returns
Boolean true if enabled.

HasAutomaticResourceEvictionEnabledChanged(inspector)

Check if the automatic resource eviction property has changed.

Boolean, Murl.ChangeInspector HasAutomaticResourceEvictionEnabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if changed.
Murl.ChangeInspector inspector The change inspector.

SetMultiTouchActive(enable)

Activate the multi-touch functionality. Activate to receive data by multiple Input::ITouchScreenDevice instances.

This feature is currently supported by iOS platform only. This feature can be activated / deactivated during runtime.

The default multi-touch activation state is true.

SetMultiTouchActive(Boolean enable)

Parameters
enabletrue to enable the multi-touch functionality.

IsMultiTouchActive()

Check if the multi-touch functionality is activated.

Boolean IsMultiTouchActive()

Returns
Boolean true if the multi-touch functionality is activated.

HasMultiTouchActiveChanged(inspector)

Check if the multi-touch activation state has changed.

Boolean, Murl.ChangeInspector HasMultiTouchActiveChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the multi-touch activation state has changed.
Murl.ChangeInspector inspector The change inspector.

SetAccelerometerActive(enable)

Activate the accelerometer functionality. Activate to receive data by the Input::IAccelerometerDevice.

This feature is currently supported by iOS and Android platform. This feature can be activated / deactivated during runtime.

The default accelerometer activation state is false.

SetAccelerometerActive(Boolean enable)

Parameters
enabletrue to enable the accelerometer functionality.

IsAccelerometerActive()

Check if the accelerometer functionality is activated.

Boolean IsAccelerometerActive()

Returns
Boolean true if the accelerometer functionality is activated.

HasAccelerometerActiveChanged(inspector)

Check if the accelerometer activation state has changed.

Boolean, Murl.ChangeInspector HasAccelerometerActiveChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the accelerometer activation state has changed.
Murl.ChangeInspector inspector The change inspector.

SetAccelerometerFrequency(frequency)

Set the accelerometer frequency. This feature is currently supported by iOS platform only. This feature can be activated / deactivated during runtime.

The default accelerometer frequency is 60.

SetAccelerometerFrequency(Integer frequency)

Parameters
frequencyThe accelerometer frequency in samples per second.

GetAccelerometerFrequency()

Get the accelerometer frequency.

Integer GetAccelerometerFrequency()

Returns
Integer The accelerometer frequency in samples per second.

HasAccelerometerFrequencyChanged(inspector)

Check if the accelerometer frequency has changed.

Boolean, Murl.ChangeInspector HasAccelerometerFrequencyChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the accelerometer frequency has changed.
Murl.ChangeInspector inspector The change inspector.

SetGyroscopeActive(enable)

Activate the gyroscope functionality. Activate to receive data by the Input::IGyroscopeDevice.

This feature is currently supported by iOS and Android platform. This feature can be activated / deactivated during runtime.

The default gyroscope activation state is false.

SetGyroscopeActive(Boolean enable)

Parameters
enabletrue to enable the gyroscope functionality.

IsGyroscopeActive()

Check if the gyroscope functionality is activated.

Boolean IsGyroscopeActive()

Returns
Boolean true if the gyroscope functionality is activated.

HasGyroscopeActiveChanged(inspector)

Check if the gyroscope activation state has changed.

Boolean, Murl.ChangeInspector HasGyroscopeActiveChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the gyroscope activation state has changed.
Murl.ChangeInspector inspector The change inspector.

SetGyroscopeFrequency(frequency)

Set the gyroscope frequency. This feature is currently supported by iOS platform only. This feature can be activated / deactivated during runtime.

The default gyroscope frequency is 60.

SetGyroscopeFrequency(Integer frequency)

Parameters
frequencyThe gyroscope frequency in samples per second.

GetGyroscopeFrequency()

Get the gyroscope frequency.

Integer GetGyroscopeFrequency()

Returns
Integer The gyroscope frequency in samples per second.

HasGyroscopeFrequencyChanged(inspector)

Check if the gyroscope frequency has changed.

Boolean, Murl.ChangeInspector HasGyroscopeFrequencyChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the gyroscope frequency has changed.
Murl.ChangeInspector inspector The change inspector.

SetLocationActive(enable)

Activate the location functionality. Activate to receive data by the Input::ILocationDevice.

This feature is currently supported by iOS, OSX and Android platform. This feature can be activated / deactivated during runtime.

The default location activation state is false.

SetLocationActive(Boolean enable)

Parameters
enabletrue to enable the location functionality.

IsLocationActive()

Check if the location functionality is activated.

Boolean IsLocationActive()

Returns
Boolean true if the location functionality is activated.

HasLocationActiveChanged(inspector)

Check if the location activation state has changed.

Boolean, Murl.ChangeInspector HasLocationActiveChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the location activation state has changed.
Murl.ChangeInspector inspector The change inspector.

SetLocationDistanceFilter(meters)

Set the location distance filter. The minimum distance a device must move horizontally before an event is generated.

This feature is currently supported by iOS, OSX and Android platform. This value can be modified during runtime on iOS and OSX only.

The default value is zero, which reports all movements.

SetLocationDistanceFilter(Number meters)

Parameters
metersThe minimum distance in meters.

GetLocationDistanceFilter()

Get the location distance filter.

Number GetLocationDistanceFilter()

Returns
Number The minimum distance in meters.

HasLocationDistanceFilterChanged(inspector)

Check if the location distance filter has changed.

Boolean, Murl.ChangeInspector HasLocationDistanceFilterChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the location distance filter has changed.
Murl.ChangeInspector inspector The change inspector.

SetLocationAccuracy(meters)

Set the location accuracy. The receiver does its best to achieve the requested accuracy, however, the actual accuracy is not guaranteed. You should assign a value that is appropriate for your usage scenario. Determining a location with greater accuracy requires more time and more power.

This feature is currently supported by iOS and OSX platform. This value can be modified during runtime.

The default value is zero, which is the highest accuracy of the device.

SetLocationAccuracy(Number meters)

Parameters
metersThe location accuracy in meters, if the accuracy is negative the highest possible accuracy combined with additional sensor data is used. This level of accuracy is intended for use in navigation applications that require precise position information at all times and are intended to be used only while the device is plugged in.

GetLocationAccuracy()

Get the location accuracy.

Number GetLocationAccuracy()

Returns
Number The accuracy in meters.

HasLocationAccuracyChanged(inspector)

Check if the location accuracy has changed.

Boolean, Murl.ChangeInspector HasLocationAccuracyChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the location accuracy has changed.
Murl.ChangeInspector inspector The change inspector.

SetLocationPurpose(purpose)

Set the location purpose description. If the system needs to ask for the user’s consent to use location services, it displays the location purpose description which should explain why the application is using the location services.

This feature is currently supported by iOS and OSX platform. This value can be modified during runtime.

The default value is an empty string.

SetLocationPurpose(String purpose)

Parameters
purposeThe location purpose description string.

GetLocationPurpose()

Get the location purpose description.

String GetLocationPurpose()

Returns
String The location purpose description string.

HasLocationPurposeChanged(inspector)

Check if the location purpose description has changed.

Boolean, Murl.ChangeInspector HasLocationPurposeChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the location purpose description has changed.
Murl.ChangeInspector inspector The change inspector.

SetHeadingActive(enable)

Activate the heading functionality. Activate to receive data by the Input::IHeadingDevice.

This feature is currently supported by iOS, OSX and Android platform. This feature can be activated / deactivated during runtime.

The default heading activation state is false.

SetHeadingActive(Boolean enable)

Parameters
enabletrue to enable the heading functionality.

IsHeadingActive()

Check if the heading functionality is activated.

Boolean IsHeadingActive()

Returns
Boolean true if the heading functionality is activated.

HasHeadingActiveChanged(inspector)

Check if the heading activation state has changed.

Boolean, Murl.ChangeInspector HasHeadingActiveChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the heading activation state has changed.
Murl.ChangeInspector inspector The change inspector.

SetHeadingCalibrationAllowed(enable)

Allow the heading calibration alert. Allow to displays the heading calibration alert on top of the current window immediately if requested by the system.

This feature is currently supported by iOS platform only. This value can be modified during runtime.

The default value is true.

SetHeadingCalibrationAllowed(Boolean enable)

Parameters
enabletrue to allow the heading calibration alert.

IsHeadingCalibrationAllowed()

Check if the heading calibration alert is allowed.

Boolean IsHeadingCalibrationAllowed()

Returns
Boolean true if the heading calibration alert is allowed.

HasHeadingCalibrationAllowedChanged(inspector)

Check if the heading calibration alert permission has changed.

Boolean, Murl.ChangeInspector HasHeadingCalibrationAllowedChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the heading calibration alert permission has changed.
Murl.ChangeInspector inspector The change inspector.

SetAutoRotationActive(enable)

Activate the screen auto-rotation functionality. Requires active orientation functionality SetOrientationActive(true).

This feature is currently supported by iOS and Android platform. This value can be modified during runtime.

The default screen auto-rotation activation state is false.

SetAutoRotationActive(Boolean enable)

Parameters
enabletrue to allow the screen auto-rotation functionality.

IsAutoRotationActive()

Check if the screen auto-rotation functionality is activated.

Boolean IsAutoRotationActive()

Returns
Boolean true if the screen auto-rotation functionality is activated.

HasAutoRotationActiveChanged(inspector)

Check if the screen auto-rotation activation state has changed.

Boolean, Murl.ChangeInspector HasAutoRotationActiveChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the screen auto-rotation activation state has changed.
Murl.ChangeInspector inspector The change inspector.

SetAutoRotationDuration(duration)

Set the duration of the screen auto-rotation animation. Describes the duration of a screen rotation by 90 degrees, if rotating by 180 degrees the time is doubled.
A duration of zero means no animation.

This feature is supported by iOS platform only. This value can be modified during runtime.

The default screen auto-rotation duration is 0.3 seconds.

SetAutoRotationDuration(Number duration)

Parameters
durationThe screen auto-rotation duration in seconds.

GetAutoRotationDuration()

Get the duration of the screen auto-rotation animation.

Number GetAutoRotationDuration()

Returns
Number The screen auto-rotation duration in seconds.

HasAutoRotationDurationChanged(inspector)

Check if the duration of the screen auto-rotation animation has changed.

Boolean, Murl.ChangeInspector HasAutoRotationDurationChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the screen auto-rotation duration has changed.
Murl.ChangeInspector inspector The change inspector.

SetOrientationActive(enable)

Activate the device orientation functionality. Activate to receive data by the Input::IOrientationDevice.

This feature is currently supported by iOS and Android platform. This feature can be activated / deactivated during runtime.

The default device orientation activation state is false.

SetOrientationActive(Boolean enable)

Parameters
enabletrue to enable the device orientation functionality.

IsOrientationActive()

Check if the device orientation functionality is activated.

Boolean IsOrientationActive()

Returns
Boolean true if the device orientation functionality is activated.

HasOrientationActiveChanged(inspector)

Check if the device orientation activation state has changed.

Boolean, Murl.ChangeInspector HasOrientationActiveChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the device orientation activation state has changed.
Murl.ChangeInspector inspector The change inspector.

SetAllowedScreenOrientations(orientations)

Set the allowed screen orientations. Predefined values are IEnums::SCREEN_ORIENTATIONS_PORTRAIT, IEnums::SCREEN_ORIENTATIONS_LANDSCAPE or IEnums::SCREEN_ORIENTATIONS_ALL. Alternatively the IEnums::ScreenOrientation values can be binary or'ed.

This feature is currently supported by iOS and Android platform. This value can be modified during runtime.

The default allowed orientations is IEnums::SCREEN_ORIENTATION_DEFAULT.

SetAllowedScreenOrientations(Integer orientations)

Parameters
orientationsThe allowed screen orientations.

GetAllowedScreenOrientations()

Get the allowed screen orientations.

Integer GetAllowedScreenOrientations()

Returns
Integer The allowed screen orientations.

HasAllowedScreenOrientationsChanged(inspector)

Check if the allowed screen orientations value has changed.

Boolean, Murl.ChangeInspector HasAllowedScreenOrientationsChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the allowed screen orientations value has changed.
Murl.ChangeInspector inspector The change inspector.

SetScreenOrientation(orientation)

Set the current screen orientation. The current screen orientation defines the screen's orientation relative to the device.

The engine adjust's the rendering output and the input device coordinates depending on the current screen orientation.

The current screen orientation is typically set by the platform's screen auto-rotation feature, see SetAutoRotationActive().

The default screen orientation is IEnums::SCREEN_ORIENTATION_DEFAULT.

SetScreenOrientation(Murl.IEnums.ScreenOrientation orientation)

Parameters
orientationThe current screen orientation.

GetScreenOrientation()

Get the current screen orientation.

Murl.IEnums.ScreenOrientation GetScreenOrientation()

Returns
Murl.IEnums.ScreenOrientation The current screen orientation.

HasScreenOrientationChanged(inspector)

Check if the current screen orientation has changed.

Boolean, Murl.ChangeInspector HasScreenOrientationChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the current screen orientation has changed.
Murl.ChangeInspector inspector The change inspector.

SetDisplaySurfaceOrientation(orientation)

Set the display surface orientation. The display surface orientation defines the display's rendering surface orientation relative to the device.

This is typically set by the platform implementation, applications should not modify this setting.

The default display surface orientation is IEnums::SCREEN_ORIENTATION_DEFAULT.

SetDisplaySurfaceOrientation(Murl.IEnums.ScreenOrientation orientation)

Parameters
orientationThe current screen orientation.

GetDisplaySurfaceOrientation()

Get the display surface orientation. This is typically set by the platform implementation, applications should not depend on this setting.

Murl.IEnums.ScreenOrientation GetDisplaySurfaceOrientation()

Returns
Murl.IEnums.ScreenOrientation The display surface orientation.

HasDisplaySurfaceOrientationChanged(inspector)

Check if the display surface orientation has changed.

Boolean, Murl.ChangeInspector HasDisplaySurfaceOrientationChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the display surface orientation has changed.
Murl.ChangeInspector inspector The change inspector.

GetDisplayRendererOrientation()

Get the display-renderer orientation. The display-renderer orientation is the relative rotation for video rendering depending on the SetScreenOrientation() and the SetDisplaySurfaceOrientation() setting.

Murl.IEnums.Orientation GetDisplayRendererOrientation()

Returns
Murl.IEnums.Orientation The display-renderer orientation.

HasDisplayRendererOrientationChanged(inspector)

Check if the display-renderer orientation has changed.

Boolean, Murl.ChangeInspector HasDisplayRendererOrientationChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the display-renderer orientation has changed.
Murl.ChangeInspector inspector The change inspector.

GetPortraitOrientations()

Get the combined relative portrait orientations.

Integer GetPortraitOrientations()

Returns
Integer The combined relative portrait orientations.

GetPortraitOrientation(index)

Get a relative portrait orientation.

Murl.IEnums.Orientation GetPortraitOrientation(Integer index)

Parameters
indexThe index in range [0 .. 1].
Returns
Murl.IEnums.Orientation The relative portrait orientation.

HasPortraitOrientationsChanged(inspector)

Check if the relative portrait orientations value has changed.

Boolean, Murl.ChangeInspector HasPortraitOrientationsChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the relative portrait orientations value has changed.
Murl.ChangeInspector inspector The change inspector.

GetLandscapeOrientations()

Get the combined relative landscape orientations.

Integer GetLandscapeOrientations()

Returns
Integer The combined relative landscape orientations.

GetLandscapeOrientation(index)

Get a relative landscape orientation.

Murl.IEnums.Orientation GetLandscapeOrientation(Integer index)

Parameters
indexThe index in range [0 .. 1].
Returns
Murl.IEnums.Orientation The relative landscape orientation.

HasLandscapeOrientationsChanged(inspector)

Check if the relative landscape orientations value has changed.

Boolean, Murl.ChangeInspector HasLandscapeOrientationsChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the relative landscape orientations value has changed.
Murl.ChangeInspector inspector The change inspector.

SetDisplaySurfaceSize(sizeX, sizeY)

Set the display surface size. The display surface size defines the video rendering size and the initial window size.

The default display surface size is set by the platform to the full screen resolution of the primary monitor.

The application can modify this setting prior to starting the engine only, e.g. IApp::Configure(). Setting the size is not supported on Android devices.

SetDisplaySurfaceSize(Integer sizeX, Integer sizeY)

Parameters
sizeXThe display surface width in pixels.
sizeYThe display surface height in pixels.

GetDisplaySurfaceSizeX()

Get the display surface width.

Integer GetDisplaySurfaceSizeX()

Returns
Integer The display surface width in pixels.

GetDisplaySurfaceSizeY()

Get the display surface height.

Integer GetDisplaySurfaceSizeY()

Returns
Integer The display surface height in pixels.

HasDisplaySurfaceSizeChanged(inspector)

Check if the display surface size has changed.

Boolean, Murl.ChangeInspector HasDisplaySurfaceSizeChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the display surface size has changed.
Murl.ChangeInspector inspector The change inspector.

SetDisplaySurfaceSafeMargin(x1, y1, x2, y2)

Set the display surface's safe margins. On devices with a notched display and/or overlaid virtual system controls (e.g. iPhone X), this specifies the margins relative to the display surface's four edges making up the area that can be safely used to display relevant content and/or input elements without being obscured.

The value for x1 stores a positive offset from the left edge of the surface, defining the leftmost pixel column to use. Likewise, y1 stores a positive offset from the bottom edge for the bottommost row. (In fact, as the surface always starts at 0/0, the values for x1 and y1 represent the actual left and top pixel coordinate of the safe area).

The values for x2 and y2 store negative offsets from the right and top edges, respectively.

Calculating the actual coordinate values can be done this way: x1 = GetDisplaySurfaceSafeMarginX1(); y1 = GetDisplaySurfaceSafeMarginY1(); x2 = GetDisplaySurfaceSafeMarginX2() + GetDisplaySurfaceSizeX(); y2 = GetDisplaySurfaceSafeMarginY2() + GetDisplaySurfaceSizeY();

Devices without a notch or virtual controls have all four values set to zero. The actual values are defined by the platform implementation.

SetDisplaySurfaceSafeMargin(Integer x1, Integer y1, Integer x2, Integer y2)

Parameters
x1The left offset of the safe area in pixels.
y1The bottom offset of the safe area in pixels.
x2The right offset of the safe area in pixels.
y2The top offset of the safe area in pixels.

GetDisplaySurfaceSafeMarginX1()

Get the display surface's left safe area margin.

Integer GetDisplaySurfaceSafeMarginX1()

Returns
Integer The left margin in pixels.

GetDisplaySurfaceSafeMarginY1()

Get the display surface's bottom safe area margin.

Integer GetDisplaySurfaceSafeMarginY1()

Returns
Integer The bottom margin in pixels.

GetDisplaySurfaceSafeMarginX2()

Get the display surface's right safe area margin.

Integer GetDisplaySurfaceSafeMarginX2()

Returns
Integer The right margin in pixels.

GetDisplaySurfaceSafeMarginY2()

Get the display surface's top safe area margin.

Integer GetDisplaySurfaceSafeMarginY2()

Returns
Integer The top margin in pixels.

HasDisplaySurfaceSafeMarginChanged(inspector)

Check if the display surface's safe margins have changed.

Boolean, Murl.ChangeInspector HasDisplaySurfaceSafeMarginChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the display surface's safe margins have changed.
Murl.ChangeInspector inspector The change inspector.

SetWindowAspectRatio(ratio)

Set the window aspect ratio. Windows are supported on desktop platforms only.

SetWindowAspectRatio(Number ratio)

Parameters
ratioThe window aspect ratio (width / height).

SetWindowAspectRatio(numerator, denominator)

Set the window aspect ratio by integer. Windows are supported on desktop platforms only.

SetWindowAspectRatio(Integer numerator, Integer denominator)

Parameters
numeratorThe window aspect numerator value.
denominatorThe window aspect denominator value.

GetWindowAspectRatio()

Get the window aspect ratio. Windows are supported on desktop platforms only.

Number GetWindowAspectRatio()

Returns
Number The window aspect ratio (width / height).

GetWindowAspectRatioNumerator()

Get the window aspect numerator. Windows are supported on desktop platforms only.

Integer GetWindowAspectRatioNumerator()

Returns
Integer The window aspect numerator value.

GetWindowAspectRatioDenominator()

Get the window aspect denominator. Windows are supported on desktop platforms only.

Integer GetWindowAspectRatioDenominator()

Returns
Integer The window aspect denominator value.

HasWindowAspectRatioChanged(inspector)

Check if the window aspect ratio has changed.

Boolean, Murl.ChangeInspector HasWindowAspectRatioChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the window aspect ratio has changed.
Murl.ChangeInspector inspector The change inspector.

GetWindowSizeX()

Get the window width. The initial window width is set to the size passed to SetDisplaySurfaceSize().

Windows are supported on desktop platforms only.

Integer GetWindowSizeX()

Returns
Integer The window width in pixels.

GetWindowSizeY()

Get the window height. The initial window height is set to the size passed to SetDisplaySurfaceSize().

Windows are supported on desktop platforms only.

Integer GetWindowSizeY()

Returns
Integer The window height in pixels.

HasWindowSizeChanged(inspector)

Check if the window size has changed.

Boolean, Murl.ChangeInspector HasWindowSizeChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the window size has changed.
Murl.ChangeInspector inspector The change inspector.

SetLockWindowAspectEnabled(enable)

Lock the window aspect ratio. Windows are supported on desktop platforms only.

SetLockWindowAspectEnabled(Boolean enable)

Parameters
enabletrue to lock the window aspect ratio.

IsLockWindowAspectEnabled()

Check if the window aspect ratio is locked. Windows are supported on desktop platforms only.

Boolean IsLockWindowAspectEnabled()

Returns
Boolean true if the window aspect ratio is locked.

HasLockWindowAspectEnabledChanged(inspector)

Check if the window aspect ratio lock has changed.

Boolean, Murl.ChangeInspector HasLockWindowAspectEnabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the window aspect ratio lock has changed.
Murl.ChangeInspector inspector The change inspector.

SetMouseCursorHidden(hide)

Hide the mouse cursor. The mouse cursor is supported on desktop platforms only.

SetMouseCursorHidden(Boolean hide)

Parameters
hidetrue to hide the mouse cursor.

IsMouseCursorHidden()

Check if the mouse cursor is hidden. The mouse cursor is supported on desktop platforms only.

Boolean IsMouseCursorHidden()

Returns
Boolean true the mouse cursor is hidden.

HasMouseCursorHiddenChanged(inspector)

Check if the mouse cursor is hidden status has changed.

Boolean, Murl.ChangeInspector HasMouseCursorHiddenChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the mouse cursor is hidden status has changed.
Murl.ChangeInspector inspector The change inspector.

SetMouseCursorDisabled(disable)

Disable the mouse cursor. If the mouse cursor is disabled no mouse coordinates are generated but mouse movement can be accessed by Input::IRawMouseDevice. When disabling the mouse cursor typically SetMouseCursorHidden(true) should be called too.

The mouse cursor is supported on desktop platforms only.

SetMouseCursorDisabled(Boolean disable)

Parameters
disabletrue to disable the mouse cursor.

IsMouseCursorDisabled()

Check if the mouse cursor is disabled. The mouse cursor is supported on desktop platforms only.

Boolean IsMouseCursorDisabled()

Returns
Boolean true the mouse cursor is disabled.

HasMouseCursorDisabledChanged(inspector)

Check if the mouse cursor is disabled status has changed.

Boolean, Murl.ChangeInspector HasMouseCursorDisabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the mouse cursor is disabled status has changed.
Murl.ChangeInspector inspector The change inspector.

SetMouseCoordinateClampingDisabled(disable)

Disable mouse input coordinate clamping. By default, input mouse coordinates are clamped to the range [-1.0 .. 1.0], which represents the actual screen bounds in view space.

SetMouseCoordinateClampingDisabled(Boolean disable)

Parameters
disabletrue to disable the coordinate clamping.

IsMouseCoordinateClampingDisabled()

Check if mouse input coordinate clamping is disabled.

Boolean IsMouseCoordinateClampingDisabled()

Returns
Boolean true ifdisabled.

HasMouseCoordinateClampingDisabledChanged(inspector)

Check if the mouse input coordinate clamping status has changed.

Boolean, Murl.ChangeInspector HasMouseCoordinateClampingDisabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if changed.
Murl.ChangeInspector inspector The change inspector.

SetCommandKeyDisabled(disable)

Disable the command-key. Disabling the command-key suppresses the functionallity of the windows-key.

This feature is supported on windows platforms only.

SetCommandKeyDisabled(Boolean disable)

Parameters
disabletrue to disable the command-key.

IsCommandKeyDisabled()

Check if the command-key is disabled. This feature is supported on windows platforms only.

Boolean IsCommandKeyDisabled()

Returns
Boolean true the command-key is disabled.

HasCommandKeyDisabledChanged(inspector)

Check if the command-key is disabled status has changed.

Boolean, Murl.ChangeInspector HasCommandKeyDisabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the command-key is disabled status has changed.
Murl.ChangeInspector inspector The change inspector.

SetDisplayRefreshFrequency(frequency, forcedFrames)

Set the desired display refresh frequency. This feature is currently supported by the iOS and Android platforms only. This feature can be activated / deactivated during runtime. The default desired display refresh frequency is 60 frames per second.

SetDisplayRefreshFrequency(Integer frequency, Integer forcedFrames)

Parameters
frequencyThe display refresh frequency in frames per second.
forcedFramesThe number of frames to subsequently force the internal clock's frame duration to the value calculated from the desired frame rate, or 0 if forcing should not be done.

GetDisplayRefreshFrequency()

Get the display refresh frequency.

Integer GetDisplayRefreshFrequency()

Returns
Integer The display refresh frequency in frames per second.

GetDisplayRefreshFrequencyForcedFrames()

Get the number of frames the frame duration is forced to the selected frame rate.

Integer GetDisplayRefreshFrequencyForcedFrames()

Returns
Integer The number of frames to apply forcing.

HasDisplayRefreshFrequencyChanged(inspector)

Check if the display refresh frequency has changed.

Boolean, Murl.ChangeInspector HasDisplayRefreshFrequencyChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the display refresh frequency has changed.
Murl.ChangeInspector inspector The change inspector.

SetClockDeltaLimit(seconds)

Set the internal clock's maximum frame delta limit. The default limit is 1.0 seconds.

SetClockDeltaLimit(Number seconds)

Parameters
secondsThe upper frame duration limit in seconds.

GetClockDeltaLimit()

Get the internal clock's maximum frame delta limit.

Number GetClockDeltaLimit()

Returns
Number The upper frame duration limit in seconds.

HasClockDeltaLimitChanged(inspector)

Check if the maximum frame delta limit has changed.

Boolean, Murl.ChangeInspector HasClockDeltaLimitChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the limit has changed.
Murl.ChangeInspector inspector The change inspector.

SetClockTimeBase(factor)

Set the internal clock's time base factor. The default time base factor is 1.0.

SetClockTimeBase(Number factor)

Parameters
factorThe time base factor.

GetClockTimeBase()

Get the internal clock's time base factor.

Number GetClockTimeBase()

Returns
Number The time base factor.

HasClockTimeBaseChanged(inspector)

Check if the clock time base has changed.

Boolean, Murl.ChangeInspector HasClockTimeBaseChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the time base has changed.
Murl.ChangeInspector inspector The change inspector.

SetClockAveragingFactor(factor)

Set the internal clock's averaging factor. The default averaging factor is 0.1.

SetClockAveragingFactor(Number factor)

Parameters
factorThe averaging factor.

GetClockAveragingFactor()

Get the internal clock's averaging factor.

Number GetClockAveragingFactor()

Returns
Number The averaging factor.

HasClockAveragingFactorChanged(inspector)

Check if the clock's averaging factor has changed.

Boolean, Murl.ChangeInspector HasClockAveragingFactorChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the factor has changed.
Murl.ChangeInspector inspector The change inspector.

SetRunLoopTriggers(triggers)

Set run loop trigger hints.

SetRunLoopTriggers(Integer triggers)

Parameters
triggersA combination of IEnums::RunLoopTrigger values.

GetRunLoopTriggers()

Get run loop trigger hints.

Integer GetRunLoopTriggers()

Returns
Integer A combination of IEnums::RunLoopTrigger values.

HasRunLoopTriggersChanged(inspector)

Check if the run loop triggers have changed.

Boolean, Murl.ChangeInspector HasRunLoopTriggersChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if changed.
Murl.ChangeInspector inspector The change inspector.

SetFullScreenEnabled(enable)

Enable the full screen display. The full screen display is a borderless window which covers the entire screen of the window's current monitor.

The default full screen display state is enabled. Windows are supported on desktop platforms only.

SetFullScreenEnabled(Boolean enable)

Parameters
enabletrue to enable the full screen display.

IsFullScreenEnabled()

Check if the full screen display is enabled. Windows are supported on desktop platforms only.

Boolean IsFullScreenEnabled()

Returns
Boolean true if the full screen display is enabled.

HasFullScreenEnabledChanged(inspector)

Check if the full screen display status has changed.

Boolean, Murl.ChangeInspector HasFullScreenEnabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the full screen display status has changed.
Murl.ChangeInspector inspector The change inspector.

SetIosHomeIndicatorAutoHiddenEnabled(enabled)

Enable or disable auto-hiding of the home indicator on iOS 11+ devices, if present. If enabled the home indicator will automatically be hidden when there is no user input for a certain amount of time.

This option is only available on devices that do not have a physical home button and show a virtual home indicator instead, such as iPhone X/XS/XR etc. On all other devices, setting this option has no effect.

The default value is true.

SetIosHomeIndicatorAutoHiddenEnabled(Boolean enabled)

Parameters
enabledtrue to enable.

IsIosHomeIndicatorAutoHiddenEnabled()

Check if auto-hiding of the home indicator is enabled.

Boolean IsIosHomeIndicatorAutoHiddenEnabled()

Returns
Boolean true if the feature is enabled.

HasIosHomeIndicatorAutoHiddenChanged(inspector)

Check if auto-hiding of the home indicator has changed.

Boolean, Murl.ChangeInspector HasIosHomeIndicatorAutoHiddenChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the setting has changed.
Murl.ChangeInspector inspector The change inspector.

SetIosPreferredScreenEdgesDeferringSystemGestures(edges)

Set screen edges with user gesture precedence over system gestures. This option is only available for iOS 11+ devices. On all other devices, setting this option has no effect.

The default value specifies all edges.

SetIosPreferredScreenEdgesDeferringSystemGestures(Integer edges)

Parameters
edgesA bit mask of preferred edges.

GetIosPreferredScreenEdgesDeferringSystemGestures()

Get screen edges with user gesture precedence over system gestures.

Integer GetIosPreferredScreenEdgesDeferringSystemGestures()

Returns
Integer A bit mask of preferred edges.

HasIosPreferredScreenEdgesDeferringSystemGesturesChanged(inspector)

Check if user gesture precedence edges have changed.

Boolean, Murl.ChangeInspector HasIosPreferredScreenEdgesDeferringSystemGesturesChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the setting has changed.
Murl.ChangeInspector inspector The change inspector.

SetAndroidLowProfileNavigationBarEnabled(enabled)

Enable or disable low profile mode for navigation bars on Android devices. If enabled the navigation bar will switch to (dimmed) low profile mode.

This option is only available on devices where the Android API level is greater than or equal to 14 (Android 4.0 ICE_CREAM_SANDWICH). Enabling this feature will have no effect on devices with API level smaller than 14.

The default value is false.

SetAndroidLowProfileNavigationBarEnabled(Boolean enabled)

Parameters
enabledtrue to enable.

IsAndroidLowProfileNavigationBarEnabled()

Check if the low profile mode for navigation bars is enabled.

Boolean IsAndroidLowProfileNavigationBarEnabled()

Returns
Boolean true if the feature is enabled.

HasAndroidLowProfileNavigationBarChanged(inspector)

Check if the low profile mode has changed.

Boolean, Murl.ChangeInspector HasAndroidLowProfileNavigationBarChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the setting has changed.
Murl.ChangeInspector inspector The change inspector.

SetAndroidHideNavigationBarImmersiveStickyEnabled(enabled)

Enable or disable the hide navigation bar feature on Android devices. If enabled the app will hide the navigation bar and set the Immersive_Sticky_Flag. When system bars are hidden in immersive mode, they can be revealed temporarily with system gestures, such as swiping from the top of the screen. These transient system bars will overlay app’s content, may have some degree of transparency, and will automatically hide after a short timeout.

This option is only available on devices where the Android API level is greater than or equal to 18 (Android 4.4 KITKAT). Enabling this feature will have no effect on devices with API level smaller than 18.

The default value is false.

SetAndroidHideNavigationBarImmersiveStickyEnabled(Boolean enabled)

Parameters
enabledtrue to enable.

IsAndroidHideNavigationBarImmersiveStickyEnabled()

Check if the hide navigation bar feature is enabled.

Boolean IsAndroidHideNavigationBarImmersiveStickyEnabled()

Returns
Boolean true if the feature is enabled.

HasAndroidHideNavigationBarImmersiveStickyChanged(inspector)

Check if the hide navigation bar feature has changed.

Boolean, Murl.ChangeInspector HasAndroidHideNavigationBarImmersiveStickyChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the setting has changed.
Murl.ChangeInspector inspector The change inspector.

SetSystemDebugInfoEnabled(enable)

Enable the system debug-info display. The system debug-info display is available if the built-in "debug" resource package is loaded.

The default system debug-info state is enabled.

SetSystemDebugInfoEnabled(Boolean enable)

Parameters
enabletrue to enable the system debug-info display.

IsSystemDebugInfoEnabled()

Check if the system debug-info display is enabled.

Boolean IsSystemDebugInfoEnabled()

Returns
Boolean true if the system debug-info display is enabled.

HasSystemDebugInfoEnabledChanged(inspector)

Check if the system debug-info status has changed.

Boolean, Murl.ChangeInspector HasSystemDebugInfoEnabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the system debug-info status has changed.
Murl.ChangeInspector inspector The change inspector.

SetSystemDebugInfoScaleFactor(factor)

Set the system debug-info scale factor. The system debug-info display is available if the built-in "debug" resource package is loaded.

The default system debug-info scale factor is 1.

SetSystemDebugInfoScaleFactor(Number factor)

Parameters
factorThe system debug-info scale factor.

GetSystemDebugInfoScaleFactor()

Get the system debug-info scale factor.

Number GetSystemDebugInfoScaleFactor()

Returns
Number The system debug-info scale factor.

HasSystemDebugInfoScaleFactorChanged(inspector)

Check if the system debug-info scale factor has changed.

Boolean, Murl.ChangeInspector HasSystemDebugInfoScaleFactorChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the system debug-info scale factor has changed.
Murl.ChangeInspector inspector The change inspector.

SetSystemDebugInfoItems(itemMask)

Select which items to display in the system debug info display. This method can be used to manually select which debug info should be displayed. The itemMask parameter represents a bit mask of individual IEnums::StatisticItem values.

SetSystemDebugInfoItems(Integer itemMask)

Parameters
itemMaskThe bit mask of items to display.

GetSystemDebugInfoItems()

Get the bit mask of displayed debug info items.

Integer GetSystemDebugInfoItems()

Returns
Integer The bit mask of displayed items.

HasSystemDebugInfoItemsChanged(inspector)

Check if the system debug-info items have changed.

Boolean, Murl.ChangeInspector HasSystemDebugInfoItemsChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the system debug-info items have changed.
Murl.ChangeInspector inspector The change inspector.

SetUserDebugInfoEnabled(enable)

Enable the user debug-info display. The user debug-info display is available if the built-in "debug" resource package is loaded. The user debug-info can be set by Logic::IState::SetUserDebugMessage().

The default user debug-info state is enabled.

SetUserDebugInfoEnabled(Boolean enable)

Parameters
enabletrue to enable the user debug-info display.

IsUserDebugInfoEnabled()

Check if the user debug-info display is enabled.

Boolean IsUserDebugInfoEnabled()

Returns
Boolean true if the user debug-info display is enabled.

HasUserDebugInfoEnabledChanged(inspector)

Check if the user debug-info status has changed.

Boolean, Murl.ChangeInspector HasUserDebugInfoEnabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the user debug-info status has changed.
Murl.ChangeInspector inspector The change inspector.

SetUserDebugInfoScaleFactor(factor)

Set the user debug-info scale factor. The user debug-info display is available if the built-in "debug" resource package is loaded. The user debug-info can be set by Logic::IState::SetUserDebugMessage().

The default user debug-info scale factor is 1.

SetUserDebugInfoScaleFactor(Number factor)

Parameters
factorThe user debug-info scale factor.

GetUserDebugInfoScaleFactor()

Get the user debug-info scale factor.

Number GetUserDebugInfoScaleFactor()

Returns
Number The user debug-info scale factor.

HasUserDebugInfoScaleFactorChanged(inspector)

Check if the user debug-info scale factor has changed.

Boolean, Murl.ChangeInspector HasUserDebugInfoScaleFactorChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the user debug-info scale factor has changed.
Murl.ChangeInspector inspector The change inspector.

SetDebugMouseEnabled(enable)

Enable the debug mouse pointer. The debug mouse pointer is available if the built-in "debug" resource package is loaded.

The default debug mouse pointer state is disabled.

SetDebugMouseEnabled(Boolean enable)

Parameters
enabletrue to enable the debug mouse pointer.

IsDebugMouseEnabled()

Check if the debug mouse pointer is enabled.

Boolean IsDebugMouseEnabled()

Returns
Boolean true if the debug mouse pointer is enabled.

HasDebugMouseEnabledChanged(inspector)

Check if the debug mouse pointer status has changed.

Boolean, Murl.ChangeInspector HasDebugMouseEnabledChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the debug mouse pointer status has changed.
Murl.ChangeInspector inspector The change inspector.

SetDebugMouseScaleFactor(factor)

Set the debug mouse pointer scale factor. The debug mouse pointer is available if the built-in "debug" resource package is loaded.

The default debug mouse pointer scale factor is 1.

SetDebugMouseScaleFactor(Number factor)

Parameters
factorThe debug mouse pointer scale factor.

GetDebugMouseScaleFactor()

Get the debug mouse pointer scale factor.

Number GetDebugMouseScaleFactor()

Returns
Number The debug mouse pointer scale factor.

HasDebugMouseScaleFactorChanged(inspector)

Check if the debug mouse pointer scale factor has changed.

Boolean, Murl.ChangeInspector HasDebugMouseScaleFactorChanged(Murl.ChangeInspector inspector)

Parameters
inspectorThe change inspector.
Returns
Boolean true if the debug mouse pointer scale factor has changed.
Murl.ChangeInspector inspector The change inspector.

SetDebugOutputFunctionVerbosity(itemMask)

Set the trace/error items' verbosity bit mask. The itemMask parameter represents a bit mask of individual values from the IEnums::DebugOutputFunctionItem enumeration, which can be used to select individual items to trace for each function/method call.

SetDebugOutputFunctionVerbosity(Integer itemMask)

Parameters
itemMaskThe trace item bit mask.

GetDebugOutputFunctionVerbosity()

Get the trace items' bit mask.

Integer GetDebugOutputFunctionVerbosity()

Returns
Integer The trace item bit mask.

SetDebugTraceLevel(level)

Set the global trace level used in MURL_TRACE macros. When running a debug build, only those trace messages are printed whose trace level is equal or below the value specified using this method. In a release build, all calls to MURL_TRACE macros are removed, so no tracing occurs at all. By default, the trace level is set to 1, which enables basic engine traces. Increase the level to get more detailed traces from the engine, currently the most detailed level is 3. The default application trace level is 0, so a value of 0 disables all engine traces and only prints app-specific messages. To further filter app traces, the level can also be set to negative values. The trace level can also be changed at run-time, so it is possible to only activate more detailed traces when a specific (user-defined) condition is met.

SetDebugTraceLevel(Integer level)

Parameters
levelThe global trace level.

GetDebugTraceLevel()

Get the global trace level used in MURL_TRACE macros.

Integer GetDebugTraceLevel()

Returns
Integer The global trace level.

SetTrackerTraceLevel(level)

Set the trace verbosity for scene graph tracker messages. A level <= 0 disables both errors and warnings, a level of 1 enables only errors and a level >= 2 enables both. By default, in release builds a trace level of 1 is set, and for debug builds a level of 2.

SetTrackerTraceLevel(Integer level)

Parameters
levelThe tracker trace level.

GetTrackerTraceLevel()

Get the trace verbosity for scene graph tracker messages.

Integer GetTrackerTraceLevel()

Returns
Integer The tracker trace level.