This script is intended to be used from a pseudo-script; usually a conversation. Place the script on an AI in the conversation that Contains some object. Use the Script message command to send the message TransferItem to the actor. The other two arguments are the destination (MsgData1) and the object to transfer (MsgData2). The item will then be removed from the AI’s inventory and put in the inventory of the destination. Objects that combine, even loot, will transfer properly.

This is a generic relay and filter that works with any message. Instead of the usual ControlDevice or SwitchLink links, it uses ScriptParams where the data of the link is the name of the message that will be relayed. You can have any number of links with different data. The length of the ScriptParams data field is only 15 characters, though. You can get around this redirecting the script to read the message name from an object property. For the link data, type the character ‘#’ then the name or ID of an object. On that object, add a design note and set it to the name of the message to be relayed. The entire design note will be read, so you can’t be using it for any other parameter.

A variation of IntrinsicText that displays the text when it receives WorldFocus.

A variation of IntrinsicText that displays the text when it receives FrobWorldEnd.

IntrinsicText displays text on-screen when triggered. If the Book\Text property exists, then it is used as the name of a string file to read. Without a book file, the text to display can be written in the design note. Using a book allows you to display translatable text; but the design note doesn’t require you to create a custom resource.

When reading the text from the design note, the text parameter will be used if it exists. Otherwise, the entire design note is shown. You must use text if you want other parameters.

The clr parameter will change the color of the text in Thief. Alternately, the three parameters clr_red, clr_green, and clr_blue can be used. On-screen text color can’t be changed in System Shock 2. The length of time the text is shown is determined by the number of words. You can specify an duration with the time parameter. The time and clr parameters can be used with either Book\Text or the text parameter.

When the object is frobbed in the inventory, a specified schema will be played. If the frobber is the Player, the schema will be played as an ambient, otherwise it is played normally at the location of the frobber.

Thief: Create a SoundDescription link to the schema. The link can be from an archetype of the script object as well.

SS2: Set the schema name in the Sound\Object Sound property.

This trap will add links to another object when turned on, and remove them when turned off. It is a template because the links are originally created anchored to the script object. That way, the link data can be set appropriately.

The object parameter is required and specifies the object that will become the new source of the links. If dest is specified, then only links to that object will be moved. Flavor will only move those types of links. If it isn’t specified, then all links except reverse trigger links will be moved.

On TurnOn, a copy of each valid link will be created with the object object in place of the script object. The link that was on the script object will then be deleted. If on_create is set, then the old links are not removed. On TurnOff, valid links with object as the endpoint will be removed, and re-linked to the script object. If off_destroy is set, then the links are not re-linked. Note that it’s possible that the links removed from object could be different than the ones originally copied to it. For instance, if you just add one Contains link on TurnOn, then TurnOff will move all the Contains links including those not added by LinkTemplate. Using a specific dest will usually avoid unexpected side-effects.

Some links, such as AIAwareness, only work right if there is just one link between any two objects. Otherwise you’ll get an error that says “Singleton link expected”. You can instruct LinkTemplate to avoid duplicate links by setting the singleton flag.

Normally, resizing an object in DromEd does not alter the physical size of the object. You could manually adjust each resized object, or you could save time and just add this script. When the game starts, this script evaluates the Shape\Scale of the object and its archetype to determine the true size of the object. The Physics\Model\Dimensions property is then set accordingly. This works for Sphere and SphereHat objects as well as OBBs.

The dimensions can be readjusted at any time by sending PMResize to the object.

A RandomRelay relays a TurnOn or TurnOff message to a randomly selected destination. The simplest mode is un-weighted and uses standard trigger links. After the relay has been used, it will lock itself. Essentially, this trap has the Once trap control flag on by default. You must set reusable to use the relay more than once. But each destination will only be triggered once, and the link to the destination removed. To keep the links intact, set preserve.

RandomRelay can also work with weighted destinations. Destinations with higher weights, relative to the other destinations, are more likely to be chosen. The destinations are linked to with ScriptParams and the data of the links are set to the weight for that destination. Reusable and preserve also apply to weighted relays. Additionally, the relay can be rechargeable, which implies preserve. A rechargeable relay will disable a destination after it is used, but maintains the link. When all links have been used, the relay is reset and it can send to previous destinations again.

This script is also named RandomRelay1x2. There is no difference.

A Sippable object display a usage count as part of its inventory name. When it is frobbed in the inventory, the count is reduced by one and, if there are no more uses left, the object is destroyed. The inventory name of the object is set as usual, in the Inventory\Object Name or Obj\Object name property. In the string resource, include the sub-string “%d” in the name. That sub-string will be replaced with the number of uses.

If the string resource doesn’t exist, or there is no “%d” in the name, then a fallback, but untranslatable, method is used. The number of uses plus the words “sips left” will be added to the end of the object name.

