docs/console.txt
changeset 5655 8f59540932fe
parent 5654 0c9a14fb6113
child 5656 0ce356fe63ad
equal deleted inserted replaced
5654:0c9a14fb6113 5655:8f59540932fe
     1 OPENTTD INGAME CONSOLE DOCUMENTATION
       
     2 ====================================
       
     3 http://wiki.openttd.org/index.php/OpenTTDDevBlackBook
       
     4 for detailed information
       
     5 
       
     6 *** WARNING **
       
     7  This document is out of date
       
     8 *** WARNING **
       
     9 
       
    10 HOTKEY: BACKQUOTE (aka tilde, the key left to "1")
       
    11 
       
    12 COMMANDS:
       
    13 ---------
       
    14 
       
    15 echo [string]
       
    16 echoc [color-code] [string]
       
    17 exit
       
    18 debug_level [0-9]
       
    19 dump_vars [filter]
       
    20 help
       
    21 list_cmds [filter]
       
    22 list_vars [filter]
       
    23 printf [formatstring] [var] [var] [var]....
       
    24 printfc [color-code] [formatstring] [var] [var] [var]....
       
    25 quit
       
    26 random
       
    27 screenshot ["big"/"no_con"]
       
    28 
       
    29 VARIABLES:
       
    30 ----------
       
    31 *con_developer
       
    32 -> true = console debugging info
       
    33 -> false = no output
       
    34 
       
    35 *developer
       
    36 -> 0 = no output
       
    37 -> 1 = console error output [like command not found]
       
    38 -> 2 = console error and debug output
       
    39 
       
    40 *cursor_rate
       
    41 -> 1-12 = defines the cursor blink interval
       
    42 
       
    43 
       
    44 VARIABLE HANDLING:
       
    45 ------------------
       
    46 
       
    47 developer = 0
       
    48 developer ++
       
    49 
       
    50 temp_string = test
       
    51 temp_string = "my little"
       
    52 
       
    53 printf "%s world" temp_string
       
    54 
       
    55 
       
    56 ---------------------------------------------------
       
    57 feel free to add more commands and use this in-game
       
    58 console for your debugging / enhancements