docs/console.txt
author truelight
Thu, 06 Jan 2005 22:31:58 +0000
changeset 919 b0d6c7642f99
parent 799 56e334cb4d31
permissions -rw-r--r--
(svn r1407) -Codechange: changed a lot around _stations, _vehicles, _towns and _industries
(in prepare of dynamic arrays):
- DEREF_XXX is changed into GetXXX
- All direct call are directed via GetXXX
- struct Industry has now an index-field
- ENUM'd some stuff
- Replaced home built loops with FOR_ALL_XXX
- Added _stations_size, _vehicles_size, ... which gives the length of the
array (which will be dynamic in the near future)
- Changed lengtof(XXX) to _XXX_size (e.g. _stations_size)
- Removed all endof(XXX) (because mostly it was part of a FOR_ALL_XXX)
- Made the sort-functions of all 4 dynamic
- Made all 4 Initialize functions more of the same
- Some minor tab-fixing and stuff
(tnx to Tron for proof-reading my 100kb patch ;))

Note for all: please do NOT directly call _stations, _vehicles, _towns and
_industries, but use the right wrapper to access them. Thank you.
Ps: please also do not use 'v++', where v is of type Vehicle *.
OPENTTD INGAME CONSOLE DOCUMENTATION
====================================
http://wiki.openttd.org/index.php/OpenTTDDevBlackBook
for detailed information

*** WARNING **
 This document is out of date
*** WARNING **

HOTKEY: BACKQUOTE (aka tilde, the key left to "1")

COMMANDS:
---------

echo [string]
echoc [color-code] [string]
exit
debug_level [0-9]
dump_vars [filter]
help
list_cmds [filter]
list_vars [filter]
printf [formatstring] [var] [var] [var]....
printfc [color-code] [formatstring] [var] [var] [var]....
quit
random
screenshot ["big"/"no_con"]

VARIABLES:
----------
*con_developer
-> true = console debugging info
-> false = no output

*developer
-> 0 = no output
-> 1 = console error output [like command not found]
-> 2 = console error and debug output

*cursor_rate
-> 1-12 = defines the cursor blink interval


VARIABLE HANDLING:
------------------

developer = 0
developer ++

temp_string = test
temp_string = "my little"

printf "%s world" temp_string


---------------------------------------------------
feel free to add more commands and use this in-game
console for your debugging / enhancements