This is a debugging aid. It shows every message that is received by an object. The messages are shown on-screen as well as coped to the monolog. Much of the additional data that accompanies messages is also displayed. Using Spy can help you make sense of the complex interactions of objects. Or it’ll just confuse you way more than you already are.

...

...

This script will attach the camera to the script object. The camera is returned to the Player when the trap is deactivated.

The camera object cannot be changed in Thief 1.

In System Shock 2, the object you attach to must be given a unique name.

Heals the target by hitcount points, which defaults to 1. Turning the trap off will damage the target by hitcount points. Hitcount can be negative, which would have the same effect as a positive value with the trap control flag Invert set. The source of the stim is the script object by default, you can change it with culprit. Damage sets the type of the stim.

This script will add or remove metaproperties on linked objects. Either operation can be performed when the trap is activated. First create a ScriptParams link to each metaproperty you want to add or remove. Set the data of each link to “S” followed by some key, such as a number or name. Each key should be different. Next create ScriptParams links to the objects you want to modify. Set the data of each link to either “A@” or “R@” followed by the key from one of the metaproperty links. When turned on, the objects with an “A@” link will have the referenced metaproperty added, and those with “R@” will have the metaproperty removed. Turning off the trap will do the opposite for each link.

Put this script on an AI to make it play a specific motion when triggered. The name of the motion schema to play is specified in the mot parameter. It must be the motion name, like “humgulp”, and not the schema tags “Drink 0”.

This script will manipulate the transparency of the object it’s on. When turned on, the object will become more visible, up to the value of alpha_max. Turning it off will make it transparent, stopping at alpha_min. The speed of the change can be set with either the fade_time or rate parameters. If fade_time is set, then it is the duration of the fade. Otherwise, the rate parameter is the change in the transparency level every second. When the object becomes fully visible, a TurnOn is relayed along trigger links. TurnOff is relayed when it becomes invisible.

The curve parameter, which didn’t appear in the original version of this script, allows you to tweak the equation used to calculate the transparency. The transition is linear by default, which is a curve value of 0. The other equations are:

...

...

...

...

Requires dh2.osl.

This script sends TurnOn when the object it is on is picked up. TurnOff is sent when it is dropped. Despite the name, the object doesn’t have to be an AI corpse.

When the object is damaged, the source of the damage gets a TurnOn message sent back to it. The “RTC” stands for “return to culprit.”

...

This trigger activates once, when the game starts, and then it destroys itself.

...

...

This is an abstract script for when an action should be taken after a book has been read. The advantage over traditional triggering methods is that the actions will always occur after the book-mode screen has been shown. This script can’t be used directly; use either PostReadPlaque or PostReadScroll instead.

The script can play a voice-over schema and set a quest variable. If both actions are being used, then the quest variable is changed after the schema plays. Specify the schema to play by creating a SoundDescription link, which can be on an archetype of the object. Unfortunately, the script can’t tell on its own when a voice-over has finished playing. So set the Script\Timing property to the length of the schema.

After the voice-over has played or, if no schema was specified, after the book is read, a quest variable is modified. The name and operation are specified in the Trap\Quest Var property. The same options as for TrapMissionQVar.

You can also use trigger links with this script. They will be activated when the book is read.

System Shock 2 doesn’t have a book-mode, so this script isn’t as useful as in a Thief game. The text to display is determined by the Script\Use Message property. Set the voice-over schema name with the Sound\Object Sound property, and use the Script\Delay Time property. The quest variable is specified with the Script\QBName property using the same format.

This script displays text on-screen that can include the values of quest variables. The text to display, which is specified by the Book\Text or Script\Use Message property, is scanned for replaceable sub-strings. Each sub-string is evaluated and a replacement made. The replacements themselves may contain further replacements, and those will be processed as well. When all of the sub-strings have been found, the text is displayed. This only works for on-screen text, so the Book\Art property is ignored.

This script can’t be used directly. You can use QVarPlaque, QVarScroll, or TrapQVarText depending on how you want the script to be triggered.

Each replaceable sub-string begins with the character ‘%’ and then the name of the quest variable enclosed in curly braces (‘{’ and ‘}’). This will insert the value of the quest variable in place of the sub-string. Instead of the value, other text can be inserted by adding a conditional character before the braces. The possible conditions are ‘=’, ‘<’, ‘>’, and ‘?’. After the curly braces, write one or two sets of square brackets (‘[’ and ‘]’) with the new text in each. The first set will be printed if the condition is true, and the optional second set will be printed if it is false.

The ‘=’, ‘<’, and ‘>’ conditionals test if the quest variable is equal to, less than, or greater than some number. Write the number to compare to immediately after the conditional character. The last conditional, ‘?’, just tests if the variable is non-zero.

The following example prints the value of the quest variable bottles if it is not zero, or the text “No more” if it is zero. Then the word “bottle” is pluralized if necessary.

