Universal World Owners Manual

Scripts run on the server can create an OSD layout that is transmitted to then executed by the client. See the ScriptedOSD Overview for a general description of how this system is used.

The OSD_TYPE can be one of :
- OSDWINDOW
- OSDBUILDING
- OSDPOPUP
- OSDBLANK
- OSDLOWER
- OSDTUTORIAL
- OSDNOTIFICATION
- OSDSPEC
- OSDSPECLOWER
- OSDBLANKCENTER
- OSDSCRIPTEDBUILDING

If OSDWINDOW is used a background window is created 400×300, in the center of the screen. With OSDBUILDING, the OSD is displayed within the region of the building access window.

The Name of the OSD is used to identify its components : See [Responding to OSD Button Presses].

Parameters : OSD_ITEMTYPE, Name, Title
Example : OsdAddItem(OSDIMAGE,“”, “http://myweb.com/image.jpg” )
Description :

Parameters : OSD_ITEMTYPE, X, Y, W, H, Name, Title
Example : OsdAddAt(OSDBUTTON, 100, 100, 200, 20, “Option1”, “Press me” )
Description :

Currently, “BlockEscape” is the only valid flag and is used to remove the user control to press escape to close an osd screen. Example

osdcreate( OSDLOWER, "Help", "Help Guide" )
osdset( "BlockEscape" )
osdaddat( TEXT, 100,0, 400, 100, "", "Welcome to my world, press the button to start" )
osdaddat( BUTTON, 200, 70, 200, 35, "", "Start Game" )
osdactivate()

Parameters : None Example : OsdActivate()
Description : Triggers the actual transmission of the OSD layout to the client.

Text can be added to your OSD using various text types, that specify the size, alignment and colour of the text to be displayed. Valid text types are as follows :

1. TEXT
2. BIGTEXT
3. FADEDTEXT
4. SMALLTEXT
5. TEXTRIGHT
6. SMALLTEXTRIGHT
7. BIGTEXTRIGHT
8. BOLDTEXT
9. SMALLFADEDTEXT (or FADEDSMALLTEXT)
10. BIGFADEDTEXT
11. WARNINGTEXT
12. BIGWARNINGTEXT
13. TEXT2
14. FADEDTEXT2
15. TEXT2RIGHT
16. GIANTTEXT
17. GIANTTEXTRIGHT
18. GIANTFADEDTEXT
19. BLINKINGWARNINGTEXT

- BUTTON - EXITBUTTON - FADEDBUTTON - APPLYBUTTON - APPLYEXITBUTTON

- IMAGE - FADEDIMAGE - EXITIMAGE