Difference between revisions of "Scripting:TWScript"

gravatar The Watcher [userbureaucratsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+] (talk | contribs)
(Created page with "{{Infobox Resource | title = TWScript | image = ScriptIcon.png | name = TWScript | author = The Watcher | version = 2.0.9 }}")
 
gravatar The Watcher [userbureaucratsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+] (talk | contribs)
Line 7: Line 7:
 
| version = 2.0.9
 
| version = 2.0.9
 
}}
 
}}
 +
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.<ref>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.)</ref>
 +
 +
== 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 [[Scripting:Version Checking|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.
 +
* [[Scripting:Changes|Changes]]: the changes made at each release.
 +
* [[Scripting:Design Note|Design Note]] describes the way in which the parameters for the scripts are specified in Dromed's `Editor -> Design Note` property.
 +
* [[Scripting:TWBaseScript|TWBaseScript]] describes the standard parameters and features available to all the scripts in the TWScript package.
 +
* [[Scripting:TWBaseTrap|TWBaseTrap]] describes the standard parameters available to all TWTrap scripts. If you have used NVScript, many of these will be familiar to you.
 +
* [[Scripting:TWBaseTrigger|TWBaseTrigger]] describes the standard parameters available to all TWTrigger scripts.
 +
 +
<references />

Revision as of 21:37, 16 June 2014

TWScript
Error creating thumbnail: Unable to save thumbnail to destination
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.
  1. 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.)

Authors

  • gravatar The Watcher [userbureaucratsysopPHRhYmxlIGNsYXNzPSJ0d3BvcHVwIj48dHI+PHRkIGNsYXNzPSJ0d3BvcHVwLWVudHJ5dGl0bGUiPkdyb3Vwczo8L3RkPjx0ZD51c2VyPGJyIC8+YnVyZWF1Y3JhdDxiciAvPnN5c29wPGJyIC8+PC90ZD48L3RyPjwvdGFibGU+]

Looking for something?

Use the form below to search the wiki:

 

Still not finding what you are looking for? Contact us so we can take care of it!