Warning
This module has been deprecated in SDK 0.19.0. Meaning it and its support on the Hub and the game site is likely going to disappear in the near future. Its functionality is now integrated into the new TurbulenzBridge library. For more details, please see the OSD-Examples.
The On Screen Display Library (osdlib) offers an interface to the osdobserver module that displays ready-styled save/load/busy messages on the Turbulenz pages. It uses the same little tab that you can sometimes see when logging into the page.
To use it, include the file jslib/services/osdlib.js in your template and create an osd-object by calling OSD.create().
Please note that for every start- call there should be one stop- call. The object keeps count of how many calls to startLoading and startSaving there where. The counter is decreased for every call to stopLoading and stopSaving. Only when the counter reaches zero is the tab removed.
Note
Any processing code following the OSD call must give time back to the browser to allow the browser to render the OSD message.
Summary
Creates an OSD object. (DEPRECATED in SDK 0.19.0, please refer to the TurbulenzBridge documentation for details)
Syntax
var osd = OSD.create();
Returns an OSD object.
Summary
Signals the begin of a loading process. (DEPRECATED in SDK 0.19.0, please refer to the TurbulenzBridge documentation for details)
Syntax
var osd = OSD.create();
osd.startLoading();
Summary
Signals the end of a loading process. (DEPRECATED in SDK 0.19.0, please refer to the TurbulenzBridge documentation for details)
Syntax
var osd = OSD.create();
osd.stopLoading();
Summary
Signals the begin of a saving process. (DEPRECATED in SDK 0.19.0, please refer to the TurbulenzBridge documentation for details)
Syntax
var osd = OSD.create();
osd.startSaving();
Summary
Signals the end of a saving process. (DEPRECATED in SDK 0.19.0, please refer to the TurbulenzBridge documentation for details)
Syntax
var osd = OSD.create();
osd.stopSaving();