Scripting:TWScript
The Watcher [
PHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+] (talk | contribs) (The Watcher moved page Scripting:Contents to Scripting:TWScript)| TWScript | |
| |
| Author | The Watcher |
|---|---|
| Download size | Not available |
| Download | Not available |
TWScript is a collection of script modules for Thief 2. These scripts are provided under the terms of the GNU GPL v2, a full copy of which may be found in the LICENSE file in the distribution directory, along with other license information.
TWScript would not be possible without the Public Scripts package released by Telliamed (Tom N. Harris), and I would like to express my sincere thanks for his generous contribution to the community.
I'd also like to thank LarryG for his suggestions, patience, feedback, and willingness to be a guinea-pig.
Installing
In order to use TWScript with missions, it must be made available to Thief 2 in a location it recognises.
Players can place the .osm in the Thief 2 directory and, if it is not provided with a mission, Thief 2 will use that version.
For editors, the simplest method to include TWScript is to place the .osm in your mission's directory inside the Thief2\FMs\ directory, and use FMSel to select your mission when editing it. When you distribute your mission you can simply zip up your mission directory and distribute that.[1]
How to find out which version you have
It's not immediately obvious to the end user which version of the twscript.osm you may have installed. Luckily, there is a way to find out: follow the steps in Version Checking if you need to work out which version is present.
Script documentation
The information in the following links is only likely to be of interest to mission authors who want to use TWScript in their missions. Players should generally never need to read any of the following to play missions using the scripts.
- Changes the changes made at each release.
- Design Note describes the way in which the parameters for the scripts are specified in Dromed's `Editor -> Design Note` property.
- TWBaseScript describes the standard parameters and features available to all the scripts in the TWScript package.
- TWBaseTrap describes the standard parameters available to all TWTrap scripts. If you have used NVScript, many of these will be familiar to you.
- TWBaseTrigger describes the standard parameters available to all TWTrigger scripts.
The source
The source code for TWScript, including supporting files and instructions for building the scripts is available in the GitHub project https://github.com/TheWatcher/twscript If you decide to fork it and add any useful features to any of the files in the base directory, please send me a pull request!
| |||||||||||||||||
| |||||||||||
- ↑ Note that doing this does have the downside that the version of the osm included with your mission will not get any bugfixes or updates unless you repackage your mission. Another, albeit less reliable, method is to simply state that players must install the .osm in their Thief2 directory - but if you do that, expect to run into problems if players do not follow the instructions! (Note: They won't follow the instructions. The mere fact that you're reading this footnote is shocking to me.)
Authors
- PHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+]