scripts/readme.txt
author rubidium
Sat, 30 Dec 2006 00:46:48 +0000
changeset 5428 00fab4aeff78
parent 3971 77061ae9b534
permissions -rw-r--r--
(svn r7632) -Codechange: several small code cleanups of texteff, like moving magic values and defines to an enum and fix coding/documentation style.
-Codechange: make DeleteAnimatedTile a little clearer (pv2b).
Scripting
---------

OpenTTD supports scripts.

local scripts:
 - 'autoexec.scr' is executed on gamestart [all - use this for custom aliases per ex.]

+network scripts:
   should be used to set client optimization settings:
 - 'on_client.scr' is executed when you join a server [all clients]

   should be used to set the servers port/ip and/or server optimization settings/patches:
 - 'pre_server.scr' is executed before the servers tcp stack is started [in-game only]
 - 'pre_dedicated.scr' is executed before the servers tcp stack is started [dedicated only]

   should be used to set the servers name, password and so on:
 - 'on_server.scr' is executed after starting a server [dedicated and in-game]
 - 'on_dedicated.scr' is additionally executed after starting a server [dedicated only]

For examples how a script can look, check the .example examples.