This is for books that are frobbed in the world. The actions that occur are described in BasePostRead.

This is for books that are frobbed in the inventory. The actions that occur are described in BasePostRead.

This script activates when the object is frobbed in the world. The text is displayed as described in BaseQVarText.

This script activates when the object is frobbed in the inventory. The text is displayed as described in BaseQVarText.

This script lets you make objects that act like the crystals from Thief. There are two types of objects: one that appears in the world, and another for the inventory. This script goes on the object that is created in the world. When the object is picked up by the Player, it will create the other type of object and put that in the inventory instead. The link that associates the two objects can be placed on the archetypes, which makes it easy to implement different types of transmogrifying objects.

Thief: Link the objects using a Transmute link.

SS2: Link the objects using a Mutate link.

The quest variable that this trap sets will be saved in the campaign database, so it can be read in later missions as well. The variable actually gets written to the mission database first, and only gets moved when the game ends. Trust me, this is the best way to make the script work. Just don’t be surprised if DromEd doesn’t always show the variable in the campaign database.

In System Shock 2, the default for most scripts is to store quest variables in the campaign database. The hack described above does not apply in SS2.

When activated, an AVI movie is played. The parameter movie is the filename of the file to view. It will be looked for in the movies directory, or whatever your movie_path is set to.

Doors are difficult to destroy by ordinary means. Traps that slay an object will only make the door pop open. And teleporting a door away will leave behind the black rectangle when the Blocks Vision? flag is on. This script will make sure a door is really destroyed, and leaves the portal open. The doors to destroy are linked to using ControlDevice or SwitchLink links.

The screen will fade out when this trap is turned on. Turning off the trap will fade the screen back in. You should always use the revert timer with this trap so the screen doesn’t get stuck in the fade-out. The fade_time is the time it will take for the screen to fade completely in or out. When using the revert feature of the trap, the timer will start at the same time as the fade. So you should set it to at least the same length as fade_time.

Thief 1: The screen will not fade in, but will just instantly reappear.

Thief 2: Fading in will make the player unwield any weapons.

SS2: The color of the fade can be changed with the fade_color parameter. The default is black.

The configuration setting no_endgame prevents this script from working.

This trap only responds to TurnOn. Each time it is triggered, it will send either TurnOn or TurnOff, alternating between the two. The Invert and Once trap control flags will be used.

When activated, the script will modify the value of a quest variable. The variable name and operation to perform are specified in the Trap\Quest Var or Script\QBName property. The quest variable is stored in the mission database. Thief games can also write the variable to the campaign database using TrapCampaignQVar.

The operation format is the same as from TrapSetQVar from Thief. First is a single-character operation, followed by an integer argument to the operation. Then there is a colon (‘:’) followed by the name of the quest variable. There should be no spaces up until the variable name. Spaces are allowed in the name, however. The following table explains the possible operations, and includes an example of what happens when the trap is activated with a certain argument. In all cases, the original value of the quest variable is 102.

You don’t have to create the quest variable ahead of time with this script. If the parameter initqv is set, then the variable will be set to that value when the game starts.

This script will relay messages if a quest variable condition is met. Set the Trap\Quest Var or Script\QBName property like TrigQuestVar. Then, when the test is true, the relay will pass messages.

When this trap is activated it displays text as described in BaseQVarText.

This script combines the outputs of multiple triggers so that when any one of the triggers changes state, the state of the trap changes. With only two sources, this is called a three-way switch; but this trap can have any number of sources. In particular, the trap is turned on when an odd number of triggers has been turned on. The triggers that are turned on are tracked using ScriptParams links that have the data set to “Require”.

This trap will be turned on when exactly one of its triggers is turned on. The triggers that are turned on are tracked using ScriptParams links that have the data set to “Require”.

A timer is the most useful type of trap that isn’t present in most of the standard games. What were they thinking? Set the time to delay the message in Script\Timing (as milliseconds) or in Script\Delay Time (as seconds). The extra data of the message will not be preserved.

This trap works like the standard TrapRelay in that it will pass not just TurnOn and TurnOff, but other (though not all) types of messages as well.

This is an OBB trigger, also known as a tripwire, that triggers when an AI enters the bounding-box of the object. Actually, it reacts to objects of type Creature (Thief) or Monsters (SS2). The creature is tracked the same way as for TrigOBBSpec.

When the value of a quest variable changes, this script tests it against a condition and sends TurnOn when the condition becomes true, or TurnOff if it is now false. (Or it sends nothing if the condition hasn’t changed.) The possible tests are the same as in Thief 2, so there’s no difference between this script and TrigQVar in that game.

The condition in the Trap\Quest Var or Script\QBName property is similar to that used by TrapMissionQVar. The first character is the type of the test, ‘=’, ‘<’, ‘>’, ‘&’, or ‘"’. Following this is the number to test against, then a colon (‘:’) and finally the name of the quest variable. There should not be any spaces from the start of the string up to the name of the variable. (Variables names can have spaces in them.)

The tests ‘=’, ‘<’, and ‘>’ test if the quest variable is equal-to, less-than, or greater-than the given number. The ‘&’ test compares the numbers as a set of binary bits. If any of the bits set in the test number are also set in the quest variable, the condition is true. The ‘"’ test compares the decimal digits of the numbers. The quest variable must have the same digits in the same places as the test number. Digits greater than those in the test number are ignored. You can test against 0, even in the leading digits. (So testing against “01” is actually different than testing against just “1”.)

Put this script on a TerrPt and it will activate its trigger links when the moving terrain object reaches it.

The standard scripts don’t properly handle the case of an AI being knocked-out while in the middle of an attack. To make sure that the attached SFX are disabled, use this script alongside AttackActivate.

Adds to Thief 1 the ability to count secrets in a mission. The number of secrets is automatically tallied when the game begins. This script will mark a secret as having been found when the object is frobbed in the world. You also have to set the Hidden flag on the Dark GameSys\Stats property.

Adds to Thief 1 the ability to count secrets in a mission. The number of secrets is automatically tallied when the game begins. This script will mark a secret as having been found when the door is opened. You also have to set the Hidden flag on the Dark GameSys\Stats property.

When this potion is used by the Player, then he will be made invisible using the metaproperty M-Invisible. The metaproperty only needs to include a Scripts with Invisible in it.

The Renderer\Invisible doesn’t exist in Thief 1, so the player’s weapon doesn’t disappear like in Thief 2.

This script is activated by the message Invisible, which is sent by the InvisiPotion script. The object will be made invisible to AI.

This script will set the object’s Dark Gamesys\Loot property to the amount of loot collected in the previous mission. To activate it, you need to add the Difficulty\Script property and set the flags for which difficulty levels you want to use the script on. If the script isn’t activated, then the Dark Gamesys\Loot property is left unmodified.

When this potion is used by the Player, his speed and gravity will be cut in half. Multiple uses don’t affect the overall speed and gravity, but instantaneous speed is reduced each time.

When the AI is knocked-out or killed, the NoPingBack metaproperty is added to it. The metaproperty should contain a PingStim receptron with no limit an an effect of Abort.

Just like the StdDoor script, but when the door is unlocked it remains closed.

When the Player object collides with this AI, its alert level will momentarily be raised to level 2. Thief 2 has this on the robots. I don’t know why it isn’t on all AI.

When an object touches this one, it will receive any contact stimuli from it.

This is actually the same as the HotPlate script from Thief Gold, but I’m including it for the sake of completeness.

When something collides with this object, its gravity is set to 3.2578125. I honestly don’t know why.

This script should be part of the M-KnockedOut metaproperty. It activates automatically. The AIAwareness links will be reset, and the message IgnorePotion is sent to the object.

Adds to Thief 1 the ability to count secrets in a mission. The number of secrets is automatically tallied when the game begins. This script will mark a secret as having been found when the object is slain. You also have to set the Hidden flag on the Dark GameSys\Stats property.

Halts the AI’s current speech when it is slain. Thief 2 uses this on frogs and rats.

This script is used for potions that activate when frobbed in the inventory. The potion will be active for a specified period of time. Using another potion of the same type will restart the timer. The duration of the potion is specified with the Script\Timing property in milliseconds. The default time is 8.6 seconds, and the potion will always last at least 1 second. The environmental schema tags “Event Deactivate” will be played just before the potion ends. This script doesn’t make any sound when the potion begins, though.

If the object is in an AI’s inventory when the game starts, then the metaproperty M-QuaffHeal is added to the AI. This already exists in Thief 1, so you don’t have to create it yourself.

When this object is unlocked, the model tweq will be activated. It also disables the lock by setting the Region Mask to 0.

This trap converts TurnOn and TurnOff messages into GoForward and GoReverse. The messages are relayed along ControlDevice links. The TweqOnOff script can be used on the controlled object to respond to these messages.

Adds to Thief 1 the ability to count secrets in a mission. The number of secrets is automatically tallied when the game begins. This script will mark a secret as having been found when the trap is turned on. You also have to set the Hidden flag on the Dark GameSys\Stats property.

This trap monitors the objective quest variables. When all of the visible objectives, except for those marked as “final” or “optional”, have been completed, then the trigger is turned on.

This is an old-fashioned relay that only passes TurnOff. It doesn’t support any of the more advanced trap features.

This is an old-fashioned trap that will relay a single TurnOn or TurnOff only. It doesn’t support any of the more advanced trap features.

This trap activates and deactivates the patrol property of all the AI that it is linked to. The standard TrapPatrol script of Thief 1 only changes the property on one object at a time.

This is an old-fashioned trap. It relays a TurnOn or TurnOff message then, after a period of time, sends the opposite message. The time is specified in the Script\Timing property as milliseconds. If it is not present, or is 0, then the trap acts like a normal relay. Sending a message while the timer is active will cancel the previous timer.

This trap will slay linked objects by damaging them with a BashStim. The hit-points of the object is set to 1 first, so the damage results in death. If this isn’t done, the object won’t do some things, such as playing a schema or leaving a corpse behind.

The standard TrapDestroy script doesn’t really destroy all objects. This script, when activated, will destroy all ControlDevice linked objects, no questions asked.

This trap controls the texture of nearby terrain. Set the properties to the path to the texture resource for when the trap is turned on and when it is turned off. The destroyed texture isn’t supported by this script. Any cells within the retexture radius will have their polygons swapped between the old and new textures. You need to have the textures initially set to the same state as the trap. Changing textures won’t work if the new texture isn’t also loaded into the mission.

This trap triggers when the Player object enters the bounding-box dimensions of the object. The properties of the object should be set like the standard BoundsTrigger trap. Of course, you’ll want to modify the dimensions to the appropriate size. An environmental schema with tags “Event Activate” will be played when the trap turns on, and “Event Deactivate” when turned off.

Put this script on an object and it will trigger when it is carried into a room by the Player. The trigger turns off if the object is dropped, even inside a target room. The object is linked to the target rooms with Route links.

Put this script on an object and it will trigger when dropped in a specific room. The trigger turns off if the object leaves the room, or is picked up again. The object is linked to the target rooms with Route links.

Put this script on an object and it will trigger when entering a target room. You can specify any number of target rooms using Route links.

This script is for room objects. It sends a TurnOn message anytime an AI or the Player enters or leaves the room.

This script is meant to be put on the burplauncher object that is emitted by burricks. When any part of the cloud of gas collides with something else, this script will destroy all other parts of the cloud. However, burplauncher works just fine without the script, and the difference isn’t very noticeable.

This trap will destroy objects in a way that the player doesn’t see them disappear. Objects that are currently visible, or are being carried by the player, will be skipped. The script continues to check every few seconds until all linked objects have been destroyed.

A collapsing floor is a type of pressure plate. The object is usually placed above a pit. You can configure the Physics\Misc\Pressure Plate however you like. A slower speed and longer travel distance will give the player time to get off of the collapsing section before it falls. When the object is fully depressed, it will be destroyed. To make the object appear to fall to the bottom of the pit, you need to create a separate archetype for the falling object. Create a Corpse link from the collapsing floor to the falling object. You can also use Flinderize links for falling objects that will be scattered.

This is a variation of WindowShade that also periodically turns the light on or off. The time between changes is randomly selected, between 5 and 15 seconds by default. This can be changed with the auto_time_min and auto_time_max parameters. Whether the light will be changed to on or to off depends on the Script\Timing property. This number is the probability that the light will be turned on. A value of 100 or greater will keep the light turned on all the time.

This script allows you to make complex multi-part conversations that can be interrupted and resumed. The controller is linked to a number of conversation traps. When the controller is turned on, it will trigger the first of the linked conversations. One of the conversation actors should have the ConvSpeaker script so it can send a ConvNext message back to the controller. When this happens, the controller will remove the link to the conversation that was just triggered and proceed to the next one. This continues until an actor sends ConvEnd, or if the controller is turned off.

A locked controller does not trigger any conversation. If the controller is turned on while locked, or was turned on when it became locked, then it will continue the conversations once it is unlocked.

The messages Presence and Absence are also accepted and will turn the controller on and off, respectively. The message Intrusion will act like locking the controller, and Privacy is like unlocking it.

This script responds to messages from an AI involved in a conversation or other pseudo-script. Add this script to the AI and use the action Script message with the message name as the first argument. Some of these messages use the other arguments of the command. Where the description mentions the “first argument”, it is referring to the arguments the message receives, which are offset by one in the pseudo-script action dialog box. So you’d type the “first” argument for the message as the second argument for the action.

The standard script CorpseFrobHack doesn’t work with AI that contain unfrobbable objects. This replacement fixes that problem.

This is a room script that generates the Presence and Absence message for the ConvControl script. It activates when the Player enters or leaves the room.

The controller can also be triggered with standard TurnOn and TurnOff messages, so this script isn’t really necessary.

This script will adjust the Shape\Scale to match the health of the object. Add the Tweq\Scale property to the object and it will shrink when slain.

The health_curve parameter modifies the relationship between the health of the object and its size. See the description of TrapPhantom for the possible values.

The objects that are used in factory set-ups share many actions. Because most of the objects are levers, or act similarly to levers, this script mostly does all the things that you would expect from the StdTwoState script, such as activating tweqs, environmental schemas, and sending TurnOn and TurnOff messages.

