User Tools

Site Tools


scripting:reference:scriptedosd

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
scripting:reference:scriptedosd [2023/02/28 06:58] – [OSDAdd] mitscripting:reference:scriptedosd [2023/05/15 03:53] (current) – [OSDText / OSDTextRight / OSDTextCenter] mit
Line 28: Line 28:
  
 Each type has a different default setup and use case, e.g. ''OSDWINDOW'' creates a 400x300 background window positioned in the center of the screen. For ''OSDBUILDING'', the OSD is displayed within the region of the building access window. See [OSD Types Reference] for details of each type. Each type has a different default setup and use case, e.g. ''OSDWINDOW'' creates a 400x300 background window positioned in the center of the screen. For ''OSDBUILDING'', the OSD is displayed within the region of the building access window. See [OSD Types Reference] for details of each type.
 +
 +==== OSDText / OSDTextRight / OSDTextCenter ====
 +^ Parameters | ''[TEXTYPE]'', X, Y, ''Text'' |
 +^ Example | ''OSDText( SMALL, 100, 100, "Hello World" )'' |
 +^ Description | Adds text to an OSD at the specified coordinate.  |
 +Note TEXTTYPE can be ommitted (text defaults to 'NORMAL') so  OSDText( 10, 10, "Hello" ) is valid. 
 +Full list of supported types below..
  
 ==== OSDAdd ==== ==== OSDAdd ====
Line 49: Line 56:
 osdcreate( OSDLOWER, "Help", "Help Guide" ) osdcreate( OSDLOWER, "Help", "Help Guide" )
 osdset( "BlockEscape" ) osdset( "BlockEscape" )
-osdaddat( TEXT, 100,0, 400, 100, "", "Welcome to my world, press the button to start" ) +osdadd( TEXT, 100,0, 400, 100, "", "Welcome to my world, press the button to start" ) 
-osdaddat( BUTTON, 200, 70, 200, 35, "", "Start Game" )+osdadd( BUTTON, 200, 70, 200, 35, "", "Start Game" )
 osdactivate() osdactivate()
 </code> </code>
Line 67: Line 74:
  
 ===== ScriptedOSD Item Types ===== ===== ScriptedOSD Item Types =====
- 
-==== Text Types ==== 
-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 :\\ 
-  * TEXT 
-  * BIGTEXT 
-  * FADEDTEXT 
-  * SMALLTEXT 
-  * TEXTRIGHT 
-  * SMALLTEXTRIGHT 
-  * BIGTEXTRIGHT 
-  * BOLDTEXT 
-  * SMALLFADEDTEXT (or FADEDSMALLTEXT) 
-  * BIGFADEDTEXT 
-  * WARNINGTEXT 
-  * BIGWARNINGTEXT 
-  * TEXT2 
-  * FADEDTEXT2 
-  * TEXT2RIGHT 
-  * GIANTTEXT 
-  * GIANTTEXTRIGHT 
-  * GIANTFADEDTEXT 
-  * BLINKINGWARNINGTEXT 
-  * BULLET 
  
 ==== Button Types ==== ==== Button Types ====
Line 113: Line 96:
   * LAYERRECT   * LAYERRECT
   * COUNTDOWN   * COUNTDOWN
-  *  
 ==== User Input Types ==== ==== User Input Types ====
  
Line 133: Line 115:
   * LISTBUTTON    * LISTBUTTON 
   * DATE   * DATE
 +
 +===== ScriptedOSD Text Types =====
 +
 +Text can be added to your OSD using various text types, that specify the size and colour of the text to be displayed.
 +If the text type is ommitted, standard text formatting will be used, otherwise valid text types are as follows :\\
 +
 +  * BIG
 +  * FADED
 +  * SMALL
 +  * BOLD
 +  * SMALLFADED
 +  * BIGFADED
 +  * WARNING
 +  * BIGWARNING
 +  * FONT2
 +  * FADEDFONT2
 +  * GIANT
 +  * GIANTFADED
 +  * BLINKINGWARNING
 +  * BULLET
 +  * GOLD
 +  * SILVER
 +  * BRONZE
 +  * BIGGOLD
 +  * BIGSILVER
 +  * BIGBRONZE
 +
  
scripting/reference/scriptedosd.1677589120.txt.gz · Last modified: 2023/02/28 06:58 by mit

Except where otherwise noted, content on this wiki is licensed under the following license: Public Domain
Public Domain Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki