-
Notifications
You must be signed in to change notification settings - Fork 13
RTS
RTS stands for "Radius Trigger Script".
With RTS, you can create scripted events that cannot be controlled by linedef triggers alone, such as a simple on-screen tip message, multiple linetypes being triggered by one switch, or a complex event where an entire structure is destroyed, monsters are spawned, sounds are played, and light levels are changed dramatically.
You can explore and build RTS scripts interactively with RTS-Online to better get a feel for how they work.
Most RTS commands take one or more parameters. Some parameters must be given, and the remaining parameters are optional (may be left out). Throughout this documentation the following bracket styles are used:
<Name>
: a compulsory parameter
[Name]
: an optional parameter
These documents apply to EDGE Classic 1.0 or higher. Some features described here will not work in earlier versions of EDGE.
There are some commands are not described here,
because they are only kept for backwards compatibility
with old mods.
RTS scripts are simple text files. On Windows you can create them with Notepad or another text editor. You cannot use word processor files (like "DOC" files), because these are not text files and EDGE-Classic cannot read them.
Some general points about RTS scripting:
- #CLEAR_ALL (if used) must be at the top of your script, or else everything before it will be cleared.
- #VERSION and #DEFINE values (if used) must be after #CLEARALL, but before the rest of your script
- You must place all your radius triggers between START_MAP and END_MAP.
- All other commands can only exist between RADIUS_TRIGGER (or RECT_TRIGGER) and END_RADIUS_TRIGGER.
Commands are not case sensitive, hence "start_map", "Start_Map" and "START_MAP" are all acceptable. Whether you use lowercase or uppercase is just a matter of personal taste.
You can include comments (text which will be ignored by EDGE-Classic) by simply placing a double slash "//" at the beginning of a line and then typing your text after it. For example:
//This is a comment
//and this is another one
Commands in RTS scripts can be extended over two (or more) actual lines by placing the \ character at the end of the line. There must not be any spaces after the \ character, otherwise it doesn't work.
Check your spelling and values carefully, and add a few functions at a time, then test.
Just like DDF development, adding a lot of entries without
testing makes it much harder to find problems. If you add a
little and test often, you have less scripting to rummage
through to find errors.
RTS docs written by many contributors.