A typical factory uses one cauldron, two levers, a gauge, one mold, and a product. Optional devices include, a buzzer, a mold socket, a gear, and sparks. With a worker, the factory can be automated. See the scripts for each individual device for specific directions.

A cauldron is a lever that, when on, indicates that molten iron is being poured into a mold. It has a joint tweq for tilting, and a model tweq for showing pouring iron. It can also be illuminated while pouring.

A cauldron is normally activated by a lever using a ControlDevice link. The cauldron should link to a gauge using ControlDevice. While moving forwards or backwards, it will turn a gear that is linked using ScriptParams links with the data “Synch”. The gear should use the script TweqOnOff. While pouring, a particle SFX can be activated. Link to the SFX using a ScriptParams link with the data “Sparks”. If the factory is automated, the worker AI must link to the cauldron using Owns.

A gauge in a factory indicates when a mold has been filled. The joint tweq of the gauge can be in three stages: rising, overflow, and falling. The speed of the tweq in each stage must be set using the parameter rates set to three floating-point values separated by commas. You also configure the Tweq\Joints property for the first stage. After the first stage, the gauge will continue moving forward at the speed from the second value in rates, and will add the value of overflow to the “high” position of the tweq. After the second stage, the tweq will reverse and return to the “low” position at the third speed from rates. The default rates are “1.75,0.5,30” and the default overflow is “20”.

When the gauge goes from the first to the second stage, it will send the message Full along ScriptParams links that have the data set to “Mold”. This link should point to the factory mold. It sends TurnOn along ControlDevice links after the second stage. This message should pass through an Inverter to turn off the lever that controls the cauldron. Another link can also go to a buzzer. It does not send TurnOff at any time.

A factory lever uses locks to prevent it from being toggled at inappropriate times. There are typically two factories in each factory: one controlling a cauldron and one controlling a mold. The lever will link to the controlled object using ControlDevice. Each lever has an associated FnordLock that the lever links to using Lock. There should also be a ScriptParams link with the data “LockMe” from each lever to the lock for the other lever. The lever can also link to a buzzer using a ScriptParams link with the data set to “ErrorOutput”. This will be used if the lever is frobbed while it is locked.

A factory light is most often used as a buzzer. When activated, the light will turn on and play a schema. After the time set in Script\Timing, the light will turn off. If Script\Timing is not set, then the light will be on for 550 milliseconds.

The object doesn’t have to use Renderer\AnimLight. Without the property, the “light” will be turned on by setting the Renderer\Render Type to Unlit, and turned off by resetting it to Normal.

...

...

The FireElement sends messages to its attached SFX indicating the alert level of the AI. This script adjusts the color of the particles based on those messages.

A fire elemental glows brighter when alerted, generates extra heat at high alert, and is damaged by water. Fire elementals can be created without using this script, but they’re much better with it.

If the Player damages or knocks out this AI, then the metaproperty M-Swaying Burrick will be removed from all creatures.

Removes the metaproperty M-Swaying Burrick from all creatures when this object is picked up. It also disables the ambient schema on the object.

When an object touches this one, it will receive any contact stimuli from it.

This is actually the same as the PhysARContact script.

This script uses a combination of a joint tweq and a flicker tweq to determine when linked hot plates are dangerous. The joint tweq, which determines when the plates are on or off, should vary between -1 and 1. The flicker tweq determines how often the plates are updated and should have a fairly low period. Each time the flicker triggers, the Renderer\Extra Light amount is set to the position of joint 1. If the value is greater than zero, then the meta-property HotPlateHeat is added, and it is removed if the value is less than zero.

The JunkEarthWebs should have both this script and JunkWebs in order to work properly. When the object is put in the inventory of the Player, it will stimulate the player by contact.

This script is meant to be used with MagicCoffin. When the object collides with its owner, it will slay itself and send BoneSlain to the owner.

This object should be an unrendered bounding-box. Create Owns links to objects that have the MagicBones script. That script will slay each object when it collides with this one. When all of the objects have been slain, the trap will be activated.

This script doesn’t work right now. Please ignore it.

...

This is a room script that generates the Intrusion and Privacy messages for the ConvControl script. It activates when an AI on a bad team enters or leaves the room.

Putting a lock on the controller does the same thing as this script, and can be more flexible. This script only exists to ease the transition from Thief 1.

Put this script on an AI that has the metaproperty M-Escapee. When a TurnOn message is sent to it, the AI will receive the signal Escape. You can also use a metaproperty that inherits from M-Escapee.

When the object is locked it will have the FrobInert put on it. The metaproperty is removed when the object is unlocked.

Add the property Tweq\Flicker to the object and configure it for the time when the lock should reset. The tweq will be activated when the object is unlocked. When the tweq halts, the object is locked again. If the lock is linked to a door that is being used by an AI, then it wait some more before locking the object.

AIWatchObj links will be created to this door if it changes from its original state. The links will be removed if it returns to normal. Put AI\Utility\Watch: Watch link defaults on the door to configure the links. The links will be created for all Human objects by default. Set the watcher parameter to the name of an archetype to override this.

You can make a door start in the open state by adding the property Difficulty\Close (Open) Door and leaving the flags unchecked.

Use this script on the EarthShot projectile. When it hits the Player, a JunkEarthWebs object will be put in his inventory.

JunkEarthWebs needs to have both JunkWebs and JunkVines on it.

Use this to activate the WakeableAI script.

When activated, the objects contained by the trap will be revealed at its location.

It’s much better to use TrapRelease instead. This only exists for the sake of compatibility.

The simplest way to use this script is to add the Engine Features\Suspicious property to the object. Then the Is Suspicious flag will be just be turned on and off.

Another way creates AIWatchObj links to the object when it is turned on, and removes the links when turned off. Use the AI\Utility\Watch: Watch link defaults property to configure the links. The links will be created on all Human objects by default, or on the archetype specified in the watcher parameter.

This trap will slay linked objects by damaging them with a BashStim. The hit-points of the object is set to 1 first, so the damage results in death. If this isn’t done, the object won’t do some things, such as playing a schema or leaving a corpse behind.

The standard TrapDestroy script doesn’t really destroy all objects. This script, when activated, will destroy all ControlDevice linked objects, no questions asked.

This is an bounds trigger that is activated by the player. It trips either when the Player object walks into the bounding-box, or if something the player throws or shoots enters.

Use this script on AI that won’t be part of the mission until teleported in. Set the AI\State\Current mode property to Asleep for improved performance. Then trigger the sleeping AI with the TrapAIWake script and they will wake up.

Put this script in a metaproperty. When the metaproperty is added to an object, that object will have AIWatchObj links created to it. By default, the links are created from every Human object in the mission. You can change the archetype with the watcher parameter.

This is a combination of AnimLight and TrapTexture. When the light is turned on, nearby terrain will be set to the texture specified in Script\TerrReplaceOn. When turned off, Script\TerrReplaceOff is used. The object can also be slain, and then it will turn the light off and set the terrain to Script\TerrReplaceDestroy. The light can be turned back on after being slain, but the texture won’t change anymore.

The starting texture should be set to match the initial state of the light.

This is an alternative to BaseLight with features that should be familiar to Thief users. Along with TurnOn and TurnOff, the light can be changed with the Toggle message. The script also toggles the AmbientHacked property, and toggles any attached SFX. (You may want to use StdParticleGroup as well.) The light can be configured to flicker when it is turned on or off. An AnimLight can also act as a trigger.

This script doesn’t play any environmental schemas, though. If you want the object to play an activate or deactivate sound, you’ll need to add the LightSound script to the object.

Some of the Renderer\Anim Light modes do not work, including smoothly dim, smoothly brighten, and random.

When this object is frobbed in the inventory, an invisible copy is made and used to stimulate the frobber by contact. The stack count of the visible object is then decremented. The life cycle of the stimulus source for the object should be configured to eventually destroy the object. Because the object is copied, any relevant properties should be set on the archetype.

This is the script that Thief uses for its healing potions.

When this AI is killed, a Obituary property is sent along ScriptParams links that have the data “Population”. These links are usually created by a room or OBB trigger script. Without this script, the trigger will see the AI enter, but never leave.

This script is normally put on the metaproperty M-NotifyRegion, which gets added to the AI by a trigger that needs it.

When an object touches this one, it will receive any contact stimuli from it.

This script toggles particle SFX for the object. It uses a slightly different method than the standard TrapParticle script. It also handles the Die message by destroying the object.

This script acts like the standard TraitMachine script; but instead of permanently disabling the machine after use, it just locks it. The machine can then be used a second time if it becomes unlocked. The machine can be unlocked by sending a TurnOn message, or locked by sending TurnOff.

The lock only prevents a player from opening the trait selection overlay. If the object has already been frobbed, and the machine receives a TurnOff, then a trait can still be selected.

Increases the player’s psi points when activated, or decreases them when turned off. The psi parameter is the number of psi points to add.

When a capacitor sends TurnOn, it will block other messages from being relayed for a period of time. If a message attempts to pass through during the discharge time, then it will be queued until the timer expires. Only the most recently received message will be sent.

This script is used when a device takes a significant amount of time to activate. A capacitor will prevent it from being turned off too quickly after it has been turned on.

A conversation is an elaborate set of pseudo-scripts. They are used a lot in Thief, but not at all in System Shock 2. I can’t imagine why.

A conversation can involve up to six different AI, known as actors. Create AIConversationActor links from the conversation trap to the actors, and set the data for each link to the actor number for that AI, starting with 1. (It’s easy to forget this, since the default value is 0.) Add the property AI\Conversations\Conversation to the trap and set the actions you want to occur. Each step of the conversation is a set of actions that will be taken. The next step doesn’t occur until the previous step has completed.

The normal AI behavior can sometimes interfere with a conversation. It helps to add the metaproperty Silent to the actors in a conversation.

I could say more, but I’m afraid that I might say something wrong. Conversations are damned tricky and I don’t have very good luck with them.

When this trap is activated, it will prompt for a code to be entered. The correct code will cause TurnOn to be relayed. Entering the wrong code sends TurnOn along ScriptParams links that have the data set to “ErrorOutput”. Of course, the code is specified in the Script\Keypad Code property.

This is a relay that will add nanites to the player when turned on. Turning off the trap, or specifying a negative value for nanites, will deduct the amount from the player. If there aren’t enough nanites to deduct, then a message is displayed, and a TurnOn message is sent along ScriptParams links that have the data “ErrorOutput”. Adding nanites will always succeed. The trap can have a revert timer set and the player will only be charged once.

This trap enables or disables patrolling of AI. The AI to control are linked from the trap with SwitchLink.

This script monitors a number of triggers. When they have all been turned on, the trap relays TurnOn. TurnOff is sent if any of the triggers turns off. The triggers that have been turned on are tracked using ScriptParams links with the data set to “Require”. The triggers must all link to this trap using SwitchLink.

This script monitors a number of triggers and sends TurnOn when at least one of them is turned on. TurnOff is sent when all the triggers are turned off. The triggers that have been turned on are tracked using ScriptParams links with the data set to “Require”. Unlike TrapRequireAll, the triggers can communicate with this trap over links other than SwitchLink.

This is a standard trap that just relays messages. The revert timer will function for TurnOff messages, though, as well as TurnOn.

This trap controls the texture of nearby terrain. Set the parameters to the path to the texture resource for when the trap is turned on and when it is turned off. Any cells within the retexture radius will have their polygons swapped between the old and new textures. You need to have the textures initially set to the same state as the trap. Changing textures won’t work if the new texture isn’t also loaded into the mission. The default value of Engine Features\Retexture Radius is zero, so you must set the property for this script to function.

When an AI goes to alert level 3, a TurnOn will be sent along SwitchLink links.

This script sends TurnOn when an object is picked up or dropped.

Flicker triggers send alternating TurnOn and TurnOff messages controlled by a flicker tweq. The tweq is turned on and off when the trap is activated or deactivated. The Tweq\Flicker property should be configured to Continue and have the Scripts flag turned on.

Activates when the object is frobbed while in the inventory.

Pressure plates are a specialized type of terrain-like object. The object must have an OBB physics model and the property Physics\Misc\Pressure Plate. When sufficient weight is placed atop the object, it will move down. This script is activated by that movement. TurnOn is relayed along SwitchLink links when the pressure plate is completely lowered, and TurnOff is relayed when it raises up again.

This script is activated by a pressure plate object, like TrigPPlate. TurnOn is relayed when the pressure plate begins moving down, and TurnOff is relayed when it begins moving upwards.

This is a trigger for rooms. It is activated when an AI enters the room. The trigger will deactivate after all AI have left the room. The AI inside the room are tracked using ScriptParams links that have the data set to “Population”. You should create a metaproperty named M-NotifyRegion that contains the script NotifyRegion. The trigger will add this metaproperty to the AI it is tracking so it can get the Obituary message if the AI were to be slain inside the room.

Put this script on an object and it will trigger when it is carried into a room by one of the players. The trigger turns off if the object is dropped, even inside a target room. The object is linked to the target rooms with ScriptParams links that have the data set to “Route”.

Put this script on an object and it will trigger when dropped in a specific room. The trigger turns off if the object leaves the room, or is picked up again. The object is linked to the target rooms with ScriptParams links that have the data set to “Route”.

Put this script on an object and it will trigger when entering a target room. You can specify any number of target rooms using ScriptParams links that have the data set to “Route”.

Create a ScriptParams link between two rooms. Give the link the data “Route”. When a player moves from the room that’s the source of the link into the room that’s the destination of the link, then the trigger will send TurnOn. Moving in the opposite direction sends TurnOff.

This script is for room objects. It sends a TurnOn message anytime an AI or the Player enters or leaves the room.

Sends a TurnOn message when the object is unlocked. TurnOff is sent when it is locked.

This trigger activates when the object is frobbed in the world.

Retrieves the contents of the design note for a particular object. The return value, if non-NULL, will have been allocated by g_pMalloc and should be free’d by the same.

Retrieves a design note parameter for a particular object. If the parameter doesn’t exist, the return value is NULL or 0. For GetObjectParamString, a non-NULL value will have been allocated by g_pMalloc.