The DarkMod Wiki - User contributions [en]

Location Settings

2016-04-11T20:07:15Z

SteveL: /* "ambient_light" */ + bug using 0 0 0 for ambient_light

== Introduction ==

This article describes how to setup '''locations''' (also called "location zones" or "zones") in your level, and then use these to:

* fade to different ambient '''light levels''' for each zone
* fade between different ambient '''sounds''' in each zone
* run '''scripts''' automatically when the player enters or exits a zone

----

You need to use four types of entities in your map:

* a special global entity (e.g. add only one, the position does not matter): '''atdm:location_settings'''
* a special global light entity named '''ambient_world'''
* multiple '''info_location''' and '''info_locationseparation''' entities


:Note: Two alternative ways to get ambient sounds in your map are using speakers ([[Adding ambient Sounds to your Map]]), and using triggers ([[Ambient Sounds - Zone (using triggers)]]). Speakers are good if you only want your ambient to cover a definite radius and have a very simple setup. Triggers are basically obsoleted by the method in this tutorial. The only time you might still want to use a trigger-system is if you want a ambient sound to begin at a place where for some reason you can't create a portal to mark the zone boundary, but you can still have a trigger brush. There are some issues with a trigger system, too (f.i. their CPU and memory usage and more importantly they are not failsafe like locations are), that make the method in this tutorial superior.


== The atdm:location_settings entity ==

Create a '''atdm:location_settings''' entity in your blueroom (i.e., a room off to the side the player will never enter) or somewhere else in your map:

'''{{RMB}} -> Create entity -> Darkmod -> Info -> atdm:location_settings'''

=== Default values ===

The location_settings entity takes a few ''default'' spawnargs related to the ambient light settings:

* [[Location Settings#"ambient_light_fade_time"|"ambient_light_fade_time"]]
* [[Location Settings#"ambient_light_fade_delay"|"ambient_light_fade_delay"]]

For their meaning and values, please refer to their sections.

=== update_period ===

The spawnarg '''update_period''' specifies the time in seconds between updates. A good value is 0.2, e.g. 5 times per second. That avoids to run the script too often, and still allows seamless transitions.

=== Sound Shaders ===

In the entity's spawnargs, put the names of all the ambient sounds you want to play in your map. (This pre-loads the sounds into the speaker so there isn't a pause when they start playing.) Put it in one of these property/value forms (without the quote marks):

'''"snd_streets" "city_night01_loop_z"'''

'''"snd_mansion" "sound/ambient/ambience/mansion_tense01a.ogg"'''

The left hand spawnarg should have a "snd_" prefix, and any name, but most useful is probably the name of the area it is for. You'll use this name again when you place the location markers or if you use the override system.

The right hand value points to the actual sound file that will play. You can enter either the soundshader name, or the address where the sound file is (but see footnote). You can see the soundshader names of ambient-ready sounds in the sub-folder "Darkmod/sound/tdm_ambient_ambience_zoned.sndshd". You can find the address of the sound files in "Darkmod/sound/ambient/ambience" (remember to start the address with "sound" in the spawnarg). You can also listen to the sounds at that location. They are are in .ogg format. But it's easier to just create a speaker (left-click>speaker) and it will give you a sound directory where can play sound files and find the names. No searching through sound folders outside of DR (thanks to Badcog for that tip).

:Note that it is very easy to add custom ambients with this system. Just create a folder in your .pk4 (a .zip file renamed to .pk4) and name the folder "sound", with another folder inside it named after your FM or an abbreviation. Put your custom sound inside that second folder. (E.g., I have a custom ambient named Frozen.ogg, and my FM's name is Patently Dangerous. So in my .pk4 was "sound/patent/frozen.ogg". Note that ambients must be in either .ogg or .wav format. Now in your speaker_zone_ambient, just put the sound's address in the spawnarg (but see footnote). In my case, I have "snd_warehouse" "sound/patent/frozen.ogg".

It is worth noting that one special "sound" is already loaded by default.

'''"snd_silence" "silence"'''

You can see it if you check "Show Inherited Properties". This is the sound you use to turn "off" the ambient sounds playing, so there is silence in the zone.

=== On Shader Names ===

One footnote on the sound shader names. The ''shader tdm_ambient_ambience_zoned.sndshd'' has a special command ("leadin") for its sounds that begins the ambient with a short pause. This is to pre-empt a possible *pop* of sound for loud ambients which can occur when the player's system slows down (and only occasionally, at that), so the player never hears the pop. (It's a quirk of how Doom3 does fade-ins; when you start a new sound, you have to rapidly fade it out first, like .001 seconds, then slowly fade back in. But if the system slows and the ambient starts loud, it might stretch that .001 to something audible.)
Edit:Baddcog- These seem to now have been appended with a _z if you look at sound names in speaker dialog.

If you alternatively use the address or the shader name from "Darkmod/sound/tdm_ambient_ambience.sndshd" (which lack the "leadin" property) it will otherwise work fine, but you won't be protected from that occasional little pop (at least until we find another fix). For ambients that start quietly or areas that won't slow the system down, it will probably never even be a problem and the player will never hear it, so using the address is fine, or using the tdm_ambient_ambience shader name if you don't want the tiny pause for whatever reason. But if you want to control it, use the tdm_ambient_ambience_zoned name, and for a custom sound, to pre-empt the pop you'll need to use a custom shader with the "leadin" line. Use the "Darkmod/sound/tdm_ambient_ambience_zoned.sndshd" as a template to do that, and name the custom shader file something like YourFMsName.sndshd, and put it in the "sound" folder in your .pk4.

=== Sound Properties ===

Regarding properties, the speaker (the '''atdm:location_settings''' entity is a speaker in disguise :) has by default the properties "omni", "global", and "looping" already turned on, so that all sounds played are heard everywhere, from no direction, and will loop. If you change these properties (e.g., for one ambient) the change will apply to all ambients on the speaker. So you probably don't want to turn these properties off.

Another spawnarg worth noting is "s_volume". Since the location_settings also acts as a speaker, this will work to change volume (0=full volume, -10=half volume, -60=silence), again globally on all the ambients playing on it. Unless you have a very good reason for doing so however (e.g., you want all your ambients much louder or quieter) you probably don't want to use the s_volume spawnarg. If you want to change the volume of a specific ambient, you can do so on the '''info_location''' entity with the "volume" spawnarg as described below (note some of the issues involved with volume changes there as well), not the location_settings entity (or directly in the sound's soundshader).

Your entity will look like this:

[[Image:Speaker4.jpg]]

=== Sound Override ===

From version 2.04, an "override" property for sounds has been added to the location settings entity. The purpose is to allow a mapper to easily override the location ambient to play their own sound, such as an ambient when a discovery is made, to build tension, action music when the player is seen, or for reading a book, etc., and then return to the location sounds when it's done.

The default value for "override" is "0", meaning override is turned off, so the location ambients play as normal. Although it looks boolean, the data type is a string, so it takes any characters. If at any time in-game you dynamically change "override" to any non-zero value (I'll explain how below), it will override the location ambients to allow you to play your own sound as long as it is non-zero. To turn location ambient sounds back on, you change "override" back to "0".

If you change "override" to one of the pre-cached sound names (that is, a name with the "snd_" prefix mentioned above, such as "snd_alert"), then the location system will fade out the location ambient and play the ambient sound you registered under that name as an override ambient. If you open the console, it will report that the override ambient is playing. The override ambient will continue to play until override is changed back to zero or to another override ambient. This means if you just want to play a one-shot ambient, you need to use a script with a wait function that waits the duration of the ambient then turns override off to restore the location ambient, otherwise it will loop. Using the function sys.waitFor( $[speaker_name]); after running the speaker is supposed to automatically wait the duration, but this needs to be tested.

If you change the override property to another value (not a sound name) such as "1", it will simply turn the system off, allowing the mapper to play a speaker in the silence if they prefer.

There are two basic ways to change the "override" property dynamically, calling a script and triggering a target_setKeyVal entity in-game.

1. Script. The script function to change a property on an entity is $tdm_location_settings_1.setKey( "override", "[snd_name]"); to turn on an override sound and $[tls_1].setKey( "override", "0"); to turn the location ambients back on. Note because it's a string data type, you need to put zero in quote marks/inverted commas. Also be sure to use the right name for the location settings entity. It may not have a "_1" suffix.

2. Target_setKeyVal. At the bottom of the entity list is target_setKeyVal (note it's not with other target entities). Create one of these entities and have it target the location settings entity (e.g., enter a property/key "target" "tdm_location_settings_1"). Now add the property/key "keyval" "override;snd_name" to turn on the override sound. Note you separate the propery and key with a semicolon and no space. Now when you trigger that entity with a trigger brush, button, or anything else, it will change the propery and your override ambient will fade in. You can have another target_setkeyval entity with "keyval" "override;0" to turn override off and turn the location based ambients back on.

The tdm_location_settings entity has also got new properties for fading behavior. Thus, the mapper can make the override ambient fade in as normal, or have it blast in with no fade-in if they want. These properties are the same 'fading' type spawnargs as are on the info_location settings described below, and work in the same way, except they are on the location settings entity and only apply to override ambients. (Volume is not included however. You'd just use the speaker property "s_volume" directly, but you'd need to restore it after the override is over if you don't want the change applying to all sounds.) You can change them dynamically in the same way as override. If you have multiple overrides, some with fading and some without, and want to revert to the default fading without looking it up, you can enter "-1" as the value of a property and it uses the default value.

You are finished with the ambient sound part now.

== The Ambient Light ==

You need to create an ambient light in your level. This will cover the entire level, and provide a minimum default light for when there is no other light covering a surface:

# '''{{RMB}} -> Create light'''
# Move the light's origin to the center of your map, and drag it's size so that it covers your entire map, and then some more. Remember to increase the size of that light when you build more area into your map!
# Open the light inspector (default shortcut {{key|L}}) and set the light texture to '''lights/ambientlightnfo'''
# Set the color of the light to a reasonable default, f.i. "8 8 8" This value will be used when a zone has no other ambient light settings
# Open the entity inspector (default shortcut {{key|N}}) and set the name of the light to '''ambient_world'''

The last step is important!

You are done now with the global ambient light.

== The Location Entities ==

Now you need to set up the location system so the game knows where the zones are, and their boundaries where changes will happen. A location is basically any area that's closed in by brushes and marked portals and contains an info_location entity. Unlike a vis-portaled area (which is one area between [[vis_portals]], a.k.a. a "leaf"), a zone can cover more than one portaled area ("leaves").

As an aside, locations are also used for setting the EAX properties in the area (e.g., the echo-y-ness of a big hall or cave, or the dullness of a small carpeted room). So you have a good reason to have them even in addition to handling ambient sounds and lights.

=== info_locationseparator ===

As I suggested above, you have to mark all the portals leading in and out of a zone by hand. You do this with an entity called a '''info_locationseparator'''. Create one so it touches the portal you want as a boundary.

'''{{RMB}} -> Create entity -> Darkmod -> Info -> info_locationseparator'''

If you don't touch a portal with this entity, than it will not register in the game as the boundary to a new zone, and the zone will continue into the area on the other side of the portal. This happens even if you have a second info_location (described below) on the other side (the game will just pick one and use that for the whole zone). This can be a good thing because, say you have a mansion with 30 portals inside. You can cover the whole area inside it by just marking the 2 or 3 portals leading into the mansion area through the doors and open windows, and everything inside that marked area will be counted as one location (just don't miss marking an exit, or have an un-portaled gap to the outside between brushes, or the location will leak outside. It has to be hermetically sealed).

I have read discussion that a door touching a portal marks it as a location boundary, but in my experiments the door did not create a new location and I still had to use a info_locationseparator over the portal to register it as a boundary.

=== info_location ===

Now, inside the zone you want to have, create an '''info_location''' entity:

'''{{RMB}} -> Create entity -> Darkmod -> Info -> info_location'''

Anywhere in the space of the zone is fine. Name it the name of the zone you want (to make it easy to find when you push {{key|J}}).

== Settings per location/zone ==

On each info_location, you can set multiple spawnargs that adjust the light or sound for that location, as well
as run scripts. We cover them next:

=== Ambient sound ===

Now create a spawnarg property of "ambient" with the value being the speaker-name of the sound you used in the location_settings entity above (NOT the soundshader name or file name). For example,

'''"ambient" "snd_streets"'''

This will send a command to the location_settings (in its speaker capacity) to play the ambient it has registered under "snd_streets" that you entered. When you enter a new zone, in turn, the new info_location sends a command to the speaker to turn off that ambient and start a new one.

If you wanted to have no ambient playing in the zone (and turn off any ambient started from another zone), you would use "snd_silence" as the value to command the speaker to turn off. Also, if you have an info_location with no "ambient" value at all, it will also turn off the ambient (in the present version of this system). That means if you make a new location but want the same ambient playing in it as the location next to it, you still need to add the ambient name for the already-playing ambient for it to continue playing into the new zone; otherwise it will turn off.

==== Examples ====

Here are two info_locations on two sides of a portal, with an info_locationseparator touching the portal (more like piercing it), and with each info_location containing the name of the ambient that will play in its respective zone.

[[Image:Snd_streets.jpg]]

[[Image:Snd_silence.jpg‎]]

That's basically it. The ambients will now turn on when you enter a zone and turn off when you enter a new zone, turning on the new ambient in that new zone (unless it's the same ambient, then it just keeps playing, useful e.g., if you want 2 different EAX but 1 ambient playing). If you open up the console, you should see a message saying that a new ambient is now playing in your current location, naming the ambient and location.

=== Sound Fading ===

Finally, there are a few other spawnargs on the info_locations that you usually don't have to worry about (with the possible exception of "volume"), but you can use them if you like, so I will mention them. They concern the properties of the ambient fading. Check the "Show Inhereted Properties" to see their default values. Entering a new value will over-write the default value, but only for that one object.

[[Image:Info_loc.jpg‎]]

==== fiduration ====

"Fade in duration". This is the length of time in seconds it takes for the in-coming ambient (the one for this zone) to completely fade-in. The default value is 4 seconds. You can, e.g., make the fade last much longer with a larger value.

If you don't want your ambient to fade in at all, but start immediately at full volume, change this value to ".001" (NOT zero).

==== foduration ====

"Fade out duration". This is the length of time in seconds it takes for the out-going ambient (the one from the zone you're leaving) to completely fade-out. Again, if you want it to cut right off without fading, use a value of ".001".

==== fidelay ====

"Fade in Delay". You can delay the beginning of the in-coming ambient's fade-in after you enter the new area. You might want to do this, for example, if you want the out-going ambient to completely fade out before you begin fading in the new ambient. So you would set fidelay to the same time as the foduration. By default it is set to .001 so that there is no delay and the fade in starts immediately. If the out-going fade-out also starts immediately (which happens by default), then they blend together in a nice transition fade.

==== fodelay ====

"Fade out Delay". Similarly you can delay the beginning of the out-going ambient's fade out. You might want to do this if you wanted the in-coming ambient to completely fade in before you started the fade out of the old ambient. Then you would set it to fiduration. Like fidelay, it is set to .001 so there is no delay and the fade out starts immediately.

==== fovolume ====

"Fade out volume". This sets the volume to which the out-going ambient fades to. -60 turns it off, which is the default (0 means no decrease in volume at all). If you go any higher than -60, than it will leave the old ambient still playing at a lower volume under the new ambient (at least until you enter a 3rd new zone). Not sure why you'd ever want to do that, so you probably don't want to change it.

==== volume ====

This allows the mapper to override the volume of the ambient sound once it has fully faded in, and uses the same decibel scale as the '''s_volume''' speaker parameter. Note, though, that it uses the spanwarg "volume" instead. I found a decibel-loudness calculator here: http://www.sengpielaudio.com/calculator-levelchange.htm that lets you compute the decibel number for relative loudness. According to it, "0" is the native volume of the sound (the default), "-60" is silence, "-4" is 3/4 (.75) of the volume, "-10" is half (.5) the volume, "-17" is 0.3 of the volume, and it goes quickly down from there. "10" is double, but be warned there may be problems with positive numbers (e.g., volume clipping) and you should keep it not far above 0 if at all. See [[Setting Up Speakers#volume/ s_volume|"Volume / S_Volume"]] & [[Volume Issues]] for more detailed discussion of the volume parameter.

'''Do not override ambient volumes unless strictly necessary'''. Maps with wildly different ambient volume settings result in a poor experience for players, and limit the ability of the Dark Mod team to respond to volume-related issues by changing default volumes in sound shader declarations.

These last two ('''foduration_2foip''' and '''fiduration_2foip''') are pretty obscure situations, so you probably don't need to ever mess with them unless you want to completely get rid of ambient fades (then you can set them to .001 like the other 'fade duration' properties).

==== foduration_2foip ====

"Fade-out duration during a '2 Fade-outs in progress' situation". This provides a shorter fade-out duration (in seconds) for when the player quickly runs into a 3rd location, such that the 1st and 2nd ambients from areas the player just left are still fading out (hence the 2 fade-outs). But the quickend-fade-out only applies to the 1st ambient fading out. (i.e., not of the ambient you just left, but the one you left just before that -- unless you're backtracking, then it just fades the prev-prev ambient back in). Fading out that prev-prev ambient more quickly in turn quickens the time the new fade-in can start (because you can't have 3 sounds on at the same time on the zone speaker, only 2). So it in effect reduces the gap of quiet that happens before the newest ambient fully fades-in by enabling it to start its fade-in faster. The default is 1 second.

==== fiduration_2foip ====

"Fade-in duration during a '2 Fade-outs in progress' situation". Like its counterpart, this sets a shorter duration of a fade-in of a new ambient (in seconds) when you run into a 3rd location, while the ambients from the 1st and 2nd locations are fading out. Again, because so many ambients are fading out, it can leave a gap of silence for a bit until the new 3rd ambient fades in. So setting a shorter duration than usual for the newest ambient to fully fade in helps shorten the quiet space. The default is 2 seconds (as opposed to a normal default fade-in duration of 4 seconds).

==== Example of Location with No Fading Transition ====

As mentioned above, if you wanted a set-up that turned off all fades so that the out-going ambient shut directly off and the in-coming ambient turns directly on, you'd change all the duration properties to .001, like the following image. (Note that this modifies the transition only for entering this one location. All the other info_locations maintain their default values unless you also change them by hand.)

[[image: Fade_duration.jpg‎]]

=== Ambient light settings ===

These spawnargs can be set on '''atdm:info_location''' entities and apply to the current zone then:

==== "ambient_light" ====

This spawnarg specifies the ambient light color for this zone. Setting it f.i. to "0.10 0.02 0.02" would fade the ambient light to a slightly reddish color. This can be useful for covering a lava cave. Other examples are slightly blue light for moonlit outsides, greenish cast for caves or underwater areas etc.

If you do not set this on an info_location entity, the default value of the global "ambient_world" entity will be used.

'''Notes:'''

:*You need to set the color values as fractions between 0 and 1, e.g. '''"0.08 0.08 0.02"''' and '''NOT''' as integers like so <s>"8 8 2"</s>, or it will not work.

:*If the color change between two zones is too big, the fading and change can become obvious to the player and spoil the subtlety. This can happen for instance if you zoom from a bluish-lit outside directly to a reddish-glowing cave inside. To help the transition, consider adding an intermidiate zone with a light color that is either in between the two, or a more neutral grey. Making it not possible to look from one zone to the other also helps, this way they player can't see that f.i. the outside ground suddenly also glows reddish when looking back from the cave entrance to the outside.

:*There's a bug with setting ambient_light to 0 0 0 (to be fixed in 2.05), so use 0.004 0.004 0.004 if you want to remove ambient light from a location.

==== "ambient_light_fade_time" ====

This specifies the time in seconds it will take to fade from the current ambient light color to the one specified for this location. A slower fade means more gradual light changes, so they don't become too obvious to the player. Use at least 3, better 5 or 7 seconds.

If set to -1, the default time specified at the '''atdm:location_settings''' entity will be used.

==== "ambient_light_fade_delay" ====

This specifies the time in seconds the fading will be delayed when the player changes location.

Useful to prevent fades toggling back and forth when the player stands in a doorway and goes a nudge forward/backwards. A good value is at least 1 second.

If set to -1, the default time specified at the '''atdm:location_settings''' entity will be used.

==== "ambient_light_dynamic" ====

'''This is a factor''', all lights in the current area will be summed together and scaled by this value.

If set to a value other than "0 0 0", the lights in the current zone will be all summed together and then
added to the current base ambient light. This happens with the frequency of '''update_period'''.

The basic effect is that a roaring fire also slightly makes the walls flicker, and extinguishing all lights in a room would decrease the ambient light slightly.

The factor should be set up so that for large and dark rooms (e.g. caves) the dynamic part is small, while for small, bright rooms (white walls) the dynamic part is bigger. Examples are: "0.05 0.05 0.05" and "0.1 0.1 0.1".

Note that setting the dynamic factor to high can result in the player being busted by lights that are turned on in the room even when the player is in the shadow.

See also the article about [[Dynamic ambient light]].

==== "ambient_light_dynamic_cap" ====

Used to cap the dynamic ambient light part. If set to 0, will be ignored, so to have a very very small
cap, set to "0.01", e.g. if you want only the red part to be dynamic, set it f.i. "0.15 0.01 0.01".

See also the article about [[Dynamic ambient light]].

==== "ambient_light_falloff" ====

Possible values are:

* -1 on info_location: use the value from the atdm:location_settings entity
* 0 - no dynamic falloff
* 0.5 - small, based on square root of distance
* 1 - medium, linear dynamic falloff (should be used as it looks best)
* 2 - high, square of distance based falloff

See also the article about [[Dynamic ambient light]].

==== "ambient_light_dist_scale" ====

A factor to scale the distance before applying a dynamic light falloff. Only used then '''ambient_light_dynamic_falloff''' is not 0. Good valuesa are around 1.0.

See also the article about [[Dynamic ambient light]].

=== Script calls ===

The next four spawnargs all specify scripts to call when the player enters or exits a zone. Note that the very first zone is also "entered" by the player when the map starts. That means "call_once_on_entry" for the start zone should be called at start-time.

==== "call_once_on_exit" ====

Called only once when the zone is left by the player.

==== "call_once_on_entry" ====

Called only once when the zone is entered by the player.

==== "call_on_exit" ====

Always called when the player leaves that zone.

==== "call_on_entry" ====

Always called when the player enters that zone.

==== Example scripts ====

Here is an example script that spawns an object where the '''info_location''' entity is for the zone the player just left. You can call this script by setting:

'''"call_once_on_exit" "spawn_pear"'''

on your info_location entity.

<pre>
void spawn_pear( entity old_zone )
{
// Get the name of the location that the player just left:
string location_name = old_zone.getName();
// and display it on the console for debugging
sys.print ("Spawning pear after leaving " + location_name + "\n");
// spawn the pear entity
entity pear = sys.spawn("atdm:moveable_food_pear");

// and now get the position of the old location entity:
vector origin = old_zone.getOrigin();
// finally move the pear to the point of the info_location
pear.setOrigin( origin );
// so once the player exits this location, ONE pear will spawn and fall down
}
</pre>

==== Example script to turn entities on/off when player enters a location ====
The basic problem with normal TDM entity work is the difficulty of turning something deliberately and reliably on or off. You never turn something on or off, but instead you send toggles to the entities. Let's say you have a omni sound (a sound which is heard everywhere) which you need to shut off when the player goes to a certain location. Trigger_multiples trigger targets when the player stands on their volume, which may result in a completely wrong situation depending how long the player stands on the trigger.

Location entity scripting can be of great help in here. This kind of scripting can generally solve any kind of problems where the mapper want something to be switched specifically on and off when the player moves to a specific location. Here is an example, which was used to switch off a global thunder sound when the player moves to a location where the rumbling cannot be heard.

Set up location setting as described above. Put a location separator on the visportal you want to be the point which switches your target on/off. Give the info_location-entity spawnargs
*call_on_entry yourscript
*call_on_exit yourscript

Then go and create in your /maps folder a file yourmapname.script. Put in the following data there:

void yourscript(entity old_zone)
{
sys.println("script yourscript running..");
sys.trigger( $entity_name );
}
void main()
{
}

*yourscript is the name of your script you call.
*sys.println is a debug feature which gives the text in console when the script is triggered. You can leave it for testing and remove it before releasing your map.
*sys.trigger ($entity_name) replace the entity_name with the entity which you want to be triggered.

Now your system works like this:
*When the player is outside the location everything is normal. Ie sound off, light off, etc.
*When the player enters the location, entity_name gets triggered once. Ie sound on, light on, etc.
*When the player leaves the location, entity_name gets triggered again. Ie sound off, light off, etc.

== See also ==

* [[Adding ambient Sounds to your Map]]
* [[Dynamic ambient light]].
* [[Ambient Sounds - Zone (using triggers)]]
* [[Sound File Formats]]

{{tutorial-sound}}
{{editing}}
{{tutorial-scripting}}
[[Category:Ambient Light]]

Objectives

2015-11-23T17:46:23Z

SteveL: /* Notes on using INVALID status */ typos

{{Original_Reference|Ishtvan|4121}} ''additions by greebo''

This article covers details of the objectives system. Note that mappers can use
DarkRadiant's [[Objectives Editor]] to make it easier to create objectives.

The objectives system exists to determine when the player has completed the mission. At the highest level, a mission consists of a list of objectives to be completed and boolean logic to determine when the mission has succeeded or failed based on which of the objectives are complete. At the objective level, an objective consists of individual components and boolean logic to determine when the objective is completed or failed. At the component level, each component has a type, a specifier, and arguments. These will be explained fully in the components section.

= Mission =
Objectives are stored by entities named [[target_tdm_addobjectives]]. Your mission can have several of these but typically you will only want one for all your objectives.

By default these entities self-trigger (activates themselves) at mission start. If you need to delay this and activate it later (via any trigger entity that can have a target spawnarg) then add the spawnarg ''wait_for_trigger'' with a value of 1.

When triggered, these entities add objectives to the mission based on their spawnargs.

Spawnargs governing mission level behavior may be entered on any target_addobjectives. Non-empty spawnargs will be overwritten by the most recently triggered target_addobjectives (FM authors may want to do this if they add an objective later on and want to change the mission success logic to include that objective, for example). The following is a list of the mission-level spawnargs and what they mean:

== Success/Failure Logic ==
By default, all mandatory objectives need to be completed for mission success. However, it's possible to define a custom success and failure logic string on an objective entity. Be sure to have this addobjectives entity active at map start so that the logic is parsed right at map load.

=== Default Logic ===
*;<tt>mission_logic_success</tt> (string)
:A string of boolean logic applied to individual objective states to determine if the mission succeeds. AND, OR, NOT and parenthesis are available. The FM author can construct strings using these and the integer index for an objective. For example: "1 OR (NOT(2) AND 3)" would complete the mission if either objective 1 is true, or if 2 is false and 3 is true. By default, a mission succeeds when all mandatory objectives are completed.

*;<tt>mission_logic_failure</tt> (string)
:Boolean logic applied to individual objective component states to determine if the mission has failed. By default, if any mandatory objective fails, the mission fails.

=== Difficulty Dependent Logic ===
The above spawnargs apply to all difficulty levels. It's of course possible to override this default for a given difficulty level, by setting these spawnargs. The index N is referring to the difficulty level number (starting from 0 = Easy):

*;<tt>mission_logic_success_diff_N</tt> (string)
:Defines the success logic for the difficulty level N (override the default logic), e.g. "1 AND 2 AND 3".
*;<tt>mission_logic_failure_diff_N</tt> (string)
:Defines the failure logic for the difficulty level N (override the default logic). When this condition is fulfilled, the mission has failed.

If specific logic is not specified for a certain difficulty level, the default spawnargs (without _diff_*) will be used.

= Objectives =
Objectives added by the target_addobjectives each have a unique integer index, starting with objective 1, the first objective. The spawnargs associated with an objective are prefixed in the following manner:
obj<objective index>_<spawnarg name>
Example: ''obj3_desc''

The spawnargs (minus prefix) and meanings for objective attributes are listed below. Each objective also includes a list of components and their attributes, which will be covered in the next section.

*;<tt>objN_desc</tt> (string)
:The description of this objective. This is used to display the objective in the GUI - the user will never see the objective number, only this string. The default value is an empty string.

*;<tt>objN_state</tt> (int) Defines the state of the objective at map start.
:'''Possible Objective States:'''
:* 0 = STATE_INCOMPLETE
:* 1 = STATE_COMPLETE
:* 2 = STATE_INVALID
:* 3 = STATE_FAILED
:Code defaults to 0 = incomplete.

*;<tt>objN_mandatory</tt> (1/0)
:Set to 0 for optional objective that doesn't fail the mission if you fail it. Objective must be completed to complete the mission if 1. Code defaults to 1.

*;<tt>objN_irreversible</tt> (1/0)
:Irreversible objectives lock their state once they're changed to COMPLETE or FAILED. Irreversible components will only change state once and then stay in that state. (Note: There are scriptfunctions to reset irreversible objectives and components if the FM author wants to let them change again for some reason). Code defaults to 0.

*;<tt>objN_ongoing</tt> (1/0)
:If true, this objective is not marked as complete and the player is not informed that it's complete until the end of the mission. Typically used for "do not kill" type objectives, because technically they would be complete right from the beginning, but we don't want to mark them off or tell the player they're complete right at the beginning. Could also be used for "have some item with you when you complete the mission." Code defaults to 0.

*;<tt>objN_visible</tt> (1/0)
:Whether the objective appears in the player's Objectives GUI. Use invalidated and hidden objectives to queue up objectives for later, or hidden but valid objectives as another way of scripting events when the player does a certain thing, since objectives can launch an arbitrary script after they're completed. Code defaults to 1.

*;<tt>objN_difficulty</tt> (integer)
:Space delimited list of difficulty levels that should include this objective. For example, "2 3" would enable this objective at difficulty levels 2 and 3, but not for other difficulty levels. Default value is empty - the objective applies to all difficulty levels.
:''Note:'' When the objective is not active for a given difficutly, it is invalidated and hidden, but it still exists, so the numbering of the next objective should still increase by 1. E.g., objective 5 only appears on hard difficulty, but you still have to call the next objective objective 6, you can't call it objective 5 only appearing on easy or medium difficulty.

*;<tt>objN_enabling_objs</tt> (space-delimited integers)
:This is a list of objectives which must be completed ''before'' this objective can be completed. For example, we shouldn't mark "objective complete" for exiting the mission until all the other mission goals have been completed. An example value for this spawnarg would be "4 6" to let this objective depend on objectives #4 and #6.

*;<tt>objN_script_complete</tt> (string)
*;<tt>objN_script_failed</tt> (string)
:Name of a script to call when this objective is completed or failed. For example, this could be used in campaigns to set up optional objectives in one mission that effect other missions. This feature could also be used as a general scripting aide if the author wants to set up the conditions for something happening using a hidden objective.

*;<tt>objN_target_complete</tt> (string)
*;<tt>objN_target_failed</tt> (string)
:Name of a target entity to [[Triggers|trigger]] when this objective is completed or failed, similar to the completion/failure script. Only one entity name is allowed here. If you need to trigger multiple entities on objective state change, use a [[Triggers#trigger_relay|trigger_relay]] entity.

*;<tt>objN_logic_success</tt> (string)
:Boolean logic applied to individual objective component states to determine if the objective is complete. The same boolean logic options are available as in the mission-level logic described above. By default, all of the components must be true to complete the objective. In other words, all components are ANDed together (1 AND 2 AND 3...).
*;<tt>objN_logic_failure</tt> (string)
:Boolean logic applied to individual objective component states to determine if the objective is failed. By default, if an objective is ongoing, and any opponent becomes false, that objective will fail.

= Objective Components =
Each objective has an associated list of components and spawnargs defining the attributes of those components. These component spawnargs associated with a given objective are prefixed in the following manner:
obj<objective index>_<component index>_<spawnarg name>
Example: ''obj1_2_state''

In the following, the index N defines the objective number and M refers to the component number. Programmers beware that both numbers start from the value 1.

*;<tt>objN_M_state</tt> (1/0)
:Defines the state of the component at map start, which can only be "1" (complete) or "0" (incomplete). Code defaults to 0.

*;<tt>objN_M_player_responsible</tt> (1/0)
:When true, the player must be responsible for the events that satisfy this component. Events the player is not responsible for are not counted. (e.g., the player kills an AI vs. another AI killing an AI). Code defaults to 1.

*;<tt>objN_M_not</tt> (1/0)
:Code defaults to 0. If true, this component is logically NOTed, so when the conditions described by the type and speifiers are not met, the component state is true, and when they are met, it is false.

*;<tt>objN_M_irreversible</tt> (1/0)
:When the component state changes from its initial state, it will stay in its new state regardless of what happens later. (There is a script event to "unlatch" a latched objective component if needed). Code defaults to 0.

*;<tt>objN_M_type</tt> (string)
:Defines the type of this objective component. See the section [[#Component_Types|Component Types]] below for detailed information.
:'''Possible 'Objective Component' Types:'''
:* kill (also includes non-living things being destroyed)
:* ko
:* ai_find_item (not implemented)
:* ai_find_body (not implemented)
:* alert
:* destroy (inanimate item destroyed ("killed"))
:* item (picked up or dropped an inventory item)
:* pickpocket (inventory item acquired from conscious AI)
:* location (Item A at location B, where "A" is any entity that must have the key "objective_ent" set to "1" on it, and location B is a special entity info_objective_location. Later on we may support using the D3 location system as well)
:* custom (custom component that is set true/false by a map script)
:These components are triggered every N milliseconds by a system clock:
:* custom_clocked (runs a custom map script that should check something and set the objective)
:* info_location (Item A at info_location area B) - TODO: more information needed
:* distance (distance between the origin of entity X and that of entity Y)

Any component can have up to two specifiers, each of which can carry a value. Here, K refers to the number of the specifier, e.g. ("obj2_1_spec4" "name").
*;<tt>objN_M_specK</tt> (string)
:'''Specification Methods:'''
:Specification methods determine what the objective component is looking for. Does it look at how many AI of a specific team you've KO'd, how many humans, how many overall, or whether you've KO'd an AI with a certain name? Each objective component can have up to two of the following specifiers (Not all components can take two specifiers, and not all specifiers make sense for all component types, future documentation will cover that). See the section [[#Specifiers|Specifiers]] below for a detailed description.
:'''The following apply to both AIs and items:'''
:* none
:* name (name of entity)
:* overall (overall count of something: kills, loot, kos, etc)
:* group (inventory group)
:* classname (soft/scripting classname)
:* spawnclass (hard / SDK classname, e.g. "idPlayer")
:'''The following specification methods apply only to AI:'''
:* ai_type (human, beast, undead, bot, etc)
:* ai_team (mapper defined team of the AI)
:* ai_innocence (For distinguishing noncombatants)

*;<tt>objN_M_spec_valK</tt>
:Value that the Kth specifier should match in order to count towards this component. (E.g., an entity name if we specify by name.)

*;<tt>objN_M_args</tt> (space-delimited string)
:'''Integer and String Arguments:'''
:A component can have an arbitrary number of int and string arguments that are fed in space delimited lists. The type of component and specifier determines which args it will use and what it will do with them. For example, the first integer arg is often used to determine how many times something can happen, e.g., the player is only allowed 4 KOs, or must get 500 loot. Not all events are counted up though. The only things that are counted up are things in the mission statistics like loot and kills, so everything else is pretty much a one shot deal where it happens once. Future documentation will detail which objective events are counted up and which are one shots.

*;<tt>objN_M_clock_interval</tt> (float/seconds)
:For clocked components like "custom_clocked" this determines how often they are updated. The value is to be set in seconds.

== Component Types ==
=== AI-Related Components ===
The following specifiers are termed "Standard AI Specifiers": All specifiers minus the <tt>group</tt> specifier.

;*<tt>kill</tt>
:An AI must be killed to satisfy this component.
:'''SDK Name''': COMP_KILL
:'''Number of Specificatons''': 1 (object that must be killed)
:'''Applicable Specifiers''': Standard AI Specifiers
:'''Expected Arguments''': int (number of kills required)

;*<tt>ko</tt> (Knockout)
:An AI must be knocked out by any means (gas, blackjack, other).
:'''SDK Name''': COMP_KO
:'''Number of Specificatons''': 1 (AI that must be KO'd)
:'''Applicable Specifiers''': Standard AI Specifiers
:'''Expected Arguments''': int (number of KOs required)

;*<tt>ai_find_item</tt>
:''not yet implemented''
:'''SDK Name''': COMP_AI_FIND_ITEM
:'''Number of Specificatons''': --
:'''Applicable Specifiers''': --
:'''Expected Arguments''': --

;*<tt>ai_find_body</tt>
:''not yet implemented'' An AI must find a body. Currently, the specifiers apply to the bodies found, and any AI finding the bodies triggers this component. Future revisions might add another specifier for the AI that finds the body.
:'''SDK Name''': COMP_AI_FIND_BODY
:'''Number of Specificatons''': 1 (Type of body that must be found)
:'''Applicable Specifiers''': Standard AI Specifiers
:'''Expected Arguments''': int (number of bodies that must be found)

;*<tt>alert</tt>
:True if an AI or type of AI is alerted. Use the player_responsible flag to determine if this should count alerts not caused by the player's actions (e.g., enemy AI being sighted)
:'''SDK Name''': COMP_ALERT
:'''Number of Specificatons''': 1 (AI that must be alerted)
:'''Applicable Specifiers''': Standard AI Specifiers
:'''Expected Arguments''': int (number of alerts required), int (minimum alert level that counts: 1-5 with 5 being the combat state)

=== Non-AI Components ===

;*<tt>destroy</tt>
:An inanimate item must be destroyed (damage it until its health is lower than zero).
:'''SDK Name''': COMP_DESTROY
:'''Number of Specificatons''': 1 (item to be destroyed)
:'''Applicable Specifiers''': all
:'''Expected Arguments''': int (number of items to be destroyed)

;*<tt>item</tt>
:Completed when the player has this inventory item or loot.
:'''SDK Name''': COMP_ITEM
:'''Number of Specificatons''': 1 (item the player must have)
:'''Applicable Specifiers''': All except AI type, team and innocence.
:'''Expected Arguments''': int (number of items to have, 1 by default)

;*<tt>pickpocket</tt>
:An inventory item must be taken from a conscious AI. Note that it doesn't matter what happens to the item after it is pickpocketed. It could be destroyed or dropped, but as long as it was originally pickpocketed, it counts.
:'''SDK Name''': COMP_PICKPOCKET
:'''Number of Specificatons''': 1 (Item the player must pickpocket)
:'''Applicable Specifiers''': All except AI type, team and innocence
:'''Expected Arguments''': int (number of items to pickpocket, 1 by default)

;*<tt>location</tt> Object in location brush (using info_tdm_objective_location brush)
:A particular item must be in a particular location, defined by an info_objective_location brush. For optimization reasons, the entity or entities to be checked must also have this spawnarg: "objective_ent" set to "1". NOTE: Multiple objects in a single location are not counted up for this component, this is a single-shot objective. If you want the player to put more than one object in a location, you must currently create several of these components, specifying by name, and OR them together in the objective logic.
:'''SDK Name''': COMP_LOCATION
:'''Number of Specificatons''': 2 (object entity to check, location entity to check)
:'''Applicable Specifiers''': For the object to check, all specifiers apply, but multiple objects are not counted up. Typically the objects will be specified by name. For the location to check, it will either be specified by name or by group.
:'''Expected Arguments''': None (if both specifiers match, the objective is completed).

;*<tt>info_location</tt> Object in location area (using info_location entities)
:A particular item must be in a particular location, defined by an info_location area (see vanilla D3 documentation for info_location). Multiple objects in a single location are not counted up for this component, this is a single-shot objective. If you want the player to put more than one object in a location, you must currently create several of these components, specifying by name, and OR them together in the objective logic.
:This check is done periodically. Set spawnarg <tt>clock_interval</tt> to the time in seconds between periodic checks.
:'''SDK Name''': COMP_INFO_LOCATION
:'''Number of Specificatons''': 2 (object entity to check, location entity to check)
:'''Applicable Specifiers''': For the object to check, all specifiers apply, but multiple objects are not counted up. Typically the objects will be specified by name. For the location to check, it will either be specified by name or by group.
:'''Expected Arguments''': None (if both specifiers match, the objective is completed).

;*<tt>custom</tt>
:This custom objective component is only changed when an external script changes it. Otherwise it does nothing.
:'''SDK Name''': COMP_CUSTOM_ASYNC
:'''Number of Specificatons''': none
:'''Applicable Specifiers''': none
:'''Expected Arguments''': none

;*<tt>custom_clocked</tt>
:This component calls a custom script periodically to check some condition. When run, the script is expected to this component true or false based on the custom check. This objective component could also be used as a convenient method to periodically call a script that has nothing to do with objectives.
:Set spawnarg <tt>clock_interval</tt> to the time in seconds between periodic calls of the script.
:'''SDK Name''': COMP_CUSTOM_CLOCKED
:'''Number of Specificatons''': none
:'''Applicable Specifiers''': none
:'''Expected Arguments''': string (name of the script to call periodically)

;*<tt>distance</tt>
:Two entities must be sufficiently close to eachother to satisfy this component. The distance check is done between the origin of the first object and that of the second object. If this distance is below the input maximum distance, the component is set to true.
:This check is done periodically. Set spawnarg "clock_interval" to the time in seconds between periodic checks.
:'''SDK Name''': COMP_DISTANCE
:'''Number of Specificatons''': none (see arguments below)
:'''Applicable Specifiers''': none
:'''Expected Arguments''': string (name of first entity), string (name of second entity), int (maximum distance in doom units). If one of the entities is the player, use the string 'player1'.

;*<tt>readable_opened</tt>
:''available since TDM 1.02''
:The player must open a named readable to satisfy this component. This doesn't refer to a specific page, just opening the readable is enough.
:'''SDK Name''': COMP_READABLE_OPENED
:'''Number of Specificatons''': 1 (The name of the readable)
:'''Applicable Specifiers''': name
:'''Expected Arguments''': none

;*<tt>readable_closed</tt>
:''available since TDM 1.02''
:The player must close a named readable to satisfy this component. This doesn't check whether the player has finished reading all pages, just closing the previously opened readable is enough.
:'''SDK Name''': COMP_READABLE_CLOSED
:'''Number of Specificatons''': 1 (The name of the readable)
:'''Applicable Specifiers''': name
:'''Expected Arguments''': none

;*<tt>readable_page_reached</tt>
:''available since TDM 1.02''
:The player must open/read a specific page of a named readable to fulfil this component. Scrolling to the page is enough to trigger this event.
:'''SDK Name''': COMP_READABLE_PAGE_REACHED
:'''Number of Specificatons''': 1 (The name of the readable)
:'''Applicable Specifiers''': name
:'''Expected Arguments''': int (the page number which should be reached, the number 1 refers to the first page)

== Specifiers ==
;*<tt>none</tt>
:No specifier. Component will be completed as soon as any event of that component type happens. (E.g., if you set a KO component type, with specifier none, it would be set to true as soon as soon as the player KO's anyone). This is the default specifier if none is entered. Not very useful, except for blanket "don't do this" objectives. Even then, it is better to use "overall" described below.
:'''SDK Name''': SPEC_NONE
:'''Specifier Argument Type Expected''': No spec argument needed since we don't have to match anything.

;*<tt>name</tt>
:Name of the entity
:'''SDK Name''': SPEC_NAME
:'''Specifier Argument Type Expected''': string

;*<tt>overall</tt>
:In the context of inventory item objectives, this refers to overall loot. In the context of AI objectives, this refers to all AI, regardless of team, type, etc.
:'''SDK Name''': SPEC_OVERALL
:'''Specifier Argument Type Expected''': No spec argument needed since we don't have to match anything.

;*<tt>Group</tt>
:For inventory items, the item's <tt>inv_name</tt> spawnarg value will be used here. For example, if you want the player to get 5 flashbombs, you would use this with group equal to the <tt>inv_name</tt> of flashbombs. As opposed to getting a specific flashbomb in the map, where you would use the <tt>name</tt> specifier instead. If an inventory item is loot, the loot group is used here instead (e.g., <tt>loot_gold</tt>).
:Group is also used for other component types as a convenient way to group things, such as info_objective_location or info_location entities checked by COMP_LOCATION and COMP_INFO_LOCATION, respectively.
:'''SDK Name''': SPEC_GROUP
:'''Specifier Argument Type Expected''': string
:'''Loot group names:''' <tt>loot_gold</tt>, <tt>loot_goods</tt>, <tt>loot_jewels</tt> and <tt>loot_total</tt>

;*<tt>Classname</tt>
:The entityDef classname of the entity. For example: atdm:ai_builder_guard
:'''SDK Name''': SPEC_CLASSNAME
:'''Specifier Argument Type Expected''': string

;*<tt>Spawnclass</tt>
: The SDK classname of the entity. For example: idAI
:'''SDK Name''': SPEC_SPAWNCLASS
:'''Specifier Argument Type Expected''': string

;*<tt>ai_type</tt>
:Type of AI: human, beast, undead, steambot, etc. (reads m_AIType in the SDK, which is set by the "type" spawnarg on idActors. Not sure if this is implemented yet).
:'''SDK Name''': SPEC_AI_TYPE
:'''Specifier Argument Type Expected''': int

;*<tt>ai_team</tt>
:The AI's team integer. This can be set up by the mapper to put AI on arbitrary teams. Mapper can also team up AI for objective purposes, and use this team specifier as a fast way of saying "KO any of these 5 AI." Alternatively, one could use the name specifier and put in multiple components for each of those 5 AI, then OR all the components in the objective success logic. Making a new team may save time over that method.
:'''SDK Name''': SPEC_AI_TEAM
:'''Specifier Argument Type Expected''': int

;*<tt>ai_innocence</tt>
:Differentiates between combatants and non-combatants. A value of 1 = non-combatant, a value of 0 => non-combatant, or otherwise not deemed "innocent" by the FM author.
:'''SDK Name''': SPEC_AI_INNOCENCE
:'''Specifier Argument Type Expected''': int (1 = innocent, 0 = not)

= Objective Conditions =
With the campaign code added to TDM 1.06 a new set of spawnargs can be used to let objectives depend on those in a previous mission. These spawnargs are starting with the <tt>obj_condition</tt> prefix.

Each condition defines the "source" mission and the source objective by number, plus the state of the source objective. It also needs to specify the "target" objective (which is always in the current mission) by number and which action to take. Right now, three different actions are supported:
* Change Objective State (complete, failed, etc.)
* Change the Objective's Visibility (hide or show)
* Change the Objective's Mandatory Flag

== Syntax ==

*;<tt>obj_condition_N_src_mission</tt> (integer)
:Defines the source mission the condition depends on. The integer is 0-based, i.e. the first mission has the number 0. The placeholder N is the number of the condition.

*;<tt>obj_condition_N_src_obj</tt> (integer)
:Defines the number of the source objective in the source mission. The integer is 0-based, i.e. the first objective has the number 0. The placeholder N is the number of the condition.

*;<tt>obj_condition_N_src_state</tt> (integer)
:Defines the state the source objective needs to be in for this condition to apply. The value can be in the same range as the objN_state spawnarg above:
:* 0 = STATE_INCOMPLETE
:* 1 = STATE_COMPLETE
:* 2 = STATE_INVALID
:* 3 = STATE_FAILED

*;<tt>obj_condition_N_target_obj</tt> (integer)
:Defines the number of the target objective in the current mission. The integer is 0-based, i.e. the first objective has the number 0. The placeholder N is the number of the condition.

*;<tt>obj_condition_N_type</tt> (string)
:Defines the action to take if the condition applies. There are three possible action types available:
:* "changestate" Change the state of the target objective.
:* "changevisibility" Change the visibility of the target objective.
:* "changemandatory" Change the mandatory flag of the target objective.
:The combination of this "type" spawnarg and the "value" spawnarg below defines exactly what action is performed on the target objective.

*;<tt>obj_condition_N_value</tt> (integer)
:The meaning and possible values of this spawnarg depend on the "type" spawnarg above. It is used as "parameter" or "argument" for the above action, e.g. the "changevisibility" action needs to know whether to show or hide the target objective. The possible values are listed below:
:* For type "changestate"
:** 0: set to incomplete
:** 1: set to complete
:** 2: set to invalid
:** 3: set to failed
:* For type "changevisibility"
:** 0: set to invisible
:** 1: set to visible
:* For type "changemandatory"
:** 0: clear mandatory flag
:** 1: set mandatory flag

= Conclusion =
Using components that combine component types with up to 2 entity arguments and 2 specifier types, plus objectives that are a boolean combination of those components should hopefully allow for a variety of different objectives.

= Using Objectives Creatively =

==A method for using objectives to change AI patrols when alert.==

This works beautifully. The AI are placed at the seats just like in the card player prefab. Each player have "sitting 1" so they sit down at map start. AI's have no targets.

Then I have one unseen objective per player:
Objective component is only "AI is alerted", with the single entity card playing AI name. I can set the minimum alert level required for the AI to react. I set that to 3, so if the AI search actively, he won't be playing cards anymore, but goes patrolling instead.
Basically the objective component says: "Alert entity cardgamer1 1 times to a minimum alert level of 3."

And when that gets satisfied, the objective has completion target gopatrol_start, which is an ordinary trigger_once. This in turn targets a func_static which gives all the cardgamers new targets to their patrol routes.

This is done as follows: Choose any kind of func_static. Open it in the Stim&Response editor. Add response trigger. Add an effect to this response. Choose "Add Target." Put in the entity box the name of the AI. Put in the target box the name of the path_node where the AI should go.

When I make one objective for each player, alerting any single one of them will make everyone of them to go for patrol. And once the trigger_once is gone, further alerting of the AI has no effect.

==A way to replace AI when others are knocked out or killed.==

Have spare AIs isolated in an inaccessible place either of your map, or room off in the void, targeting a path_waitfortrigger which then carries on their path. Have the AI subject to substitution on a unique team in your map (or identify another way), as well as the spare AIs. An objective is set up like the usual fail if you knock out or kill an AI, but not visible, set to the appropriate team. I found I needed multiple Objective Components, the first no knock/no kill set to an amount of one. Then two and three, etc. Take note of what objective number the objective is and plan on not altering that. Set the failure target to a trigger relay, which targets as many trigger_counts as you have replacement AI. That's it for setting up the objective part.

Add the aforementioned trigger relay, trigger_counts, and a target_setobjective_state. Setup the target_setobjective_state with "Obj_id0" #, where # is the objective number noted earlier, and set "obj_state" to "0". Add a matching number of atdm:teleport (in target/) as trigger_counts, each teleport targeting one of the stored AI. The first trigger_count is set to 1, and targets the first teleport and AI (to release it from the path_waitfortrigger). The second trigger_count is set to 2, and targets the next teleport and AI, etc. The trigger_relay targets all the trigger_counts and the target_setobjective_state.

So when the initial AI is knocked out or killed, the objective failure triggers the relay. It in turns increments the counts and resets the objective to work again. The first count activates the teleport and triggers the AI to move off it's path_waitfortrigger on to the next path node. Test and voilà!

==Having the player place multiple interchangeable items in varied places.==

In "{{TDM-FM|83|Inn Business}}", the player has to place a number of markers in any of several places. However it was key to not permit multiple markers being placed in the same place, and not all places are required, between half and two-thirds so there's flexibility for various players and their styles.

An "item is in location" with "group identifier" component was used, so each spot (info_tdm_objective_location) had the same spawnarg "objective_group", "drops". Also "interval" was set to "0.3", with no noticeable performance issue while being responsive enough for player feedback. These locations were separate enough, but limited in size, to meet the restrictions below.

So a number of objectives matching the number of inventory items were made, with several components.
* let the target entity ''marker1'' be at location 0 of ''drops''
* Do NOT let the entity ''marker1'' and ''marker2'' get within 150 units (check interval 0.3)
* Do NOT let the entity ''marker1'' and ''marker3'' get within 150 units (check interval 0.3)
* Do NOT let the entity ''marker1'' and ''marker4'' get within 150 units (check interval 0.3)
* etc., depending how many marker entities there are

The other objectives were set up the same way but for their own ''marker#''. (IE, don't let 2 and 1 get within..., don't let 2 and 3, etc.) In this manner, the objective checks if the marker is within the area, but unchecks if the maker rolls out or is removed by the player, and rechecks when they put it back in.

Finally, another objective was created to complete when all had been placed which is not visible but irreversible. It has Enabling Objectives of the former objectives AND together. IE, "9 AND 10 AND 11 AND 12" if there are four. It has a completion target of a [[Triggers#trigger_relay|trigger relay]] entity which targeted several "atdm:target_setobjective_visibility" to turn off all the marker objectives and enable other mission specific things.

The components match the markers, again using the group identifier:
* let the target entity ''marker1'' be at location 0 of ''drops''
* let the target entity ''marker2'' be at location 0 of ''drops''
* let the target entity ''marker#etc...'' be at location 0 of ''drops''

So if all the marker objectives are complete (all items dropped in separate spots), then this completes and fires the trigger, which removes all the marker objectives from display (which the player had for feedback of progress) and moves on with objectives, perhaps displaying a dummy completed objective "All markers placed."

Note: It's important for the marker objective numbers in the objective editor not to change, or update the non visible completion objective AND logic accordingly.

== Don't hurt AI script ==

To have a mission fail if an AI is simply hurt (not just knocked out/killed), this script may be used:

void checkHarm()
{
float JackHealth = $Jack.getHealth();
float JillHealth = $Jill.getHealth(); 
while(1)
{ 
if(JackHealth - $Jack.getHealth() > 1)
{
$FailHarmObjective.activate($player1);
} 
if(JillHealth - $Jill.getHealth() > 1)
{
$FailHarmObjective.activate($player1);
} 
sys.wait(1);
}
}

You would just need to add one variable/if statement for each AI to be affected and run it from the start of the level (i.e. in the void main just have a line that says "thread checkHarm()"). The "FailHarmObjective" is an actual entity in the map which would then fail the relevant objective.

==Notes on using INVALID status==

The INVALID state on an objective:

* prevents any ''timed'' components from being checked (e.g. check every 0.3 seconds whether item A is in place B )
* prevents the objective itself from being checked for completion
* allows objectives that are dependent on the invalid objective to complete
* allows the mission to complete
* is used as the status for missing or malformed objectives
* is used for non-applicable objectives, e.g. the loot goal for a different difficulty setting

You can use INVALID for objectives that don't apply at map start, but then activate them later by setting them to status INCOMPLETE.
Note that:
* The mission and any dependent objectives can still be completed, whether or not the invalid objective has been completed.
* Players can still complete individual components of your invalid objective. This can cause unexpected behaviour. If the player completes all of the components of an invalid objective and then you set the objective to "incomplete" status, the objective will be marked completed, but not right away: it'll be marked complete the next time any ''other'' objective gets an update. That's because any objective getting an update causes all objectives to be re-tested for completeness.

If you need to avoid the second scenario, you can use a target_setobjective_component_state to uncheck the components when you re-enable the objective.

[[Category:Editing]]
[[Category:Tutorial]]

Objectives

2015-10-08T21:20:13Z

SteveL: + Notes on using INVALID status

{{Original_Reference|Ishtvan|4121}} ''additions by greebo''

This article covers details of the objectives system. Note that mappers can use
DarkRadiant's [[Objectives Editor]] to make it easier to create objectives.

The objectives system exists to determine when the player has completed the mission. At the highest level, a mission consists of a list of objectives to be completed and boolean logic to determine when the mission has succeeded or failed based on which of the objectives are complete. At the objective level, an objective consists of individual components and boolean logic to determine when the objective is completed or failed. At the component level, each component has a type, a specifier, and arguments. These will be explained fully in the components section.

= Mission =
Objectives are stored by entities named [[target_tdm_addobjectives]]. Your mission can have several of these but typically you will only want one for all your objectives.

By default these entities self-trigger (activates themselves) at mission start. If you need to delay this and activate it later (via any trigger entity that can have a target spawnarg) then add the spawnarg ''wait_for_trigger'' with a value of 1.

When triggered, these entities add objectives to the mission based on their spawnargs.

Spawnargs governing mission level behavior may be entered on any target_addobjectives. Non-empty spawnargs will be overwritten by the most recently triggered target_addobjectives (FM authors may want to do this if they add an objective later on and want to change the mission success logic to include that objective, for example). The following is a list of the mission-level spawnargs and what they mean:

== Success/Failure Logic ==
By default, all mandatory objectives need to be completed for mission success. However, it's possible to define a custom success and failure logic string on an objective entity. Be sure to have this addobjectives entity active at map start so that the logic is parsed right at map load.

=== Default Logic ===
*;<tt>mission_logic_success</tt> (string)
:A string of boolean logic applied to individual objective states to determine if the mission succeeds. AND, OR, NOT and parenthesis are available. The FM author can construct strings using these and the integer index for an objective. For example: "1 OR (NOT(2) AND 3)" would complete the mission if either objective 1 is true, or if 2 is false and 3 is true. By default, a mission succeeds when all mandatory objectives are completed.

*;<tt>mission_logic_failure</tt> (string)
:Boolean logic applied to individual objective component states to determine if the mission has failed. By default, if any mandatory objective fails, the mission fails.

=== Difficulty Dependent Logic ===
The above spawnargs apply to all difficulty levels. It's of course possible to override this default for a given difficulty level, by setting these spawnargs. The index N is referring to the difficulty level number (starting from 0 = Easy):

*;<tt>mission_logic_success_diff_N</tt> (string)
:Defines the success logic for the difficulty level N (override the default logic), e.g. "1 AND 2 AND 3".
*;<tt>mission_logic_failure_diff_N</tt> (string)
:Defines the failure logic for the difficulty level N (override the default logic). When this condition is fulfilled, the mission has failed.

If specific logic is not specified for a certain difficulty level, the default spawnargs (without _diff_*) will be used.

= Objectives =
Objectives added by the target_addobjectives each have a unique integer index, starting with objective 1, the first objective. The spawnargs associated with an objective are prefixed in the following manner:
obj<objective index>_<spawnarg name>
Example: ''obj3_desc''

The spawnargs (minus prefix) and meanings for objective attributes are listed below. Each objective also includes a list of components and their attributes, which will be covered in the next section.

*;<tt>objN_desc</tt> (string)
:The description of this objective. This is used to display the objective in the GUI - the user will never see the objective number, only this string. The default value is an empty string.

*;<tt>objN_state</tt> (int) Defines the state of the objective at map start.
:'''Possible Objective States:'''
:* 0 = STATE_INCOMPLETE
:* 1 = STATE_COMPLETE
:* 2 = STATE_INVALID
:* 3 = STATE_FAILED
:Code defaults to 0 = incomplete.

*;<tt>objN_mandatory</tt> (1/0)
:Set to 0 for optional objective that doesn't fail the mission if you fail it. Objective must be completed to complete the mission if 1. Code defaults to 1.

*;<tt>objN_irreversible</tt> (1/0)
:Irreversible objectives lock their state once they're changed to COMPLETE or FAILED. Irreversible components will only change state once and then stay in that state. (Note: There are scriptfunctions to reset irreversible objectives and components if the FM author wants to let them change again for some reason). Code defaults to 0.

*;<tt>objN_ongoing</tt> (1/0)
:If true, this objective is not marked as complete and the player is not informed that it's complete until the end of the mission. Typically used for "do not kill" type objectives, because technically they would be complete right from the beginning, but we don't want to mark them off or tell the player they're complete right at the beginning. Could also be used for "have some item with you when you complete the mission." Code defaults to 0.

*;<tt>objN_visible</tt> (1/0)
:Whether the objective appears in the player's Objectives GUI. Use invalidated and hidden objectives to queue up objectives for later, or hidden but valid objectives as another way of scripting events when the player does a certain thing, since objectives can launch an arbitrary script after they're completed. Code defaults to 1.

*;<tt>objN_difficulty</tt> (integer)
:Space delimited list of difficulty levels that should include this objective. For example, "2 3" would enable this objective at difficulty levels 2 and 3, but not for other difficulty levels. Default value is empty - the objective applies to all difficulty levels.
:''Note:'' When the objective is not active for a given difficutly, it is invalidated and hidden, but it still exists, so the numbering of the next objective should still increase by 1. E.g., objective 5 only appears on hard difficulty, but you still have to call the next objective objective 6, you can't call it objective 5 only appearing on easy or medium difficulty.

*;<tt>objN_enabling_objs</tt> (space-delimited integers)
:This is a list of objectives which must be completed ''before'' this objective can be completed. For example, we shouldn't mark "objective complete" for exiting the mission until all the other mission goals have been completed. An example value for this spawnarg would be "4 6" to let this objective depend on objectives #4 and #6.

*;<tt>objN_script_complete</tt> (string)
*;<tt>objN_script_failed</tt> (string)
:Name of a script to call when this objective is completed or failed. For example, this could be used in campaigns to set up optional objectives in one mission that effect other missions. This feature could also be used as a general scripting aide if the author wants to set up the conditions for something happening using a hidden objective.

*;<tt>objN_target_complete</tt> (string)
*;<tt>objN_target_failed</tt> (string)
:Name of a target entity to [[Triggers|trigger]] when this objective is completed or failed, similar to the completion/failure script. Only one entity name is allowed here. If you need to trigger multiple entities on objective state change, use a [[Triggers#trigger_relay|trigger_relay]] entity.

*;<tt>objN_logic_success</tt> (string)
:Boolean logic applied to individual objective component states to determine if the objective is complete. The same boolean logic options are available as in the mission-level logic described above. By default, all of the components must be true to complete the objective. In other words, all components are ANDed together (1 AND 2 AND 3...).
*;<tt>objN_logic_failure</tt> (string)
:Boolean logic applied to individual objective component states to determine if the objective is failed. By default, if an objective is ongoing, and any opponent becomes false, that objective will fail.

= Objective Components =
Each objective has an associated list of components and spawnargs defining the attributes of those components. These component spawnargs associated with a given objective are prefixed in the following manner:
obj<objective index>_<component index>_<spawnarg name>
Example: ''obj1_2_state''

In the following, the index N defines the objective number and M refers to the component number. Programmers beware that both numbers start from the value 1.

*;<tt>objN_M_state</tt> (1/0)
:Defines the state of the component at map start, which can only be "1" (complete) or "0" (incomplete). Code defaults to 0.

*;<tt>objN_M_player_responsible</tt> (1/0)
:When true, the player must be responsible for the events that satisfy this component. Events the player is not responsible for are not counted. (e.g., the player kills an AI vs. another AI killing an AI). Code defaults to 1.

*;<tt>objN_M_not</tt> (1/0)
:Code defaults to 0. If true, this component is logically NOTed, so when the conditions described by the type and speifiers are not met, the component state is true, and when they are met, it is false.

*;<tt>objN_M_irreversible</tt> (1/0)
:When the component state changes from its initial state, it will stay in its new state regardless of what happens later. (There is a script event to "unlatch" a latched objective component if needed). Code defaults to 0.

*;<tt>objN_M_type</tt> (string)
:Defines the type of this objective component. See the section [[#Component_Types|Component Types]] below for detailed information.
:'''Possible 'Objective Component' Types:'''
:* kill (also includes non-living things being destroyed)
:* ko
:* ai_find_item (not implemented)
:* ai_find_body (not implemented)
:* alert
:* destroy (inanimate item destroyed ("killed"))
:* item (picked up or dropped an inventory item)
:* pickpocket (inventory item acquired from conscious AI)
:* location (Item A at location B, where "A" is any entity that must have the key "objective_ent" set to "1" on it, and location B is a special entity info_objective_location. Later on we may support using the D3 location system as well)
:* custom (custom component that is set true/false by a map script)
:These components are triggered every N milliseconds by a system clock:
:* custom_clocked (runs a custom map script that should check something and set the objective)
:* info_location (Item A at info_location area B) - TODO: more information needed
:* distance (distance between the origin of entity X and that of entity Y)

Any component can have up to two specifiers, each of which can carry a value. Here, K refers to the number of the specifier, e.g. ("obj2_1_spec4" "name").
*;<tt>objN_M_specK</tt> (string)
:'''Specification Methods:'''
:Specification methods determine what the objective component is looking for. Does it look at how many AI of a specific team you've KO'd, how many humans, how many overall, or whether you've KO'd an AI with a certain name? Each objective component can have up to two of the following specifiers (Not all components can take two specifiers, and not all specifiers make sense for all component types, future documentation will cover that). See the section [[#Specifiers|Specifiers]] below for a detailed description.
:'''The following apply to both AIs and items:'''
:* none
:* name (name of entity)
:* overall (overall count of something: kills, loot, kos, etc)
:* group (inventory group)
:* classname (soft/scripting classname)
:* spawnclass (hard / SDK classname, e.g. "idPlayer")
:'''The following specification methods apply only to AI:'''
:* ai_type (human, beast, undead, bot, etc)
:* ai_team (mapper defined team of the AI)
:* ai_innocence (For distinguishing noncombatants)

*;<tt>objN_M_spec_valK</tt>
:Value that the Kth specifier should match in order to count towards this component. (E.g., an entity name if we specify by name.)

*;<tt>objN_M_args</tt> (space-delimited string)
:'''Integer and String Arguments:'''
:A component can have an arbitrary number of int and string arguments that are fed in space delimited lists. The type of component and specifier determines which args it will use and what it will do with them. For example, the first integer arg is often used to determine how many times something can happen, e.g., the player is only allowed 4 KOs, or must get 500 loot. Not all events are counted up though. The only things that are counted up are things in the mission statistics like loot and kills, so everything else is pretty much a one shot deal where it happens once. Future documentation will detail which objective events are counted up and which are one shots.

*;<tt>objN_M_clock_interval</tt> (float/seconds)
:For clocked components like "custom_clocked" this determines how often they are updated. The value is to be set in seconds.

== Component Types ==
=== AI-Related Components ===
The following specifiers are termed "Standard AI Specifiers": All specifiers minus the <tt>group</tt> specifier.

;*<tt>kill</tt>
:An AI must be killed to satisfy this component.
:'''SDK Name''': COMP_KILL
:'''Number of Specificatons''': 1 (object that must be killed)
:'''Applicable Specifiers''': Standard AI Specifiers
:'''Expected Arguments''': int (number of kills required)

;*<tt>ko</tt> (Knockout)
:An AI must be knocked out by any means (gas, blackjack, other).
:'''SDK Name''': COMP_KO
:'''Number of Specificatons''': 1 (AI that must be KO'd)
:'''Applicable Specifiers''': Standard AI Specifiers
:'''Expected Arguments''': int (number of KOs required)

;*<tt>ai_find_item</tt>
:''not yet implemented''
:'''SDK Name''': COMP_AI_FIND_ITEM
:'''Number of Specificatons''': --
:'''Applicable Specifiers''': --
:'''Expected Arguments''': --

;*<tt>ai_find_body</tt>
:''not yet implemented'' An AI must find a body. Currently, the specifiers apply to the bodies found, and any AI finding the bodies triggers this component. Future revisions might add another specifier for the AI that finds the body.
:'''SDK Name''': COMP_AI_FIND_BODY
:'''Number of Specificatons''': 1 (Type of body that must be found)
:'''Applicable Specifiers''': Standard AI Specifiers
:'''Expected Arguments''': int (number of bodies that must be found)

;*<tt>alert</tt>
:True if an AI or type of AI is alerted. Use the player_responsible flag to determine if this should count alerts not caused by the player's actions (e.g., enemy AI being sighted)
:'''SDK Name''': COMP_ALERT
:'''Number of Specificatons''': 1 (AI that must be alerted)
:'''Applicable Specifiers''': Standard AI Specifiers
:'''Expected Arguments''': int (number of alerts required), int (minimum alert level that counts: 1-5 with 5 being the combat state)

=== Non-AI Components ===

;*<tt>destroy</tt>
:An inanimate item must be destroyed (damage it until its health is lower than zero).
:'''SDK Name''': COMP_DESTROY
:'''Number of Specificatons''': 1 (item to be destroyed)
:'''Applicable Specifiers''': all
:'''Expected Arguments''': int (number of items to be destroyed)

;*<tt>item</tt>
:Completed when the player has this inventory item or loot.
:'''SDK Name''': COMP_ITEM
:'''Number of Specificatons''': 1 (item the player must have)
:'''Applicable Specifiers''': All except AI type, team and innocence.
:'''Expected Arguments''': int (number of items to have, 1 by default)

;*<tt>pickpocket</tt>
:An inventory item must be taken from a conscious AI. Note that it doesn't matter what happens to the item after it is pickpocketed. It could be destroyed or dropped, but as long as it was originally pickpocketed, it counts.
:'''SDK Name''': COMP_PICKPOCKET
:'''Number of Specificatons''': 1 (Item the player must pickpocket)
:'''Applicable Specifiers''': All except AI type, team and innocence
:'''Expected Arguments''': int (number of items to pickpocket, 1 by default)

;*<tt>location</tt> Object in location brush (using info_tdm_objective_location brush)
:A particular item must be in a particular location, defined by an info_objective_location brush. For optimization reasons, the entity or entities to be checked must also have this spawnarg: "objective_ent" set to "1". NOTE: Multiple objects in a single location are not counted up for this component, this is a single-shot objective. If you want the player to put more than one object in a location, you must currently create several of these components, specifying by name, and OR them together in the objective logic.
:'''SDK Name''': COMP_LOCATION
:'''Number of Specificatons''': 2 (object entity to check, location entity to check)
:'''Applicable Specifiers''': For the object to check, all specifiers apply, but multiple objects are not counted up. Typically the objects will be specified by name. For the location to check, it will either be specified by name or by group.
:'''Expected Arguments''': None (if both specifiers match, the objective is completed).

;*<tt>info_location</tt> Object in location area (using info_location entities)
:A particular item must be in a particular location, defined by an info_location area (see vanilla D3 documentation for info_location). Multiple objects in a single location are not counted up for this component, this is a single-shot objective. If you want the player to put more than one object in a location, you must currently create several of these components, specifying by name, and OR them together in the objective logic.
:This check is done periodically. Set spawnarg <tt>clock_interval</tt> to the time in seconds between periodic checks.
:'''SDK Name''': COMP_INFO_LOCATION
:'''Number of Specificatons''': 2 (object entity to check, location entity to check)
:'''Applicable Specifiers''': For the object to check, all specifiers apply, but multiple objects are not counted up. Typically the objects will be specified by name. For the location to check, it will either be specified by name or by group.
:'''Expected Arguments''': None (if both specifiers match, the objective is completed).

;*<tt>custom</tt>
:This custom objective component is only changed when an external script changes it. Otherwise it does nothing.
:'''SDK Name''': COMP_CUSTOM_ASYNC
:'''Number of Specificatons''': none
:'''Applicable Specifiers''': none
:'''Expected Arguments''': none

;*<tt>custom_clocked</tt>
:This component calls a custom script periodically to check some condition. When run, the script is expected to this component true or false based on the custom check. This objective component could also be used as a convenient method to periodically call a script that has nothing to do with objectives.
:Set spawnarg <tt>clock_interval</tt> to the time in seconds between periodic calls of the script.
:'''SDK Name''': COMP_CUSTOM_CLOCKED
:'''Number of Specificatons''': none
:'''Applicable Specifiers''': none
:'''Expected Arguments''': string (name of the script to call periodically)

;*<tt>distance</tt>
:Two entities must be sufficiently close to eachother to satisfy this component. The distance check is done between the origin of the first object and that of the second object. If this distance is below the input maximum distance, the component is set to true.
:This check is done periodically. Set spawnarg "clock_interval" to the time in seconds between periodic checks.
:'''SDK Name''': COMP_DISTANCE
:'''Number of Specificatons''': none (see arguments below)
:'''Applicable Specifiers''': none
:'''Expected Arguments''': string (name of first entity), string (name of second entity), int (maximum distance in doom units)

;*<tt>readable_opened</tt>
:''available since TDM 1.02''
:The player must open a named readable to satisfy this component. This doesn't refer to a specific page, just opening the readable is enough.
:'''SDK Name''': COMP_READABLE_OPENED
:'''Number of Specificatons''': 1 (The name of the readable)
:'''Applicable Specifiers''': name
:'''Expected Arguments''': none

;*<tt>readable_closed</tt>
:''available since TDM 1.02''
:The player must close a named readable to satisfy this component. This doesn't check whether the player has finished reading all pages, just closing the previously opened readable is enough.
:'''SDK Name''': COMP_READABLE_CLOSED
:'''Number of Specificatons''': 1 (The name of the readable)
:'''Applicable Specifiers''': name
:'''Expected Arguments''': none

;*<tt>readable_page_reached</tt>
:''available since TDM 1.02''
:The player must open/read a specific page of a named readable to fulfil this component. Scrolling to the page is enough to trigger this event.
:'''SDK Name''': COMP_READABLE_PAGE_REACHED
:'''Number of Specificatons''': 1 (The name of the readable)
:'''Applicable Specifiers''': name
:'''Expected Arguments''': int (the page number which should be reached, the number 1 refers to the first page)

== Specifiers ==
;*<tt>none</tt>
:No specifier. Component will be completed as soon as any event of that component type happens. (E.g., if you set a KO component type, with specifier none, it would be set to true as soon as soon as the player KO's anyone). This is the default specifier if none is entered. Not very useful, except for blanket "don't do this" objectives. Even then, it is better to use "overall" described below.
:'''SDK Name''': SPEC_NONE
:'''Specifier Argument Type Expected''': No spec argument needed since we don't have to match anything.

;*<tt>name</tt>
:Name of the entity
:'''SDK Name''': SPEC_NAME
:'''Specifier Argument Type Expected''': string

;*<tt>overall</tt>
:In the context of inventory item objectives, this refers to overall loot. In the context of AI objectives, this refers to all AI, regardless of team, type, etc.
:'''SDK Name''': SPEC_OVERALL
:'''Specifier Argument Type Expected''': No spec argument needed since we don't have to match anything.

;*<tt>Group</tt>
:For inventory items, the item's <tt>inv_name</tt> spawnarg value will be used here. For example, if you want the player to get 5 flashbombs, you would use this with group equal to the <tt>inv_name</tt> of flashbombs. As opposed to getting a specific flashbomb in the map, where you would use the <tt>name</tt> specifier instead. If an inventory item is loot, the loot group is used here instead (e.g., <tt>loot_gold</tt>).
:Group is also used for other component types as a convenient way to group things, such as info_objective_location or info_location entities checked by COMP_LOCATION and COMP_INFO_LOCATION, respectively.
:'''SDK Name''': SPEC_GROUP
:'''Specifier Argument Type Expected''': string
:'''Loot group names:''' <tt>loot_gold</tt>, <tt>loot_goods</tt>, <tt>loot_jewels</tt> and <tt>loot_total</tt>

;*<tt>Classname</tt>
:The entityDef classname of the entity. For example: atdm:ai_builder_guard
:'''SDK Name''': SPEC_CLASSNAME
:'''Specifier Argument Type Expected''': string

;*<tt>Spawnclass</tt>
: The SDK classname of the entity. For example: idAI
:'''SDK Name''': SPEC_SPAWNCLASS
:'''Specifier Argument Type Expected''': string

;*<tt>ai_type</tt>
:Type of AI: human, beast, undead, steambot, etc. (reads m_AIType in the SDK, which is set by the "type" spawnarg on idActors. Not sure if this is implemented yet).
:'''SDK Name''': SPEC_AI_TYPE
:'''Specifier Argument Type Expected''': int

;*<tt>ai_team</tt>
:The AI's team integer. This can be set up by the mapper to put AI on arbitrary teams. Mapper can also team up AI for objective purposes, and use this team specifier as a fast way of saying "KO any of these 5 AI." Alternatively, one could use the name specifier and put in multiple components for each of those 5 AI, then OR all the components in the objective success logic. Making a new team may save time over that method.
:'''SDK Name''': SPEC_AI_TEAM
:'''Specifier Argument Type Expected''': int

;*<tt>ai_innocence</tt>
:Differentiates between combatants and non-combatants. A value of 1 = non-combatant, a value of 0 => non-combatant, or otherwise not deemed "innocent" by the FM author.
:'''SDK Name''': SPEC_AI_INNOCENCE
:'''Specifier Argument Type Expected''': int (1 = innocent, 0 = not)

= Objective Conditions =
With the campaign code added to TDM 1.06 a new set of spawnargs can be used to let objectives depend on those in a previous mission. These spawnargs are starting with the <tt>obj_condition</tt> prefix.

Each condition defines the "source" mission and the source objective by number, plus the state of the source objective. It also needs to specify the "target" objective (which is always in the current mission) by number and which action to take. Right now, three different actions are supported:
* Change Objective State (complete, failed, etc.)
* Change the Objective's Visibility (hide or show)
* Change the Objective's Mandatory Flag

== Syntax ==

*;<tt>obj_condition_N_src_mission</tt> (integer)
:Defines the source mission the condition depends on. The integer is 0-based, i.e. the first mission has the number 0. The placeholder N is the number of the condition.

*;<tt>obj_condition_N_src_obj</tt> (integer)
:Defines the number of the source objective in the source mission. The integer is 0-based, i.e. the first objective has the number 0. The placeholder N is the number of the condition.

*;<tt>obj_condition_N_src_state</tt> (integer)
:Defines the state the source objective needs to be in for this condition to apply. The value can be in the same range as the objN_state spawnarg above:
:* 0 = STATE_INCOMPLETE
:* 1 = STATE_COMPLETE
:* 2 = STATE_INVALID
:* 3 = STATE_FAILED

*;<tt>obj_condition_N_target_obj</tt> (integer)
:Defines the number of the target objective in the current mission. The integer is 0-based, i.e. the first objective has the number 0. The placeholder N is the number of the condition.

*;<tt>obj_condition_N_type</tt> (string)
:Defines the action to take if the condition applies. There are three possible action types available:
:* "changestate" Change the state of the target objective.
:* "changevisibility" Change the visibility of the target objective.
:* "changemandatory" Change the mandatory flag of the target objective.
:The combination of this "type" spawnarg and the "value" spawnarg below defines exactly what action is performed on the target objective.

*;<tt>obj_condition_N_value</tt> (integer)
:The meaning and possible values of this spawnarg depend on the "type" spawnarg above. It is used as "parameter" or "argument" for the above action, e.g. the "changevisibility" action needs to know whether to show or hide the target objective. The possible values are listed below:
:* For type "changestate"
:** 0: set to incomplete
:** 1: set to complete
:** 2: set to invalid
:** 3: set to failed
:* For type "changevisibility"
:** 0: set to invisible
:** 1: set to visible
:* For type "changemandatory"
:** 0: clear mandatory flag
:** 1: set mandatory flag

= Conclusion =
Using components that combine component types with up to 2 entity arguments and 2 specifier types, plus objectives that are a boolean combination of those components should hopefully allow for a variety of different objectives.

= Using Objectives Creatively =

==A method for using objectives to change AI patrols when alert.==

This works beautifully. The AI are placed at the seats just like in the card player prefab. Each player have "sitting 1" so they sit down at map start. AI's have no targets.

Then I have one unseen objective per player:
Objective component is only "AI is alerted", with the single entity card playing AI name. I can set the minimum alert level required for the AI to react. I set that to 3, so if the AI search actively, he won't be playing cards anymore, but goes patrolling instead.
Basically the objective component says: "Alert entity cardgamer1 1 times to a minimum alert level of 3."

And when that gets satisfied, the objective has completion target gopatrol_start, which is an ordinary trigger_once. This in turn targets a func_static which gives all the cardgamers new targets to their patrol routes.

This is done as follows: Choose any kind of func_static. Open it in the Stim&Response editor. Add response trigger. Add an effect to this response. Choose "Add Target." Put in the entity box the name of the AI. Put in the target box the name of the path_node where the AI should go.

When I make one objective for each player, alerting any single one of them will make everyone of them to go for patrol. And once the trigger_once is gone, further alerting of the AI has no effect.

==A way to replace AI when others are knocked out or killed.==

Have spare AIs isolated in an inaccessible place either of your map, or room off in the void, targeting a path_waitfortrigger which then carries on their path. Have the AI subject to substitution on a unique team in your map (or identify another way), as well as the spare AIs. An objective is set up like the usual fail if you knock out or kill an AI, but not visible, set to the appropriate team. I found I needed multiple Objective Components, the first no knock/no kill set to an amount of one. Then two and three, etc. Take note of what objective number the objective is and plan on not altering that. Set the failure target to a trigger relay, which targets as many trigger_counts as you have replacement AI. That's it for setting up the objective part.

Add the aforementioned trigger relay, trigger_counts, and a target_setobjective_state. Setup the target_setobjective_state with "Obj_id0" #, where # is the objective number noted earlier, and set "obj_state" to "0". Add a matching number of atdm:teleport (in target/) as trigger_counts, each teleport targeting one of the stored AI. The first trigger_count is set to 1, and targets the first teleport and AI (to release it from the path_waitfortrigger). The second trigger_count is set to 2, and targets the next teleport and AI, etc. The trigger_relay targets all the trigger_counts and the target_setobjective_state.

So when the initial AI is knocked out or killed, the objective failure triggers the relay. It in turns increments the counts and resets the objective to work again. The first count activates the teleport and triggers the AI to move off it's path_waitfortrigger on to the next path node. Test and voilà!

==Having the player place multiple interchangeable items in varied places.==

In "{{TDM-FM|83|Inn Business}}", the player has to place a number of markers in any of several places. However it was key to not permit multiple markers being placed in the same place, and not all places are required, between half and two-thirds so there's flexibility for various players and their styles.

An "item is in location" with "group identifier" component was used, so each spot (info_tdm_objective_location) had the same spawnarg "objective_group", "drops". Also "interval" was set to "0.3", with no noticeable performance issue while being responsive enough for player feedback. These locations were separate enough, but limited in size, to meet the restrictions below.

So a number of objectives matching the number of inventory items were made, with several components.
* let the target entity ''marker1'' be at location 0 of ''drops''
* Do NOT let the entity ''marker1'' and ''marker2'' get within 150 units (check interval 0.3)
* Do NOT let the entity ''marker1'' and ''marker3'' get within 150 units (check interval 0.3)
* Do NOT let the entity ''marker1'' and ''marker4'' get within 150 units (check interval 0.3)
* etc., depending how many marker entities there are

The other objectives were set up the same way but for their own ''marker#''. (IE, don't let 2 and 1 get within..., don't let 2 and 3, etc.) In this manner, the objective checks if the marker is within the area, but unchecks if the maker rolls out or is removed by the player, and rechecks when they put it back in.

Finally, another objective was created to complete when all had been placed which is not visible but irreversible. It has Enabling Objectives of the former objectives AND together. IE, "9 AND 10 AND 11 AND 12" if there are four. It has a completion target of a [[Triggers#trigger_relay|trigger relay]] entity which targeted several "atdm:target_setobjective_visibility" to turn off all the marker objectives and enable other mission specific things.

The components match the markers, again using the group identifier:
* let the target entity ''marker1'' be at location 0 of ''drops''
* let the target entity ''marker2'' be at location 0 of ''drops''
* let the target entity ''marker#etc...'' be at location 0 of ''drops''

So if all the marker objectives are complete (all items dropped in separate spots), then this completes and fires the trigger, which removes all the marker objectives from display (which the player had for feedback of progress) and moves on with objectives, perhaps displaying a dummy completed objective "All markers placed."

Note: It's important for the marker objective numbers in the objective editor not to change, or update the non visible completion objective AND logic accordingly.

== Don't hurt AI script ==

To have a mission fail if an AI is simply hurt (not just knocked out/killed), this script may be used:

void checkHarm()
{
float JackHealth = $Jack.getHealth();
float JillHealth = $Jill.getHealth(); 
while(1)
{ 
if(JackHealth - $Jack.getHealth() > 1)
{
$FailHarmObjective.activate($player1);
} 
if(JillHealth - $Jill.getHealth() > 1)
{
$FailHarmObjective.activate($player1);
} 
sys.wait(1);
}
}

You would just need to add one variable/if statement for each AI to be affected and run it from the start of the level (i.e. in the void main just have a line that says "thread checkHarm()"). The "FailHarmObjective" is an actual entity in the map which would then fail the relevant objective.

==Notes on using INVALID status==

The INVALID state on an objective:

* prevents any ''timed'' components from being checked (e.g. check every 0.3 seconds whether item A is in place B )
* prevents the objective itself from being checked for completion
* allows objectives that are dependent on the invalid objective to complete
* allows the mission to complete
* is used as the status for missing or malformed objectives
* is used for non-applicable objectives, e.g. the loot goal for a different difficulty setting

You can use INVALID for objectives that don't apply at map start, but then activate them later by setting them to status INCOMPLETE.
Note that:
* The mission and any dependent objectives can still be completed, whether or not the invalid objective has been completed.
* Players can still complete individual components of your invalid objective. This can cause unexpected behaviour. If the player completes all of the components of an invalid objective and then you set the objective to "incomplete" status, the objective will be marked completed, but not eright asway: it'll be marked complete the next time any ''other'' objective gets an update. That's because any objective getting an update causes all objectives to be re-tested for completeness.

If you need to avoid the second scenario, you can use a target_setobjective_component_state to uncheck the components when you re-enable the objective.

[[Category:Editing]]
[[Category:Tutorial]]

Objectives Editor

2015-10-08T17:36:57Z

SteveL: /* How to directly trigger an objective or component to complete */

''Written by HappyCheeze and Fidcal. Small additions by Sotha and Springheel.''

==Introduction==

{{clear}}
The objectives editor is a very useful tool located inside Darkradiant (Version 0.9.7 or later) that allows the map author to set objectives or goals that the player must do in order to win the level. The opposite is also true, the author can set restrictions that the player must adhere to, or will fail the mission.

==Adding Objectives Entities==

IMPORTANT: The add objectives entity has been renamed to atdm:target_addobjectives so ignore any reference to the old name target_tdm_addobjectives in the images.

To access the objectives editor once inside Darkradiant, click the pull-down menu Map>Objectives...
[[Image:Objmenu.png]]

Upon clicking you will see a separate window that looks like this.
[[Image:Objedblank.png|left]]

{{clear}}
To start things off, click the
[[Image:%2Badd.png]]Button

[[Image:Msnobjadd.png]]

This will create an Entity that stores all of the objectives information that will you be editing.

Now we've spawned our objectives entity,
{{clear}}
[[Image:Objentity.png]]
{{clear}}
Notice the numbers in the “[]”'s. Those are the entities' coordinates on the map. These numbers will most likely be different from yours. When the objectives entity spawns it is placed randomly around the origin (As of 0.9.7 this is how it is, it might change in future versions, but for now this is how it is).

*Note:Be mindful that sometimes this entity will spawn outside your map and into the void. This will cause a leak, so look around the origin.

**Alternatively you can right-click in an orthogonal view, create entity, Targets/atdm:target_addobjectives. This will create a small yellow box like placing any entity or object. Then when you open the objectives editor it will be in the list. Good to do this where the players starts, it will always be easy to find.

==Adding Objectives==

Now we're ready to start adding some objectives.

Click the second [[Image:%2Badd.png]] Button

[[Image:Newobj1.png|left]]
{{clear}}

Under Objectives you'll notice there's a new Objective. You can add more as needed.

==Editing Objectives==

Click an objective in the list than click [[Image:Edit.png]]

This will bring up this window.
{{clear}}
[[Image:Editobj.png]]

Now we're editing our first objective. It may seem a little confusing at a first glance but a lot of it is self explanitory and a little practice will take you a long way.

So what do all these various lines and checkboxes do?
They effect the objective components at the bottom.

What do they all mean?

'''Description''': This what the player will read in the objectives menu. For example: “Steal the scepter”, “Don't kill any guards”, “Get back to where you entered the warehouse”. Its explaining what you want to player read so he/she knows what to do. A good rule to follow is to make them short and to the point.

'''Difficulty''':These refer to Easy/Medium/Hard difficulty levels. If the author wishes, they can be different for each difficulty. For example: on Hard difficulty the player will have to avoid being seen. On Easy the player will only have to steal 200 gold at the minimum. All Levels means that the objectives that are checked under this will be there regardless of difficulty.

'''Initial State''':This is the condition of the objective at mission start. There are four options. Complete, Incomplete, Invalid, Failed. Typically the objective will be incomplete and the player has to complete it in-game to fulfil the objective.

'''Flags''':

''Mandatory'' means the objective in question is necessary to complete the game. If it is unchecked than the objective will be optional.

''Ongoing'' means that the objective won't show completion until the end of the mission. Use this with do NOT type objectives, eg, do NOT kill.

''Irreversible'' means that once the objective is done it will not UNcheck even if logically in the game it becomes no longer true. Example: get a special object. If the player later drops it normally the objective will then UNcheck because the player no longer has got it. But sometimes you don't want it to reverse. Example: get magic skull. New objective: throw it in magic pool. Player no longer has 'got' the skull so normally it would then UNcheck the objective. Make it irreversible and it won't. Another example is to go to a location. If the player then leaves it would UNcheck so make it irreversible.

''Visible'' means that objective will be visible in the objectives menu ingame. If unchecked than there will be no objective shown. (The objective will still work, it just won't show up in the menu).

'''Enabling Objectives:'''
These are other objectives that must be completed before this objective can be done. Example: ''"When you have completed your main objectives, escape from the castle."'' So, those main objectives would be the enabling objectives and if the player escapes the castle without doing them first then the escape objective does not check off either.

You can list them as "1 AND 2" if objectives 1&2 need to be completed first.

Or, if there are 3 different objectives for each difficulty (as in most loot objectives) the following will work: 1 AND (2 OR 3 OR 4). (where 2,3&4 are the loot objectives)

'''Logic Success:'''
These are only needed if you have more than one type component. For example, if you can escape the castle by either of two routes this would be an objective with two go to ''location'' components. These components would be numbered 1 and 2 so the logic success would be "1 or 2" since either would work. If however you wanted say the player to escape the castle via a special corridor then the player has to go to both corridor location and exit castle location so that would be logic success 1 AND 2. Those components need not necessarily be the same type - the player might be required to pull a lever AND escape for example (even though he could escape without pulling the lever but you don't want him to.)

Note: I needed to make the "or" lower-case for it to work for me in 2.01. -RJFerret

'''Scripts''': Under Construction

==Components==

'''Components''': These are the type of objective you want, eg, steal, kill - or rather 'types' because each objective can have more than one (eg, go to exit A or go to exit B or it could be go to exit A AND go to exit B! - see logic success) These type components are used by the editor to specify what objectives need to be done. The map author can choose from a variety of options under '''Type''' with varying degrees of specification. For example: Knocking out an AI named "Roy". Not being seen by the ANY enemy. (less examples, should cover this in the coming up tutorial.)

'''Components Flags''': Components have their own special flags as well.

''Satisfied at Start'': For some objectives it makes sense to have them done at start. For example: Not killing anyone.

''Irreversible'': Once the objective has reached a certain state, it will stay that way and not change.

''Boolean NOT'': Adds "NOT" to your component so the player has to do the opposite of said objective. For example: Do NOT kill any AI on team 2.

''Player Responsible'': The player MUST follow through with the objective himself. For example:The player must kill the zombie to complete the objective, instead of letting something else take care of it.

Now it might seem a bit crazy trying to take all of this in at once, so lets start with something easy.

== Tutorial ==

*Note:This tutorial is assuming you've learned the basics for using Darkradiant.

You should already be in Darkradiant. Start a new map if you're in an existing one.

We'll start with the basic cube room. Nothing fancy, just make a room, stick in a player start, a light and plaster on some textures.
[[Image:cube.png|left]]
{{clear}}
For this tutorial, our player is going to have to knock out a guard and steal a trophy.

So lets start with adding the AI, I chose atdm:ai_citywatch. Select him, go into the entity editor ("N") and change his NAME to "Roy" (without quotes).

Now its time to open up our objectives editor.

[[Image:Objmenu.png|left]]
{{clear}}
Now as you just learned, click add, click the atdm:target_addobjectives_1 and click add again.

The ''Edit Objective'' window should be open now. Clear the text under '''Description''' and type in "Knock out the guard". Set the initial state to 'Complete'. Check the '''Mandatory''' and '''Visible''' flags.

Time for a new step, click the [[Image:%2Badd.png]] button under '''Components''' and the word "Kill" should appear. Select it and you will see some more options. Under '''Type''' select "AI is knocked out".

under '''Knockout target:''' select "Name of single entity" and type in the box to the right of it, "roy" (without quotes). Set amount to 1.

Now compare your screen to this, it should be the same.
[[Image:Editprogress.png|left|]]
{{clear}}
If all looks good than click OK.

Its always a good idea to test things to make sure everything is running right. So save your map, get into TDM and load your map.

First, hit ESC and click ''Objectives''. You should see your objective onscreen.
[[Image:Onjyes.png]]
*NOTE:If you don't see it on screen, you probably forgot to check the '''Visible''' box.

Now its time to test your objective. Exit out of the objectives menu and launch a gas arrow or use the blackjack on poor Roy. When he goes down you should see the words "Objective Complete" appear onscreen and since thats the only objective we've added so far you'll win the mission.
*NOTE:If you don't win nor see the on screen message, go back and try to figure what you did wrong.

If all is well than its time to move on. Exit TDM and go back into Darkradiant.

Now it is time to add the trophy. In your map add a trophy somewhere, I used the entity loot>atdm:loot_trophy_old
change its name to "trophy" and go back into objectives editor.

Add another objective and edit it.
'''Description''' should be ''Steal the Trophy''. State is ''Complete'', '''Flags''' should be ''Mandatory'' and ''Visible''. Click ADD and select '''Player possesses item''. Change '''Item:''' to ''Name of single entity'' and type in the box to right, "trophy". Change the amount to "1".

Your objective should look like this.
[[Image:Trophyedit.PNG|left]]
{{clear}}
Since this is a tutorial this map is very small and very basic so we are tossing all pre-thought and planning for the objectives out the window. As maps get bigger, more elaborate, complex, so too will the objectives be to suit the level. You might want to the trophy in a vault. Maybe the guards will be patrolling.

Save your map and load it up in TDM. Look at the objectives menu to see if the fresh addition is there. And than take it and see if it completes the objective.

Congratulations!

You now have a basic understanding of how the objectives editor works. For more advanced work, look for more tutorials in the future or go on the forums.

== FAQs & Examples ==

===KO objective but AI already dead!===

;*If I kill the guard I don't fail the mission, but I can't complete it either.
:Answer: I'll quote Ishtvan for this one.
:''"The system is not smart enough to know automatically that someone who's killed can't be KO'd later, so if you want it to fail when they're killed, you have to put that in specifically. Note that this doesn't have to be a whole 'nother objective, it can be a component of the KO objective, so you have two components, KO them, and don't kill them. We could potentially make this automatic later on, but that's the way it is right now."''
:Until this is fixed, I'd recommend making a knockout objective optional, unless you want to put in the kill component.

===Kill objective thwarted by another AI===

;*I put a monster in my map and he killed the guard, yet I still passed/failed the objective.
: Answer: Check the '''Player Responsible''' Flag, this means that the player MUST do it himself in order to get credit.

===Leak caused by Objectives Entity===

;*Help! My objectives entity is outside the map and I have a leak! I can't find it! I even used the pointfile!! help!!!!
: Answer: The objectives entity is a very small, yellow cube that is spawned around the origin. Its about the size of a light entity.

===How to directly trigger an objective or component to complete===
If the actions that the player has to do in a mission are not directly covered by the normal objectives properties, for example, the player must open a door, then objectives can be triggered to complete by any target entity.

In the objectives editor, to your objective add a component type : custom script. (this might just say 'custom' or similar.) The objective now just awaits some external trigger or script in the game to set it complete. To do this with a trigger...

* Create a new entity : ''target_tdm_setobjectivestate''
* Give it the properties/values... obj_idN O ... where O is the objective number and N is simply the obj_id number if you want several on the same entity. Just use obj_id1 if you only want one. obj_state 1

You must then target that from some [[Triggers|triggering entity]] like a button, lever, door (see [[Doors]]) or you can trigger it from stims & responses or from a custom script.

In a similar way, you can trigger individual components using entity target_tdm_setobjective_component_state. In this give it the properties/values...

* Create a new entity : target_tdm_setobjective_component_state
* Give it the properties/values... comp_idN C ... where N is just this ID number and C is the component number. obj_state 1

Again, trigger that as above.

"obj_state" sets whether the target will mark the objectives or components complete ("1") or uncheck them, that is make them incomplete ("0"). A target can handle multiple objectives, but it can have only one "obj_state" spawnarg, so it will either check or uncheck all its objectives.

===How to make my invisible objective become visible to the player later===

There are two methods. One way ''adds'' a new objective at the end of the current list of objectives. The other way makes an existing objective visible. This is the one for general use because it appears in the position in the list where you first put it rather than on the end. It makes sense to have your objectives in some kind of order so for example, you might have right at the end of the list 'when all else is done, escape from Castle...'

====To make an invisible objective visible later====

* Create a new entity : ''atdm:target_setobjective_visibility''
* Give it the properties/values... obj_idN O ... where O is the objective number and N is simply the obj_id number if you want several on the same entity. Just use obj_id1 if you only want one.

You must then target that from some triggering entity like a button, lever, door (see [[Doors]]) or you can trigger it from stims & responses or from a custom script. Note that sometimes it helps to put in a delay (see below.) It will by default then become visible. You can do it the other way round and make an objective become invisible (remember it is still active by default) by changing the spawnarg value 1 to...

obj_visibility 0

====To add a new objective on the end of the list====

* In the objectives editor use the top Add button to create a new ''atdm:target_addobjectives'' entity.
* Add the new objective(s) just as described above
* Find the atdm:target_addobjectives entity in the map (you normally need to check it is not in the void anyway plus you might like to place it near where it makes sense the new objective shows.
* Add to the atdm:target_addobjectives entity the property ''wait_for_trigger'' and the value 1. Otherwise it will show right at the start of the game.
* You then need to target that atdm:target_addobjectives from some triggering entity like a button, lever, door (see [[Doors]]) or you can trigger it from stims & responses or from a custom script. Note that it may help to include a delay (see below.)
* The new objective(s) will show as added at the end of the list of objectives when triggered.

====Inserting a delay before new objective shows====

It often helps to include a delay from triggering before the ''New Objective'' message shows. To do this:

* Create a ''trigger_relay'' entity.
* Give it the properties:
** ''wait -1''
** ''delay N'' (replace N with delay time in seconds)
** ''target'' <the name of the atdm:target_addobjectives>
** Make your original trigger target this relay instead of the atdm:target_addobjectives directly.

===Completing Objective Components in a Certain Order===

Suppose you want the player to complete two or more parts of an objective but in a certain order. Example : "Close the office door then open the safe." In that example you want the player to close the door first not just do both in any order. If you just make the two components they default to a Success Logic of 1 AND 2 which means the player must do both to complete the objective but it does not matter which order. So if the player opens the safe and then closes the office door then the objective will check off - perhaps not what you want. This is how to do it if you want to force the order in which the player does the components...

There are two possible outcomes :

If you want the mission to '''fail''' set the failure logic for that objective to

''NOT(1) AND 2'', i.e., door is open AND safe is open.

But if you just want the objective to not complete (so the player can try again)...

Make '''two''' objectives, both using the door and safe components - the first is invisible but still active:

# Objective 1: success logic: Door closed, safe not open = 1 AND NOT(2)
# Objective 2: success logic: Door closed, safe open = 1 AND 2 (Objective 2 enabling objectives = 1)

===An Objective to place an object in a Certain Location===

To make an objective where an object (body, junk object, readable, or even the player) has to be placed somewhere:

* Create a brush where you want the object to be put. This might be the size of a room, a street, or a chest or wherever you want the object. Better to make it too large than too small--the origin point of the object needs to be inside the brush to activate it.
* Texture it with common > clip
* With the brush selected, Create entity > info > info_tdm_objective_location
* Give this entity a name you can remember like BodyDrop. Write it down or in a text editor
* Give your object, eg, a ragdoll, a name, eg, JakesCorpse and note it down.
* If it is not the player, then give it the property "objective_ent" and set it to "1"
* Menu > Map > Objectives
* If you haven't yet got any objectives then click the + Add button at top right. This creates a atdm:target_addobjectives entity so later make sure it is not in the void or you get a leak. Put it somewhere convenient. It is not visible in game.
* Select the atdm:target_addobjectives in the Objectives entities list top left
* In the objectives list below click the +Add button on the right.
* This creates a new objective in the objectives list. Select it.
* Click the edit button on the right.
* Type a description near the top, eg, Carry Jake's body back to X and drop it in the soandso
* In the components list further down click the +Add button on the right.
* This creates a default Kill objective. Select it. Click the Edit button.
* Just below it click the Type bar and from the list that show select 'Item is in location' ('''NOT''' Item is in '''info'''_location!!)
* Further down click the bar below 'Entity' and select 'Name of single entity'
* On the right of that type or paste in the name of the object (eg ragdoll) entity eg, JakesCorpse
* Below, click the bar below Location and select 'Name of single entity'
* On the right of that type or paste in the location entity name you gave above, eg, BodyDrop
* Click the OK button and OK again and save your map.

=== Classic "Get X Loot" Objectives ===

Use the "overall (component specific)" option of "Player posess item" for loot.

How do you find out how much loot is in your map? The easiest way is to set up an easy objective to lead to mission success. On the Mission Statistics screen, it will list your loot total.

=== Optional 'No alerts', KO's, and Kills ===

It is recommended that 'No alerts', KO's, and Kills be optional or at least provide a separate difficulty level that approximates another where these are enforced. Many players find these restrictions limiting and often very annoying. Some will abandon an FM in frustration if they find they can barely move without triggering an alert - mission failed.

To create a "NOT" objective (do NOT kill X, do NOT find more than 3 potions, etc), you need to select the "Boolean" checkbox. This will turn the objective into its opposite ("Kill 3 AI" turns into "Do NOT kill 3 AI").

'''Important''': No kill objectives need be set as "Satisfied at Game Start" and "ongoing" or they will not work!

=== Using Objectives to trigger things ===

You can use objectives like a trigger. Don't put the target spawnarg on the objective entity, however; you have to use the Objective Editor. The "Completion Target" and "Failure Target" fields can take any kind of entity that can normally be triggered, like a speaker or an atdm:teleport.

You can trigger more than one thing, but then you must create a trigger_relay entity. Put the name of that entity in the "Completion Target" field, and then target your other triggers from the relay.

=== The standard "exit here when you're done objective" ===
* Place a (large!) brush in the location you want to work as the exit.
* Give it texture textures/common/clip
* Make the thing into an entity info_tdm_objective_location
* Give it name player_exit
* Go to objectives editor and make an objective "After you're done, go to the exit" or something like that. Set it to be INCOMPLETE and mandatory.
* Set enabling objectives. Here you need to set which objectives need to be complete for the exit to work. If you have objective numbers 1 and 2 must be completed in order the player to exit, you need to put text "1 AND 2" in the enabling objectives box. If you need to have objectives 1,2 and 5 completed you need to put "1 AND 2 AND 5" If you have some objectives that only appear under certain difficulty levels (like loot objectives), you can do this: Enabling objectives: 1 AND (2 OR 3 OR 4)
You can check the objective numbers in the objective editor window under "#" mark.
* set the component to be:
* Type: item in location '''(NOT item in info_location!!)'''
* Entity: any entity with SDK-level spawnclass idPlayer (Note the capital "P"--won't work without!!)
* Location: name of single entity player_exit

'''NOTE''': You must make the brush for the info_tdm_objective_location '''large'''! I have had this objective completely fail when using a vaguely player-sized brush. Expanding the brush to fill the entire room made the objective work.

== Troubleshooting ==

My objective doesn't work, what's wrong? Can't count the number of times I had to ask that. Here are a list of helpful suggestions:

* Case sensitivity. I had an objective that didn't work because I had "idplayer" instead of "idPlayer".
* The most common error with the exit objective is using the 'in info_location' component rather than the 'in location' component.
* The info_tdm_objective_location entity uses the spawnarg interval with 1 second as default. This might not be long enough for a small volume if the player (or other entity) can pass through in less. It should be as high as possible for performance but not so high the player might pass through in less.
* No kill objectives need be set as "Satisfied at Game Start" or they will not work!

===Technical info===

;*I have some other questions about objectives
: Answer:This article talks about more specific, more technical and advanced work. [[Objectives]]

{{tutorial-editing}} {{darkradiant}}

Lightning

2015-09-07T19:48:27Z

SteveL: +Flashing decals

''written by Flanders''

==Prefab and settings==

Here we use func_fx’s to simulate random interval lightning. Start by loading up the tdm_sky_storm_thunder prefab in prefabs/nature/skyboxes. The func_fx underneath the [[skybox]] is used to create a light and a sound inside your map. Move it to a position high in your map where you want the flash to appear. The func_fx in the [[skybox]] makes a flash in the sky.

To trigger the lightning a trigger_timer is used. The time between triggering is a random time between “wait” ± “random” in seconds. The trigger_timer targets the func_fx’s. The fx effects are defined in thunder.fx in the fx folder. The fx that is used can be set with the “fx” property.

* fx/thunder.fx for standard lightning
* fx/thunder_distant.fx for distant lightning (dim light, long time between flash and sound)
* fx/thunder_close.fx for close lightning (bright light, immediate sound)

These are for the fx inside the [[skybox]]:

* fx/thunder_skylight.fx
* fx/thunder_skylight_distant.fx
* fx/thunder_skylight_close.fx

==Skybox==

Here there is a short explanation on how to change the appearance of the used [[skybox]].

To change the colour of the sky select the big light and edit its properties. To change the colour of the small lights in the sky edit the two smaller lights. To make the clouds move at a different speed select the func_static with the cloud texture and add “shaderparm3” to it and give it a value (0.5 ~ 3). You can change the size of the clouds with the surface inspector, as long as you make sure it fits a rounded number of times so that there are no seams when the texture scrolls. As you can see, the whole [[skybox]] can be edited by editing the objects in the prefab [[skybox]]. The sky that is used in your map is just a projection of the stuff surrounding the info_portalsky.

==Flashing decals, webs==

Decals like spider webs that get lit by nearby lights might flash in the lightning even when they are deep in an underground cave. To fix this, you need to place a visportal that's been forced shut, in between the decal and the thunder_fx entity. There are 2 ways to force a portal shut: put a closed door in it, or a closed func_portal. If you don't want to use an auto-closing door to fix your scene, use a func_portal that's set to close when the player is a short distance away.

The problem happens because webs and other translucent-but-lit decals don't ever get shadowed. So the surrounding walls don't shadow them from the lightning flash. A portal that's been shut by a door or func_portal effectively seals off the visleafs behind from all lights the other side.

{{editing}}

Light Properties

2015-06-26T19:32:28Z

SteveL: + Other light settings / ai_see spawnarg, plus regularise formatting

== Introduction ==

For Doom 3 (and subsequently, The Dark Mod), there are 4 different types of lights at our disposal. Each has their own advantages and drawbacks, and hopefully this article will help to familiarize The Dark Mod hopefuls with their use. For information on creating lights and a lot of other useful information, see [[A - Z Beginner Full Guide Start Here!]]

__TOC__

==Light Volume Properties==

=== Point Light ===

A point light is the default light (also the default for fog). No option must be checked to make a light a point light. A point light casts light, and subsequently shadows in all directions evenly, falling off after a distance defined by the light texture. This works best for most small indoor and outdoor lighting, like lamps, candles, fireplaces etc. For this reason, it is going to be the most used type.

* Note, a misconception about Point Light is that they project spherically. The box shaped bounding volume in Dark Radiant is no mere simplification, it is the literal area affected by the light for calculation purposes. Point Light volumes should be perceived as cylindrical prisms that on one axis are shaped by the silhouette of the [[Light_Properties#Lighting_Textures | projection texture]] (think of a stack of cheese cut with a cookie cutter) and the other axis (z-axis) traditionally determines the distance from origin brightness (usually vertical... or how tall you make your cheese stack) with the LightFalloffImage.

=== Projected Light ===

Projected light is just as the name suggests. It is probably more intuitive and easier to use than a parallel light and is better for things like projecting a window-shaped light on the floor of a room or a spotlight on a wall. To make one, select projected instead of the default omni option at the top of the light inspector.

This creates a triangular prism as the bounding box for the light (instead of a rectangular prism like a regular light), with the point ending right at the entity itself. This can be rotated using any of the XYZ rotation buttons or manually using DarkRadiant’s rotation tool (shortcut R).

You can also manipulate the projected light via the vertices (shortcut V to enable vertices dragging). By dragging the vertices in the center of the projected square, you can lengthen and change the angle of the projection while keeping the projected square the same size. To resize the projection, use the two side vertices in the correct XYZ grid view. Making the bounding box flat against a surface (like a floor) is usually unnecessary (for example, making a moonlight window light on a floor or wall), because with shadows enabled and making the projection long enough to intersect the plane on which the shadow is to be cast, the full shadow will be cast (its simple geometry and just requires minor toying).

As with all the lights, projected lights have a full range of color and texture options to let the mapper find just the effect they need, allowing you to create a great atmosphere for your map.

=== Parallel Light ===

A light is said to be parallel when the parallel checkbox is checked in the light inspector. It is subject to all the same options as a point light, but it has a few distinct differences. A parallel light tends to not care exactly where the entity itself is placed. The most important thing is where the light_center vertex is placed and where the light entities bounding box intersects with elements in your map.

The light_center vertex starts right in the middle of the entity. The main difference between the parallel and point lights is that a parallel light does not radiate from the origin around the entity itself. What controls the direction that shadows are cast is the placement of the light_center vertex. Shadows will run parallel (hence the name) to a line between this vertices and the light entity itself. As such, this makes it an excellent choice for sunlight or moonlight. As such, it has some of the elements of a point light and a projected light, it can seem to radiate in a circle (if you use the appropriate texture) whilst casting a shadow in any direction preferred.

Switch to Vertex mode in [[DarkRadiant]] to drag the light_center vertex of your selected light entity.

Posted by Greebo: Also, note that a parallel light will only light surfaces "matching" the direction of the "light vector" (origin minus light_center). All other surfaces will stay completely unlit, therefore it should be combined with an ambient light to achieve good lighting effects. [http://modetwo.net/darkmod/index.php?s=&showtopic=8091&view=findpost&p=159842]

What this means is, you can draw a line from the center vertex to the light entity's origin and on from there, and only objects in the direction of that line will be lit. The light won't light 4 walls of a room and the floor, it would only light one of the walls or the floor (or ceiling)

==== Troubleshooting Parallel Lights ====

''I added a parallel light but I can’t see any light at all!''

Parallel lights can have some quirks. The light seems to fail and do nothing when intersecting multiple walls that are parallel to the face the light is actually casting on. It seems the light will work as long as it doesn’t intersect a face parallel to the one it is casting light on.

''I have a parallel light but it casts a jagged light on my floor!''

Similar to above, a parallel light can sometimes have anomalies when intersecting multiple walls and a floor. Since having the light intersect multiple walls when it can only cast on one of them, having a massive bounding box is pointless anyways so pay attention to what the light is touching and you should be fine.

==Light Interaction Properties==

=== Normal Light ===

This is the default light type. It performs all the surface interaction stages and shadow calculations. It has the heaviest performance impact.

=== Ambient Light ===

Ambient light is really just a lighting texture, but it is also a specific item that is needed in practically every map, so for those purposes it will be treated as if it were its own subset of lights.

Properties: No shadows, No specular, Bumpmapping or Directionality (Note: The "Enhance Ambient" does add Bumpmapping )

Use the ambientLight keyword.

An ambient light can be any form: it can be a point, parallel or even projected (though projected would probably be useless).

The only requirement of an ambient light is to use one of the available ambient light textures, accessible by opening the light inspector (with the shortcut L in DarkRadiant, and get used to using it), and selecting ambientlightnfo from the list.

* Ambient Light is covered in more detail in [[A_-_Z_Beginner_Full_Guide_Page_2#Ambient_Light:_Gloom_not_Doom| Ambient Light: Gloom not Doom]]

* To understand The Dark Mod's unique ambient light detection system see: [[Virtual Darkness]]

* Ambient Light can be set to automatically adjust color and brightness per "location" see: [[Location Settings]] and [[Dynamic ambient light]]

=== Fog Light ===

This applies Doom 3's style distance fog to a light volume. The texture applied will become more opaque with distance away from the viewer. There is a variant called No Portal Fog which will not apply opaque fog to Portal areas in view. ( [[A_-_Z_Beginner_Full_Guide_Page_3#Fog|Beginner Tutorial: Fog]] )

In rare cases, you may wish for some surface inside a fog-volume to be fog-free. You can use the "noFog" keyword in the material definition for the texture applied to this surface to keep it from being "fogged".

Very thin fog (or BlendLight ) can also be used to soften the apparent light interactions near surfaces in a similar manner to the Post Process shader effect but with more mapper control. You can fake certain radiosity effects simply by amplifying small ambient light with small thin fog volumes.

Use the fogLight keyword.

==== noFogBoundary ====

Fog lights don't actually paint mist in the air, which would slow down performance quite a bit. They achieve their effect by fogging out the colour of the surfaces that they hit, proportionate to the depth of fog that lies between the player and the surface. In addition, if there is no surface between the player and the edge of the fog volume, they paint fog on the invisible walls of their own bounding volume. That's needed for a large open scene, for example, where there might be no surface between the player and the edge of the fog volume. If you're in a misty forest, and there happened to be no tree visible in a certain direction, you'd expect to see grey fog rather than clear space between the fogged trees.

Sometimes you don't want that to happen, for example if you're using a very large but very light fog to simulate atmospheric perspective in a town. You want the colour and detail of buildings to fade with distance, but you don't want heavy fog blocking the view of the sky in the gaps between buildings where you see to the very edge of the big fog light. You can use spawnarg "noFogBoundary" for that. It lets fog paint on solid surfaces, while leaving empty space and caulk sky free of fog effects.

=== Blend Light ===

Blend lights can be considered to be like volumetric decals. They do not perform most of the interaction shader operations and merely apply a texture to a volume using an [http://web.archive.org/web/20110111010457/http://www.modwiki.net/wiki/Blend_%28Material_stage_keyword%29 OpenGL Blend Mode]. Blend lights have the least performance impact. Blend lights can also be used to create [http://www.doom3world.org/phpbb2/viewtopic.php?f=1&t=12256&start=0&st=0&sk=t&sd=a "negative light"].

Example negative light shader:

<pre>
lights/bdog_testBlendLight2
{
blendLight
lightFalloffImage makeintensity( textures/blackdog/blendlight_falloff_inverse.tga )
{
blend gl_zero, gl_one_minus_src_color
map textures/blackdog/blackdog_icon_inverse.tga
zeroclamp
//alphazeroclamp
colored
}
}
</pre>

Use the blendLight keyword.

=== Spectrum ===

You may use the "spectrum" keyword to isolate specific lights to specific materials which have the same spectrum value in their material definition.
[http://web.archive.org/web/20080704080454/http://www.modwiki.net/wiki/Spectrum_%28Material_global_keyword%29 Spectrum Keyword at Modwiki]

== Light Settings ==

There are several settings with which to customize your lights. These settings allow the mapper to customize the look of a light (or a combination of lights) into a near infinity of looks. All are accessed through the light inspector (shortcut of L in DarkRadiant)

=== Color ===

The color palette allows the mapper to pick the color of the light emitted, arguably one of the most useful controls the mapper has over a light. To access it, click the button under the “Colour” heading. From there, adjust the settings until you find a correct color (can take some trial and error). In a game like The Dark Mod or Doom 3, where darkness is often more prevalent than light, the color picked often needs to be darker than expected. Without a direct brightness option, the color takes on this task. For a low level ambient light, the color picked would be almost pitch black. A pitch black light would not cast any light, but anything less than pitch black will cast a faint light. As such, it can take some trial and error to find the correct light for a situation, as intiailly, one is likely to pick a seemingly correct color only to find it is far too bright.

Remember: changing light settings or adding lights (and models) does not require re-compiling the map!

=== Radius ===

The 'radius' of your light can be changed by dragging its corners around in the 2d windows. Doom 3 lights do not have an actual radius, they are actually square lights and will light up everything they touch inside their bounding box in the editor. They will evenly light everything to their edges. While square lights might seem fairly odd there are options to make them more believable and have a nice fade, namely the 'texture' applied.

Tip: you can rotate a light so only one corner will touch a wall and make a triangular shaped light.

Or rotate it so 2 corners touch a wall and make a line of light.

'''Changing Radius of Light Entity:'''

If you put a premade light entity into your map, the radius of the light won't be visible.

To change it, use the following syntax (and whichever value you wish):

<pre>

"set _color on flame" "0.9 0.8 0.7"
"set light_radius on flame" "250 250 250"

</pre>

With lanterns and such use 'light' and with torches and candles etc use 'flame'.

<pre>

"set _color on light" "0.9 0.8 0.7"
"set light_radius on light" "250 250 250"

</pre>

(Copied from Baddcog's old "Lighting A to Z" article)

=== Parallel ===

Selecting this option turns the light into a parallel light (as opposed to a point or projected light). See [[Light Properties#Parallel Light|Parallel Light]]

=== Do not cast shadows (fast) ===

As the name suggests, this setting causes the light to not cast shadows on any object. This can cause the light itself to not be confined by walls, which can sometimes be beneficial and sometimes not. The main purpose of enabling this option is performance. Shadows are processor intensive and are not needed in some cases, so removing them wherever not beneficial to gameplay can vastly improve performance. Note that ambient lights never cast any shadows. Another way to improve performance similarly is to set the entity property on a model or func_static (this doesn’t work on worldspawn) <tt>noshadows</tt> to 1.

* '''Further details''': [[Turning Shadows Off]] , [[Noselfshadows]]

=== Skip Specular Lighting ===

Specular Lighting refers to a texture's specular map, wherein a flat surface (such as a wall) is painted with a texture that has a specular component. This causes a surface to have shinier and duller parts on a flat surface based on the darkness of the corresponding location on the specular map. Not all textures have specular maps. Checking this option could improve performance or remove the effect if it is not wanted. [http://www.modwiki.net/wiki/Texturing#Specular_maps]

=== Skip Diffuse Lighting ===

Like Specular lighting, diffuse lighting also references an attribute of a texture, the Diffuse Map. Diffuse Maps determine the intensity and color of the light reflected off of the different elements of a texture (an example being the difference between bricks and the mortar in between, as well as different bricks having different properties as well giving a less bland appearance).
[http://www.modwiki.net/wiki/Texturing#Diffuse_maps]

== Other light settings ==

=== AI sight ===

Spawnarg '''ai_see''' controls whether the light is visible to AI. It defaults to "1", i.e. the light does help AI to see. You can set this spawnarg to "0" to make accent lights that will (1) not affect the player's lightgem, and (2) won't make suspicious objects like rope arrows more visible to AI.

== Chandeliers ==

Typically chandeliers are setup with multiple particle flames, but just one light entity (for better performance). Bind the candles to the chandelier, then if one is doused, all will extinguish. (See the prefab for an example.)

== Lighting Textures ==

[[Image:LT_Projectedlight.png|400px|thumb|Rich_is_Bored's Example]]

The lighting textures are also accessed in the light inspector.

Lights can be modified by two different texture types:

* Projection Image - This is the texture that is projected on the surface
* LightFalloffImage - This texture varies the intensity of the light through the volume along the Z Axis
* (Notes: While the Falloff Image is a 2D texture it is rendered as 1D (one dimensional). You will notice that almost all Falloff Images are thin strips with perpendicular stripes. Traditionally, Falloff will be used to diminish the light with distance to the source but you can violate the physics of real lights and have the intensity increase with distance or vary intensity from bright to dim to bright... etc. )

These textures allow the mapper to change the intensity and falloff of a light.

Light textures with the addition of material keywords like [https://modwiki.xnet.fi/Scroll_%28Material_stage_keyword%29 scroll],[https://modwiki.xnet.fi/Rotate_%28Material_stage_keyword%29 rotate], etc. will grant lights the ability to animate and produce special effects such as;

* A moving light for a fireplace
* A candle or torch
* A light flickering along with sound volume.

One can also apply a fog texture to the light (the only way built into Doom 3 to create fog). Color is of a similar concern when [[A_-_Z_Beginner_Full_Guide_Page_3#Fog|creating fog]], as noted in [[Light Properties#Color|Color]]

* A typical "Light Shader" [http://www.iddevnet.com/doom3/materials.php material] definition

<pre>

lights/My_Custom_Light1
{

lightFalloffImage makeIntensity( textures/My_Custom_Light1_Z ) // Falloff Image

{
forceHighQuality
map textures/My_Custom_Light1_XY // Z-Projection Image
zeroClamp
}

}

</pre>

(For advanced detail and techniques see [[Light Textures and Falloff Images]] )

== Further reading ==

* [[Performance:_Essential_Must-Knows#Lighting_Performance_Options|Lighting Performance Options]]
* [[Relighting Lights]]
* A great tutorial on outdoor lighting can be found here: http://www.katsbits.com/htm/tutorials/doom_3_lighting_outdoor.htm
* Modwiki's summarized Doom 3 lighting article: [http://www.modwiki.net/wiki/Light Light]

{{tutorial-editing}}
[[Category:Lighting]]
[[Category:Ambient Light]]

Light Properties

2015-06-26T19:20:37Z

SteveL: /* Fog Light */ +noFogBoundary spawnarg

'''''NOTE: This is a first-draft article. It has not yet undergone quality control, so take information with a grain of salt as it is subject to change '''''

== Introduction ==

For Doom 3 (and subsequently, The Dark Mod), there are 4 different types of lights at our disposal. Each has their own advantages and drawbacks, and hopefully this article will help to familiarize The Dark Mod hopefuls with their use. For information on creating lights and a lot of other useful information, see [[A - Z Beginner Full Guide Start Here!]]

*

{{clear}}

==Light Volume Properties==

=== Point Light ===

A point light is the default light (also the default for fog). No option must be checked to make a light a point light. A point light casts light, and subsequently shadows in all directions evenly, falling off after a distance defined by the light texture. This works best for most small indoor and outdoor lighting, like lamps, candles, fireplaces etc. For this reason, it is going to be the most used type.

* Note, a misconception about Point Light is that they project spherically. The box shaped bounding volume in Dark Radiant is no mere simplification, it is the literal area affected by the light for calculation purposes. Point Light volumes should be perceived as cylindrical prisms that on one axis are shaped by the silhouette of the [[Light_Properties#Lighting_Textures | projection texture]] (think of a stack of cheese cut with a cookie cutter) and the other axis (z-axis) traditionally determines the distance from origin brightness (usually vertical... or how tall you make your cheese stack) with the LightFalloffImage.

=== Projected Light ===

Projected light is just as the name suggests. It is probably more intuitive and easier to use than a parallel light and is better for things like projecting a window-shaped light on the floor of a room or a spotlight on a wall. To make one, select projected instead of the default omni option at the top of the light inspector.

This creates a triangular prism as the bounding box for the light (instead of a rectangular prism like a regular light), with the point ending right at the entity itself. This can be rotated using any of the XYZ rotation buttons or manually using DarkRadiant’s rotation tool (shortcut R).

You can also manipulate the projected light via the vertices (shortcut V to enable vertices dragging). By dragging the vertices in the center of the projected square, you can lengthen and change the angle of the projection while keeping the projected square the same size. To resize the projection, use the two side vertices in the correct XYZ grid view. Making the bounding box flat against a surface (like a floor) is usually unnecessary (for example, making a moonlight window light on a floor or wall), because with shadows enabled and making the projection long enough to intersect the plane on which the shadow is to be cast, the full shadow will be cast (its simple geometry and just requires minor toying).

As with all the lights, projected lights have a full range of color and texture options to let the mapper find just the effect they need, allowing you to create a great atmosphere for your map.

=== Parallel Light ===

A light is said to be parallel when the parallel checkbox is checked in the light inspector. It is subject to all the same options as a point light, but it has a few distinct differences. A parallel light tends to not care exactly where the entity itself is placed. The most important thing is where the light_center vertex is placed and where the light entities bounding box intersects with elements in your map.

The light_center vertex starts right in the middle of the entity. The main difference between the parallel and point lights is that a parallel light does not radiate from the origin around the entity itself. What controls the direction that shadows are cast is the placement of the light_center vertex. Shadows will run parallel (hence the name) to a line between this vertices and the light entity itself. As such, this makes it an excellent choice for sunlight or moonlight. As such, it has some of the elements of a point light and a projected light, it can seem to radiate in a circle (if you use the appropriate texture) whilst casting a shadow in any direction preferred.

Switch to Vertex mode in [[DarkRadiant]] to drag the light_center vertex of your selected light entity.

Posted by Greebo: Also, note that a parallel light will only light surfaces "matching" the direction of the "light vector" (origin minus light_center). All other surfaces will stay completely unlit, therefore it should be combined with an ambient light to achieve good lighting effects. [http://modetwo.net/darkmod/index.php?s=&showtopic=8091&view=findpost&p=159842]

What this means is, you can draw a line from the center vertex to the light entity's origin and on from there, and only objects in the direction of that line will be lit. The light won't light 4 walls of a room and the floor, it would only light one of the walls or the floor (or ceiling)

==== Troubleshooting Parallel Lights ====

''I added a parallel light but I can’t see any light at all!''

Parallel lights can have some quirks. The light seems to fail and do nothing when intersecting multiple walls that are parallel to the face the light is actually casting on. It seems the light will work as long as it doesn’t intersect a face parallel to the one it is casting light on.

''I have a parallel light but it casts a jagged light on my floor!''

Similar to above, a parallel light can sometimes have anomalies when intersecting multiple walls and a floor. Since having the light intersect multiple walls when it can only cast on one of them, having a massive bounding box is pointless anyways so pay attention to what the light is touching and you should be fine.

*

{{clear}}

==Light Interaction Properties==

=== Normal Light ===

This is the default light type. It performs all the surface interaction stages and shadow calculations. It has the heaviest performance impact.

=== Ambient Light ===

Ambient light is really just a lighting texture, but it is also a specific item that is needed in practically every map, so for those purposes it will be treated as if it were its own subset of lights.

Properties: No shadows, No specular, Bumpmapping or Directionality (Note: The "Enhance Ambient" does add Bumpmapping )

Use the ambientLight keyword.

An ambient light can be any form: it can be a point, parallel or even projected (though projected would probably be useless).

The only requirement of an ambient light is to use one of the available ambient light textures, accessible by opening the light inspector (with the shortcut L in DarkRadiant, and get used to using it), and selecting ambientlightnfo from the list.

* Ambient Light is covered in more detail in [[A_-_Z_Beginner_Full_Guide_Page_2#Ambient_Light:_Gloom_not_Doom| Ambient Light: Gloom not Doom]]

* To understand The Dark Mod's unique ambient light detection system see: [[Virtual Darkness]]

* Ambient Light can be set to automatically adjust color and brightness per "location" see: [[Location Settings]] and [[Dynamic ambient light]]

=== Fog Light ===

This applies Doom 3's style distance fog to a light volume. The texture applied will become more opaque with distance away from the viewer. There is a variant called No Portal Fog which will not apply opaque fog to Portal areas in view. ( [[A_-_Z_Beginner_Full_Guide_Page_3#Fog|Beginner Tutorial: Fog]] )

In rare cases, you may wish for some surface inside a fog-volume to be fog-free. You can use the "noFog" keyword in the material definition for the texture applied to this surface to keep it from being "fogged".

Very thin fog (or BlendLight ) can also be used to soften the apparent light interactions near surfaces in a similar manner to the Post Process shader effect but with more mapper control. You can fake certain radiosity effects simply by amplifying small ambient light with small thin fog volumes.

Use the fogLight keyword.

==== noFogBoundary ====
Fog lights don't actually paint mist in the air, which would slow down performance quite a bit. They achieve their effect by fogging out the colour of the surfaces that they hit, proportionate to the depth of fog that lies between the player and the surface. In addition, if there is no surface between the player and the edge of the fog volume, they paint fog on the invisible walls of their own bounding volume. That's needed for a large open scene, for example, where there might be no surface between the player and the edge of the fog volume. If you're in a misty forest, and there happened to be no tree visible in a certain direction, you'd expect to see grey fog rather than clear space between the fogged trees.

Sometimes you don't want that to happen, for example if you're using a very large but very light fog to simulate atmospheric perspective in a town. You want the colour and detail of buildings to fade with distance, but you don't want heavy fog blocking the view of the sky in the gaps between buildings where you see to the very edge of the big fog light. You can use spawnarg "noFogBoundary" for that. It lets fog paint on solid surfaces, while leaving empty space and caulk sky free of fog effects.

=== Blend Light ===

Blend lights can be considered to be like volumetric decals. They do not perform most of the interaction shader operations and merely apply a texture to a volume using an [http://web.archive.org/web/20110111010457/http://www.modwiki.net/wiki/Blend_%28Material_stage_keyword%29 OpenGL Blend Mode]. Blend lights have the least performance impact. Blend lights can also be used to create [http://www.doom3world.org/phpbb2/viewtopic.php?f=1&t=12256&start=0&st=0&sk=t&sd=a "negative light"].

Example negative light shader:

<pre>
lights/bdog_testBlendLight2
{
blendLight
lightFalloffImage makeintensity( textures/blackdog/blendlight_falloff_inverse.tga )
{
blend gl_zero, gl_one_minus_src_color
map textures/blackdog/blackdog_icon_inverse.tga
zeroclamp
//alphazeroclamp
colored
}
}
</pre>

Use the blendLight keyword.

----

=== Spectrum ===

You may use the "spectrum" keyword to isolate specific lights to specific materials which have the same spectrum value in their material definition.
[http://web.archive.org/web/20080704080454/http://www.modwiki.net/wiki/Spectrum_%28Material_global_keyword%29 Spectrum Keyword at Modwiki]

----

*

{{clear}}

== Light Settings ==
There are several settings with which to customize your lights. These settings allow the mapper to customize the look of a light (or a combination of lights) into a near infinity of looks. All are accessed through the light inspector (shortcut of L in DarkRadiant)

=== Color ===

The color palette allows the mapper to pick the color of the light emitted, arguably one of the most useful controls the mapper has over a light. To access it, click the button under the “Colour” heading. From there, adjust the settings until you find a correct color (can take some trial and error). In a game like The Dark Mod or Doom 3, where darkness is often more prevalent than light, the color picked often needs to be darker than expected. Without a direct brightness option, the color takes on this task. For a low level ambient light, the color picked would be almost pitch black. A pitch black light would not cast any light, but anything less than pitch black will cast a faint light. As such, it can take some trial and error to find the correct light for a situation, as intiailly, one is likely to pick a seemingly correct color only to find it is far too bright.

Remember: changing light settings or adding lights (and models) does not require re-compiling the map!

=== Radius ===
The 'radius' of your light can be changed by dragging its corners around in the 2d windows. Doom 3 lights do not have an actual radius, they are actually square lights and will light up everything they touch inside their bounding box in the editor. They will evenly light everything to their edges. While square lights might seem fairly odd there are options to make them more believable and have a nice fade, namely the 'texture' applied.

Tip: you can rotate a light so only one corner will touch a wall and make a triangular shaped light.

Or rotate it so 2 corners touch a wall and make a line of light.

'''Changing Radius of Light Entity:'''

If you put a premade light entity into your map, the radius of the light won't be visible.

To change it, use the following syntax (and whichever value you wish):

<pre>

"set _color on flame" "0.9 0.8 0.7"
"set light_radius on flame" "250 250 250"

</pre>

With lanterns and such use 'light' and with torches and candles etc use 'flame'.

<pre>

"set _color on light" "0.9 0.8 0.7"
"set light_radius on light" "250 250 250"

</pre>

(Copied from Baddcog's old "Lighting A to Z" article)

=== Parallel ===

Selecting this option turns the light into a parallel light (as opposed to a point or projected light). See [[Light Properties#Parallel Light|Parallel Light]]

=== Do not cast shadows (fast) ===

As the name suggests, this setting causes the light to not cast shadows on any object. This can cause the light itself to not be confined by walls, which can sometimes be beneficial and sometimes not. The main purpose of enabling this option is performance. Shadows are processor intensive and are not needed in some cases, so removing them wherever not beneficial to gameplay can vastly improve performance. Note that ambient lights never cast any shadows. Another way to improve performance similarly is to set the entity property on a model or func_static (this doesn’t work on worldspawn) <tt>noshadows</tt> to 1.

* '''Further details''': [[Turning Shadows Off]] , [[Noselfshadows]]

=== Skip Specular Lighting ===

Specular Lighting refers to a texture's specular map, wherein a flat surface (such as a wall) is painted with a texture that has a specular component. This causes a surface to have shinier and duller parts on a flat surface based on the darkness of the corresponding location on the specular map. Not all textures have specular maps. Checking this option could improve performance or remove the effect if it is not wanted. [http://www.modwiki.net/wiki/Texturing#Specular_maps]

=== Skip Diffuse Lighting ===

Like Specular lighting, diffuse lighting also references an attribute of a texture, the Diffuse Map. Diffuse Maps determine the intensity and color of the light reflected off of the different elements of a texture (an example being the difference between bricks and the mortar in between, as well as different bricks having different properties as well giving a less bland appearance).
[http://www.modwiki.net/wiki/Texturing#Diffuse_maps]

*

{{clear}}

== Chandeliers ==

Typically chandeliers are setup with multiple particle flames, but just one light entity (for better performance). Bind the candles to the chandelier, then if one is doused, all will extinguish. (See the prefab for an example.)

== Lighting Textures ==

[[Image:LT_Projectedlight.png|400px|thumb|Rich_is_Bored's Example]]

The lighting textures are also accessed in the light inspector.

Lights can be modified by two different texture types:

* Projection Image - This is the texture that is projected on the surface
* LightFalloffImage - This texture varies the intensity of the light through the volume along the Z Axis
* (Notes: While the Falloff Image is a 2D texture it is rendered as 1D (one dimensional). You will notice that almost all Falloff Images are thin strips with perpendicular stripes. Traditionally, Falloff will be used to diminish the light with distance to the source but you can violate the physics of real lights and have the intensity increase with distance or vary intensity from bright to dim to bright... etc. )

----

These textures allow the mapper to change the intensity and falloff of a light.

Light textures with the addition of material keywords like [https://modwiki.xnet.fi/Scroll_%28Material_stage_keyword%29 scroll],[https://modwiki.xnet.fi/Rotate_%28Material_stage_keyword%29 rotate], etc. will grant lights the ability to animate and produce special effects such as;

* A moving light for a fireplace
* A candle or torch
* A light flickering along with sound volume.

One can also apply a fog texture to the light (the only way built into Doom 3 to create fog). Color is of a similar concern when [[A_-_Z_Beginner_Full_Guide_Page_3#Fog|creating fog]], as noted in [[Light Properties#Color|Color]]

{{clear}}

* A typical "Light Shader" [http://www.iddevnet.com/doom3/materials.php material] definition

<pre>

lights/My_Custom_Light1
{

lightFalloffImage makeIntensity( textures/My_Custom_Light1_Z ) // Falloff Image

{
forceHighQuality
map textures/My_Custom_Light1_XY // Z-Projection Image
zeroClamp
}

}

</pre>

(For advanced detail and techniques see [[Light Textures and Falloff Images]] )

*

{{clear}}

== Further reading ==

* [[Performance:_Essential_Must-Knows#Lighting_Performance_Options|Lighting Performance Options]]
* [[Relighting Lights]]
* A great tutorial on outdoor lighting can be found here: http://www.katsbits.com/htm/tutorials/doom_3_lighting_outdoor.htm
* Modwiki's summarized Doom 3 lighting article: [http://www.modwiki.net/wiki/Light Light]

{{tutorial-editing}}
[[Category:Lighting]]
[[Category:Ambient Light]]

Loading Screen Text

2015-06-20T18:14:26Z

SteveL: + 2.04 changes

: ''In TDM 2.03 and before, this works only on a fresh game start, not when loading a saved game. It'll be changed in TDM 2.04.''

It's common to add flavour text to a loading screen to help set the mood and give the player something to read while the map is loading.

Mappers can now add a random selection of text, so players will see a different bit of text each time they load the map.

Use the following GUI event to read out the "gui::random_value" state variable. The event will be fired by the SDK code as soon as the random_value is set. Just copy and paste into your loading screen .gui.

<pre>
onNamedEvent OnRandomValueInitialised
{
if ("gui::random_value" < 0.1)
{
set "TextLoading::text" "Text1"; // Replace "TextLoading" with the name of your text windowdef.
}
else if ("gui::random_value" < 0.2)
{
set "TextLoading::text" "Text2";
}
else if ("gui::random_value" < 0.3)
{
set "TextLoading::text" "Text3";
}
else if ("gui::random_value" < 0.4)
{
set "TextLoading::text" "Text4";
}
else if ("gui::random_value" < 0.5)
{
set "TextLoading::text" "Text5";
}
else if ("gui::random_value" < 0.6)
{
set "TextLoading::text" "Text6";
}
else if ("gui::random_value" < 0.7)
{
set "TextLoading::text" "Text7";
}
else if ("gui::random_value" < 0.8)
{
set "TextLoading::text" "Text8";
}
else if ("gui::random_value" < 0.9)
{
set "TextLoading::text" "Text9";
}
else
{
set "TextLoading::text" "Text10";
}
}
</pre>

(The indentation has been screwed by the forum code block). This is just an example supporting 10 different texts of roughly equal probability in a "TextLoading" windowDef. The "gui::random_value" will be in the range [0..1), so if you need more or less than 10 values as in the example, you need to adjust the if () clauses in the GUI code accordingly.

===Changes in TDM 2.04===
In TDM 2.03, the "OnRandomValueInitialised" GUI code is activated only on new mission starts, not when the player is loading a saved game. In TDM 2.04, the GUI event will be activated during save game loads too, including for quick loads.

Quick loads can be very fast, so you might want to suppress your text (or other random GUI actions) during quickloading. TDM 2.04 will add another flag to the state information available to your gui: "gui::quickloading" which will be set to 1 when quickloading or 0 when not.

Example usage:
<pre>
onNamedEvent OnRandomValueInitialised
{
if ("gui::quickloading" == 0) // Don't display text when quickloading
{
if ("gui::random_value" < 0.1)
{
set "TextLoading::text" "Text1"; // Replace "TextLoading" with the name of your text windowdef.
}
else if ("gui::random_value" < 0.2)
{
... etc etc
}
}
</pre>

World Particle System

2015-03-17T23:29:44Z

SteveL: update other parts of article for func_smoke

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by func_smokes and scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of any emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==

===Func_smoke===
Func_smoke entities use the world particle system. Use them like a func_emitter, except that the particle effect is specified by the "smoke" spawnarg instead of "model".

Func_smokes can be triggered on and off like func_emitters. They also support the "start_off" spawnarg.

If bound to a moving object, func_smokes will leave their particles trailing behind them. The two flasks in the video are bound to rotating gears and have the same particle attached (mcu_lilpipesmoke.prt): the left one uses a func_emitter, the right one a func_smoke.

[https://youtu.be/B_PQ5TO3VE4 Video demo of the difference]

===Scripting===
Script event sys.emitParticle is used for world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

====Single quad emission====
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

===="Natural" timing====
To make sys.emitParticle emit particle quads just like a func_smoke does, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.emitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters and func_smokes, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles of the same kind will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

World Particle System

2015-03-17T23:28:06Z

SteveL: rv "not available until TDM 2.03"

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of any emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==

===Func_smoke===
Func_smoke entities use the world particle system. Use them like a func_emitter, except that the particle effect is specified by the "smoke" spawnarg instead of "model".

Func_smokes can be triggered on and off like func_emitters. They also support the "start_off" spawnarg.

If bound to a moving object, func_smokes will leave their particles trailing behind them. The two flasks in the video are bound to rotating gears and have the same particle attached (mcu_lilpipesmoke.prt): the left one uses a func_emitter, the right one a func_smoke.

[https://youtu.be/B_PQ5TO3VE4 Video demo of the difference]

===Scripting===
Script event sys.emitParticle is used for world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

====Single quad emission====
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

===="Natural" timing====
To make sys.emitParticle emit particle quads just like a func_smoke does, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.emitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters and func_smokes, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles of the same kind will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

World Particle System

2015-03-17T23:27:20Z

SteveL: /* Usage */ + func_smoke

:''This article describes a feature that will become available in TDM 2.03.''

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of any emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==

===Func_smoke===
Func_smoke entities use the world particle system. Use them like a func_emitter, except that the particle effect is specified by the "smoke" spawnarg instead of "model".

Func_smokes can be triggered on and off like func_emitters. They also support the "start_off" spawnarg.

If bound to a moving object, func_smokes will leave their particles trailing behind them. The two flasks in the video are bound to rotating gears and have the same particle attached (mcu_lilpipesmoke.prt): the left one uses a func_emitter, the right one a func_smoke.

[https://youtu.be/B_PQ5TO3VE4 Video demo of the difference]

===Scripting===
Script event sys.emitParticle is used for world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

====Single quad emission====
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

===="Natural" timing====
To make sys.emitParticle emit particle quads just like a func_smoke does, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.emitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters and func_smokes, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles of the same kind will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

Template:Tdm-scripting-reference-intro

2015-03-02T02:12:58Z

SteveL:

General utility functions not related to specific entities are listed under idThread. They're accessed in scripts using the dummy "sys" object, e.g. ''sys.waitFrame()'', or ''float brown_position = sys.strFind("The quick brown fox", "brown", 0, 0, -1)''.

Template:Tdm-scripting-reference-intro

2015-03-02T02:11:50Z

SteveL: General utility functions

TDM Script Reference

2015-02-14T12:43:20Z

SteveL: Updating for 2.03

This page has been generated automatically by the tdm_gen_script_event_doc console command, with [[Talk:TDM_Script_Reference/2.03|manual amendments]].

Generated by The Dark Mod 2.03, code revision 6439, last update: 2015-01-01 23:22

{{tdm-scripting-reference-intro}}
<div class="toclimit-4">
__TOC__
</div>
= TDM Script Event Reference =

== All Events ==
=== Alphabetic List ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''CTarget_AddObjectives'', ''CTarget_CallScriptFunction'', ''CTarget_ChangeEntityRelation'', ''CTarget_ChangeLockState'', ''CTarget_ChangeTarget'', ''CTarget_InterMissionTrigger'', ''CTarget_SetEntityRelation'', ''CTarget_SetFrobable'', ''CTarget_SetObjectiveComponentState'', ''CTarget_SetObjectiveState'', ''CTarget_SetObjectiveVisibility'', ''CTarget_SetRelations'', ''CTarget_SetTeam'', ''CTarget_StartConversation'', ''idAFEntity_Generic'', ''idAFEntity_WithAttachedHead'', ''idAI'', ''idActivator'', ''idAnimated'', ''idBeam'', ''idBrittleFracture'', ''idCameraAnim'', ''idCameraView'', ''idCombatNode'', ''idDamagable'', ''idEarthQuake'', ''idEntityFx'', ''idExplodable'', ''idForceField'', ''idFuncAASObstacle'', ''idFuncAASPortal'', ''idFuncPortal'', ''idFuncSmoke'', ''idItem'', ''idLight'', ''idMoveable'', ''idMover'', ''idMover_Binary'', ''idPhantomObjects'', ''idPlayerStart'', ''idPortalSky'', ''idRiser'', ''idRotater'', ''idShaking'', ''idSound'', ''idStaticEntity'', ''idTarget_CallObjectFunction'', ''idTarget_Damage'', ''idTarget_EnableLevelWeapons'', ''idTarget_EndLevel'', ''idTarget_FadeEntity'', ''idTarget_FadeSoundClass'', ''idTarget_Give'', ''idTarget_LightFadeIn'', ''idTarget_LightFadeOut'', ''idTarget_PostScriptEvent'', ''idTarget_Remove'', ''idTarget_RemoveWeapons'', ''idTarget_SessionCommand'', ''idTarget_SetFov'', ''idTarget_SetGlobalShaderTime'', ''idTarget_SetInfluence'', ''idTarget_SetKeyVal'', ''idTarget_SetModel'', ''idTarget_SetShaderParm'', ''idTarget_SetShaderTime'', ''idTarget_Show'', ''idTarget_WaitForButton'', ''idTrigger_Count'', ''idTrigger_EntityName'', ''idTrigger_Fade'', ''idTrigger_Hurt'', ''idTrigger_Multi'', ''idTrigger_Timer'', ''idTrigger_Touch'', ''idVacuumSeparatorEntity''
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''ammoInClip'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''attackEnd'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

:Spawnclasses responding to this event: ''idAI'', ''idMoveable''
==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''burn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canHitEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSee'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''checkAAS'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''checkAbsence'''(); ====

:description missing

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearSignal'''(float signalNum); ====

:Disables the callback function on the specified signal.
::''signalNum'': signal number

:Spawnclasses responding to this event:
==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''clipSize'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''createProjectile'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

:Spawnclasses responding to this event: ''Seed''
==== scriptEvent void '''customDeath'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

:Spawnclasses responding to this event: ''idBrittleFracture''
==== scriptEvent void '''deathMenu'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''disableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropTorch'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''ejectBrass'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''enableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange2D'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''error'''(string text); ====

:Issues an error.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''exitTeleporter'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''faceEnemy'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''facingIdeal'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''flashlight'''(float enable); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated''
==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getAudThresh'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCombatNode'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

:Spawnclasses responding to this event: ''CFrobDoorHandle''
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getIdealWeapon'''(); ====

:No description

:Spawnclasses responding to this event:
==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

:Spawnclasses responding to this event: ''CFrobLockHandle''
==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive):
::{|
|-
|gamePlayTime||gameplay time in seconds
|-
|damageDealt||damage dealt to enemies
|-
|damageReceived||damage received by player
|-
|healthReceived||health received by player
|-
|pocketsPicked||pockets picked by player
|-
|foundLoot||loot found by player
|-
|missionLoot||total loot available in mission
|-
|totalTimePlayerSeen||total time the player was seen by enemies in seconds
|-
|numberTimesPlayerSeen||number of times player was seen by enemies
|-
|numberTimesAISuspicious||number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score.
|-
|numberTimesAISearched||number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score.
|-
|sightingScore||sighting score (number of times player was seen * weight)
|-
|stealthScore||stealth score (sighting score + alerts * weights)
|-
|killedByPlayer||number of enemies killed by player
|-
|knockedOutByPlayer||number of enemies knocked out by player
|-
|bodiesFound||number of times enemies have spotted a body
|}

:Spawnclasses responding to this event: ''idThread''

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getState'''(); ====

:Gets the current state.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTurnDelta'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Gibbable'', ''idMoveableItem''
==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''hideByLODBias'''(); ====

:internal

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInvisible'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''isLight'''(); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''kill'''(); ====

:Kills the monster.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

:Spawnclasses responding to this event: ''idCombatNode''
==== scriptEvent float '''melee'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''missionFailed'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''missionSuccess'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''moveStatus'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCover'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''netEndReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''netReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''nextWeapon'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''On'''(); ====

:Turns the entity on.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

:Spawnclasses responding to this event: ''CFrobButton'', ''CFrobLever''
==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''playStartSound'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''preBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''randomPath'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI'', ''idPathCorner''
==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

:Spawnclasses responding to this event: ''idClass''
==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''respawn'''(); ====

:Respawn

:Spawnclasses responding to this event: ''idItem''
==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restartPatrol'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''restoreMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''saveGame'''(string filename); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''saveMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setStartedOff'''(); ====

:no description

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''shrivel'''(float time); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''stopFxFov'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopThinking'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

:Spawnclasses responding to this event: ''CFrobLever''
==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

:Spawnclasses responding to this event: ''CFrobHandle''
==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock'', ''idProjectile''
==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testChargeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''throwAF'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''throwMoveable'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

:Spawnclasses responding to this event: ''idForceField''
==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitAction'''(string name); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wander'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''weaponHolstered'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponLowering'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReady'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReloading'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponRising'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''

== Events by Spawnclass / Entity Type ==
=== idActor ===
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

==== scriptEvent string '''getState'''(); ====

:Gets the current state.

==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

=== idAFEntity_Base ===
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

=== idAFEntity_Gibbable ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idAFEntity_Generic ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idAFEntity_WithAttachedHead ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CAIVehicle ===
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

=== idCombatNode ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

=== idAI ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

==== scriptEvent void '''attackEnd'''(); ====

:no description

==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

==== scriptEvent void '''becomeSolid'''(); ====

:no description

==== scriptEvent void '''burn'''(); ====

:no description

==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

==== scriptEvent float '''canHitEnemy'''(); ====

:no description

==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

==== scriptEvent float '''canSee'''(entity ent); ====

:no description

==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

==== scriptEvent void '''clearBurn'''(); ====

:no description

==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

==== scriptEvent void '''disableAFPush'''(); ====

:no description

==== scriptEvent void '''disableClip'''(); ====

:no description

==== scriptEvent void '''disableGravity'''(); ====

:no description

==== scriptEvent void '''dropTorch'''(); ====

:no description

==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

==== scriptEvent void '''enableAFPush'''(); ====

:no description

==== scriptEvent void '''enableClip'''(); ====

:no description

==== scriptEvent void '''enableGravity'''(); ====

:no description

==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

==== scriptEvent float '''enemyRange'''(); ====

:no description

==== scriptEvent float '''enemyRange2D'''(); ====

:no description

==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

==== scriptEvent void '''faceEnemy'''(); ====

:No description

==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

==== scriptEvent float '''facingIdeal'''(); ====

:No description

==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

==== scriptEvent float '''getAudThresh'''(); ====

:no description

==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

==== scriptEvent entity '''getCombatNode'''(); ====

:No description

==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

==== scriptEvent entity '''getEnemy'''(); ====

:no description

==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

==== scriptEvent float '''getTurnDelta'''(); ====

:no description

==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

==== scriptEvent void '''kill'''(); ====

:Kills the monster.

==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

==== scriptEvent float '''moveStatus'''(); ====

:no description

==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

==== scriptEvent void '''moveToCover'''(); ====

:no description

==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

==== scriptEvent void '''moveToEnemy'''(); ====

:no description

==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

==== scriptEvent void '''preBurn'''(); ====

:no description

==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

==== scriptEvent entity '''randomPath'''(); ====

:no description

==== scriptEvent void '''restartPatrol'''(); ====

:no description

==== scriptEvent void '''restoreMove'''(); ====

:no description

==== scriptEvent void '''saveMove'''(); ====

:no description

==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

==== scriptEvent void '''shrivel'''(float time); ====

:no description

==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

==== scriptEvent void '''stopMove'''(); ====

:no description

==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

==== scriptEvent void '''stopThinking'''(); ====

:no description

==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

==== scriptEvent float '''testChargeAttack'''(); ====

:no description

==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

==== scriptEvent void '''throwAF'''(); ====

:no description

==== scriptEvent void '''throwMoveable'''(); ====

:no description

==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

==== scriptEvent void '''waitAction'''(string name); ====

:no description

==== scriptEvent void '''waitMove'''(); ====

:no description

==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

==== scriptEvent void '''wander'''(); ====

:no description

=== idTestModel ===
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

=== CBinaryFrobMover ===
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

=== idBrittleFracture ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

=== idCameraView ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idCameraAnim ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

=== idFuncEmitter ===
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

=== idEntity ===
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

==== scriptEvent void '''checkAbsence'''(); ====

:description missing

==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

==== scriptEvent void '''hideByLODBias'''(); ====

:internal

==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

==== scriptEvent float '''isLight'''(); ====

:No description

==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''StimRemove'''(float type); ====

:No description

==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

=== idAnimatedEntity ===
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

=== CFrobButton ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

=== CFrobDoor ===
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

=== CFrobDoorHandle ===
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

=== CFrobHandle ===
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

=== CFrobLever ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

=== CFrobLock ===
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

=== CFrobLockHandle ===
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

=== tdmFuncShooter ===
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

=== idEntityFx ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idClass ===
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

=== idItem ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''respawn'''(); ====

:Respawn

=== idMoveableItem ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idLight ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

==== scriptEvent void '''setStartedOff'''(); ====

:no description

==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

=== idPlayerStart ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idActivator ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPathCorner ===
==== scriptEvent entity '''randomPath'''(); ====

:no description

=== idDamagable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idExplodable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idForceField ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

=== idAnimated ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

=== idStaticEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncSmoke ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idVacuumSeparatorEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalEntity ===
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

=== idBeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idShaking ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idEarthQuake ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASObstacle ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPhantomObjects ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalSky ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== tdmVine ===
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

=== idMoveable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

=== idMover ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

=== idMover_Binary ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

=== idRotater ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idRiser ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPlayer ===
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

==== scriptEvent void '''checkAAS'''(); ====

:No description

==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

==== scriptEvent void '''customDeath'''(); ====

:No description

==== scriptEvent void '''deathMenu'''(); ====

:No description

==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

==== scriptEvent void '''exitTeleporter'''(); ====

:No description

==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

==== scriptEvent void '''missionFailed'''(); ====

:No description

==== scriptEvent void '''missionSuccess'''(); ====

:No description

==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

==== scriptEvent void '''playStartSound'''(); ====

:No description

==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

==== scriptEvent void '''saveGame'''(string filename); ====

:No description

==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

==== scriptEvent void '''stopFxFov'''(); ====

:No description

==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

=== idProjectile ===
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

=== CProjectileResult ===
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

=== CTarget_SetRelations ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idThread ===
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

==== scriptEvent void '''error'''(string text); ====

:Issues an error.

==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive):
::{|
|-
|gamePlayTime||gameplay time in seconds
|-
|damageDealt||damage dealt to enemies
|-
|damageReceived||damage received by player
|-
|healthReceived||health received by player
|-
|pocketsPicked||pockets picked by player
|-
|foundLoot||loot found by player
|-
|missionLoot||total loot available in mission
|-
|totalTimePlayerSeen||total time the player was seen by enemies in seconds
|-
|numberTimesPlayerSeen||number of times player was seen by enemies
|-
|numberTimesAISuspicious||number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score.
|-
|numberTimesAISearched||number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score.
|-
|sightingScore||sighting score (number of times player was seen * weight)
|-
|stealthScore||stealth score (sighting score + alerts * weights)
|-
|killedByPlayer||number of enemies killed by player
|-
|knockedOutByPlayer||number of enemies knocked out by player
|-
|bodiesFound||number of times enemies have spotted a body
|}

==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

=== Seed ===
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idSound ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

=== idTarget_Remove ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Show ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Damage ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SessionCommand ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EndLevel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_WaitForButton ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetGlobalShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderParm ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeIn ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeOut ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Give ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetModel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetInfluence ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetKeyVal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetFov ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_CallObjectFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_PostScriptEvent ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EnableLevelWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_RemoveWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeSoundClass ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_AddObjectives ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveVisibility ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveComponentState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_StartConversation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetFrobable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_CallScriptFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeLockState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeTarget ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_InterMissionTrigger ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetTeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger ===
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idTrigger_Multi ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_EntityName ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Timer ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Count ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Hurt ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Fade ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Touch ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idWeapon ===
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

==== scriptEvent float '''ammoInClip'''(); ====

:No description

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''clipSize'''(); ====

:No description

==== scriptEvent entity '''createProjectile'''(); ====

:no description

==== scriptEvent void '''ejectBrass'''(); ====

:no description

==== scriptEvent void '''flashlight'''(float enable); ====

:no description

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

==== scriptEvent float '''isInvisible'''(); ====

:no description

==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

==== scriptEvent float '''melee'''(); ====

:no description

==== scriptEvent void '''netEndReload'''(); ====

:no description

==== scriptEvent void '''netReload'''(); ====

:no description

==== scriptEvent void '''nextWeapon'''(); ====

:No description

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

==== scriptEvent void '''weaponHolstered'''(); ====

:no description

==== scriptEvent void '''weaponLowering'''(); ====

:no description

==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

==== scriptEvent void '''weaponReady'''(); ====

:no description

==== scriptEvent void '''weaponReloading'''(); ====

:no description

==== scriptEvent void '''weaponRising'''(); ====

:no description

==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

[[Category:Scripting]]

A - Z Beginner Full Guide Start Here!

2015-02-12T21:03:28Z

SteveL: /* Changing a Light's Brightness */ updating "Value" to read "Lum:" to match latest DR

{{A-Z Beginner Guide TOC}}
'''''PLEASE NOTE: THIS GUIDE CONTAINS SPOILERS FOR THE "THIEF'S DEN" DEMO MISSION RELEASED JAN 18TH, 2008.'''''

== Introduction ==

Since writing this I've created a [[Startpack Mappers' Guide]] which is a ready made FM template with a set of ready made components to make it even easier to make a Dark Mod FM because it already includes things like objectives, briefing, readables, etc. etc and you just modify them and concentrate on building. However, I recommend you first follow this guide so you have some understanding of the basics and then the startpack will make more sense.

This is an easy guide for complete beginners to Dark Mod. It will lead you from start to finish, 'push that button, click that menu' and at the end you will have a fully working (but tiny) Dark Mod mission with all the main essential features including objectives all zipped up. You will be able to include variations of your own as you progress if you wish. Links to more detailed info is included but ignore those first time if you wish. Creating this mission is a learning process: although others will be able to play it, it will be too simple for that purpose - though it might be fun to see how varied the results might be from different players following the same instructions! When finished you can modify it and customise it to learn more or just shelve it for reference while you start your ''real'' mission!

This tutorial does not describe how to make your mission architecturally beautiful - just the opposite; the build may be as crude, quick, and ugly as you like. Nor does it advise how to design for good gameplay, etc. For that you should go to [[Mission Design Tips]] after you have mastered the basics. This is a ''method'' tutorial, not a ''design'' tutorial. Nor can it answer every question. It will merely present the most basic information for making a complete mission.

Feel free to experiment, add to, or even skip parts you already know or seem obvious, especially if you have a background producing Doom or Quake maps.

This guide was inspired by Komag's famous tutorial which helped a great many Dromeders (including myself) to get started producing Thief 2 FMs. If you are or were a Dromeder then you might first like to browse quickly through [[Dromed - Dark Mod Differences]] before proceeding - though it is not essential for this tutorial as I am trying to make few assumptions of prior knowledge. It will refer to default keys/mouse settings in Dard Radiant (editor - see later) so if you have changed any hot keys in Dark Radiant's help menu then keep that in mind. Also note that any screenshots might be in a different colour to your settings of course.

== Installation ==

This tutorial assumes that you have Dark Mod already installed. If not, please refer to [http://www.thedarkmod.com The Dark Mod] website for information.

Alternatively you can use the limited Dark Mod resources provided by the pre-release demo mission [[Thief's Den]]

== The Dark Mod Editor ==

To edit Dark Mod missions you will need a game editor. '''This tutorial is based on the [[Dark Radiant]] editor''' (hereinafter may be called DR) but you can possibly follow most of it in other editors like DoomEd. Variations might be shown where possible but it will mainly assume Dark Radiant. If you haven't got Dark Radiant yet, consult the [[Dark Radiant]] sections, install it and set it up how you like it. If you want to use DoomEd then you need to look elsewhere first. DoomEd of course is supplied with Doom.

You might wish to open the [[Dark Radiant Controls, Keys & Mouse|DR Controls]] page in a new window in your web browser for quick reference while following this tutorial. I'll try to make it so you don't need to!

Make sure you can run Dark Mod and your editor before proceeding. In particular remember you can undo your last step(s) (edit menu or {{key|CTRL}}+{{key|Z}})

== Your First Mission ==

Let's get started.

* Open Dark Radiant (hereinafter DR) and also open Dark Mod for quick testing.
* If you have a mission already open in DR then select File menu > New Map to clear it.
* Save it now as any suitable name. You might prefer to save later but I always do it immediately. All missions must go (with exceptions I will describe later in [[A - Z Beginner Full Guide Page 5#Managing your Mission Files|Managing your Mission Files]]) in the darkmod\maps folder or a folder within that. I urge you to create a new folder for each project within that maps folder. In this case:
# Open File Menu > Save As
# Make sure you are in the 'maps' folder.
# Select 'Create Folder' and type in say 'tutorial'. You might prefer 'Tut' or even 'T' because you have to keep typing it over and over in the Dark Mod console when testing!
# Select that folder
# Enter the name of your mission at the top.
* The game will be saved as a 'map' file with a .map suffix and is commonly called a 'map' in Doom circles. But I will use the term 'mission' or 'FM' (Fan Mission) or maybe 'game' for the map file to try to avoid confusion with actual 'city' or 'treasure' maps within the mission.

First, let's consider our rough storyline so we have some idea what to build...

== Story, Briefing ==

Formal mission objectives will be described much later in this tutorial. But before you begin your mission you will obviously need to have at least some idea of storyline and plot else you will have no idea what to build. You might have a detailed story or just some simple ideas which you can develop later.

Ultimately, you will need to brief the player with information about the story, characters, and the main purpose of the mission. It probably makes sense to write that fully when you are nearly finished the mission because new ideas or even technical difficulties might make you change your story. However, in this tutorial I'll describe it early so as you build the mission the layout and objects make sense.

Your briefing text should eventually be entered as described at [[Briefing]] but temporarily you might just write it in a plain text document for reference.

This mini tutorial mission is called 'Thief's Den' so here is an example briefing ('''not''' in correct format for the gui or .xd file):

"I had a nice haul the other night including a grand scepter from Lord Frothley. But a low-life named Creep who had given me the info, then stole it from ME! Never trust a thief I say. But I know where he lives...

I also still have his message in his own hand, giving the low-down. If I can dispose of Creep and drop the message nearby then he should take the heat for the heist diverting all suspicion from me.

Creep is a nasty piece of work who is handy with a blade. He can be dangerous and may be expecting me - may even have recruited a thug or two as back up - but he has badly underestimated my stealth skills..."

== Preparing to Build ==

When you open Dark Radiant it will default to a grid size (in the XYZ orthoview) of 8 units by 8 (changeable from version 0.9.5 onwards.) These [[Conversion of Game Units|units]] are 1.1 inches. Check your preference (default key P) in DR as it will be easier during this tutorial if you have the following checked (ticked) in Preferences > Orthoview...

* Show Grid
* Show Size Info
* Show Coordinates

'''Important:''' It is recommend you generally build with the grid set reasonably to a large size such as the default 8 or 16 for all walls, floors, etc. This makes alignment easier. You can reduce this in the grid menu for fine placement but don't leave it like that generally or you will have complexity problems. Snap to grid ([[Image:DRsnapGrid.jpg]], {{key|CTRL}}+{{key|G}}) will re-align a selection to the current grid size.

We'll mostly be working in the XYZ grid orthoview but if you have room for the camera view at the side so much the better. The camera view does a rough render in 3D (F3 toggles a better rendering with lighting etc but keep that off if it slows things down which it is likely to and just use it now and again.)

* Note the origin icon of the 'world' at 0,0,0 in the grid view
* Zoom in and out with the mouse wheel
* Right mouse drag the grid view to scroll around (zoom out further to scroll around faster)
* Use ''Change views'' tool ([[Image:DRnextViewBut.jpg]], {{key|CTRL}}+{{key|Tab}}) to toggle between top (XY), front (XZ), and side (YZ) views (you can open aditional windows using menu <tt>View > New XY view</tt>).

The blank windows in the grid and camera views can be regarded as empty void - the space in which we shall build. We have to build in bubbles sealed off from that void like an airtight spaceship or a submarine. Any gaps will cause leaks and crash your game so it's obviously the first major rule to learn: always build inner spaces sealed off from the outer void

Apart from special materials like water and weather, all the raw material you will use is 'solid' to form different shapes. So we can make panels and place them together to form lots of floating airtight boxes and these can be linked together. The entire game then takes place inside those boxes. One box can hold a tiny cupboard or an entire cathedral and a lot of boxes can hold a city. Inside those boxes you cannot see the void.

A shortcut to putting panels together is to make one solid block and hollow it out to form a box and this is what we are going to do now to form our first room.

== Making Your First Room ==

First we make a rough solid block...

* Select the top view (XY) in the grid view (toggle with [[Image:DRnextViewBut.jpg]]).
* Left mouse drag out a rectangle any few grid units across in the middle somewhere.
* This rectangle is called a 'brush' and used to define raw shapes for walls, floors etc.
* Left drag ''within'' that brush to drag the brush around
* Select the ''Resize'' tool ([[Image:DRdragResize.jpg]], {{key|Q}}).
* Now left drag ''outside'' that brush to resize it.

Now we adjust its top view area...

* Left drag outside that brush to resize it to 256 across left to right (X direction) by 192 up and down (Y direction in top view.) You should see those dimensions at the sides of the rectangle if you have 'Show Size Info' set in Edit > Preferences > Orthoview. The position of the top left corner is in brackets at top left.
* Left drag within the brush to move it so its sides fit on the bigger grid. If all sides don't fit then check your dimensions and that you are still in grid size 8 (see grid menu.)
* I prefer to build up in the top right corner from the world 0,0,0 so none of the values are negatives but you decide for yourself. Move it where you want but ideally so the sides are on the big grid.

Now we adjust its height to get our finished block (brush)...

* Use [[Image:DRnextViewBut.jpg]] ({{key|CTRL}}+{{key|Tab}}) to switch to side (YZ) or front (XZ) view and left drag outside the brush to change its height to 128
* Left drag inside the brush to move it up and down so its sides are on a big grid same as you did in the top view.
* You should now have brush 256 x 192 x 128 (see [[Conversion of Game Units#Tips|Unit Tips]])

<center>[[Image:AZblock.jpg]]</center>

== Selecting and DEselecting ==

We only have one item in our view but eventually many. Operations only work on what is currently selected. When you have just created something as we just have it is automatically the current selection and should be highlighted in your views (see DR Preferences for colour.)

* To DEselect it, point your mouse at it in either the grid or camera view and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} (or just press the {{key|Esc}} key.)
*To select it again, point your mouse at it and use {{key|SHIFT}}+{{key|ALT}}+{{LMB}} again.

Selecting is something you'll do a lot of so get familiar with that {{key|SHIFT}}+{{key|ALT}}+{{LMB}}. It's an exclusive select to get just one item. There are other selects I'll describe later. The {{key|Esc}} key always deselects and it is vitally important to get into the habit of DEselecting before you select or create something new or in some cases you will have multiple selections without knowing it and can delete or change something you didn't want to. This is why the {{key|SHIFT}}+{{key|ALT}}+{{LMB}} is the safest select as it is exclusive and will automatically DEselect anything else that was left selected. But it won't protect an item when creating. Yes, it is possible to have say a brush selected, forget it is selected, then create say, a new light. Oh! what happened to the brush? It's gone - replaced by the light. Develop a nervous habit of keep hitting {{key|Esc}} to deselect when you go to create!

From now on I'll use LMB, MMB, and RMB to refer to the mouse buttons.

== Camera View ==

You should be able to see this block in the camera view. If the camera view is just black remember {{key|F3}} toggles true light rendering and we don't yet have a light so hit {{key|F3}} to get a constant bright test light throughout. I won't go into details of all the camera controls suffice to say use the arrow keys and {{key|D}} and {{key|C}} to move vertically. But scroll down to 'camera' in [[Dark Radiant Controls, Keys & Mouse]] and you will see a fantastic amount of control you have in DR's camera view - especially with the mouse. It will take time to get used to them all so for now perhaps just learn enough to move around to see what you've done so far.

If you can see your block(brush) in the camera view then it is likely not to have any particular texture unless you were doing something before this tutorial. Close up you may see it is covered in a checkered blue 'shader not found' message. Don't worry if it's covered in something else like stone or wood though. Since it will eventually be hollowed out to form a room, let's paint it now with some material more suitable to the Dark Mod universe...

== Materials, Textures, Painting the Block ==

This is the tiny home of a cheap thief so we'll use some old stonework.

I've mentioned 'textures', 'shaders', and 'materials'; what do these terms mean? A 'material' or 'shader' is the properties of a surface, including (but not necessarily) texture, sound, and others. To 'paint' our block we...

* Select the Media Browser. This is one of the tabs on a panel. Pressing N or T hides/shows the whole panel but I guess most people leave the panel showing all the time and just select the tab they want.
* Allow a few seconds for DR to read in the media first time and then you should see 'textures' listed
* Click 'textures' and it opens up to show all available textures. Many of the ones you see are Doom textures. Scroll down and select 'darkmod' which reveals the ones most suitable for our use. Scroll down to stone, open it, then cobblestones and select blocks_mixed_multicolour. Right click it and select 'Apply to selection'. This covers all surfaces of the block because we have still got selected the whole block not just one surface. You should see this in the camera view. Use this throughout the house (and eventually on its outside surface for consistency.)
* Select the Texture Browser. This is one of the tabs on the same panel as Media Browser. The Texture Browser only shows recently used textures. You should see only the one texture you selected so it's handy for future use. Odds are you will want to re-use the same textures. It will also show other textures if you clicked on them in the media browser plus any others if you were using DR before this tutorial. You can also copy and paste textures onto single or multiple surfaces (see later.)
* Hover the mouse over the four little buttons at the top of the Texture Browser and read the text so you have some idea of what features are there for the future. For now, click on the one that says 'Flush and Reload Shaders' and it should clear all of them except the one we put on our brush. As we add others they will appear in the texture browser so you can get to them more quickly.
* Now, press S for Surface Inspector (or View menu)
* If you have only one face selected (more about this later) you can set Horiz and Vert scale. Value like 0.3 makes it harder for the player to see any pattern repetition (in this situation and in my opinion - use your own judgement with other textures and wall sizes.) In the mean time you can use arrow buttons to adjust the scale for the whole selected brush. Whatever scale you use, generally you should be consistent with it for the same texture wherever used in a mission. If you use copy and paste then it will transfer the scale as well which is far easier.
* There will be more on texture adjustment later in this tutorial.

== Hollowing out a Room from the Block ==

Building to a large grid size helps performance. The outside of our block will never be seen in the game. Once we hollow it out then the player will only see the inside so that is the surface that is rendered and that we need to align to the large grid. There are two tools to hollow out a block, both activated by a button on the left button bar: one called 'hollow' and the other 'room'. Don't use 'hollow' as it reduces the internal sides so they don't fit the big grid AND it overlaps the corners which can cause rendering errors like so....

<center>BAD!</center> 
<center>[[Image:AZhollow.jpg]]</center> 

Instead use the 'room' button which does the job right (note the increased size so the ''internal'' dimensions will be the same as our original block and align to the big grid... 

<center>GOOD!</center> 
<center>[[Image:AZroom.jpg]]</center> 

All brushes in Doom must be convex. They cannot have any inward angles (like an L shape which would have to be two brushes together) and cannot actually be hollow. The above tools really create new side panel brushes to replace the original brush. In the case of our six-sided block that is six new brushes positioned as walls, floor, and ceiling. ''The walls they create are one small grid line wide so their width will vary depending on your grid size setting.''

Examine the block in the camera view and zoom right inside so you can see it internally which is where it will be seen in game. Note the texture aligns nicely because we stuck to a big grid size. The stone is appropriate for all four walls (which is why I textured the whole block in one go rather than one surface at a time) but now we need different textures for floor and ceiling...

== Selecting and Texturing Individual Surfaces ==

'''You cannot select a surface in the grid view''' so move inside the room in the camera view.

'''To texture the floor...'''

* Press Esc to make sure everything is DEselected
* Point at the floor and use {{key|SHIFT}}+{{LMB}}. Repeat a few times and you will see it selects/DEselects the surface. Keep it selected.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say stone/cobblestones or maybe you would like some wood/boards/worn_01 ? You choose but something like carpet might need special alignment so stick with stones or boards maybe for now? Remember - RIGHT click the texture name and select 'Apply to Selection'
* Alternatively you can click on several possibles then select them with one LMB in the Texture Browser on the other tab. In the Texture Browser you can enlarge the textures if preferred to see them better.
* Esc to DEselect so you can see it better in camera view.

'''To texture the ceiling...'''

* Press Esc to make sure everything is DEselected
* Point at the ceiling and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Select the Media Browser again (on the tabbed panel)
* In the darkmod section select say plaster/plaster01 and apply it.

'''If you change your mind about the walls you can change them to something else...'''

* Press Esc to make sure everything is DEselected
* Point at one wall and use {{key|SHIFT}}+{{LMB}} again to select its surface.
* Point at another wall use {{key|SHIFT}}+{{LMB}} again so now both surfaces are selected
* 'Accidentally' select the ceiling. No problem. Just use {{key|SHIFT}}+{{LMB}} on it again to DEselect it but the walls are still selected. In this way you can select which surfaces you want to select.
* Select the Media Browser again and just apply another type of stone, perhaps brick, to the walls if you want or just leave it as it is.

Now press {{key|CTRL}}+{{key|S}} to resave the mission or use the File menu. Get into the habit of doing this often unless you have autosave set. Now and again you can also save with a new name so you can go back to an earlier one if you totally mess up. Note: There is also a backup file made automatically by DR.

== Adding the Player's Start Point ==

One more thing is ''essential'' to play this in Dark Mod and that is the Player's starting position.

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the middle of the room and RMB to get a pop up menu. This menu is important so glance at some of the other items on it while you're here. 'Entities' are special function items and the player start is amongst them but there is a shortcut on the menu so instead...
* Select "Create Player Start here" on the menu. This will create the playerstart entity (red box) and put it where you clicked. Drag the entity around to the point where you want the player to start.
* You should see an arrow on the red box indicating the way the player will face at the start. If you cannot see the arrow then menu <tt>View > Show > Show Angles</tt> will reveal it. You can rotate the player by selecting ''Rotate'' tool ([[Image:DRrotate.jpg]], {{key|R}}) and dragging with the mouse.
* Use {{key|CTRL}}+{{key|Tab}} to switch to the side view (YZ) and use LMB to drag the ''inside'' of the player start box so its base is on the floor of the room (you can also use ''Translate'' tool, [[Image:DRtranslate.jpg]], {{key|W}}). Make sure you do not go below or the floor or the player might be stuck with his feet in concrete! Tip: In Thief games it was common to start just dropping over a wall with this player start a few feet above the ground. You might note that entities do not directly resize like brushes so LMB dragging on the ''outside'' of the box does nothing (unless you have selected the ''Translate'' tool).
* RMB in the grid view again and you will see there is now a ''Move player start here'' option so you can quickly move its position while testing different areas of your mission. But always remember to check both the side and top view when moving things around, to make sure the vertical position is also valid. (Also note that ''Move player start here'' does not ''select'' the player start - you will need to select it if you need to adjust its position by dragging.)
* With the player start still selected you can select the Entity Inspector (on the panel, or {{key|N}} to hide/show it) and see the properties of your first entity.

The game could now be played but it will be totally dark so we need to create at least one light.....

== Creating a Light ==

* Press Esc to DEselect everything.
* In the TOP grid view, point the mouse in the ''middle'' of the room and RMB to get the pop up menu.
* Select "Create Light" on the menu.
* A large red box appears with diagonals representing the light's centre and its rough 'radius'. The default light is more like six pyramids pointing out to their peaks in the centre of each side of the box. This gives a rough impression of a sphere of light and helps performance.
* {{key|CTRL}}+{{key|TAB}} to get a side view and LMB drag ''right in the centre of the light'' to move it up/down to centre it in the room if it is not already. Just dragging inside the radius box won't move it - you have to point at the centre.

== Resizing a Light ==

Resizing a light is awkward because dragging any side moves the centre (this might be changed in a later Dark Radiant.) Two ways of dealing with this. Just roughly drag it about and keep moving the light back to where you want it. But if you have very precisely positioned a light then you don't want to have to keep doing that so this is what I do...

* Select the Entity Inspector on the panel
* You should see it has a light radius property with three values for XYZ for the three dimensions. They are north and south for Y, east and west for X, and up and down for Z. (those are the compass directions in game by the way.)
* Click on the light radius property to highlight it.
* Note that its values appear in a choice of inputs at the bottom - You can type new values in a line with a space in between then click the check(tick) button or enter them as separate values or even use the little scrolly buttons at the side and then click the Apply button.
* The room interior is 192 x 256 x 128 (in XYZ order) so give the light radius the values 200 260 133 so it protrudes outside the walls (we're setting radius - so the light diameter will be twice that size). We may well change this again later if we want the light to spill out through a doorway or something.
* You can now toggle light rendering in the preview using {{Key|F3}} (or an icon in the preview toolbar) to see how the light affects the walls.

The light radius is not just a cut-off point. It can be regarded as a 'fade to zero point'. What this means is that the light is at maximum brightness at its centre and fades to zero at the limit of the radius. So in a big open area, if you extend the radius you will 'stretch the brightness' further. Imagine the scale from max to min compacted in a small radius or expanded in a large one. More on this later when we place wall torches.

== Changing a Light's Brightness ==

The light may be a little bright. To change it...

* Press L (or View menu)* to call up the Light Inspector
* Click on the white rectangle button just below where it says 'Colour'
* The brightness value is called 'Lum:' (luminosity) and should default to 100. Reduce it to 90, by overtyping it or using the slider to the far right. It might not matter. I'm just showing you where the control is for now.
* Fool around with the colours if you want - there are extensive features I won't cover here.

Hey! We should have your first working mission! Do a {{key|CTRL}}+{{key|S}} to save it and then follow the next sections in Dark Mod itself not in Dark Radiant.....

== Sound ==

There is no need to do anything special about ''hearing'' sounds such as footsteps, collision sounds, etc. at this stage as it will work automatically. Adding custom sounds will be dealt with later.

== Pathfinding ==

Pathfinding data to tell the AI characters where they can move is created by dmap by default when compiling in the next section...

== Dmap: Compiling the Mission ==

* Your mission file cannot be played itself; it is simply the directions to create a game file. To do this...
* From any Dark Mod menu go to the console. By default, the console is {{key|CTRL}}+{{key|ALT}}+{{key|~}} (US Keyboards) or {{key|CTRL}}+{{key|ALT}}+{{key|'}} (UK Keyboards). This key is the top left below Esc and to the left of "1" on all keyboards I believe. But most people set up a shortcut to just use the ~ (` in UK) on its own so:

For single key click to get the console:
In your desktop shortcut to Doom3.exe add this argument to its properties (right click shortcut): '''''+set com_allowConsole 1''''' so the target line would be something like:

'''''C:\Doom3\doom3.exe +set com_allowConsole 1'''''

(plus any other arguments you might want)
* In the console type and Enter dmap Tut/T001 where you should substitute your subfolder name for Tut and your mission filename for T001. So, if you created your mission file directly in the maps folder then you do not need a folder name and can put dmap T001. If you made a subfolder in maps called MyMaps and named your mission MissionImpossible999.map then enter dmap MyMaps/MissionImpossible999. I recommend you do not use upper case in filenames in Doom as I think it can cause problems on other platforms.
* Wait while dmap compiles the mission. This should only be a few seconds with this tiny mission but will be much longer for big missions.
* If you get a 'leaked' error or some other serious red warning then recheck your work; look for gaps in the wall or a wrong texture like nodraw or have you got an entity outside in the void? See [[Performance: Essential Must-Knows#How to detect and fix leaks|HERE]] for more about fixing leaks but at this stage of this tutorial it might be easier just to redo. What I have laboured over is basically make a block, texture it, hollow it, stick in a player start and a light. As you get more proficient you can do it in less than a minute.
* Assuming there were no dmap red "ERROR"s then you should be returned to the Dark Mod menus and are now able to play the mission.
* Return to the console.
* Type and Enter map Tut/T001. Tip: Press the up arrow key toggles back through the history of what you have typed before so your dmap should re-appear. Just press the Home key and delete the 'd'. An alternative is to use 'testmap' instead of dmap which does both dmap and map but I prefer to see dmap's results.
* You should now be able to walk around in the room. If you have a player shadow set then you might notice that walking through that light looks odd so keep that in mind for light placement. But most lights you will place close to a visible source like a gaslight or wall torch.

That's the first part done!

{{A-Z Beginner Guide TOC}}

{{tutorial-editing}}

LOD

2015-02-08T10:46:06Z

SteveL: /* Customizing AI models */

A '''Level of Detail''' (LOD) system can be used to bring more details to the screen while still speeding up rendering. See [http://en.wikipedia.org/wiki/Level_of_detail Wikipedia] for an introduction.

== The new LOD System - Overview ==

[[Image:TheDarkMod LOD System Overview.png]]

SVG version of the above graphic [http://bloodgate.com/mirrors/tdm/TheDarkMod_LOD_System.svg here].

{{infobox|Note: Fade in and fade out '''only''' work via ''[[alpha-fading]]'', so on materials that use an alpha blend and don't respond to lighting.|bg=#f09090|fg=yellow}}

== How to use LOD in your TDM map ==

To enable the LOD system, use either one of the pre-made LOD-enabled entities in your map (most of these are defined in '''def/tdm_lod.def''') or set '''dist_check_period''' to a number greater than 0.

Note: The '''dist_check_period''' spawnarg needs to be combined with one of "hide_distance" or "lod_X_distance" and "model_lod_X", "skin_lod_X" or "noshadows_lod_X" to have any effect!

See also '''[[LOD Bias]]''' for how to hide individual entities depending on the menu setting.

== GUI Setting ==

There is a new GUI setting, called [[Object detail| '''Object detail''' ]]. You'll find it under <tt>'''Settings - Video - Advanced'''</tt>. It consist of multiple levels, where '''Normal''' is the default. Lower settings cause the LOD distances to shrink, meaning entities switch sooner to the low-quality version and vanish sooner. Higher settings are the opposite, increasing the quality, but may be decreasing the FPS.

Mappers should design and test their map with the '''Normal''' setting on a typical modern PC (e.g. not too old and not high-end gaming rig either), and preferable also test on some slower and faster machines.

== Entities ==

Supported entity types:
* Models that don't move (i.e. func static models)

''From TDM version 2.03:''
* Animated models like waving flags and laundry (i.e. anything with spawnclass idAnimated)
* AI
* Animated attachments to AI

=== Example entities ===

* atdm:nature_pine_skeleton (just the tree trunk)
* atdm:nature_pine (Pine + particle leaves slowly swaying)
* atdm:nature_tree_stump

More can be found in the "Nature" folder with the DarkRadiant "Create entity" command.

== Spawnargs ==

=== min_lod_bias/max_lod_bias ===

See [[LOD Bias]] for how to hide individual entities depending on the menu setting.

=== hide_distance ===

In D3 units. When set to a value > 0, then the entity will be hidden if it is further away than this distance from the player.

Note: This might cause "popping", e.g. the entity will suddenly vanish or appear. See '''lod_fadeout_range''' for how to avoid this.

The actual value used from this spawnarg is modified by the menu setting "Object detail", so make to sure to test with this setting at "Normal".

=== lod_normal_distance ===

From TDM v1.05 onwards: This spawnarg defines a '''minimum''' distance from the player where the entity will ignore settings lower than '''Normal'''. This can be used to enforce a certain minimum distance so that players who set the detail level to '''Low''' or '''Lowest''' still do not experience entities popping in and out when being very close.

If this spawnarg is not set, it defaults to '''500 units'''. Avoid setting this spawnarg too high or even equal or higher than "hide_distance". This would only result in the menu setting "Object detail" being fixed at "Normal", e.g. players could never lower the quality settings to achive better frame rates. Do so only in rare cases where important entities would otherwise vanish in front of the eyes of the player.

=== lod_hide_probability ===

If '''lod_hide_distance''' is true, this spawnarg controls what the probabiliy of this entity vanishing is. Values range from 0.0 (will never vanish) to 1.0 (will certainly vanish). Whether a particular entity vanishes is computed at map start, so an entity either stays or vanishes, but does not change during the map play time.

Example:

"lod_hide_probability" "0.2"

If you place X identical entities, about 20% of them will vanish at the '''hide_distance''' and 80% will stay.

This can be used to "thin out" forests at a distance without having them vanish completely.

=== lod_X_distance ===

In D3 units. Sets the distance from where on LOD X is used. Will be valid until the next defined lod_(X+1)_distance, or infinty if there is no further LOD distance set.

To change the appearance of the entity inside this LOD, use the following spawnargs with a matching X:

==== model_lod_X ====

Set the model the entity displays inside this LOD. If not set, uses the model from LOD 0 e.g. the one from the "model" spawnarg.

''From TDM version 2.03:''

A special value "be_still" is supported for animated models. Setting model_lod_X to "be_still" for a LOD level means: stop the animation but don't switch model.

==== skin_lod_X ====

Set the skin the entity displays uses this LOD. If not set, uses the skin from LOD 0 e.g. the one from the "skin" spawnarg.

==== noshadows_lod_X ====

Boolean. If set, the entity casts no shadows while in this LOD zone.

==== offset_lod_X ====
Vector. Origin offset that can be applied to the replacement model if it doesn't naturally line up with the original.

==== lod_fadein_range ====

{{infobox|Note: Fade in and fade out only work via ''[[alpha-fading]]'', so on materials that use an alpha blend and don't respond to lighting.|bg=#f09090|fg=yellow}}

In D3 units. If set to non-zero, then the object will start hidden and begin to fade in at '''lod_1_distance''' - '''lod_fadein_range''' and be completely (100% opacity) visible at '''lod_1_distance'''. This can be used to create entities that only appear in some distance but not close up.

==== lod_fadeout_range ====

{{infobox|Note: Fade in and fade out only work via ''[[alpha-fading]]'', so on materials that use an alpha blend and don't respond to lighting.|bg=#f09090|fg=yellow}}

In D3 units. If set to non-zero, then the object will not vanish suddenly at '''hide_distance''', but start to fade out and be completely invisible at '''hide_distance''' + '''lod_fadeoutrange'''. Defaults to 0.

=== no_lod ===
:''This spawnarg will be available in TDM version 2.03''
Set "no_lod" "1" to disable LOD completely on an entity. Useful if you want to make use of a LOD entity but use a custom setup.

== Increasing the LOD steps ==

The number of possible LOD steps is fixed in code and defined in '''game/misc.h''' as a constant. The current
value is 7, meaning that there are 5 different rendering possibilities beside level 0 (the original) and level 6 (the object is hidden). That should be enough even for huge outdoor maps.

== Performance ==

Profiling showed that 3000 thinking entities consume about 7% CPU time. So if you use only a few hundred or thousand LOD entities, the performance of the extra thinking time is very small compared to the benefits of having only a few entities actually visible around the player.

== Example ==

At it's simplest, model, dist_check_period, hide_distance, lod_1_distance and model_lod_1 are used:
[[File:Lod_test2.png|thumb|right|click for full size]]
* '''model ''RegularModelName''''' -- point this to the fully detailed model
* '''dist_check_period 0.5''' -- time in seconds between distance checks
* '''hide_distance 400'''
* '''lod_1_distance 100'''
* '''model_lod_1 ''LessDetailedModelName''''' -- lower detail model
* '''lod_2_distance 200''' -- (optional further step)
* '''model_lod_2 ''LowerDetailModelName''''' -- even lower detail model (optional further step)

== Customizing AI models ==
From TDM 2.03, many of the common AI models use LOD. This is automatic. They are much more detailed than in 2.02 when seen close up, and are lower-poly when seen in the distance.

If you want to switch an AI's model, for example to make a Builder archer from a citywatch archer by changing the model def and the vocal set and team, then you have a choice: you can change all the different model_lod_* stages to match the ones used by your target Builder; or you can change only the "model" spawnarg, which will work ok but note that LOD will be switched off for that AI. That's because you won't your Builder archer to revert to a citywatch model when distant.

This rule was applied so that existing maps with custom models on AI woudn't get broken by the new AI LOD feature. The rules are: if the mapper overrides the "model" spawnarg but doesn't override any "model_lod" spawnargs, LOD is disabled on the entity. If the mapper overrides at least one "model_lod" spawnarg too, that shows they have it in hand so LOD remains enabled on the entity.

== History ==

Doom3 did not have any LOD system at all. The first steps of such a system were added in TDM by supporting a '''hide_distance''' spawnarg, which made entities hide or portals close once they were further away than this distance. The LOD system in TDM was totally rewritten for v1.04.

Support for animated models and AI was added in TDM version 2.03. More details are available on the [http://bugs.thedarkmod.com/view.php?id=3770 bugtracker].

=== Comparison ===

Here we compare the new (v1.04) to the old system (until v1.02):

* The old system had only two levels: 0 (original model), and 1 (entity is hidden)
* Due to a typo, all thinking for the LOD entities happened in the first half of the interval. That means if you set the intervall to 1 s, all entities did their distance check between 0 and 0.5 seconds, and none between 0.5 and 1 second and so on. This lead to fluctuating frame rates.

The new system:

* Supports up to 7 levels (last is ''hide''), more can easily be done with a recompile
* You can use less levels if you want
* Thinking is distributed over the entire interval
* makes scenes with thousands of entities possible
* Can not only switch the model, but also change the skin (f.i. use less expensive glass shaders) and turn shadows off
* Can hide only a fraction of all entities of the same class (''thinning out'')
* Allows the player (via the settings menu) to control the quality vs. speed

== See also ==

* [[LOD Bias]]
* [[Creating LOD Models]] with only Gimp/Photoshop and DarkRadiant
* [[List of LOD Models]]
* [[SEED]] - Random entity placement and distant culling

{{editing}} {{scripting}}

LOD

2015-02-08T10:45:44Z

SteveL: + Customizing AI models

A '''Level of Detail''' (LOD) system can be used to bring more details to the screen while still speeding up rendering. See [http://en.wikipedia.org/wiki/Level_of_detail Wikipedia] for an introduction.

== The new LOD System - Overview ==

[[Image:TheDarkMod LOD System Overview.png]]

SVG version of the above graphic [http://bloodgate.com/mirrors/tdm/TheDarkMod_LOD_System.svg here].

{{infobox|Note: Fade in and fade out '''only''' work via ''[[alpha-fading]]'', so on materials that use an alpha blend and don't respond to lighting.|bg=#f09090|fg=yellow}}

== How to use LOD in your TDM map ==

To enable the LOD system, use either one of the pre-made LOD-enabled entities in your map (most of these are defined in '''def/tdm_lod.def''') or set '''dist_check_period''' to a number greater than 0.

Note: The '''dist_check_period''' spawnarg needs to be combined with one of "hide_distance" or "lod_X_distance" and "model_lod_X", "skin_lod_X" or "noshadows_lod_X" to have any effect!

See also '''[[LOD Bias]]''' for how to hide individual entities depending on the menu setting.

== GUI Setting ==

There is a new GUI setting, called [[Object detail| '''Object detail''' ]]. You'll find it under <tt>'''Settings - Video - Advanced'''</tt>. It consist of multiple levels, where '''Normal''' is the default. Lower settings cause the LOD distances to shrink, meaning entities switch sooner to the low-quality version and vanish sooner. Higher settings are the opposite, increasing the quality, but may be decreasing the FPS.

Mappers should design and test their map with the '''Normal''' setting on a typical modern PC (e.g. not too old and not high-end gaming rig either), and preferable also test on some slower and faster machines.

== Entities ==

Supported entity types:
* Models that don't move (i.e. func static models)

''From TDM version 2.03:''
* Animated models like waving flags and laundry (i.e. anything with spawnclass idAnimated)
* AI
* Animated attachments to AI

=== Example entities ===

* atdm:nature_pine_skeleton (just the tree trunk)
* atdm:nature_pine (Pine + particle leaves slowly swaying)
* atdm:nature_tree_stump

More can be found in the "Nature" folder with the DarkRadiant "Create entity" command.

== Spawnargs ==

=== min_lod_bias/max_lod_bias ===

See [[LOD Bias]] for how to hide individual entities depending on the menu setting.

=== hide_distance ===

In D3 units. When set to a value > 0, then the entity will be hidden if it is further away than this distance from the player.

Note: This might cause "popping", e.g. the entity will suddenly vanish or appear. See '''lod_fadeout_range''' for how to avoid this.

The actual value used from this spawnarg is modified by the menu setting "Object detail", so make to sure to test with this setting at "Normal".

=== lod_normal_distance ===

From TDM v1.05 onwards: This spawnarg defines a '''minimum''' distance from the player where the entity will ignore settings lower than '''Normal'''. This can be used to enforce a certain minimum distance so that players who set the detail level to '''Low''' or '''Lowest''' still do not experience entities popping in and out when being very close.

If this spawnarg is not set, it defaults to '''500 units'''. Avoid setting this spawnarg too high or even equal or higher than "hide_distance". This would only result in the menu setting "Object detail" being fixed at "Normal", e.g. players could never lower the quality settings to achive better frame rates. Do so only in rare cases where important entities would otherwise vanish in front of the eyes of the player.

=== lod_hide_probability ===

If '''lod_hide_distance''' is true, this spawnarg controls what the probabiliy of this entity vanishing is. Values range from 0.0 (will never vanish) to 1.0 (will certainly vanish). Whether a particular entity vanishes is computed at map start, so an entity either stays or vanishes, but does not change during the map play time.

Example:

"lod_hide_probability" "0.2"

If you place X identical entities, about 20% of them will vanish at the '''hide_distance''' and 80% will stay.

This can be used to "thin out" forests at a distance without having them vanish completely.

=== lod_X_distance ===

In D3 units. Sets the distance from where on LOD X is used. Will be valid until the next defined lod_(X+1)_distance, or infinty if there is no further LOD distance set.

To change the appearance of the entity inside this LOD, use the following spawnargs with a matching X:

==== model_lod_X ====

Set the model the entity displays inside this LOD. If not set, uses the model from LOD 0 e.g. the one from the "model" spawnarg.

''From TDM version 2.03:''

A special value "be_still" is supported for animated models. Setting model_lod_X to "be_still" for a LOD level means: stop the animation but don't switch model.

==== skin_lod_X ====

Set the skin the entity displays uses this LOD. If not set, uses the skin from LOD 0 e.g. the one from the "skin" spawnarg.

==== noshadows_lod_X ====

Boolean. If set, the entity casts no shadows while in this LOD zone.

==== offset_lod_X ====
Vector. Origin offset that can be applied to the replacement model if it doesn't naturally line up with the original.

==== lod_fadein_range ====

{{infobox|Note: Fade in and fade out only work via ''[[alpha-fading]]'', so on materials that use an alpha blend and don't respond to lighting.|bg=#f09090|fg=yellow}}

In D3 units. If set to non-zero, then the object will start hidden and begin to fade in at '''lod_1_distance''' - '''lod_fadein_range''' and be completely (100% opacity) visible at '''lod_1_distance'''. This can be used to create entities that only appear in some distance but not close up.

==== lod_fadeout_range ====

{{infobox|Note: Fade in and fade out only work via ''[[alpha-fading]]'', so on materials that use an alpha blend and don't respond to lighting.|bg=#f09090|fg=yellow}}

In D3 units. If set to non-zero, then the object will not vanish suddenly at '''hide_distance''', but start to fade out and be completely invisible at '''hide_distance''' + '''lod_fadeoutrange'''. Defaults to 0.

=== no_lod ===
:''This spawnarg will be available in TDM version 2.03''
Set "no_lod" "1" to disable LOD completely on an entity. Useful if you want to make use of a LOD entity but use a custom setup.

== Increasing the LOD steps ==

The number of possible LOD steps is fixed in code and defined in '''game/misc.h''' as a constant. The current
value is 7, meaning that there are 5 different rendering possibilities beside level 0 (the original) and level 6 (the object is hidden). That should be enough even for huge outdoor maps.

== Performance ==

Profiling showed that 3000 thinking entities consume about 7% CPU time. So if you use only a few hundred or thousand LOD entities, the performance of the extra thinking time is very small compared to the benefits of having only a few entities actually visible around the player.

== Example ==

At it's simplest, model, dist_check_period, hide_distance, lod_1_distance and model_lod_1 are used:
[[File:Lod_test2.png|thumb|right|click for full size]]
* '''model ''RegularModelName''''' -- point this to the fully detailed model
* '''dist_check_period 0.5''' -- time in seconds between distance checks
* '''hide_distance 400'''
* '''lod_1_distance 100'''
* '''model_lod_1 ''LessDetailedModelName''''' -- lower detail model
* '''lod_2_distance 200''' -- (optional further step)
* '''model_lod_2 ''LowerDetailModelName''''' -- even lower detail model (optional further step)

== Customizing AI models ==
From TDM 2.03, many of the common AI models use LOD. This is automatic. They are much more detailed that in 2.02 when seen close up, and are lower-poly when seen in the distance.

If you want to switch an AI's model, for example to make a Builder archer from a citywatch archer by changing the model def and the vocal set and team, then you have a choice: you can change all the different model_lod_* stages to match the ones used by your target Builder; or you can change only the "model" spawnarg, which will work ok but note that LOD will be switched off for that AI. That's because you won't your Builder archer to revert to a citywatch model when distant.

This rule was applied so that existing maps with custom models on AI woudn't get broken by the new AI LOD feature. The rules are: if the mapper overrides the "model" spawnarg but doesn't override any "model_lod" spawnargs, LOD is disabled on the entity. If the mapper overrides at least one "model_lod" spawnarg too, that shows they have it in hand so LOD remains enabled on the entity.

== History ==

Doom3 did not have any LOD system at all. The first steps of such a system were added in TDM by supporting a '''hide_distance''' spawnarg, which made entities hide or portals close once they were further away than this distance. The LOD system in TDM was totally rewritten for v1.04.

Support for animated models and AI was added in TDM version 2.03. More details are available on the [http://bugs.thedarkmod.com/view.php?id=3770 bugtracker].

=== Comparison ===

Here we compare the new (v1.04) to the old system (until v1.02):

* The old system had only two levels: 0 (original model), and 1 (entity is hidden)
* Due to a typo, all thinking for the LOD entities happened in the first half of the interval. That means if you set the intervall to 1 s, all entities did their distance check between 0 and 0.5 seconds, and none between 0.5 and 1 second and so on. This lead to fluctuating frame rates.

The new system:

* Supports up to 7 levels (last is ''hide''), more can easily be done with a recompile
* You can use less levels if you want
* Thinking is distributed over the entire interval
* makes scenes with thousands of entities possible
* Can not only switch the model, but also change the skin (f.i. use less expensive glass shaders) and turn shadows off
* Can hide only a fraction of all entities of the same class (''thinning out'')
* Allows the player (via the settings menu) to control the quality vs. speed

== See also ==

* [[LOD Bias]]
* [[Creating LOD Models]] with only Gimp/Photoshop and DarkRadiant
* [[List of LOD Models]]
* [[SEED]] - Random entity placement and distant culling

{{editing}} {{scripting}}

Particles

2015-02-08T10:29:09Z

SteveL: + particle decl keywords

== Introduction ==

Particles are VERY flexible - they can function as rain, snow, falling leaves, oscillating leaves and foliage, smoke, mist, flame, trickling sand, trickling water, drips, waterfall, spray, fountain - anything that can be made up of particles, big or small, fast or slow.

There are already many particle effects available to the Dark Mod mapper. This tutorial is just the basics of how to get particle effects, new or old, into your mission...

== Getting Particle effects into your game ==

First, all that is assumed is you know the essentials described in [[Dark Radiant Must Know Basic Intro]]

Like so many things - it's easy when you know how. Let me describe by example. Say you want to have some smoke coming out of a chimney in your mission...

* Right click and select Create Entity. Select func_emitter from the list.
* Add the property : model
* If you select the model property then you see two buttons at the bottom - Choose Model and Choose Particle.
* Select the Choose Particles button (see below for information on Choose Model)
* Select a particles effect from the list. For chimney smoke there are a couple of Doom ones - admin_hall_smk_cone.prt and mc2_hall_smk_cone.prt though they are a little bright (but could be modified in the Particles Editor and resaved as a new particles effect.) There are also a couple of Dark Mod ones - chimney_smoke1.prt and chimney_smoke2.prt at this time. Other DM stuff is under tdm_ but it's worth exploring the whole list to see what is available.
* All that remains is to position your func_emitter over a chimney.
* Note that there is a DR bug that does not allow you to rotate the func_emitter on the X or Y planes; however, there's some question whether most particles care about where the emitter is rotated.

That will give you a start. Try out some of the others so you see what is available and what is possible and then you can move on to more advanced stuff...

* Note that 'Choose Model' does not assign a model or models to be emitted such as a leaf or snowflake (see [[Particle Editor]]) No, if you choose model then it just assigns a visible model shape to the entity in the normal way. I guess one could use a chimney pot in our example but the particle effect would have to be customised to line up so we shall create a separate particle effect and just place it over a chimney. Depends on what you are doing whether you need a model at the position of the particle effect. It does save on entities, but it is less flexible.

==Switching Particles on and off==

func_emitter can be turned on and off by using target from any targetting entity eg a button or lever.

Particle effects can also be created using the [[Stim/Response]] system.

==Starting OFF at game start==

To start a particle effect OFF at game start give the func_emitter the property and value...

start_off 1

You can then make it start when you want by using target from any targetting entity eg a button or lever.

Note that the particle effect may be very briefly visible at game start then turn off within a second. This is normal and I don't think can be avoided. In most cases this doesn't matter if the effect is not in the player's view right at game start.

== Creating Your Own Particle Effects ==

You can create your own particle effects - or even easier - modify existing ones. To do this read [[Particle Editor]].

== Soft Particles ==
Beginning in TDM 2.03, particle effects are softened where they intersect solid objects. There's no longer any need to move lamp glares away from walls, and dust/fog/smoke will appear to be shapeless 3d volumes instead of 2d images cut off at the floor and walls.

Soft particles start to fade out where they get close to solid objects. And when they intersect solid objects, they continue to draw over the top for a short distance. This "rubs out" any hard edges belonging to the 2d images that make up the particle effect, which stops the eye getting a fix on exactly where those images are and restores the illusion of a 3d volume.

The range over which the particle fades out -- and is allow to draw over solid stuff -- is proportional to the "radius" of the particle volume being represented. By default, it's 0.4 times the diameter of the particle stages' quads.

Soft particles can be toggled on and off using the cvar r_useSoftParticles.

Mappers don't have to do anything to take advantage of this -- it's enabled by default and will "just work" in 99% of cases -- but mappers can control the effect more precisely if they wish using the "SofteningRadius" keyword documented below.

== Particle decl keywords ==
Most particle settings are applied using the particle editor, but there are a few more keywords that can be added manually to the decl generated by the editor.

=== WorldAxis ===
Added in 2.03 to enable better candle smoke. If a particle stage has an offset to its origin, or if it moves in any way independent of gravity, WorldAxis will make that offset and movement use the world axis instead of the emitter's axis. Particles also have a WorldGravity keyword that's set using the particle editor. WorldGravity affects only movement under gravity. WorldAxis affects other kinds of movement plus offsets. Added so that candle smoke can rise upright at a constant rate no matter how the player turns the candle.

Example: the new candle smoke in 2.03 starts with a narrow plume of smoke emitted from the candle's wick (which is where the emitter is placed), followed by a wider volume of wispy smoke that spreads out from the top of the narrow plume. Both stages use WorldAxis: the first stage so that it can rise upright from a knocked-over candle at a constant rate; the second stage so that it always starts from a point ''above'' the candle even if the candle is on its side.

=== DepthHack ===
This is a primitive way of avoiding some particle intersections, the only one that was available in the original idTech4 engine. It's a keyword placed at the top of the particle decl and applies to all stages of the particle: it can't be applied separately to individual stages. It causes the particle to draw in front of solid objects by up to the specified number of units, e.g. "depthHack 20" was used in lamp glares to make them draw over things by up to 20 units.

DepthHack is overridden by the new soft particle technique in TDM 2.03. The keyword and its value are ignored, unless the particle decl turns off the new soft particles effect.

=== SofteningRadius ===
New particle stage keyword for TDM 2.03. Add this to individual particle ''stages'' to change the behaviour of soft particles. Accepted values are:
* -1: Turn off soft particles and draw this particle stage the old way, including using DepthHack if it's specified in the decl.
* 0: Turn off soft particles AND Depthhack.
* Any positive number: sets the particle "radius", which is the amount it's allowed to draw in front of anything solid that intersects it. Defaults to 0.4 times the max particle quad size for the stage. If you have a tricky particle that's showing through a wall, you can reduce the radius a bit. For example: a tdm_dustfog_03 with a max quad size of 100 will have a default radius of 40. If you want to put it in a confined space where it ends up showing through a wall, you could add "softeningRadius 30" to the stage to stop that happening.

[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]

Particle Editor

2015-02-08T10:12:35Z

SteveL: +Particle settings not set by the editor

Beginners and those who just want to use the already existing particle effects might like to first read [[Particles for Beginners]].

==Editing the particles themselves (size etc):==
The particle editor in DR is under menu option Entity > Particle Editor

[[Image:Ptcl editor.png|728px]]

:Note: this article refers to the older Doom3 particle editor, and the editor layout has been updated since. The options do the same things so the information is still valid.

Now to explain a few things. At the top you have the particle name next to "particle", next to it you have new, save, and save as. Now, for easiest editing of particles, load up an existing particle, such as the leaf one in the example, modify it and then use "save as". I will explain a bit more further down.

Firstly, and most importantly, we have material. This is the path to your material; not the image file but the material for your custom leaf. So for example you can see the example above has textures/particles/tdm_leaves_01. If you know the name of your material (for example textures/particles/green_leaves) then you can type that in there and press enter and it will find it by itself showing the changes in the render view.

Now that you can see your custom material we can continue on to the size of the leaves etc.

'''Bunching''' this determines how much the particles tend to bunch together, 0 meaning they want to spread out as evenly as possible, while 1 means that they bunch together a bit. The effect is not actually that noticeable mind.

'''Count''' controls how many particles there are, so basically the example shown has 32 particles in total. Obviously the more you have, the more dense the tree. This is a slider so slide it around as necessary. Alternatively you can input a value into the box and then press apply down the bottom right.

'''Cycles''' this is how long the effect will last in seconds, If you set "cycles 0.000", it is endless, otherwise repeated so many times. In my case I am creating some ceiling dust that is triggered so am going with 1 or 2 cycles.

To see the changes you are making, center your camera in the render view on the tree and press {{key|F7}} and {{key|F6}}. {{key|F7}} rebuilds everything and {{key|F6}} enables animations. Leave it in render view and move the particle editor to the side so you can see the render view (to watch the changes you are making as you make them).

You will also notice the "time" input beneath it. This is the lifespan of a particle in seconds. If I may suggest, don't mess with this, as putting it too low will make the particle lifespan visible, as in you'll notice them appearing/disappearing etc. If you put it to something ridiculous, like 99999, then it will load for extremely long, and sometimes not at all. It's best to leave it at 300 (5 minute), as you won't notice the tree leaves changing around every 5 minutes.

'''Distribution''' This is where things get a little more annoying. You'll notice 3 check dots - rect, cylinder, and sphere. Realistically you'd want to use sphere, but for some reason the algorithm for distribution in the sphere (at least for the leaves) does not work correctly and you get several particles occupying the same spot, which results in z-fighting and generally looks really bad. Now, the rectangle distribution works perfect; particles are properly distributed and there is no z-fighting, but it's a rectangular shape, but can look ok if not too many particles are used. Another alternative is the cylinder distribution. Cylinder distribution works well but annoyingly enough the particles get distributed only on the walls of the cylinder, which means a hole in the middle, so you need to adjust the particle size and cylinder size so that there is no hole in the middle.

The values to the right are the size values in doom units, so change that to roughly be the size you want the leaves to cover. If you selected cylindrical distribution, don't bother adding a ring value as it just makes it larger in diameter, so leave it at 0.

The offset is the offset from the center of the particle entity. Try keeping the leaves centered on the particle emitter, as Doom 3's light rendering system calculates whether or not to light the particles by checking whether the particle emitter is inside the boundary of the light; if yes then applies the lighting to it, but if not then it leaves the particle unaffected, ID did this for performance reasons.

'''Random Distribution''' is just what it says, so you may want to leave that ticked.

'''Speed''' leave that at 0 for the leaves as that is the speed at which the particles move away from the center of the emitter.

'''Size''' is self-explanatory; it's the size of each particle.

'''Rotation''' is rotation speed of the particle and aspect stretches the particle from the center of the emitter. So leave these 2 alone for leaves.

Notice that each of these has 2 sliders. This is for time based particles, so one slider is "from" and the second is "to". This is governed over the lifespan, so for example a particle that has sizes 0 to 50 and a lifespan of 10 would mean that it would gradually increase it's size to 50 from 0 over a span of 10 seconds. So for leaves this means that you leave both sliders at the same value. The other values below the speed, size, rotation, and aspect sliders do various things and you can mess around with them if you wish but they are not useful for leaves.

Now that you know what each value does, just mess around with them until you reach something that looks good.

'''Saving'''
- Press save as (presuming you modified one of the existing leaf particles) and it will come up with a dialog asking for the particle name.
- Enter the name you wish (for example green_leaves_01) and press {{ok}}.
- Now it comes up with a path dialog. Browse to the Doom3/base/particles folder (if there is no particles folder create one) and name it as what you want (this is the file name, not the particle name), for example something like "mymap_particles" and then press ok. [[Make sure you save it into doom3/base/particles as saving it into doom3/darkmod/particles WILL NOT WORK]].

[EDIT - Someone check me but I tested this and it does seem you can save it direct in the darkmod/particles folder but if you save it in base/particles then it goes in darkmod/particles anyway. Also note that if you select an existing file it will ''append'' it - it does not overwrite but adds new particles definitions to existing files if selected. - Fidcal] Once you save it there you will find the particle file (in this case "mymap_particles.prt") in the doom3/darkmod/particles folder; strange, yes, but it saves it there due to the way Doom 3 mod-loading works.

Now in DarkRadiant you should be able to find your new leaf particle when browsing through the particle list.

''Tutorial by Dram'' - updated by Bikerdude

== Particle settings not set by the editor ==
There are a few tweaks that can be added to particle decls manually, and that can't be set in the editor. See the [[Particles]] article for details.

{{editing}}[[Category:Particles]]

Particles

2015-02-08T10:08:18Z

SteveL: tidying up

== Introduction ==

Particles are VERY flexible - they can function as rain, snow, falling leaves, oscillating leaves and foliage, smoke, mist, flame, trickling sand, trickling water, drips, waterfall, spray, fountain - anything that can be made up of particles, big or small, fast or slow.

There are already many particle effects available to the Dark Mod mapper. This tutorial is just the basics of how to get particle effects, new or old, into your mission...

== Getting Particle effects into your game ==

First, all that is assumed is you know the essentials described in [[Dark Radiant Must Know Basic Intro]]

Like so many things - it's easy when you know how. Let me describe by example. Say you want to have some smoke coming out of a chimney in your mission...

* Right click and select Create Entity. Select func_emitter from the list.
* Add the property : model
* If you select the model property then you see two buttons at the bottom - Choose Model and Choose Particle.
* Select the Choose Particles button (see below for information on Choose Model)
* Select a particles effect from the list. For chimney smoke there are a couple of Doom ones - admin_hall_smk_cone.prt and mc2_hall_smk_cone.prt though they are a little bright (but could be modified in the Particles Editor and resaved as a new particles effect.) There are also a couple of Dark Mod ones - chimney_smoke1.prt and chimney_smoke2.prt at this time. Other DM stuff is under tdm_ but it's worth exploring the whole list to see what is available.
* All that remains is to position your func_emitter over a chimney.
* Note that there is a DR bug that does not allow you to rotate the func_emitter on the X or Y planes; however, there's some question whether most particles care about where the emitter is rotated.

That will give you a start. Try out some of the others so you see what is available and what is possible and then you can move on to more advanced stuff...

* Note that 'Choose Model' does not assign a model or models to be emitted such as a leaf or snowflake (see [[Particle Editor]]) No, if you choose model then it just assigns a visible model shape to the entity in the normal way. I guess one could use a chimney pot in our example but the particle effect would have to be customised to line up so we shall create a separate particle effect and just place it over a chimney. Depends on what you are doing whether you need a model at the position of the particle effect. It does save on entities, but it is less flexible.

==Switching Particles on and off==

func_emitter can be turned on and off by using target from any targetting entity eg a button or lever.

Particle effects can also be created using the [[Stim/Response]] system.

==Starting OFF at game start==

To start a particle effect OFF at game start give the func_emitter the property and value...

start_off 1

You can then make it start when you want by using target from any targetting entity eg a button or lever.

Note that the particle effect may be very briefly visible at game start then turn off within a second. This is normal and I don't think can be avoided. In most cases this doesn't matter if the effect is not in the player's view right at game start.

== Creating Your Own Particle Effects ==

You can create your own particle effects - or even easier - modify existing ones. To do this read [[Particle Editor]].

== Soft particles ==
Beginning in TDM 2.03, particle effects are softened where they intersect solid objects. There's no longer any need to move lamp glares away from walls, and dust/fog/smoke will appear to be shapeless 3d volumes instead of 2d images cut off into the floor and walls.

Soft particles start to fade out where they get close to solid objects. And when they intersect solid objects, they continue to draw over the top for a short distance. This "rubs out" any hard edges belonging to the 2d images that make up the particle effect, which stops the eye getting a fix on exactly where those images are and restores the illusion of a 3d volume.

The range over which the particle fades out -- and is allow to draw over solid stuff -- is proportional to the "radius" of the particle volume being represented. By default, it's 0.4 times the diameter of the particle stages' quads.

Soft particles can be toggled on and off using the cvar r_useSoftParticles.

Mappers don't have to do anything to take advantage of this -- it's enabled by default and will "just work" in 99% of cases -- but there are a couple of relevant particle decl keywords, including one new keyword for tricky spots:

=== DepthHack ===
This is a more primitive way of avoiding some particle intersections, the only one that was available in the original idTech4 engine. It's a keyword placed at the top of the particle decl and applies to all stages of the particle: it can't be applied separately to individual stages. It causes the particle to draw in front of solid objects by up to the specified number of units, e.g. "depthHack 20" was used in lamp glares to make them draw over things by up to 20 units.

DepthHack is overridden by the new soft particle technique in TDM 2.03. The keyword and its value are ignored, unless the particle decl turns off the new soft particles effect.

=== SofteningRadius ===
New particle stage keyword for TDM 2.03. Add this to individual particle ''stages'' to change the behaviour of soft particles. Accepted values are:
* -1: Turn off soft particles and draw this particle stage the old way, including using DepthHack if it's specified in the decl.
* 0: Turn off soft particles AND Depthhack.
* Any positive number: sets the particle "radius", which is the amount it's allowed to draw in front of anything solid that intersects it. Defaults to 0.4 times the max particle quad size for the stage. If you have a tricky particle that's showing through a wall, you can reduce the radius a bit. For example: a tdm_dustfog_03 with a max quad size of 100 will have a default radius of 40. If you want to put it in a confined space where it ends up showing through a wall, you could add "softeningRadius 30" to the stage to stop that happening.

[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]

Particles

2015-02-08T10:07:12Z

SteveL: + soft particles

''written by Fidcal''

== Introduction ==

Particles are VERY flexible - they can function as rain, snow, falling leaves, oscillating leaves and foliage, smoke, mist, flame, trickling sand, trickling water, drips, waterfall, spray, fountain - anything that can be made up of particles, big or small, fast or slow.

There are already many particle effects available to the Dark Mod mapper. This tutorial is just the basics of how to get particle effects, new or old, into your mission...

== Getting Particle effects into your game ==

First, all that is assumed is you know the essentials described in [[Dark Radiant Must Know Basic Intro]]

Like so many things - it's easy when you know how. Let me describe by example. Say you want to have some smoke coming out of a chimney in your mission...

* Right click and select Create Entity. Select func_emitter from the list.
* Add the property : model
* If you select the model property then you see two buttons at the bottom - Choose Model and Choose Particle.
* Select the Choose Particles button (see below for information on Choose Model)
* Select a particles effect from the list. For chimney smoke there are a couple of Doom ones - admin_hall_smk_cone.prt and mc2_hall_smk_cone.prt though they are a little bright (but could be modified in the Particles Editor and resaved as a new particles effect.) There are also a couple of Dark Mod ones - chimney_smoke1.prt and chimney_smoke2.prt at this time. Other DM stuff is under tdm_ but it's worth exploring the whole list to see what is available.
* All that remains is to position your func_emitter over a chimney.
* Note that there is a DR bug that does not allow you to rotate the func_emitter on the X or Y planes; however, there's some question whether most particles care about where the emitter is rotated.

That will give you a start. Try out some of the others so you see what is available and what is possible and then you can move on to more advanced stuff...

* Note that 'Choose Model' does not assign a model or models to be emitted such as a leaf or snowflake (see [[Particle Editor]]) No, if you choose model then it just assigns a visible model shape to the entity in the normal way. I guess one could use a chimney pot in our example but the particle effect would have to be customised to line up so we shall create a separate particle effect and just place it over a chimney. Depends on what you are doing whether you need a model at the position of the particle effect. It does save on entities, but it is less flexible.

==Switching Particles on and off==

func_emitter can be turned on and off by using target from any targetting entity eg a button or lever.

Particle effects can also be created using the [[Stim/Response]] system.

==Starting OFF at game start==

To start a particle effect OFF at game start give the func_emitter the property and value...

start_off 1

You can then make it start when you want by using target from any targetting entity eg a button or lever.

Note that the particle effect may be very briefly visible at game start then turn off within a second. This is normal and I don't think can be avoided. In most cases this doesn't matter if the effect is not in the player's view right at game start.

== Creating Your Own Particle Effects ==

You can create your own particle effects - or even easier - modify existing ones. To do this read [[Particle Editor]].

[[Category:Editing]][[Category:Tutorial]][[Category:Particles]]

== Soft particles ==
Beginning in TDM 2.03, particle effects are softened where they intersect solid objects. There's no longer any need to move lamp glares away from walls, and dust/fog/smoke will appear to be shapeless 3d volumes instead of 2d images cut off into the floor and walls.

Soft particles start to fade out where they get close to solid objects. And when they intersect solid objects, they continue to draw over the top for a short distance. This "rubs out" any hard edges belonging to the 2d images that make up the particle effect, which stops the eye getting a fix on exactly where those images are and restores the illusion of a 3d volume.

The range over which the particle fades out -- and is allow to draw over solid stuff -- is proportional to the "radius" of the particle volume being represented. By default, it's 0.4 times the diameter of the particle stages' quads.

Soft particles can be toggled on and off using the cvar r_useSoftParticles.

Mappers don't have to do anything to take advantage of this -- it's enabled by default and will "just work" in 99% of cases -- but there are a couple of relevant particle decl keywords, including one new keyword for tricky spots:

=== DepthHack ===
This is a more primitive way of avoiding some particle intersections, the only one that was available in the original idTech4 engine. It's a keyword placed at the top of the particle decl and applies to all stages of the particle: it can't be applied separately to individual stages. It causes the particle to draw in front of solid objects by up to the specified number of units, e.g. "depthHack 20" was used in lamp glares to make them draw over things by up to 20 units.

DepthHack is overridden by the new soft particle technique in TDM 2.03. The keyword and its value are ignored, unless the particle decl turns off the new soft particles effect.

=== SofteningRadius ===
New particle stage keyword for TDM 2.03. Add this to individual particle ''stages'' to change the behaviour of soft particles. Accepted values are:
* -1: Turn off soft particles and draw this particle stage the old way, including using DepthHack if it's specified in the decl.
* 0: Turn off soft particles AND Depthhack.
* Any positive number: sets the particle "radius", which is the amount it's allowed to draw in front of anything solid that intersects it. Defaults to 0.4 times the max particle quad size for the stage. If you have a tricky particle that's showing through a wall, you can reduce the radius a bit. For example: a tdm_dustfog_03 with a max quad size of 100 will have a default radius of 40. If you want to put it in a confined space where it ends up showing through a wall, you could add "softeningRadius 30" to the stage to stop that happening.

Cube maps

2015-02-08T07:24:20Z

SteveL: Doom3 -> TDM

''written by angua''


How to create a cube map (also called environmental map) of your environment using the envshot command in TDM.

Cube maps can be used to fake reflections e.g on water and highly reflective tiles, etc. The advantage is that rendering is faster.

You can also find more inflormation on Cube maps in the modwiki: [http://web.archive.org/web/20080607193940/http://www.modwiki.net/wiki/Cube_maps Wayback archive]

==Create your room==
Create the room you want to have your pseudo-reflective water in. Add all the large parts, but you can leave small details (and of course the AI) out. Your room might for example look like this:

[[Image:Cube map empty.jpg|320px|Example room]]

==Create your images==
* Set the screen resolution of TDM to 640 x 480. If you don't, parts of your images will be cut off and they will not fit together any more. You will have to restart TDM or use console command vid_restart for the changes to take effect.

* Open your map in TDM and get to the position of your water (at the center of the water source, about surface level, you can use noclip if you can't get there by walking).

* In the console, type

envshot [prefix] [size]

[prefix] is how the images are going to be named. The size should be in powers of two. For example, your command could look like this:

envshot water_pool 512

Press enter, and you will see some flickering on the screen while your images are created, and a message in the console will appear saying

Wrote env/water_pool_nz.tga,etc.

You might want to make a few more envshots at slightly different positions, so that you don't have to repeat the whole procedure if your images are not appropriate. The direction at which you are facing during the shots is not important.

* You should now see six new images in your /env folder:

water_pool_nx.tga
water_pool_ny.tga
water_pool_nz.tga
water_pool_px.tga
water_pool_py.tga
water_pool_pz.tga

looking like this:

[[Image:Cube map.jpg|320px|Cube map after shot]]

You can of course also move them to a different folder if you want.

==Edit your images==
:''This section won't be necessary in TDM 2.04. The images will be named and oriented correctly.''

If you leave the images like this, they will not work ingame. You have to rename them and there is also some rotating and flipping required. (Note that this works for me if the reflecting surface is located at the bottom facing upwards, the required procedure might be different if the reflection is located at the walls or the ceiling).

* Rename water_pool_nx to water_pool_back. Rotate it 90° counter clock wise and flip it horizontally. This is going to be located at the west.
* Rename water_pool_ny to water_pool_right. Flip it horizontally. This is going to be located at the south.
* Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.
* Rename water_pool_px to water_pool_forward. Rotate it 90° clock wise and flip it horizontally. This is going to be located at the east.
* Rename water_pool_py to water_pool_left. Rotate it 180° and flip it horizontally. This is going to be located at the north.
* Rename water_pool_pz to water_pool_up. Flip it horizontally and rotate it 90° counter clock wise.

*Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.

You should now have six files in your /env folder (or wherever you moved them) called

water_pool_back
water_pool_right
water_pool_down
water_pool_forward
water_pool_left
water_pool_up

looking like this:

[[Image:Cube map processed.jpg|320px|Cube maps processed]]

You can also add some blurryness if you want. That makes it less obvious that the reflection is faked by a static image.

==Write a material shader==
Open an already existing material file or create a new one. Add the following shader:

textures/env/water_pool
{
qer_editorimage env/water_pool_up.tga

noFragment
noshadows
noimpact
nooverlays
forceOpaque
nonsolid

{
forceHighQuality
blend add
cameraCubeMap env/water_pool
texgen reflect
}
}

If you have forceOpaque in your shader, the texture will be opaque and you will not be able to see the ground. If you leave it out, it will be semi-transparent and you can see the ground also.
If you moved the images to a different folder, make sure that the correct paths are entered at the qer_editorimage and the cameraCubemap lines. (The path entered in the name of the shader (before the { ) is for the folder the texture will appear in Darkradiant. It can be different from the path the images are in.)

==Get your enviromental map ingame==

* Open DarkRadiant (if you already have it open you might have to close and reopen it to be able to see the texture).
* Draw a brush that is going to be your water. Texture it with common/nodraw.
* Go to the media browser. You should find your texture in the /env folder. (If you wrote another path in the name of your shader, it will appear there.)
[[Image:Cubemap1.jpg|300px]]

* Apply it to the top face of the water brush. You should now see the water_pool_up image as editor image (that's what the qer_editorimage line in the shader was for). Scale and position of the texture is not important.

[[Image:Cubemap2.jpg|300px]]
* Convert the brush to a func_liquid. (You don't want to be able to walk on water, do you? That would happen if you didn't convert your brush.) For more detailed information on water creation, you can also look at the [[Swimmable Water]] tutorial.

* you should now be able to see your water ingame.

[[Image:Cubemap3.jpg|300px]]

It will still look flat, like a mirror, and you will see that it is a static image (the torch is not flickering) so you might want to add a patch slightly above the water textured with, e.g. water_clear (or any other water texture that produces water waves).

[[Image:Cubemap4.jpg|300px]]

Here you can see the same pool textured with true reflective water for comparison:

[[Image:Cubemap5.jpg|300px]]

==Notes==

You have to take into consideration that in contrast to a true reflection, the cube map texture will not react to changes in the environment. So if you for example put the torch out, it will still be lit in the cube map.

[[Image:Cubemap6.jpg|300px]]

So it would be more practical to have non-extinguishable lights and no large moveables near the water.

{{tutorial-editing}}
[[Category:Skybox]]

Cube maps

2015-02-08T07:23:52Z

SteveL: /* Create your images */ Doom3 -> TDM

''written by angua''


How to create a cube map (also called environmental map) of your environment using the envshot command in Doom3.

Cube maps can be used to fake reflections e.g on water and highly reflective tiles, etc. The advantage is that rendering is faster.

You can also find more inflormation on Cube maps in the modwiki: [http://web.archive.org/web/20080607193940/http://www.modwiki.net/wiki/Cube_maps Wayback archive]

==Create your room==
Create the room you want to have your pseudo-reflective water in. Add all the large parts, but you can leave small details (and of course the AI) out. Your room might for example look like this:

[[Image:Cube map empty.jpg|320px|Example room]]

==Create your images==
* Set the screen resolution of TDM to 640 x 480. If you don't, parts of your images will be cut off and they will not fit together any more. You will have to restart TDM or use console command vid_restart for the changes to take effect.

* Open your map in TDM and get to the position of your water (at the center of the water source, about surface level, you can use noclip if you can't get there by walking).

* In the console, type

envshot [prefix] [size]

[prefix] is how the images are going to be named. The size should be in powers of two. For example, your command could look like this:

envshot water_pool 512

Press enter, and you will see some flickering on the screen while your images are created, and a message in the console will appear saying

Wrote env/water_pool_nz.tga,etc.

You might want to make a few more envshots at slightly different positions, so that you don't have to repeat the whole procedure if your images are not appropriate. The direction at which you are facing during the shots is not important.

* You should now see six new images in your /env folder:

water_pool_nx.tga
water_pool_ny.tga
water_pool_nz.tga
water_pool_px.tga
water_pool_py.tga
water_pool_pz.tga

looking like this:

[[Image:Cube map.jpg|320px|Cube map after shot]]

You can of course also move them to a different folder if you want.

==Edit your images==
:''This section won't be necessary in TDM 2.04. The images will be named and oriented correctly.''

If you leave the images like this, they will not work ingame. You have to rename them and there is also some rotating and flipping required. (Note that this works for me if the reflecting surface is located at the bottom facing upwards, the required procedure might be different if the reflection is located at the walls or the ceiling).

* Rename water_pool_nx to water_pool_back. Rotate it 90° counter clock wise and flip it horizontally. This is going to be located at the west.
* Rename water_pool_ny to water_pool_right. Flip it horizontally. This is going to be located at the south.
* Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.
* Rename water_pool_px to water_pool_forward. Rotate it 90° clock wise and flip it horizontally. This is going to be located at the east.
* Rename water_pool_py to water_pool_left. Rotate it 180° and flip it horizontally. This is going to be located at the north.
* Rename water_pool_pz to water_pool_up. Flip it horizontally and rotate it 90° counter clock wise.

*Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.

You should now have six files in your /env folder (or wherever you moved them) called

water_pool_back
water_pool_right
water_pool_down
water_pool_forward
water_pool_left
water_pool_up

looking like this:

[[Image:Cube map processed.jpg|320px|Cube maps processed]]

You can also add some blurryness if you want. That makes it less obvious that the reflection is faked by a static image.

==Write a material shader==
Open an already existing material file or create a new one. Add the following shader:

textures/env/water_pool
{
qer_editorimage env/water_pool_up.tga

noFragment
noshadows
noimpact
nooverlays
forceOpaque
nonsolid

{
forceHighQuality
blend add
cameraCubeMap env/water_pool
texgen reflect
}
}

If you have forceOpaque in your shader, the texture will be opaque and you will not be able to see the ground. If you leave it out, it will be semi-transparent and you can see the ground also.
If you moved the images to a different folder, make sure that the correct paths are entered at the qer_editorimage and the cameraCubemap lines. (The path entered in the name of the shader (before the { ) is for the folder the texture will appear in Darkradiant. It can be different from the path the images are in.)

==Get your enviromental map ingame==

* Open DarkRadiant (if you already have it open you might have to close and reopen it to be able to see the texture).
* Draw a brush that is going to be your water. Texture it with common/nodraw.
* Go to the media browser. You should find your texture in the /env folder. (If you wrote another path in the name of your shader, it will appear there.)
[[Image:Cubemap1.jpg|300px]]

* Apply it to the top face of the water brush. You should now see the water_pool_up image as editor image (that's what the qer_editorimage line in the shader was for). Scale and position of the texture is not important.

[[Image:Cubemap2.jpg|300px]]
* Convert the brush to a func_liquid. (You don't want to be able to walk on water, do you? That would happen if you didn't convert your brush.) For more detailed information on water creation, you can also look at the [[Swimmable Water]] tutorial.

* you should now be able to see your water ingame.

[[Image:Cubemap3.jpg|300px]]

It will still look flat, like a mirror, and you will see that it is a static image (the torch is not flickering) so you might want to add a patch slightly above the water textured with, e.g. water_clear (or any other water texture that produces water waves).

[[Image:Cubemap4.jpg|300px]]

Here you can see the same pool textured with true reflective water for comparison:

[[Image:Cubemap5.jpg|300px]]

==Notes==

You have to take into consideration that in contrast to a true reflection, the cube map texture will not react to changes in the environment. So if you for example put the torch out, it will still be lit in the cube map.

[[Image:Cubemap6.jpg|300px]]

So it would be more practical to have non-extinguishable lights and no large moveables near the water.

{{tutorial-editing}}
[[Category:Skybox]]

Cube maps

2015-02-08T07:23:24Z

SteveL: /* Create your images */

''written by angua''


How to create a cube map (also called environmental map) of your environment using the envshot command in Doom3.

Cube maps can be used to fake reflections e.g on water and highly reflective tiles, etc. The advantage is that rendering is faster.

You can also find more inflormation on Cube maps in the modwiki: [http://web.archive.org/web/20080607193940/http://www.modwiki.net/wiki/Cube_maps Wayback archive]

==Create your room==
Create the room you want to have your pseudo-reflective water in. Add all the large parts, but you can leave small details (and of course the AI) out. Your room might for example look like this:

[[Image:Cube map empty.jpg|320px|Example room]]

==Create your images==
* Set the screen resolution of Doom3 to 640 x 480. If you don't, parts of your images willbe cut off and they will not fit together any more. You will have to restart TDM or use console command vid_restart for the changes to take effect.

* Open your map in TDM and get to the position of your water (at the center of the water source, about surface level, you can use noclip if you can't get there by walking).

* In the console, type

envshot [prefix] [size]

[prefix] is how the images are going to be named. The size should be in powers of two. For example, your command could look like this:

envshot water_pool 512

Press enter, and you will see some flickering on the screen while your images are created, and a message in the console will appear saying

Wrote env/water_pool_nz.tga,etc.

You might want to make a few more envshots at slightly different positions, so that you don't have to repeat the whole procedure if your images are not appropriate. The direction at which you are facing during the shots is not important.

* You should now see six new images in your /env folder:

water_pool_nx.tga
water_pool_ny.tga
water_pool_nz.tga
water_pool_px.tga
water_pool_py.tga
water_pool_pz.tga

looking like this:

[[Image:Cube map.jpg|320px|Cube map after shot]]

You can of course also move them to a different folder if you want.

==Edit your images==
:''This section won't be necessary in TDM 2.04. The images will be named and oriented correctly.''

If you leave the images like this, they will not work ingame. You have to rename them and there is also some rotating and flipping required. (Note that this works for me if the reflecting surface is located at the bottom facing upwards, the required procedure might be different if the reflection is located at the walls or the ceiling).

* Rename water_pool_nx to water_pool_back. Rotate it 90° counter clock wise and flip it horizontally. This is going to be located at the west.
* Rename water_pool_ny to water_pool_right. Flip it horizontally. This is going to be located at the south.
* Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.
* Rename water_pool_px to water_pool_forward. Rotate it 90° clock wise and flip it horizontally. This is going to be located at the east.
* Rename water_pool_py to water_pool_left. Rotate it 180° and flip it horizontally. This is going to be located at the north.
* Rename water_pool_pz to water_pool_up. Flip it horizontally and rotate it 90° counter clock wise.

*Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.

You should now have six files in your /env folder (or wherever you moved them) called

water_pool_back
water_pool_right
water_pool_down
water_pool_forward
water_pool_left
water_pool_up

looking like this:

[[Image:Cube map processed.jpg|320px|Cube maps processed]]

You can also add some blurryness if you want. That makes it less obvious that the reflection is faked by a static image.

==Write a material shader==
Open an already existing material file or create a new one. Add the following shader:

textures/env/water_pool
{
qer_editorimage env/water_pool_up.tga

noFragment
noshadows
noimpact
nooverlays
forceOpaque
nonsolid

{
forceHighQuality
blend add
cameraCubeMap env/water_pool
texgen reflect
}
}

If you have forceOpaque in your shader, the texture will be opaque and you will not be able to see the ground. If you leave it out, it will be semi-transparent and you can see the ground also.
If you moved the images to a different folder, make sure that the correct paths are entered at the qer_editorimage and the cameraCubemap lines. (The path entered in the name of the shader (before the { ) is for the folder the texture will appear in Darkradiant. It can be different from the path the images are in.)

==Get your enviromental map ingame==

* Open DarkRadiant (if you already have it open you might have to close and reopen it to be able to see the texture).
* Draw a brush that is going to be your water. Texture it with common/nodraw.
* Go to the media browser. You should find your texture in the /env folder. (If you wrote another path in the name of your shader, it will appear there.)
[[Image:Cubemap1.jpg|300px]]

* Apply it to the top face of the water brush. You should now see the water_pool_up image as editor image (that's what the qer_editorimage line in the shader was for). Scale and position of the texture is not important.

[[Image:Cubemap2.jpg|300px]]
* Convert the brush to a func_liquid. (You don't want to be able to walk on water, do you? That would happen if you didn't convert your brush.) For more detailed information on water creation, you can also look at the [[Swimmable Water]] tutorial.

* you should now be able to see your water ingame.

[[Image:Cubemap3.jpg|300px]]

It will still look flat, like a mirror, and you will see that it is a static image (the torch is not flickering) so you might want to add a patch slightly above the water textured with, e.g. water_clear (or any other water texture that produces water waves).

[[Image:Cubemap4.jpg|300px]]

Here you can see the same pool textured with true reflective water for comparison:

[[Image:Cubemap5.jpg|300px]]

==Notes==

You have to take into consideration that in contrast to a true reflection, the cube map texture will not react to changes in the environment. So if you for example put the torch out, it will still be lit in the cube map.

[[Image:Cubemap6.jpg|300px]]

So it would be more practical to have non-extinguishable lights and no large moveables near the water.

{{tutorial-editing}}
[[Category:Skybox]]

Cube maps

2015-02-08T07:22:08Z

SteveL: /* Create your images */ removing instruction that player must be in fullscreen mode. That's not necessary.

''written by angua''


How to create a cube map (also called environmental map) of your environment using the envshot command in Doom3.

Cube maps can be used to fake reflections e.g on water and highly reflective tiles, etc. The advantage is that rendering is faster.

You can also find more inflormation on Cube maps in the modwiki: [http://web.archive.org/web/20080607193940/http://www.modwiki.net/wiki/Cube_maps Wayback archive]

==Create your room==
Create the room you want to have your pseudo-reflective water in. Add all the large parts, but you can leave small details (and of course the AI) out. Your room might for example look like this:

[[Image:Cube map empty.jpg|320px|Example room]]

==Create your images==
* Set the screen resolution of Doom3 to 640 x 480. If you don't, part of your images might be cut off and they will not fit together any more. You might have to close and reopen Doom3 for the changes to take effect.

* Open your map in Doom3 and get to the position of your water (at the center of the water source, about surface level, you can use noclip if you can't get there by walking).

* In the console, type

envshot [prefix] [size]

[prefix] is how the images are going to be named. The size should be in powers of two. For example, your command could look like this:

envshot water_pool 512

Press enter, and you will see some flickering on the screen while your images are created, and a message in the console will appear saying

Wrote env/water_pool_nz.tga,etc.

You might want to make a few more envshots at slightly different positions, so that you don't have to repeat the whole procedure if your images are not appropriate. The direction at which you are facing during the shots is not important.

* You should now see six new images in your /env folder:

water_pool_nx.tga
water_pool_ny.tga
water_pool_nz.tga
water_pool_px.tga
water_pool_py.tga
water_pool_pz.tga

looking like this:

[[Image:Cube map.jpg|320px|Cube map after shot]]

You can of course also move them to a different folder if you want.

==Edit your images==
:''This section won't be necessary in TDM 2.04. The images will be named and oriented correctly.''

If you leave the images like this, they will not work ingame. You have to rename them and there is also some rotating and flipping required. (Note that this works for me if the reflecting surface is located at the bottom facing upwards, the required procedure might be different if the reflection is located at the walls or the ceiling).

* Rename water_pool_nx to water_pool_back. Rotate it 90° counter clock wise and flip it horizontally. This is going to be located at the west.
* Rename water_pool_ny to water_pool_right. Flip it horizontally. This is going to be located at the south.
* Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.
* Rename water_pool_px to water_pool_forward. Rotate it 90° clock wise and flip it horizontally. This is going to be located at the east.
* Rename water_pool_py to water_pool_left. Rotate it 180° and flip it horizontally. This is going to be located at the north.
* Rename water_pool_pz to water_pool_up. Flip it horizontally and rotate it 90° counter clock wise.

*Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.

You should now have six files in your /env folder (or wherever you moved them) called

water_pool_back
water_pool_right
water_pool_down
water_pool_forward
water_pool_left
water_pool_up

looking like this:

[[Image:Cube map processed.jpg|320px|Cube maps processed]]

You can also add some blurryness if you want. That makes it less obvious that the reflection is faked by a static image.

==Write a material shader==
Open an already existing material file or create a new one. Add the following shader:

textures/env/water_pool
{
qer_editorimage env/water_pool_up.tga

noFragment
noshadows
noimpact
nooverlays
forceOpaque
nonsolid

{
forceHighQuality
blend add
cameraCubeMap env/water_pool
texgen reflect
}
}

If you have forceOpaque in your shader, the texture will be opaque and you will not be able to see the ground. If you leave it out, it will be semi-transparent and you can see the ground also.
If you moved the images to a different folder, make sure that the correct paths are entered at the qer_editorimage and the cameraCubemap lines. (The path entered in the name of the shader (before the { ) is for the folder the texture will appear in Darkradiant. It can be different from the path the images are in.)

==Get your enviromental map ingame==

* Open DarkRadiant (if you already have it open you might have to close and reopen it to be able to see the texture).
* Draw a brush that is going to be your water. Texture it with common/nodraw.
* Go to the media browser. You should find your texture in the /env folder. (If you wrote another path in the name of your shader, it will appear there.)
[[Image:Cubemap1.jpg|300px]]

* Apply it to the top face of the water brush. You should now see the water_pool_up image as editor image (that's what the qer_editorimage line in the shader was for). Scale and position of the texture is not important.

[[Image:Cubemap2.jpg|300px]]
* Convert the brush to a func_liquid. (You don't want to be able to walk on water, do you? That would happen if you didn't convert your brush.) For more detailed information on water creation, you can also look at the [[Swimmable Water]] tutorial.

* you should now be able to see your water ingame.

[[Image:Cubemap3.jpg|300px]]

It will still look flat, like a mirror, and you will see that it is a static image (the torch is not flickering) so you might want to add a patch slightly above the water textured with, e.g. water_clear (or any other water texture that produces water waves).

[[Image:Cubemap4.jpg|300px]]

Here you can see the same pool textured with true reflective water for comparison:

[[Image:Cubemap5.jpg|300px]]

==Notes==

You have to take into consideration that in contrast to a true reflection, the cube map texture will not react to changes in the environment. So if you for example put the torch out, it will still be lit in the cube map.

[[Image:Cubemap6.jpg|300px]]

So it would be more practical to have non-extinguishable lights and no large moveables near the water.

{{tutorial-editing}}
[[Category:Skybox]]

Cube maps

2015-02-08T07:20:42Z

SteveL: /* Edit your images */ This section won't be necessary in TDM 2.04

''written by angua''


How to create a cube map (also called environmental map) of your environment using the envshot command in Doom3.

Cube maps can be used to fake reflections e.g on water and highly reflective tiles, etc. The advantage is that rendering is faster.

You can also find more inflormation on Cube maps in the modwiki: [http://web.archive.org/web/20080607193940/http://www.modwiki.net/wiki/Cube_maps Wayback archive]

==Create your room==
Create the room you want to have your pseudo-reflective water in. Add all the large parts, but you can leave small details (and of course the AI) out. Your room might for example look like this:

[[Image:Cube map empty.jpg|320px|Example room]]

==Create your images==
* Set the screen resolution of Doom3 to 640 x 480. If you don't, part of your images might be cut off and they will not fit together any more. You might have to close and reopen Doom3 for the changes to take effect.

* Make sure you are on full screen before you take your images. (If you don't, you can see the windows task bar and it doesn't look that good ingame.) If you are in windowed mode, you can change to full screen by pressing Alt + Enter.

* Open your map in Doom3 and get to the position of your water (at the center of the water source, about surface level, you can use noclip if you can't get there by walking).

* In the console, type

envshot [prefix] [size]

[prefix] is how the images are going to be named. The size should be in powers of two. For example, your command could look like this:

envshot water_pool 512

Press enter, and you will see some flickering on the screen while your images are created, and a message in the console will appear saying

Wrote env/water_pool_nz.tga,etc.

You might want to make a few more envshots at slightly different positions, so that you don't have to repeat the whole procedure if your images are not appropriate. The direction at which you are facing during the shots is not important.

* You should now see six new images in your /env folder:

water_pool_nx.tga
water_pool_ny.tga
water_pool_nz.tga
water_pool_px.tga
water_pool_py.tga
water_pool_pz.tga

looking like this:

[[Image:Cube map.jpg|320px|Cube map after shot]]

You can of course also move them to a different folder if you want.

==Edit your images==
:''This section won't be necessary in TDM 2.04. The images will be named and oriented correctly.''

If you leave the images like this, they will not work ingame. You have to rename them and there is also some rotating and flipping required. (Note that this works for me if the reflecting surface is located at the bottom facing upwards, the required procedure might be different if the reflection is located at the walls or the ceiling).

* Rename water_pool_nx to water_pool_back. Rotate it 90° counter clock wise and flip it horizontally. This is going to be located at the west.
* Rename water_pool_ny to water_pool_right. Flip it horizontally. This is going to be located at the south.
* Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.
* Rename water_pool_px to water_pool_forward. Rotate it 90° clock wise and flip it horizontally. This is going to be located at the east.
* Rename water_pool_py to water_pool_left. Rotate it 180° and flip it horizontally. This is going to be located at the north.
* Rename water_pool_pz to water_pool_up. Flip it horizontally and rotate it 90° counter clock wise.

*Rename water_pool_nz to water_pool_down. You don't have to manipulate the direction here, since it is located at the bottom and will not be visible anyway.

You should now have six files in your /env folder (or wherever you moved them) called

water_pool_back
water_pool_right
water_pool_down
water_pool_forward
water_pool_left
water_pool_up

looking like this:

[[Image:Cube map processed.jpg|320px|Cube maps processed]]

You can also add some blurryness if you want. That makes it less obvious that the reflection is faked by a static image.

==Write a material shader==
Open an already existing material file or create a new one. Add the following shader:

textures/env/water_pool
{
qer_editorimage env/water_pool_up.tga

noFragment
noshadows
noimpact
nooverlays
forceOpaque
nonsolid

{
forceHighQuality
blend add
cameraCubeMap env/water_pool
texgen reflect
}
}

If you have forceOpaque in your shader, the texture will be opaque and you will not be able to see the ground. If you leave it out, it will be semi-transparent and you can see the ground also.
If you moved the images to a different folder, make sure that the correct paths are entered at the qer_editorimage and the cameraCubemap lines. (The path entered in the name of the shader (before the { ) is for the folder the texture will appear in Darkradiant. It can be different from the path the images are in.)

==Get your enviromental map ingame==

* Open DarkRadiant (if you already have it open you might have to close and reopen it to be able to see the texture).
* Draw a brush that is going to be your water. Texture it with common/nodraw.
* Go to the media browser. You should find your texture in the /env folder. (If you wrote another path in the name of your shader, it will appear there.)
[[Image:Cubemap1.jpg|300px]]

* Apply it to the top face of the water brush. You should now see the water_pool_up image as editor image (that's what the qer_editorimage line in the shader was for). Scale and position of the texture is not important.

[[Image:Cubemap2.jpg|300px]]
* Convert the brush to a func_liquid. (You don't want to be able to walk on water, do you? That would happen if you didn't convert your brush.) For more detailed information on water creation, you can also look at the [[Swimmable Water]] tutorial.

* you should now be able to see your water ingame.

[[Image:Cubemap3.jpg|300px]]

It will still look flat, like a mirror, and you will see that it is a static image (the torch is not flickering) so you might want to add a patch slightly above the water textured with, e.g. water_clear (or any other water texture that produces water waves).

[[Image:Cubemap4.jpg|300px]]

Here you can see the same pool textured with true reflective water for comparison:

[[Image:Cubemap5.jpg|300px]]

==Notes==

You have to take into consideration that in contrast to a true reflection, the cube map texture will not react to changes in the environment. So if you for example put the torch out, it will still be lit in the cube map.

[[Image:Cubemap6.jpg|300px]]

So it would be more practical to have non-extinguishable lights and no large moveables near the water.

{{tutorial-editing}}
[[Category:Skybox]]

World Particle System

2015-01-11T22:21:36Z

SteveL: /* "Natural" timing */

:''This article describes a feature that will become available in TDM 2.03.''

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of any emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==
Script event sys.emitParticle is used for all world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

===Single quad emission===
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

==="Natural" timing===
To make sys.emitParticle emit particle quads just like a func_emitter would, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.emitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles of the same kind will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

World Particle System

2015-01-11T22:19:02Z

SteveL: /* Usage */

:''This article describes a feature that will become available in TDM 2.03.''

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of any emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==
Script event sys.emitParticle is used for all world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

===Single quad emission===
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

==="Natural" timing===
To make sys.emitParticle emit particle quads just like a func_emitter would, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.EmitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles of the same kind will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

World Particle System

2015-01-11T22:04:41Z

SteveL: /* Performance considerations */

:''This article describes a feature that will become available in TDM 2.03.''

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of any emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==
Script event sys.EmitParticle is used for all world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

===Single quad emission===
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

==="Natural" timing===
To make sys.emitParticle emit particle quads just like a func_emitter would, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.EmitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles of the same kind will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

World Particle System

2015-01-11T22:01:18Z

SteveL: /* Usage */

:''This article describes a feature that will become available in TDM 2.03.''

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of any emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==
Script event sys.EmitParticle is used for all world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

===Single quad emission===
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

==="Natural" timing===
To make sys.emitParticle emit particle quads just like a func_emitter would, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.EmitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles that use the same texture will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

World Particle System

2015-01-11T21:59:31Z

SteveL:

:''This article describes a feature that will become available in TDM 2.03.''

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of any emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==
Script event sys.EmitParticle is used for all world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from the guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

===Single quad emission===
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

==="Natural" timing===
To make sys.emitParticle emit particle quads just like a func_emitter would, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.EmitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles that use the same texture will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

World Particle System

2015-01-11T21:54:19Z

SteveL: /* Performance considerations */

:''This article describes a feature that will become available in TDM 2.03.''

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of the emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==
Script event sys.EmitParticle is used for all world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from the guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

===Single quad emission===
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

==="Natural" timing===
To make sys.emitParticle emit particle quads just like a func_emitter would, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.EmitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles that use the same texture will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Editing]][[Category:Particles]]

World Particle System

2015-01-11T21:53:49Z

SteveL: Creating article

:''This article describes a feature that will become available in TDM 2.03.''

The world particle system allows particles to exist in the world independent of any emitter entity. It enables effects like trailing smoke where the emitted smoke rises naturally instead of moving with the emitter, as well as fine-grained control of the emission of individual particle quads.

In TDM 2.03, the world particle system is usable only via scripting. We plan to add more user-friendly methods for mappers in 2.04, as well as to add it to some stock entities.

TDM 2.03 supports 3 particle systems: weather patches, that emit particles like rain or snow from a wide surface; func_emitters, entities that emit particles from a point; and the world particle system that's controlled by scripts. If you want a particle effect to be emitted from a stationary spot, use a func_emitter or a weather patch. If you want a particle that should always move with its emitter, for example a lamp glare, use a func_emitter bound to the light source. World particles are for effects that once released take their own path independent of the movement of the emitter, like trailing smoke, or for effects where you need fine-grained control of the release of individual particle quads.

==Usage==
Script event sys.EmitParticle is used for all world particle system emissions.

From the script reference:
<blockquote>
'''scriptEvent float ''emitParticle''(string particle, float startTime, float diversity, vector origin, vector angle);'''

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
</blockquote>

"origin" is where the quad will be released from. You can use an entity origin as reference: using $player1.getOrigin(), for example, will emit the quad from between the player's feet. Using $guard2.getEyePos() will emit it from the guard2's eyes.

Once you have emitted a particle quad, you have no further control over it. It will go its own way according to the path specified in the [[Particle_Editor|particle decl]].

The script event is designed to be called every frame if you want to achieve "normal" particle emission as specified in the particle decl. It needs to be given a start time, which it uses to determine whether it should emit a quad or not right now.

===Single quad emission===
Calling emitParticle with the current time -- sys.getTime() -- as the startTime parameter will always emit a quad, the first that would be emitted by the specified particle effect. That's because particle effects always emit their first quad as soon as they start up no matter what timing is specified in the particle decl.

==="Natural" timing===
To make sys.emitParticle emit particle quads just like a func_emitter would, using the timings specified in the particle decl, call it with the same "startTime" every frame. Typically your script will start with the current time, and store that time so that you can pass the same time in every frame. Your code will continue doing that until emitParticle returns false (0), meaning that all quads for the particle effect have now been released:

<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt> </tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

For example, if you are using a particle effect that emits one quad every second, and you call sys.EmitParticle every frame, i.e. 60 times per second, then it will emit 1 particle every 60th call. The 59 calls in between will not emit anything.

Unlike func_emitters, emitParticle does not support cycling particle effects. If you want your emissions to carry on forever, you have to repeat the above instructions for ever in your script, e.g:

<tt>while (1) // cycle for ever</tt>
<tt>{</tt>
<tt> float starttime = sys.getTime();</tt>
<tt> float more_to_come = 1;</tt>
<tt> </tt>
<tt> while ( more_to_come )</tt>
<tt> {</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt> }</tt>
<tt>}</tt>

== Example ==
The following script emits a trailing smoke particle effect from an extinguished candle using the "natural" timing method and without cycling.

This is an exaggerated version of the standard 2.03 candle smoke effect, where the particle decl has been tweaked to increase the number, size, and duration of the particle quads.

The script runs through the particle effect once without cycling. The only change from the script given above is that it calculates the origin of the candle top every frame from the origin of the candle base and its current orientation, so if the player is moving the candle during the effect, the smoke comes out of the right place.

<tt>float candle_height = 17; // height of wick above candle holder </tt>
<tt> </tt>
<tt>float starttime = sys.getTime();</tt>
<tt>float more_to_come = 1;</tt>
<tt>while ( more_to_come )</tt>
<tt>{</tt>
<tt> vector candle_top = sys.angToUp( $candle_holder.getAngles() ) * candle_height;</tt>
<tt> vector smoke_origin = $candle_holder.getOrigin() + candle_top;</tt>
<tt> more_to_come = sys.emitParticle("tdm_smoke_candleout", starttime, sys.random(1), smoke_origin, '0 0 0');</tt>
<tt> sys.waitFrame();</tt>
<tt>}</tt>

=== Video of the result ===
[http://youtu.be/OdctCfJjv8g YouTube video]

==Performance considerations==
Particles emitted by weather patches and func_emitters are rendered only if the particle effect might appear in some area of the map that the player can see. Particle effects on the far side of the map will be "turned off". World particles are different: they are rendered every frame no matter whether the player has any chance of seeing them or not. They won't actually be drawn if not in view -- i.e. converted to screen pixels and coloured in -- but their positions will be calculated and passed to the graphics card every frame. If you have a thousand trailing particle emitters in your map, using a variety of different particle effects, you are likely to see an impact on FPS.

On the other hand, world particles enjoy some performance advantages over other types of particle. Weather patches and func_emitters each generate their own individual draw call every frame that they are in view. If you have two smoking torches next to one another, that's 2 draw calls each frame for the smoke.

All world particles that use the same texture will be drawn in a single draw call, no matter how spread out they are in the map. So adding more world smoke emitters will increase calculations a bit, but it won't add more draw calls.

[[Category:Particles]]

Particle Editor

2015-01-11T18:24:58Z

SteveL: Adding Category:Particles

Beginners and those who just want to use the already existing particle effects might like to first read [[Particles for Beginners]].

===Editing the particles themselves (size etc):===
The particle editor in DR is under menu option Entity > Particle Editor

[[Image:Ptcl editor.png|728px]]

:Note: this article refers to the older Doom3 particle editor, and the editor layout has been updated since. The options do the same things so the information is still valid.

Now to explain a few things. At the top you have the particle name next to "particle", next to it you have new, save, and save as. Now, for easiest editing of particles, load up an existing particle, such as the leaf one in the example, modify it and then use "save as". I will explain a bit more further down.

Firstly, and most importantly, we have material. This is the path to your material; not the image file but the material for your custom leaf. So for example you can see the example above has textures/particles/tdm_leaves_01. If you know the name of your material (for example textures/particles/green_leaves) then you can type that in there and press enter and it will find it by itself showing the changes in the render view.

Now that you can see your custom material we can continue on to the size of the leaves etc.

'''Bunching''' this determines how much the particles tend to bunch together, 0 meaning they want to spread out as evenly as possible, while 1 means that they bunch together a bit. The effect is not actually that noticeable mind.

'''Count''' controls how many particles there are, so basically the example shown has 32 particles in total. Obviously the more you have, the more dense the tree. This is a slider so slide it around as necessary. Alternatively you can input a value into the box and then press apply down the bottom right.

'''Cycles''' this is how long the effect will last in seconds, If you set "cycles 0.000", it is endless, otherwise repeated so many times. In my case I am creating some ceiling dust that is triggered so am going with 1 or 2 cycles.

To see the changes you are making, center your camera in the render view on the tree and press {{key|F7}} and {{key|F6}}. {{key|F7}} rebuilds everything and {{key|F6}} enables animations. Leave it in render view and move the particle editor to the side so you can see the render view (to watch the changes you are making as you make them).

You will also notice the "time" input beneath it. This is the lifespan of a particle in seconds. If I may suggest, don't mess with this, as putting it too low will make the particle lifespan visible, as in you'll notice them appearing/disappearing etc. If you put it to something ridiculous, like 99999, then it will load for extremely long, and sometimes not at all. It's best to leave it at 300 (5 minute), as you won't notice the tree leaves changing around every 5 minutes.

'''Distribution''' This is where things get a little more annoying. You'll notice 3 check dots - rect, cylinder, and sphere. Realistically you'd want to use sphere, but for some reason the algorithm for distribution in the sphere (at least for the leaves) does not work correctly and you get several particles occupying the same spot, which results in z-fighting and generally looks really bad. Now, the rectangle distribution works perfect; particles are properly distributed and there is no z-fighting, but it's a rectangular shape, but can look ok if not too many particles are used. Another alternative is the cylinder distribution. Cylinder distribution works well but annoyingly enough the particles get distributed only on the walls of the cylinder, which means a hole in the middle, so you need to adjust the particle size and cylinder size so that there is no hole in the middle.

The values to the right are the size values in doom units, so change that to roughly be the size you want the leaves to cover. If you selected cylindrical distribution, don't bother adding a ring value as it just makes it larger in diameter, so leave it at 0.

The offset is the offset from the center of the particle entity. Try keeping the leaves centered on the particle emitter, as Doom 3's light rendering system calculates whether or not to light the particles by checking whether the particle emitter is inside the boundary of the light; if yes then applies the lighting to it, but if not then it leaves the particle unaffected, ID did this for performance reasons.

'''Random Distribution''' is just what it says, so you may want to leave that ticked.

'''Speed''' leave that at 0 for the leaves as that is the speed at which the particles move away from the center of the emitter.

'''Size''' is self-explanatory; it's the size of each particle.

'''Rotation''' is rotation speed of the particle and aspect stretches the particle from the center of the emitter. So leave these 2 alone for leaves.

Notice that each of these has 2 sliders. This is for time based particles, so one slider is "from" and the second is "to". This is governed over the lifespan, so for example a particle that has sizes 0 to 50 and a lifespan of 10 would mean that it would gradually increase it's size to 50 from 0 over a span of 10 seconds. So for leaves this means that you leave both sliders at the same value. The other values below the speed, size, rotation, and aspect sliders do various things and you can mess around with them if you wish but they are not useful for leaves.

Now that you know what each value does, just mess around with them until you reach something that looks good.

'''Saving'''
- Press save as (presuming you modified one of the existing leaf particles) and it will come up with a dialog asking for the particle name.
- Enter the name you wish (for example green_leaves_01) and press {{ok}}.
- Now it comes up with a path dialog. Browse to the Doom3/base/particles folder (if there is no particles folder create one) and name it as what you want (this is the file name, not the particle name), for example something like "mymap_particles" and then press ok. [[Make sure you save it into doom3/base/particles as saving it into doom3/darkmod/particles WILL NOT WORK]].

[EDIT - Someone check me but I tested this and it does seem you can save it direct in the darkmod/particles folder but if you save it in base/particles then it goes in darkmod/particles anyway. Also note that if you select an existing file it will ''append'' it - it does not overwrite but adds new particles definitions to existing files if selected. - Fidcal] Once you save it there you will find the particle file (in this case "mymap_particles.prt") in the doom3/darkmod/particles folder; strange, yes, but it saves it there due to the way Doom 3 mod-loading works.

Now in DarkRadiant you should be able to find your new leaf particle when browsing through the particle list.

''Tutorial by Dram'' - updated by Bikerdude

{{editing}}[[Category:Particles]]

Particles

2015-01-11T18:24:05Z

SteveL: Adding Category:Particles

Category:Particles

2015-01-11T18:23:57Z

SteveL: Creating Category:Particles

Fan Missions for The Dark Mod

2015-01-02T21:34:11Z

SteveL: Lord Edgar's Bathhouse is not The Accountant 2

__NOTOC__
{{infobox|<center>'''Big Ugly Disclaimer:'''</center> '''The Dark Mod''' team does not necessarily support or endorse content listed here, and only hosts missions listed on the [http://www.thedarkmod.com/ official TDM website]. This is a community maintained list, and an ongoing work in progress. Most of the mirror links in this list are dead or are for missions that are not 2.0 compliant. Mission entries which are suspected to violate copyright must be text-only, and cannot contain links. Report and/or remove links found in violation of this rule.}}

* For details about editing this table, see [http://modetwo.net/darkmod/wiki/index.php?title=Fan_Missions_for_The_Dark_Mod#Editing_This_Table below].
* For details about how to install Fan Missions please visit: [[Installing and Running Fan Missions]]
* To sort by a different criterion, click the [[Image:Sort none.gif]] icon in the relevant column header.

{|class="wikitable sortable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2 width=100%
|-
!bgcolor=#d0d0e0 width="21%"|Fan Mission Title
!bgcolor=#d0d0e0 width="12%"|Author(s)
!bgcolor=#d0d0e0 width="9%" class="unsortable"|Links
!bgcolor=#d0d0e0 width="5%"|First Release
!bgcolor=#d0d0e0 width="4%"|Size (MB)
!bgcolor=#d0d0e0 width="10%"|Series
!bgcolor=#d0d0e0 width="13%"|Mission Type
!bgcolor=#d0d0e0 width="6%"|Spiders and Undead
|-



|-
!align=left|{{TDM-FM|95|Lord Edgar's Bathhouse}}
|Goldwell
|{{Forumlink|1=http://forums.thedarkmod.com/topic/16828-fan-mission-lord-edgars-bathhouse-by-goldwell-27122014/}}
|2014-12-27
|71
|
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|94|La Banque Bienveillante}}
|Airship Ballet
|{{Forumlink|1=http://forums.thedarkmod.com/topic/16658-fan-mission-exhumed-by-kyyrma-and-airship-ballet-20141104/}}
|2014-11-22
|70
|Bienveillante
|Bank Jobs
|
|-

|-
!align=left|{{TDM-FM|93|Exhumed}}
|Airship Ballet and Kyyrma
|{{Forumlink|1=http://forums.thedarkmod.com/topic/16658-fan-mission-exhumed-by-kyyrma-and-airship-ballet-20141104/}}
|2014-11-04
|24
|HSC 2014
|Church/Cathedral
|
|-

|-
!align=left|{{TDM-FM|92|Briarwood Cathedral}}
|buck28
|{{Mirrorlink|http://www64.zippyshare.com/v/25705489/file.html}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16644-briarwood-cathedral/}}
|2014-10-29
|7
|HSC 2014
|Church/Cathedral
|
|-

|-
!align=left|{{TDM-FM|91|One Step Too Far}}
|Dragofer
|{{Mirrorlink|https://www.dropbox.com/s/sfxcap1gfdzf318/onesteptoofar.pk4}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16457-fan-mission-one-step-too-far-by-dragofer-20140804/}}
|2014-08-04
|9
|
|Pirate Missions
|
|-

|-
!align=left|{{TDM-FM|90|Lockner Manor}}
|buck28
|{{Mirrorlink|http://www76.zippyshare.com/v/44108372/file.html}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16452-new-mission-lockner-manor/}}
|2014-08-02
|6
|
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|89|Ulysses: Genesis}}
|Sotha
|{{Mirrorlink|http://www4.zippyshare.com/v/67195436/file.html}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16428-fan-mission-ulysses-genesis-by-sotha-20140724/}}
|2014-07-24
|98
|Ulysses
|Mansion/Estate FMs
|Horror theme?
|-

|-
!align=left|{{TDM-FM|88|Penny Dreadful 2: All the way up}}
|Melan and Bikerdude
|{{Mirrorlink|https://mega.co.nz/#!EwoXHZYZ!tE_sKon2h4AWtWPNt9QS3FQClwmXdimhfjIMPcpCQ34}}{{Forumlink|1=http://http://forums.thedarkmod.com/topic/16387-fan-mission-penny-dreadful-2-by-melan-and-bikerdude-2014078/}}
|2014-07-08
|102
|Penny Dreadful 2
|Thieves' Highway / Rooftop
|Spiders
|-

|-
!align=left|{{TDM-FM|87|Poets and Peasants}}
|Digi
|{{Mirrorlink|https://drive.google.com/file/d/0B1HHvWAgbWGfTkI0SXFubXZucXM}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16373-fan-mission-poets-peasants-by-digi-62914}}
|2014-06-29
|1
|
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|85|A Reputation to Uphold}}
|Springheel
|{{Mirrorlink|http://www.mindplaces.com/follow.pk4}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16204-fan-mission-a-reputation-to-uphold-by-springheel/}}
|2014-04-18
|25.5
|Corbin
|City Missions
|
|-

|-
!align=left|{{TDM-FM|86|Breaking out the Fence}}
|Kyyrma
|{{Mirrorlink|https://dl.dropboxusercontent.com/u/17706561/breakingout.pk4}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16091-fan-mission-breaking-out-the-fence-17032014-by-kyyrma/}}
|2014-03-17
|11.6
|In a Time of Need 2
|City Missions
|
|-

|-
!align=left|{{TDM-FM|84|A Noble Home}}
|Goldwell, Bikerdude
|{{Mirrorlink|http://www18.zippyshare.com/v/48473186/file.html}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16085-fan-mission-80-a-noble-home-the-accountant-prologue-by-goldwell-bikerdude-20140314/}}
|2014-03-14
|23
|The Accountant
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|83|Inn Business}} (v.1.48, 2014/03/08)
|RJFerret
|{{Mirrorlink|https://drive.google.com/file/d/0B81T2ZXLPqhTYWVaODRiSExGeGc}} {{Forumlink|1=http://forums.thedarkmod.com/topic/16018-fan-mission-inn-business-by-rjferret-20140303/}}
|2014-03-03
|6
|
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|82|William Steele 3: Cleighmoor}}
|grayman
|{{Forumlink|http://forums.thedarkmod.com/topic/16011-fan-mission-cleighmoor-by-grayman-201431/#entry338349/}}
|2014-03-01
|38
|William Steele 3
|Sewer / Prison
|none
|-

|-
!align=left|{{TDM-FM|81|William Steele 2: Home Again}}
|grayman
|{{Forumlink|http://forums.thedarkmod.com/topic/15919-fan-mission-home-again-by-grayman-2014212/page__fromsearch__1}}
|2014-02-12
|26
|William Steele 2
|Thieves' Highway / Rooftop
|none
|-

|-
!align=left|{{TDM-FM|80|The Gatehouse}}
|Bikerdude Goldchocobo
|{{Mirrorlink|http://www.southquarter.com/tdm/fms/gatehouse.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/15844-fan-mission-the-gatehouse-by-bikerdude-goldchocobo-20140114/}}
|2014-01-29
|100
|Remake of Evilartist's Doom 3 mod
|Castle/Fortress Missions
|Ghosts
|-

|-
!align=left|{{TDM-FM|79|Window of Opportunity}} (v.1.43, 2014/01/01)
|RJFerret
|{{Mirrorlink|https://drive.google.com/file/d/0B81T2ZXLPqhTWTMzQXZtMVFBSG8}} {{Forumlink|1=http://forums.thedarkmod.com/topic/15727-fan-mission-window-of-opportunity-by-rjferret-20140101/}}
|2014-01-01
|7
|
|Outdoor/caves
|Spiders (not in short mode)
|-

|-
!align=left|{{TDM-FM|78|In A Time Of Need}}
|kyyrma
| {{Mirrorlink|http://www.mediafire.com/download/a97or40t1xrybh3/timeofneed_v1.zip}} {{Forumlink|http://forums.thedarkmod.com/topic/15354-fan-mission-in-a-time-of-need-by-kyyrma-20131112/}}
|2013-11-12
|5.6
|In a Time of Need 1
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|76|Requiem}}
|Moonbo
| {{Mirrorlink|http://www.mediafire.com/download/l6o3vvj9y78hu89/requiem.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/15101-fan-mission-requiem-by-gelo-moonbo-fleisher-2013106/}}
|2013-10-08
|107.3
|[http://www.amazon.com/Shadowcursed-ebook/dp/B00BYEW02M Shadowcursed]
|Lost Civilizations
|Undead
|-

|-
!align=left|{{TDM-FM|75|Vengeance for a Thief Part 2}}
|Sir Taffsalot
| {{Mirrorlink|https://dl.dropboxusercontent.com/u/17706561/vfat2.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/15051-fan-mission-vengeance-for-a-thief-part-2-by-sir-taffsalot-06092013/}}
|2013-09-06
|22
|VFAT 2 and CUC 13
|Museum Missions
|
|-

|-
!align=left|{{TDM-FM|74|Lords and Legacy}}
|Kvorning
| {{Mirrorlink|https://dl.dropboxusercontent.com/u/17706561/lordsnlegacy.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/15016-fan-mission-lords-legacy-by-kvorning-20130830/}}
|2013-08-30
|45
|
|Thieves' Highway / Rooftop
|
|-

|-
!align=left|{{TDM-FM|72|Not An Ordinary Guest}}
|Fieldmedic
| {{Mirrorlink|https://dl.dropboxusercontent.com/u/17706561/naog.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/14965-fan-mission-not-an-ordinary-guest-by-fieldmedic-20130801/}}
|2013-08-01
|79.6
|CUC 13
|City Missions
|
|-

|-
!align=left|{{TDM-FM|71|Penny Dreadful: Grail of Regrets}}
|Melan
| {{Forumlink|http://forums.thedarkmod.com/topic/14952-fan-mission-penny-dreadful-by-melan-20130728/}}
|2013-07-27
|74
|Penny Dreadful 1
|Horror FMs
|Undead and Spiders
|-

|-
!align=left|{{TDM-FM|70|Solar Escape 1}}
|Tr00pertj
| {{Forumlink|http://forums.thedarkmod.com/topic/14944-fan-mission-solar-escape-1/}}
|2013-07-22
|6
|
|Mansion/Estate FMs
|Undead
|-

|-
!align=left|{{TDM-FM|69|The Lich Queen's Demise}}
|Sotha
|{{Mirrorlink|https://dl.dropboxusercontent.com/u/17706561/lich_queens_demise.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/14826-fan-mission-the-lich-queens-demise-by-sotha-20130520/unread/}}
|2013-05-20
|97.6
|Thomas Porter 6 CUC 13 (Winner)
|Horror FMs
|Undead
|-

|-
!align=left|{{TDM-FM|77|Old Habits Rebuild}}
|Obsttorte
|{{Bloodgate|mc.pk4}} {{Mirrorlink|http://www.mediafire.com/download/u2gwucibh17c45a/oldhabits.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/14827-fan-mission-old-habits-rebuild-by-obsttorte-20052013/}}
|2013-05-20
|28.6
|
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|68|The Builder's Blocks}}
|Jesps
|{{Mirrorlink|https://dl.dropboxusercontent.com/u/17706561/builders_blocks.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/14592-unusual-gameplay-contest-fm-the-builders-blocks-by-jesps/}}
|2013-03-18
|2.85
|CUC 13
|
|
|-

|-
!align=left|{{TDM-FM|67|Crystal Grave}} (v.2.0, 2013/02/09)
|ERH+ Bikerdude
|{{Mirrorlink|https://dl.dropbox.com/u/17706561/crystalgravev2.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/14510-fan-mission-crystal-grave-v2-by-erh-and-bikerdude-20130209/unread/}}
|2011-11-15
|12.4
|
|Horror FMs
|Undead
|-

|-
!align=left|{{TDM-FM|66|The Builder Roads}}
|Obsttorte
|{} {{Forumlink|http://forums.thedarkmod.com/topic/14449-fan-mission-the-builder-roads-by-obsttorte-20130119/}}
|2013-01-19
|?
|
|Horror FMs
|Ghosts
|-

|-
!align=left|{{TDM-FM|65|William Steele 1: In the North}}
|grayman
|{{Bloodgate|ws1_north.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/14214-fan-mission-in-the-north-by-grayman-20121020/}}
|2012-10-20
|39.8
|William Steele 1
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|64|Old Habits}}
|Obsttorte
|{{Bloodgate|mc.pk4}} {{Mirrorlink|http://www.mediafire.com/download.php?andes2xnsonssfj}} {{Forumlink|http://forums.thedarkmod.com/topic/14206-fan-mission-old-habits-by-obsttorte-20121019/}}
|2012-10-19
|12.8
|
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|63|Deceptive Shadows}}
|ShadowHide
|{{Bloodgate|DeceptiveShadows.pk4}} {{Mirrorlink|http://www.sendspace.com/file/jzr9s7}} {{Forumlink|http://forums.thedarkmod.com/topic/14103-fan-mission-deceptive-shadows-by-shadowhide-16sep12/}}
|2012-09-16
|22.4
|
|Pagan/Outdoor Missions
|Spiders
|-

|-
!align=left|{{TDM-FM|62|Vengeance for a Thief: Part 1}}
|Sir Taffsalot
|{{Bloodgate|VFAT1.pk4}} {{Mirrorlink|https://dl.dropbox.com/u/17706561/VFAT1.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/14068-fan-mission-vengeance-for-a-thief-part-1-by-sir-taffsalot-06092012/}}
|2012-09-06
|20.9
|VFAT 1
|Jail/Prison Missions
|
|-

|-
!align=left|{{TDM-FM|61|The Phrase Book}}
|Sotha
|{{Bloodgate|phrase_book.pk4}} {{Mirrorlink|http://dl.dropbox.com/u/17706561/phrase_book.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/13799-fan-mission-the-phrase-book-by-sotha-20120512/}}
|2012-05-11
|24
|Thomas Porter 5
|Thieves' Highway / Rooftop
|
|-

|-
!align=left|{{TDM-FM|60|In Remembrance of Him}}
|RPGista
|{{Bloodgate|remembrance.pk4}} {{Mirrorlink|http://dl.dropbox.com/u/17706561/remembrance.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/13749-fan-mission-in-remembrance-of-him-by-rpgista/}}
|2012-04-22
|27.6
|CBC 12
|City Missions
|
|-

|-
!align=left|{{TDM-FM|59|Rightful Property}}
|jysk
|{{Bloodgate|rightful.pk4}} {{Mirrorlink|http://dl.dropbox.com/u/17706561/rightful1.1b.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/13711-fan-mission-rightful-property-by-jysk-20120413/}}
|2012-04-12
|22.5
|CBC 12
|Bank Jobs
|Spiders
|-

|-
!align=left|{{TDM-FM|58|Sneak and Destroy}}
|SeriousToni
|{{Bloodgate|kneipe24.pk4}} {{Mirrorlink|http://minus.com/mVcf61n3G/1f}} {{Forumlink|http://forums.thedarkmod.com/topic/13706-fan-mission-sneak-destroy-by-serioustoni-beginners-contest-2012/}}
|2012-04-11
|158
|CBC 12
|City Missions
|
|-

|-
!align=left|{{TDM-FM|56|House of Theo}}
|Theothesnopp
|{{Bloodgate|houseoftheo.pk4}} {{Mirrorlink|http://www.gamefront.com/files/21053391/houseoftheo__2__2.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/13242-fan-mission-house-of-theo/}}
|2011-12-04
|6.2
|
|Castle/Fortress Missions
|
|-

|-
!align=left|{{TDM-FM|53|Dragon's Claw}}
|Bikerdude, Flanders (map assets)
|{{Bloodgate|claw.pk4}}{{Mirrorlink|http://www.gamefront.com/files/20948800/claw.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/13181-fan-missiondragons-claw-by-b1k3rdude-31102011/}}
|2011-10-31
|98
|HSC 11
|City Missions
|
|-

|-
!align=left|{{TDM-FM|52|A Night to Remember}}
|Fieldmedic
|{{Bloodgate|antr.pk4}}{{Mirrorlink|http://www.mediafire.com/?d4hch59m4nef3dc}} {{Forumlink|http://forums.thedarkmod.com/topic/13177-fan-mission-a-night-to-remember-by-fieldmedic-20111030/}}
|2011-10-31
|32
|HSC 11
|Mansion/Estate FMs
|Ghosts
|-

|-
!align=left|{{TDM-FM|51|The Creeps}}
|Mortem Desino
|{{Bloodgate|thecreeps.pk4}}{{Mirrorlink|http://www.gamefront.com/files/20939925/thecreeps.pk4}} {{Forumlink|http://forums.thedarkmod.com/topic/13176-fan-mission-creeps-the-20111030-by-mortem-desino/}}
|2011-10-30
|61
|HSC 11
|Horror FMs
|Ghosts
|-

|-
!align=left|{{TDM-FM|50|House in Blackbog Hollow}}
|Stumpy
|{{Bloodgate|blackbog.pk4}}{{Mirrorlink|http://www.bookofages.co.uk/doom3/mods/blackbog.html}} {{Forumlink|http://forums.thedarkmod.com/topic/13172-fan-mission-house-in-blackbog-hollow-by-stumpy-20111028/}}
|2011-10-28
|12
|HSC 11
|Horror FMs
|Undead and Spiders
|-

|-
!align=left|{{TDM-FM|49|Let Sleeping Thieves Lie}}
|Sir Taffsalot, Bikerdude
|{{Bloodgate|lstl.pk4}}{{Mirrorlink|http://www.mediafire.com/?zkd1jn4lpwgioh9}} {{Forumlink|http://modetwo.net/darkmod/index.php?/topic/13153-let-sleeping-thieves-lie-by-sir-taffsalot-bikerdude-20102011/}}
|2011-10-20
|13
|
|Tombs, Catacombs & Crypts
|Undead
|-

|-
!align=left|{{TDM-FM|48|Samhain Night}}
|PranQster
|{{Bloodgate|samhain.pk4}}{{Mirrorlink|http://jdchoate.mcn.org/games/darkmod/samhain.zip}} {{Forumlink|http://modetwo.net/darkmod/index.php?/topic/13127-fan-mission-samhain-night-on-bone-hill-by-pranqster-20111009/}}
|2011-10-09
|10
|HSC 11
|Horror FMs
|Undead and Spiders
|-

|-
!align=left|{{TDM-FM|47|A Score to Settle}}
|Springheel
|{{Bloodgate|score_to_settle.pk4}}{{Mirrorlink|http://www.mediafire.com/?f3o7hm4h4ew7o3l}} {{Forumlink|http://modetwo.net/darkmod/index.php?/topic/12894-fan-mission-%2348-a-score-to-settle-by-springheel-20110701/}}
|2011-07-01
|135
|Corbin
|City Missions
|
|-

|-
!align=left|{{TDM-FM|46|Siege Shop}} (v3.0 2013/10/10)
|PranQster and Lowenz
|{{Bloodgate|siegeshop.pk4}}{{Mirrorlink|http://jdchoate.mcn.org/games/darkmod/siegeshop.pk4}} {{Forumlink|http://modetwo.net/darkmod/index.php?/topic/12874-fan-mission-the-siege-shop-by-pranqster-20110626/}}
|2011-06-26
|20.51
|
|Castle/Fortress Missions
|
|-

|-
!align=left|{{TDM-FM|44|Alberic's Curse}}
|Bikerdude
|{{Bloodgate|alberic.pk4}} {{Mirrorlink|http://www.gamefront.com/files/20459738/alberic.pk4}} {{Forumlink|http://modetwo.net/darkmod/index.php?/topic/12850-fan-mission-alberics-curse-by-b1k3rdude-20062011/}}
|2011-06-20
|29
|CSC 11 (Winner), T2 FM homage
|Church/Cathedral
|Undead and Spiders
|-

|-
!align=left|{{TDM-FM|45|Reap as you sow}}
|Fieldmedic
|{{Bloodgate|reap.pk4}} {{Forumlink|http://modetwo.net/darkmod/index.php?/topic/12849-fan-mission-reap-as-you-sow-by-fieldmedic-20110619/}}
|2011-06-19
|52
|CSC 11
|Daylight Missions
|
|-

|-
!align=left|{{TDM-FM|43|Rake Off}}
|Jesps
|{{Bloodgate|rake_off.pk4}} {{Forumlink|http://modetwo.net/darkmod/index.php?/topic/12846-fm-rake-off-19-06-2011/}}
|2011-06-19
|8
|CSC 11, Selis Woderose 2
|Castle/Fortress Missions
|
|-

|-
!align=left|{{TDM-FM|42|Winter Harvest}} (v2.0 2011/07/24 with Bikerdude)
|ShadowHide
|{{Bloodgate|winterharvest.pk4}} {{Forumlink|http://modetwo.net/darkmod/index.php?/topic/12690-seasons-contest-entry-winter-harvest-by-shadowhide/}}
|2011-05-08
|10
|CSC 11
|Pagan/Outdoor Missions
|Spiders
|-

|-
!align=left|{{TDM-FM|41|Fiasco at Fauchard Street}}
|Melan
|{{Bloodgate|fauchard.pk4}} {{Mirrorlink|https://rapidshare.com/files/460141132/fauchard.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/12655-fan-mission-fiasco-at-fauchard-street-by-melan-20110501//}}
|2011-05-01
|62
|Talbot 3
|Thieves' Highway / Rooftop
|
|-

|-
!align=left|{{TDM-FM|40|Mandrasola}}
|Sotha
|{{Bloodgate|mandrasola.pk4}} {{Mirrorlink|http://www.mediafire.com/?2ox2nbhh796ne71}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/12575-fan-mission-mandrasola-by-sotha-20110410/}}
|2011-04-10
|10
|Thomas Porter 0, CSC 11
|City Missions
|Undead
|-

|-
!align=left|[http://www.gamefront.com/files/20167184/yantdm1.1.pk4 Q4 Conversion: Yan's Test]
|Bikerdude
|{{Mirrorlink|http://www.mediafire.com/?2nona089nzi00sv}} {{Mirrorlink|http://www.gamefront.com/files/20167184/yantdm1.1.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/12506-fan-mission-q4-map-conversion-yantdm1-280311/}}
|2011-03-28
|28
|
|
|
|-

|-
!align=left|{{TDM-FM|38|The Transaction}}
|Sotha
|{{Bloodgate|transaction.pk4}} {{Mirrorlink|http://www.mediafire.com/?ux7mx79wumnvcb6}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/12408-fan-mission-the-transaction-by-sotha-20110304/}}
|2011-03-04
|10
|Thomas Porter 4
|City Missions
|
|-

|-
!align=left|{{TDM-FM|13|Return to the City}} (v2.0 2011/03/01)
|Melan, Bikerdude
|{{Bloodgate|ReturnToTheCityV2.pk4}}{{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10509-fan-mission-return-to-the-city-by-melan-20100110/}} {{Forumlink|1=http://www.ttlg.com/forums/showthread.php?t=130519/}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/12390-fan-mission-return-to-the-city-v2-01032011/}}
|2010-01-10
|26
|Version 1.0, GCC 09 (Winner); Talbot 2
|City Missions
|
|-

|-
!align=left|{{TDM-FM|39|Lockdown}}
|GameDevGoro Bikerdude Fidcal
|{{Bloodgate|lockdown1_2_1.pk4}} {{Mirrorlink|http://www.fidcal.com/darkuser/missions/lockdown1_2_1.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/12064-fm-lockdown-part-1-by-gamedevgoro-and-bikerdude-20101224/}}
|2010-12-25
|3
|Lockdown 1
|City Missions
|Undead
|-

|-
!align=left|{{TDM-FM|37|Flakebridge Monastery}}
|Jesps
|{{Bloodgate|flakebridge.pk4}} {{Mirrorlink|http://www.file-upload.net/download-3024426/flakebridge.pk4.html}} {{Mirrorlink|http://rapidshare.com/files/434997519/flakebridge.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11991-fm-flakebridge-monastery-by-jesps/}}
|2010-12-05
|16
|Selis Woderose 1
|Church/Cathedral
|Undead
|-

|-
!align=left|{{TDM-FM|36|Knighton Manor, The}}
|Sotha
|{{Bloodgate|knighton_manor.pk4}} {{Mirrorlink|http://www.mediafire.com/?xrdts3j4t2qxre2}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11898-fan-mission-the-knighton-manor-by-sotha-20101109/page__view__getnewpost}}
|2010-11-09
|21
|Thomas Porter 1
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|35|St Albans Cathedral}} (v2.0 2014/06/11)
|Bikerdude
|{{Bloodgate|stac160.pk4}} [[http://www.bloodgate.com/fms/stac142.pk4 Classic]] {{Mirrorlink|http://www.filefront.com/17464439/stac141.pk4}}{{Forumlink|1=http://forums.thedarkmod.com/topic/16343-fan-mission-st-albans-cathedral-v20-11062014/}} {{Loot|FM:TDM_St_Alban's_Cathedral_-_Bikerdude}}
|2010-11-01
|67
|St Alban
|Church/Cathedral
|Undead
|-

|-
!align=left|{{TDM-FM|33|Swing}}
|Komag
|{{Bloodgate|swing_v1.2.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11660-vertigo-contest-entry-swing-by-komag-20100825/}} {{Loot|FM:TDM_Swing_-_Komag}}
|2010-08-25
|3
|SVC 10
|Platforming / Jumping
|
|-

|-
!align=left|{{TDM-FM|32|The Caduceus of St. Alban}} (v.1.5.5 2010/08/26)
|Bikerdude
|{{bloodgate|stalban.pk4}} {{Mirrorlink|http://www.filefront.com/17237609/stalban.pk4/}}{{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11644-the-caduceus-of-st-alban-vertical-fm-contest-entry-aug-8th-2010/}}
|2010-08-23
|11.3
|SVC 10/St Alban
|Church/Cathedral
|Spiders
|-

|-
!align=left|{{TDM-FM|30|Somewhere Above the City}} (v1.1 2010/08/27)
|Grayman
|{{Bloodgate|somewhere1.1.pk4}}{{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11619-vertical-contest-mission-somewhere-above-the-city-by-grayman-aug-20-2010/}} {{Loot|FM:TDM_Somewhere_Above_the_City_-_grayman}}
|2010-08-20
|11
|SVC 10
|Tombs, Catacombs & Crypts
|
|-

|-
!align=left|{{TDM-FM|29|Betrayal}} (v.1.1, 2010/09/01)
|Fieldmedic
|{{Bloodgate|betrayal.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11605-betrayal-by-fieldmedic-20100817-summer-fm-vertical-contest-entry/}} {{Loot|FM:TDM_Awaiting_the_Storm_-_HappyCheeze}}
|2010-08-17
|12
|SVC 10
|Horror FMs
|Undead
|-

|-
!align=left|{{TDM-FM|31|Rift, The}}
|Baddcog
|{{Bloodgate|rift.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11599-vert-contest-mission-the-rift-by-baddcog-aug-15-2010/}}
|2010-08-15
|10
|SVC 10
|Lost Civilizations
|Undead and Spiders
|-

|-
!align=left|{{TDM-FM|34|Illusionist's Tower}}
|stumpy
|{{Bloodgate|holetower.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11541-illusionists-tower-by-stumpy-201085-summer-fm-vertical-contest-entry}} {{Forumlink|1=http://www.bookofages.co.uk/doom3/mods/holetower.html}} {{Loot|FM:TDM_Illusionist%27s_Tower_-_stumpy}}
|2010-08-05
|9
|SVC 10
|Horror FMs
|Undead and Spiders
|-

|-
!align=left|{{TDM-FM|28|Mad's Mountain}}
|Jesps
|{{Bloodgate|madmountain.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11510-fan-mission-mads-mountain-by-jesps-20100731}} {{Loot|FM:TDM_Lord_Dufford%27s_-_stumpy}}
|2010-07-31
|2
|SVC 10
|Tombs, Catacombs & Crypts
|
|-

|-
!align=left|{{TDM-FM|27|Glenham Tower, The}}
|Sotha
|{{Bloodgate|glenham_tower.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11423-fan-mission-the-glenham-tower-by-sotha-20100717}}
|2010-07-17
|5
|Thomas Porter 3, SVC 10 (Winner)
|Horror FMs
|Undead
|-

|-
!align=left|{{TDM-FM|25|Pandora's Box}}
|Jesps, Fidcal
|{{Bloodgate|pandoras_box.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11381-fan-mission-pandoras-box-by-jesps20100711}} {{Loot|FM:TDM_Pandora%27s_Box_-_Jesps}}
|2010-07-11
|7
|
|Pirate Missions
|
|-

|-
!align=left|{{TDM-FM|23|Beleaguered Fence, The}}
|Sotha
|{{Bloodgate|beleaguered_fence.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11298-fan-mission-the-beleaguered-fence-by-sotha-20100623}} {{Loot|FM:TDM_The_Beleaguered_Fence_-_Sotha}}
|2010-06-23
|11
|Thomas Porter 2
|Jail/Prison Missions
|
|-

|-
!align=left|{{TDM-FM|22|Special Delivery, A}}
|Silencium18
|{{Bloodgate|delivery.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11247-fan-mission-a-special-delivery-by-silencium1820100612}} {{Loot|FM:TDM_A_Special_Delivery_-_Silencium18}}
|2010-06-12
|2
|
|Warehouse Missions
|
|-

|-
!align=left|{{TDM-FM|21|Alchemist, The}} (2010/06/04)
|Sotha, Fidcal
|{{Bloodgate|alchemist.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11170-fan-mission-the-alchemist-by-sotha-fidcal20100601}} {{Loot|FM:TDM_The_Alchemist_-_Sotha_%26_Fidcal}}
|2010-06-01
|27
|Thief's Den 4
|City Missions
|Undead
|-

|-
!align=left|{{TDM-FM|20|Awaiting The Storm}}
|HappyCheeze
|{{Bloodgate|storm.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11095-fm-awaiting-the-storm-by-happycheeze-20200522}} {{Loot|FM:TDM_Awaiting_the_Storm_-_HappyCheeze}}
|2010-05-22
|4
|
|City Missions
|
|-

|-
!align=left|{{TDM-FM|18|No Honor Among Thieves}} (v.2.0, 2013/10/16)
|Goldchocobo, RailGun, Mortem Desino
|{{Mirrorlink|http://tinyurl.com/2a9mdcs}}{{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10993-fan-mission-no-honor-among-thieves-20100429}} {{Loot|FM:TDM_No_Honor_Among_Thieves_-_Goldchocobo}}
|2010-04-29
|144
|
|Pagan/Outdoor Missions
|Undead and Spiders
|-

|-
!align=left|{{TDM-FM|17|Heart of Lone Salvation, The}} (v.2.0, 2010/04/12)
|Fidcal, Baddcog
|{{Bloodgate|heart.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10878-fan-mission-the-heart-of-lone-salvation-by-fidcal-baddcog-20100402/}} {{Walkthrough|FM:TDM_The_Heart_of_Lone_Salvation_-_Fidcal_%26_Baddcog}} {{loot|FM:TDM_The_Heart_of_Lone_Salvation_-_Fidcal_%26_Baddcog}}
|2010-04-02
|41
|Thief's Den 3
|City Missions
|Spiders
|-

|-
!align=left|{{TDM-FM|73|Lord Dufford's}}
|stumpy
|{{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10868-fan-mission-lord-duffords-20100331}} {{Loot|FM:TDM_Lord_Dufford%27s_-_stumpy}}
|2010-03-31
|22
|
|City Missions
|
|-

|-
!align=left|{{TDM-FM|16|Builder's Influence, The}} (2010/03/23)
|Railgun, Springheel
|{{Bloodgate|builders_influence.pk4}} {{Mirrorlink|http://www.fidcal.com/darkuser/missions/builders_influence.pk4}}{{Forumlink|http://modetwo.net/darkmod/index.php?/topic/10811-fan-mission-the-builders-influence-20100320/}} {{Loot|FM:TDM_The_Builders_Influence_-_Railgun%26Springheel}}
|2010-03-20
|15
|Corbin
|Castle/Fortress Missions
|
|-

|-
!align=left|{{TDM-FM|14|Business as Usual}} (v2.0 2011/09/24)
|Bikerdude
|{{Bloodgate|business.pk4}}{{Mirrorlink|1=http://rapidshare.com/files/335299431/business.pk4.html}}{{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10533-fan-mission-business-as-usual-by-b1k3rdude-14012010-christmas-fm-contest-entry/page__view__findpost__p__207055}}
|2010-01-14
|4
|GCC 09
|Sewer
|
|-

|-
!align=left|{{TDM-FM|12|Sons of Baltona 1, The}}
|Carnage
|{{Bloodgate|sons_of_baltona_1.pk4}} {{Mirrorlink|1=http://www.mediafire.com/?m4ywobjodm0}}{{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10498-fan-mission-the-sons-of-baltona-1-by-carnage-20100109}}
|2010-01-09
|3
|GCC 09 / Baltona 1
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|11|Living Expenses}}
|Sonosuke
|{{Bloodgate|living_expenses.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10451-fm-living-expenses-by-sonosuke-2-jan-10/page__view__findpost__p__205386}}
|2010-01-02
|6
|GCC 09
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|10|Trapped!}}
|RailGun
|{{Bloodgate|trapped.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10442-fm-trapped-by-railgun-dec-30/page__view__findpost__p__205092}}
|2009-12-30
|6
|
|Jail/Prison Missions
|
|-

|-
!align=left|{{TDM-FM|8|Parcel, The}}
|Xonze
|{{Bloodgate|parcel.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10404-fm-the-parcel-by-xonze-dec-24/page__view__findpost__p__204459}}
|2009-12-24
|7
|GCC 09
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|9|Too Late}}
|Nielsen74
|{{Bloodgate|too_late.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10400-fm-too-late-by-nielsen74-24-dec-09/page__view__findpost__p__204396}}
|2009-12-24
|4
|GCC 09
|Warehouse Missions
|
|-

|-
!align=left|{{TDM-FM|7|Thieves}}
|Silencium, RailGun, Fidcal
|{{Bloodgate|thieves.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10286-fm-the-thieves-nov-2509/}}
|2009-11-26
|9
|
|City Missions
|
|-

|-
!align=left|{{TDM-FM|6|Patently Dangerous}} (v.2.0, 2013/10/08)
|demagogue
|{{Bloodgate|patently_dangerous.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10125-fm-patently-dangerous-oct3109/page__view__findpost__p__199324/}}
|2009-10-31
|24
|
|City Missions
|
|-

|-
!align=left|{{TDM-FM|5|Dark Mod Training Mission, The}}
|TDM Team
|{{Bloodgate|training_mission.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/9932-fm-training-mission-17-oct-09/}}
|2009-10-17
|6
|
|Training
|
|-

|-
!align=left|{{TDM-FM|2|Crown of Penitence, The}}
|Jesps
|{{Bloodgate|crow_of_penitence.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/9934-fm-crown-of-penitence-by-jesps-17-oct-09/}}
|2009-10-16
|12
|
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|3|Chalice of Kings, The}}
|Fidcal
|{{Bloodgate|chalice.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/9935-fm-chalice-of-kings-by-fidcal-17-oct-09/}} {{Loot|FM:TDM_Chalice_of_Kings_-_Fidcal}}
|2009-10-15
|3
|Thief's Den 2
|Castle/Fortress Missions
|
|-

|-
!align=left|{{TDM-FM|1|Outpost, The}}
|angua, greebo
|{{Bloodgate|outpost.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/9937-fm-the-outpost-by-angua-greebo-17-oct-09/}}
|2008-12-23
|2
|
|Castle/Fortress Missions
|
|-

|-
!align=left|{{TDM-FM|15|Tears of Saint Lucia, The}} (v.1.01, 2010/04/29)
|TDM Team
|{{Bloodgate|saintlucia.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/10579-fan-mission-the-tears-of-st-lucia-20081021/page__view__findpost__p__207972}} {{Loot|FM:TDM_The_Tears_of_Saint_Lucia_-_jdude}}
|2008-10-21
|18
|
|Church/Cathedral
|Spiders
|-

|-
!align=left|{{TDM-FM|57|Closemouthed Shadows}} (v.2.0, 2012/01/15)
|LordSavage, Bikerdude
|{{Bloodgate|closemouthed_shadows.pk4}} {{Forumlink|1=http://forums.thedarkmod.com/topic/13383-fan-mission-closemouthed-shadows-2008-reworked-for-tdm-107-20120115/}}
|2008-09-21
|2
|Closemouthed Shadows 1
|Mansion/Estate FMs
|
|-

|-
!align=left|{{TDM-FM|24|Thief's Den}} (v.2.0, 2010/07/04)
|Fidcal, greebo
|{{Bloodgate|thiefs_den.pk4}} {{Forumlink|1=http://modetwo.net/darkmod/index.php?/topic/11347-fan-mission-thiefs-den-re-release-by-fidcal20100704}} {{Walkthrough|FM:TDM_Thief's_Den_-_Fidcal}} {{Loot|FM:TDM_Thief%27s_Den_-_Fidcal}}
|2008-01-18
|3
|Thief's Den 1
|City Missions
|
|}

If the aforementioned download links are down, [http://www.southquarter.com/downloads/missions_view.php South Quarter] has some TDM missions (-2011) as well as a link to it's TTLG forum thread. Just click the 'game column' to sort the list with TDM.

To see a speculative list of Upcoming Fan Missions please visit: [[Upcoming Fan Missions]]

'''Series Key'''

GCC 09: Grand Christmas Contest 2009

SVC 10: Summer Vertical Contest 2010

CSC 11: Community Seasons Contest 2011

HSC 11: Halloween Speed-Build Contest 2011

CBC 12: Community Beginner Contest 2012

CUC 13: Community Unusual Contest 2013

'''Links Key'''

{|class="wikitable" border=1 style="border-collapse: collapse;" cellspacing=0 cellpadding=2

|-
|[http://modetwo.net/darkmod/wiki/images/b/be/Icon_forum.png http://modetwo.net/darkmod/wiki/images/b/be/Icon_forum.png]
|Link to discussion in Forums

|-
|{{Mirrorlink|}}
|Misc. download mirror

|-
|{{Bloodgate|}}
|Bloodgate download mirror

|-
|{{Loot|}}
|Loot list

|-
|{{Walkthrough|}}
|Walkthrough

|}

== Editing This Table ==
* Please only include playable missions that are fully released, not those currently in development or testing. Tutorials, demos, prefabs, etc. should be listed elsewhere.
* A mission title may be listed in plain text as a record of release, or preferably a link to an information page or primary direct download.
* List by release date descending (newest at the top).
* If a fan mission only has a single mirror/host please consider adding additional mirrors.
{{general|sort=Fan Missions}}
[[Category:Fan Missions]]

TDM Script Reference/2.03

2015-01-01T23:37:49Z

SteveL: header for pre-release version

This page has been generated automatically by the tdm_gen_script_event_doc console command, with [[Talk:TDM_Script_Reference/2.03|manual amendments]].

'''This is a pre-release page for TDM 2.03: Not all script events on this page are available in the current TDM version 2.02.'''

Generated by The Dark Mod 2.03, code revision 6439, last update: 2015-01-01 23:22

{{tdm-scripting-reference-intro}}
<div class="toclimit-4">
__TOC__
</div>
= TDM Script Event Reference =

== All Events ==
=== Alphabetic List ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''CTarget_AddObjectives'', ''CTarget_CallScriptFunction'', ''CTarget_ChangeEntityRelation'', ''CTarget_ChangeLockState'', ''CTarget_ChangeTarget'', ''CTarget_InterMissionTrigger'', ''CTarget_SetEntityRelation'', ''CTarget_SetFrobable'', ''CTarget_SetObjectiveComponentState'', ''CTarget_SetObjectiveState'', ''CTarget_SetObjectiveVisibility'', ''CTarget_SetRelations'', ''CTarget_SetTeam'', ''CTarget_StartConversation'', ''idAFEntity_Generic'', ''idAFEntity_WithAttachedHead'', ''idAI'', ''idActivator'', ''idAnimated'', ''idBeam'', ''idBrittleFracture'', ''idCameraAnim'', ''idCameraView'', ''idCombatNode'', ''idDamagable'', ''idEarthQuake'', ''idEntityFx'', ''idExplodable'', ''idForceField'', ''idFuncAASObstacle'', ''idFuncAASPortal'', ''idFuncPortal'', ''idFuncSmoke'', ''idItem'', ''idLight'', ''idMoveable'', ''idMover'', ''idMover_Binary'', ''idPhantomObjects'', ''idPlayerStart'', ''idPortalSky'', ''idRiser'', ''idRotater'', ''idShaking'', ''idSound'', ''idStaticEntity'', ''idTarget_CallObjectFunction'', ''idTarget_Damage'', ''idTarget_EnableLevelWeapons'', ''idTarget_EndLevel'', ''idTarget_FadeEntity'', ''idTarget_FadeSoundClass'', ''idTarget_Give'', ''idTarget_LightFadeIn'', ''idTarget_LightFadeOut'', ''idTarget_PostScriptEvent'', ''idTarget_Remove'', ''idTarget_RemoveWeapons'', ''idTarget_SessionCommand'', ''idTarget_SetFov'', ''idTarget_SetGlobalShaderTime'', ''idTarget_SetInfluence'', ''idTarget_SetKeyVal'', ''idTarget_SetModel'', ''idTarget_SetShaderParm'', ''idTarget_SetShaderTime'', ''idTarget_Show'', ''idTarget_WaitForButton'', ''idTrigger_Count'', ''idTrigger_EntityName'', ''idTrigger_Fade'', ''idTrigger_Hurt'', ''idTrigger_Multi'', ''idTrigger_Timer'', ''idTrigger_Touch'', ''idVacuumSeparatorEntity''
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''ammoInClip'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''attackEnd'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

:Spawnclasses responding to this event: ''idAI'', ''idMoveable''
==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''burn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canHitEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSee'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''checkAAS'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''checkAbsence'''(); ====

:description missing

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearSignal'''(float signalNum); ====

:Disables the callback function on the specified signal.
::''signalNum'': signal number

:Spawnclasses responding to this event:
==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''clipSize'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''createProjectile'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

:Spawnclasses responding to this event: ''Seed''
==== scriptEvent void '''customDeath'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

:Spawnclasses responding to this event: ''idBrittleFracture''
==== scriptEvent void '''deathMenu'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''disableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropTorch'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''ejectBrass'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''enableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange2D'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''error'''(string text); ====

:Issues an error.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''exitTeleporter'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''faceEnemy'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''facingIdeal'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''flashlight'''(float enable); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated''
==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getAudThresh'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCombatNode'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

:Spawnclasses responding to this event: ''CFrobDoorHandle''
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getIdealWeapon'''(); ====

:No description

:Spawnclasses responding to this event:
==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

:Spawnclasses responding to this event: ''CFrobLockHandle''
==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive):
::{|
|-
|gamePlayTime||gameplay time in seconds
|-
|damageDealt||damage dealt to enemies
|-
|damageReceived||damage received by player
|-
|healthReceived||health received by player
|-
|pocketsPicked||pockets picked by player
|-
|foundLoot||loot found by player
|-
|missionLoot||total loot available in mission
|-
|totalTimePlayerSeen||total time the player was seen by enemies in seconds
|-
|numberTimesPlayerSeen||number of times player was seen by enemies
|-
|numberTimesAISuspicious||number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score.
|-
|numberTimesAISearched||number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score.
|-
|sightingScore||sighting score (number of times player was seen * weight)
|-
|stealthScore||stealth score (sighting score + alerts * weights)
|-
|killedByPlayer||number of enemies killed by player
|-
|knockedOutByPlayer||number of enemies knocked out by player
|-
|bodiesFound||number of times enemies have spotted a body
|}

:Spawnclasses responding to this event: ''idThread''

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getState'''(); ====

:Gets the current state.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTurnDelta'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Gibbable'', ''idMoveableItem''
==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''hideByLODBias'''(); ====

:internal

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInvisible'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''isLight'''(); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''kill'''(); ====

:Kills the monster.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

:Spawnclasses responding to this event: ''idCombatNode''
==== scriptEvent float '''melee'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''missionFailed'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''missionSuccess'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''moveStatus'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCover'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''netEndReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''netReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''nextWeapon'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''On'''(); ====

:Turns the entity on.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

:Spawnclasses responding to this event: ''CFrobButton'', ''CFrobLever''
==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''playStartSound'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''preBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''randomPath'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI'', ''idPathCorner''
==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

:Spawnclasses responding to this event: ''idClass''
==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''respawn'''(); ====

:Respawn

:Spawnclasses responding to this event: ''idItem''
==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restartPatrol'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''restoreMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''saveGame'''(string filename); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''saveMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setStartedOff'''(); ====

:no description

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''shrivel'''(float time); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''stopFxFov'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopThinking'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

:Spawnclasses responding to this event: ''CFrobLever''
==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

:Spawnclasses responding to this event: ''CFrobHandle''
==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock'', ''idProjectile''
==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testChargeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''throwAF'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''throwMoveable'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

:Spawnclasses responding to this event: ''idForceField''
==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitAction'''(string name); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wander'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''weaponHolstered'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponLowering'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReady'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReloading'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponRising'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''

== Events by Spawnclass / Entity Type ==
=== idActor ===
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

==== scriptEvent string '''getState'''(); ====

:Gets the current state.

==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

=== idAFEntity_Base ===
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

=== idAFEntity_Gibbable ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idAFEntity_Generic ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idAFEntity_WithAttachedHead ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CAIVehicle ===
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

=== idCombatNode ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

=== idAI ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

==== scriptEvent void '''attackEnd'''(); ====

:no description

==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

==== scriptEvent void '''becomeSolid'''(); ====

:no description

==== scriptEvent void '''burn'''(); ====

:no description

==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

==== scriptEvent float '''canHitEnemy'''(); ====

:no description

==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

==== scriptEvent float '''canSee'''(entity ent); ====

:no description

==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

==== scriptEvent void '''clearBurn'''(); ====

:no description

==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

==== scriptEvent void '''disableAFPush'''(); ====

:no description

==== scriptEvent void '''disableClip'''(); ====

:no description

==== scriptEvent void '''disableGravity'''(); ====

:no description

==== scriptEvent void '''dropTorch'''(); ====

:no description

==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

==== scriptEvent void '''enableAFPush'''(); ====

:no description

==== scriptEvent void '''enableClip'''(); ====

:no description

==== scriptEvent void '''enableGravity'''(); ====

:no description

==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

==== scriptEvent float '''enemyRange'''(); ====

:no description

==== scriptEvent float '''enemyRange2D'''(); ====

:no description

==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

==== scriptEvent void '''faceEnemy'''(); ====

:No description

==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

==== scriptEvent float '''facingIdeal'''(); ====

:No description

==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

==== scriptEvent float '''getAudThresh'''(); ====

:no description

==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

==== scriptEvent entity '''getCombatNode'''(); ====

:No description

==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

==== scriptEvent entity '''getEnemy'''(); ====

:no description

==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

==== scriptEvent float '''getTurnDelta'''(); ====

:no description

==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

==== scriptEvent void '''kill'''(); ====

:Kills the monster.

==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

==== scriptEvent float '''moveStatus'''(); ====

:no description

==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

==== scriptEvent void '''moveToCover'''(); ====

:no description

==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

==== scriptEvent void '''moveToEnemy'''(); ====

:no description

==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

==== scriptEvent void '''preBurn'''(); ====

:no description

==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

==== scriptEvent entity '''randomPath'''(); ====

:no description

==== scriptEvent void '''restartPatrol'''(); ====

:no description

==== scriptEvent void '''restoreMove'''(); ====

:no description

==== scriptEvent void '''saveMove'''(); ====

:no description

==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

==== scriptEvent void '''shrivel'''(float time); ====

:no description

==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

==== scriptEvent void '''stopMove'''(); ====

:no description

==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

==== scriptEvent void '''stopThinking'''(); ====

:no description

==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

==== scriptEvent float '''testChargeAttack'''(); ====

:no description

==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

==== scriptEvent void '''throwAF'''(); ====

:no description

==== scriptEvent void '''throwMoveable'''(); ====

:no description

==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

==== scriptEvent void '''waitAction'''(string name); ====

:no description

==== scriptEvent void '''waitMove'''(); ====

:no description

==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

==== scriptEvent void '''wander'''(); ====

:no description

=== idTestModel ===
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

=== CBinaryFrobMover ===
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

=== idBrittleFracture ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

=== idCameraView ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idCameraAnim ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

=== idFuncEmitter ===
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

=== idEntity ===
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

==== scriptEvent void '''checkAbsence'''(); ====

:description missing

==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

==== scriptEvent void '''hideByLODBias'''(); ====

:internal

==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

==== scriptEvent float '''isLight'''(); ====

:No description

==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''StimRemove'''(float type); ====

:No description

==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

=== idAnimatedEntity ===
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

=== CFrobButton ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

=== CFrobDoor ===
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

=== CFrobDoorHandle ===
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

=== CFrobHandle ===
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

=== CFrobLever ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

=== CFrobLock ===
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

=== CFrobLockHandle ===
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

=== tdmFuncShooter ===
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

=== idEntityFx ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idClass ===
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

=== idItem ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''respawn'''(); ====

:Respawn

=== idMoveableItem ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idLight ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

==== scriptEvent void '''setStartedOff'''(); ====

:no description

==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

=== idPlayerStart ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idActivator ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPathCorner ===
==== scriptEvent entity '''randomPath'''(); ====

:no description

=== idDamagable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idExplodable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idForceField ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

=== idAnimated ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

=== idStaticEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncSmoke ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idVacuumSeparatorEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalEntity ===
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

=== idBeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idShaking ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idEarthQuake ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASObstacle ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPhantomObjects ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalSky ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== tdmVine ===
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

=== idMoveable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

=== idMover ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

=== idMover_Binary ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

=== idRotater ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idRiser ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPlayer ===
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

==== scriptEvent void '''checkAAS'''(); ====

:No description

==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

==== scriptEvent void '''customDeath'''(); ====

:No description

==== scriptEvent void '''deathMenu'''(); ====

:No description

==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

==== scriptEvent void '''exitTeleporter'''(); ====

:No description

==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

==== scriptEvent void '''missionFailed'''(); ====

:No description

==== scriptEvent void '''missionSuccess'''(); ====

:No description

==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

==== scriptEvent void '''playStartSound'''(); ====

:No description

==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

==== scriptEvent void '''saveGame'''(string filename); ====

:No description

==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

==== scriptEvent void '''stopFxFov'''(); ====

:No description

==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

=== idProjectile ===
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

=== CProjectileResult ===
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

=== CTarget_SetRelations ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idThread ===
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

==== scriptEvent void '''error'''(string text); ====

:Issues an error.

==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive):
::{|
|-
|gamePlayTime||gameplay time in seconds
|-
|damageDealt||damage dealt to enemies
|-
|damageReceived||damage received by player
|-
|healthReceived||health received by player
|-
|pocketsPicked||pockets picked by player
|-
|foundLoot||loot found by player
|-
|missionLoot||total loot available in mission
|-
|totalTimePlayerSeen||total time the player was seen by enemies in seconds
|-
|numberTimesPlayerSeen||number of times player was seen by enemies
|-
|numberTimesAISuspicious||number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score.
|-
|numberTimesAISearched||number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score.
|-
|sightingScore||sighting score (number of times player was seen * weight)
|-
|stealthScore||stealth score (sighting score + alerts * weights)
|-
|killedByPlayer||number of enemies killed by player
|-
|knockedOutByPlayer||number of enemies knocked out by player
|-
|bodiesFound||number of times enemies have spotted a body
|}

==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

=== Seed ===
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idSound ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

=== idTarget_Remove ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Show ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Damage ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SessionCommand ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EndLevel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_WaitForButton ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetGlobalShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderParm ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeIn ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeOut ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Give ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetModel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetInfluence ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetKeyVal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetFov ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_CallObjectFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_PostScriptEvent ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EnableLevelWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_RemoveWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeSoundClass ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_AddObjectives ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveVisibility ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveComponentState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_StartConversation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetFrobable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_CallScriptFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeLockState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeTarget ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_InterMissionTrigger ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetTeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger ===
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idTrigger_Multi ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_EntityName ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Timer ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Count ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Hurt ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Fade ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Touch ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idWeapon ===
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

==== scriptEvent float '''ammoInClip'''(); ====

:No description

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''clipSize'''(); ====

:No description

==== scriptEvent entity '''createProjectile'''(); ====

:no description

==== scriptEvent void '''ejectBrass'''(); ====

:no description

==== scriptEvent void '''flashlight'''(float enable); ====

:no description

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

==== scriptEvent float '''isInvisible'''(); ====

:no description

==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

==== scriptEvent float '''melee'''(); ====

:no description

==== scriptEvent void '''netEndReload'''(); ====

:no description

==== scriptEvent void '''netReload'''(); ====

:no description

==== scriptEvent void '''nextWeapon'''(); ====

:No description

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

==== scriptEvent void '''weaponHolstered'''(); ====

:no description

==== scriptEvent void '''weaponLowering'''(); ====

:no description

==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

==== scriptEvent void '''weaponReady'''(); ====

:no description

==== scriptEvent void '''weaponReloading'''(); ====

:no description

==== scriptEvent void '''weaponRising'''(); ====

:no description

==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

[[Category:Scripting]]

TDM Script Reference/2.03

2015-01-01T23:35:05Z

SteveL: /* scriptEvent float getMissionStatistic(string statisticName); */ formatting

This page has been generated automatically by the tdm_gen_script_event_doc console command.

'''This is a pre-release page for TDM 2.03: Not all script events on this page are available in the current TDM version 2.02 and this page does ''not'' have the manual amendments to the current documentation.'''

Generated by The Dark Mod 2.03, code revision 6439, last update: 2015-01-01 23:22

{{tdm-scripting-reference-intro}}
<div class="toclimit-4">
__TOC__
</div>
= TDM Script Event Reference =

== All Events ==
=== Alphabetic List ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''CTarget_AddObjectives'', ''CTarget_CallScriptFunction'', ''CTarget_ChangeEntityRelation'', ''CTarget_ChangeLockState'', ''CTarget_ChangeTarget'', ''CTarget_InterMissionTrigger'', ''CTarget_SetEntityRelation'', ''CTarget_SetFrobable'', ''CTarget_SetObjectiveComponentState'', ''CTarget_SetObjectiveState'', ''CTarget_SetObjectiveVisibility'', ''CTarget_SetRelations'', ''CTarget_SetTeam'', ''CTarget_StartConversation'', ''idAFEntity_Generic'', ''idAFEntity_WithAttachedHead'', ''idAI'', ''idActivator'', ''idAnimated'', ''idBeam'', ''idBrittleFracture'', ''idCameraAnim'', ''idCameraView'', ''idCombatNode'', ''idDamagable'', ''idEarthQuake'', ''idEntityFx'', ''idExplodable'', ''idForceField'', ''idFuncAASObstacle'', ''idFuncAASPortal'', ''idFuncPortal'', ''idFuncSmoke'', ''idItem'', ''idLight'', ''idMoveable'', ''idMover'', ''idMover_Binary'', ''idPhantomObjects'', ''idPlayerStart'', ''idPortalSky'', ''idRiser'', ''idRotater'', ''idShaking'', ''idSound'', ''idStaticEntity'', ''idTarget_CallObjectFunction'', ''idTarget_Damage'', ''idTarget_EnableLevelWeapons'', ''idTarget_EndLevel'', ''idTarget_FadeEntity'', ''idTarget_FadeSoundClass'', ''idTarget_Give'', ''idTarget_LightFadeIn'', ''idTarget_LightFadeOut'', ''idTarget_PostScriptEvent'', ''idTarget_Remove'', ''idTarget_RemoveWeapons'', ''idTarget_SessionCommand'', ''idTarget_SetFov'', ''idTarget_SetGlobalShaderTime'', ''idTarget_SetInfluence'', ''idTarget_SetKeyVal'', ''idTarget_SetModel'', ''idTarget_SetShaderParm'', ''idTarget_SetShaderTime'', ''idTarget_Show'', ''idTarget_WaitForButton'', ''idTrigger_Count'', ''idTrigger_EntityName'', ''idTrigger_Fade'', ''idTrigger_Hurt'', ''idTrigger_Multi'', ''idTrigger_Timer'', ''idTrigger_Touch'', ''idVacuumSeparatorEntity''
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''ammoInClip'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''attackEnd'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

:Spawnclasses responding to this event: ''idAI'', ''idMoveable''
==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''burn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canHitEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSee'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''checkAAS'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''checkAbsence'''(); ====

:description missing

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearSignal'''(float signalNum); ====

:Disables the callback function on the specified signal.
::''signalNum'': signal number

:Spawnclasses responding to this event:
==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''clipSize'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''createProjectile'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

:Spawnclasses responding to this event: ''Seed''
==== scriptEvent void '''customDeath'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

:Spawnclasses responding to this event: ''idBrittleFracture''
==== scriptEvent void '''deathMenu'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''disableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropTorch'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''ejectBrass'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''enableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange2D'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''error'''(string text); ====

:Issues an error.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''exitTeleporter'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''faceEnemy'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''facingIdeal'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''flashlight'''(float enable); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated''
==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getAudThresh'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCombatNode'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

:Spawnclasses responding to this event: ''CFrobDoorHandle''
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getIdealWeapon'''(); ====

:No description

:Spawnclasses responding to this event:
==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

:Spawnclasses responding to this event: ''CFrobLockHandle''
==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive):
::{|
|-
|gamePlayTime||gameplay time in seconds
|-
|damageDealt||damage dealt to enemies
|-
|damageReceived||damage received by player
|-
|healthReceived||health received by player
|-
|pocketsPicked||pockets picked by player
|-
|foundLoot||loot found by player
|-
|missionLoot||total loot available in mission
|-
|totalTimePlayerSeen||total time the player was seen by enemies in seconds
|-
|numberTimesPlayerSeen||number of times player was seen by enemies
|-
|numberTimesAISuspicious||number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score.
|-
|numberTimesAISearched||number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score.
|-
|sightingScore||sighting score (number of times player was seen * weight)
|-
|stealthScore||stealth score (sighting score + alerts * weights)
|-
|killedByPlayer||number of enemies killed by player
|-
|knockedOutByPlayer||number of enemies knocked out by player
|-
|bodiesFound||number of times enemies have spotted a body
|}

:Spawnclasses responding to this event: ''idThread''

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getState'''(); ====

:Gets the current state.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTurnDelta'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Gibbable'', ''idMoveableItem''
==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''hideByLODBias'''(); ====

:internal

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInvisible'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''isLight'''(); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''kill'''(); ====

:Kills the monster.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

:Spawnclasses responding to this event: ''idCombatNode''
==== scriptEvent float '''melee'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''missionFailed'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''missionSuccess'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''moveStatus'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCover'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''netEndReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''netReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''nextWeapon'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''On'''(); ====

:Turns the entity on.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

:Spawnclasses responding to this event: ''CFrobButton'', ''CFrobLever''
==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''playStartSound'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''preBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''randomPath'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI'', ''idPathCorner''
==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

:Spawnclasses responding to this event: ''idClass''
==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''respawn'''(); ====

:Respawn

:Spawnclasses responding to this event: ''idItem''
==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restartPatrol'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''restoreMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''saveGame'''(string filename); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''saveMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setStartedOff'''(); ====

:no description

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''shrivel'''(float time); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''stopFxFov'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopThinking'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

:Spawnclasses responding to this event: ''CFrobLever''
==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

:Spawnclasses responding to this event: ''CFrobHandle''
==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock'', ''idProjectile''
==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testChargeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''throwAF'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''throwMoveable'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

:Spawnclasses responding to this event: ''idForceField''
==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitAction'''(string name); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wander'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''weaponHolstered'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponLowering'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReady'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReloading'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponRising'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''

== Events by Spawnclass / Entity Type ==
=== idActor ===
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

==== scriptEvent string '''getState'''(); ====

:Gets the current state.

==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

=== idAFEntity_Base ===
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

=== idAFEntity_Gibbable ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idAFEntity_Generic ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idAFEntity_WithAttachedHead ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CAIVehicle ===
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

=== idCombatNode ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

=== idAI ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

==== scriptEvent void '''attackEnd'''(); ====

:no description

==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

==== scriptEvent void '''becomeSolid'''(); ====

:no description

==== scriptEvent void '''burn'''(); ====

:no description

==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

==== scriptEvent float '''canHitEnemy'''(); ====

:no description

==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

==== scriptEvent float '''canSee'''(entity ent); ====

:no description

==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

==== scriptEvent void '''clearBurn'''(); ====

:no description

==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

==== scriptEvent void '''disableAFPush'''(); ====

:no description

==== scriptEvent void '''disableClip'''(); ====

:no description

==== scriptEvent void '''disableGravity'''(); ====

:no description

==== scriptEvent void '''dropTorch'''(); ====

:no description

==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

==== scriptEvent void '''enableAFPush'''(); ====

:no description

==== scriptEvent void '''enableClip'''(); ====

:no description

==== scriptEvent void '''enableGravity'''(); ====

:no description

==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

==== scriptEvent float '''enemyRange'''(); ====

:no description

==== scriptEvent float '''enemyRange2D'''(); ====

:no description

==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

==== scriptEvent void '''faceEnemy'''(); ====

:No description

==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

==== scriptEvent float '''facingIdeal'''(); ====

:No description

==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

==== scriptEvent float '''getAudThresh'''(); ====

:no description

==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

==== scriptEvent entity '''getCombatNode'''(); ====

:No description

==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

==== scriptEvent entity '''getEnemy'''(); ====

:no description

==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

==== scriptEvent float '''getTurnDelta'''(); ====

:no description

==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

==== scriptEvent void '''kill'''(); ====

:Kills the monster.

==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

==== scriptEvent float '''moveStatus'''(); ====

:no description

==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

==== scriptEvent void '''moveToCover'''(); ====

:no description

==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

==== scriptEvent void '''moveToEnemy'''(); ====

:no description

==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

==== scriptEvent void '''preBurn'''(); ====

:no description

==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

==== scriptEvent entity '''randomPath'''(); ====

:no description

==== scriptEvent void '''restartPatrol'''(); ====

:no description

==== scriptEvent void '''restoreMove'''(); ====

:no description

==== scriptEvent void '''saveMove'''(); ====

:no description

==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

==== scriptEvent void '''shrivel'''(float time); ====

:no description

==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

==== scriptEvent void '''stopMove'''(); ====

:no description

==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

==== scriptEvent void '''stopThinking'''(); ====

:no description

==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

==== scriptEvent float '''testChargeAttack'''(); ====

:no description

==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

==== scriptEvent void '''throwAF'''(); ====

:no description

==== scriptEvent void '''throwMoveable'''(); ====

:no description

==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

==== scriptEvent void '''waitAction'''(string name); ====

:no description

==== scriptEvent void '''waitMove'''(); ====

:no description

==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

==== scriptEvent void '''wander'''(); ====

:no description

=== idTestModel ===
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

=== CBinaryFrobMover ===
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

=== idBrittleFracture ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

=== idCameraView ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idCameraAnim ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

=== idFuncEmitter ===
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

=== idEntity ===
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

==== scriptEvent void '''checkAbsence'''(); ====

:description missing

==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

==== scriptEvent void '''hideByLODBias'''(); ====

:internal

==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

==== scriptEvent float '''isLight'''(); ====

:No description

==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''StimRemove'''(float type); ====

:No description

==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

=== idAnimatedEntity ===
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

=== CFrobButton ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

=== CFrobDoor ===
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

=== CFrobDoorHandle ===
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

=== CFrobHandle ===
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

=== CFrobLever ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

=== CFrobLock ===
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

=== CFrobLockHandle ===
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

=== tdmFuncShooter ===
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

=== idEntityFx ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idClass ===
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

=== idItem ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''respawn'''(); ====

:Respawn

=== idMoveableItem ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idLight ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

==== scriptEvent void '''setStartedOff'''(); ====

:no description

==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

=== idPlayerStart ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idActivator ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPathCorner ===
==== scriptEvent entity '''randomPath'''(); ====

:no description

=== idDamagable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idExplodable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idForceField ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

=== idAnimated ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

=== idStaticEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncSmoke ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idVacuumSeparatorEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalEntity ===
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

=== idBeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idShaking ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idEarthQuake ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASObstacle ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPhantomObjects ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalSky ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== tdmVine ===
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

=== idMoveable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

=== idMover ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

=== idMover_Binary ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

=== idRotater ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idRiser ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPlayer ===
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

==== scriptEvent void '''checkAAS'''(); ====

:No description

==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

==== scriptEvent void '''customDeath'''(); ====

:No description

==== scriptEvent void '''deathMenu'''(); ====

:No description

==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

==== scriptEvent void '''exitTeleporter'''(); ====

:No description

==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

==== scriptEvent void '''missionFailed'''(); ====

:No description

==== scriptEvent void '''missionSuccess'''(); ====

:No description

==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

==== scriptEvent void '''playStartSound'''(); ====

:No description

==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

==== scriptEvent void '''saveGame'''(string filename); ====

:No description

==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

==== scriptEvent void '''stopFxFov'''(); ====

:No description

==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

=== idProjectile ===
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

=== CProjectileResult ===
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

=== CTarget_SetRelations ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idThread ===
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

==== scriptEvent void '''error'''(string text); ====

:Issues an error.

==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive):
::{|
|-
|gamePlayTime||gameplay time in seconds
|-
|damageDealt||damage dealt to enemies
|-
|damageReceived||damage received by player
|-
|healthReceived||health received by player
|-
|pocketsPicked||pockets picked by player
|-
|foundLoot||loot found by player
|-
|missionLoot||total loot available in mission
|-
|totalTimePlayerSeen||total time the player was seen by enemies in seconds
|-
|numberTimesPlayerSeen||number of times player was seen by enemies
|-
|numberTimesAISuspicious||number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score.
|-
|numberTimesAISearched||number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score.
|-
|sightingScore||sighting score (number of times player was seen * weight)
|-
|stealthScore||stealth score (sighting score + alerts * weights)
|-
|killedByPlayer||number of enemies killed by player
|-
|knockedOutByPlayer||number of enemies knocked out by player
|-
|bodiesFound||number of times enemies have spotted a body
|}

==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

=== Seed ===
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idSound ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

=== idTarget_Remove ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Show ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Damage ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SessionCommand ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EndLevel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_WaitForButton ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetGlobalShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderParm ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeIn ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeOut ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Give ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetModel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetInfluence ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetKeyVal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetFov ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_CallObjectFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_PostScriptEvent ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EnableLevelWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_RemoveWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeSoundClass ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_AddObjectives ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveVisibility ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveComponentState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_StartConversation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetFrobable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_CallScriptFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeLockState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeTarget ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_InterMissionTrigger ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetTeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger ===
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idTrigger_Multi ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_EntityName ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Timer ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Count ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Hurt ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Fade ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Touch ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idWeapon ===
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

==== scriptEvent float '''ammoInClip'''(); ====

:No description

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''clipSize'''(); ====

:No description

==== scriptEvent entity '''createProjectile'''(); ====

:no description

==== scriptEvent void '''ejectBrass'''(); ====

:no description

==== scriptEvent void '''flashlight'''(float enable); ====

:no description

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

==== scriptEvent float '''isInvisible'''(); ====

:no description

==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

==== scriptEvent float '''melee'''(); ====

:no description

==== scriptEvent void '''netEndReload'''(); ====

:no description

==== scriptEvent void '''netReload'''(); ====

:no description

==== scriptEvent void '''nextWeapon'''(); ====

:No description

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

==== scriptEvent void '''weaponHolstered'''(); ====

:no description

==== scriptEvent void '''weaponLowering'''(); ====

:no description

==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

==== scriptEvent void '''weaponReady'''(); ====

:no description

==== scriptEvent void '''weaponReloading'''(); ====

:no description

==== scriptEvent void '''weaponRising'''(); ====

:no description

==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

[[Category:Scripting]]

TDM Script Reference/2.03

2015-01-01T23:34:29Z

SteveL: /* scriptEvent float getMissionStatistic(string statisticName); */ formatting

This page has been generated automatically by the tdm_gen_script_event_doc console command.

'''This is a pre-release page for TDM 2.03: Not all script events on this page are available in the current TDM version 2.02 and this page does ''not'' have the manual amendments to the current documentation.'''

Generated by The Dark Mod 2.03, code revision 6439, last update: 2015-01-01 23:22

{{tdm-scripting-reference-intro}}
<div class="toclimit-4">
__TOC__
</div>
= TDM Script Event Reference =

== All Events ==
=== Alphabetic List ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''CTarget_AddObjectives'', ''CTarget_CallScriptFunction'', ''CTarget_ChangeEntityRelation'', ''CTarget_ChangeLockState'', ''CTarget_ChangeTarget'', ''CTarget_InterMissionTrigger'', ''CTarget_SetEntityRelation'', ''CTarget_SetFrobable'', ''CTarget_SetObjectiveComponentState'', ''CTarget_SetObjectiveState'', ''CTarget_SetObjectiveVisibility'', ''CTarget_SetRelations'', ''CTarget_SetTeam'', ''CTarget_StartConversation'', ''idAFEntity_Generic'', ''idAFEntity_WithAttachedHead'', ''idAI'', ''idActivator'', ''idAnimated'', ''idBeam'', ''idBrittleFracture'', ''idCameraAnim'', ''idCameraView'', ''idCombatNode'', ''idDamagable'', ''idEarthQuake'', ''idEntityFx'', ''idExplodable'', ''idForceField'', ''idFuncAASObstacle'', ''idFuncAASPortal'', ''idFuncPortal'', ''idFuncSmoke'', ''idItem'', ''idLight'', ''idMoveable'', ''idMover'', ''idMover_Binary'', ''idPhantomObjects'', ''idPlayerStart'', ''idPortalSky'', ''idRiser'', ''idRotater'', ''idShaking'', ''idSound'', ''idStaticEntity'', ''idTarget_CallObjectFunction'', ''idTarget_Damage'', ''idTarget_EnableLevelWeapons'', ''idTarget_EndLevel'', ''idTarget_FadeEntity'', ''idTarget_FadeSoundClass'', ''idTarget_Give'', ''idTarget_LightFadeIn'', ''idTarget_LightFadeOut'', ''idTarget_PostScriptEvent'', ''idTarget_Remove'', ''idTarget_RemoveWeapons'', ''idTarget_SessionCommand'', ''idTarget_SetFov'', ''idTarget_SetGlobalShaderTime'', ''idTarget_SetInfluence'', ''idTarget_SetKeyVal'', ''idTarget_SetModel'', ''idTarget_SetShaderParm'', ''idTarget_SetShaderTime'', ''idTarget_Show'', ''idTarget_WaitForButton'', ''idTrigger_Count'', ''idTrigger_EntityName'', ''idTrigger_Fade'', ''idTrigger_Hurt'', ''idTrigger_Multi'', ''idTrigger_Timer'', ''idTrigger_Touch'', ''idVacuumSeparatorEntity''
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''ammoInClip'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''attackEnd'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

:Spawnclasses responding to this event: ''idAI'', ''idMoveable''
==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''burn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canHitEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSee'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''checkAAS'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''checkAbsence'''(); ====

:description missing

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearSignal'''(float signalNum); ====

:Disables the callback function on the specified signal.
::''signalNum'': signal number

:Spawnclasses responding to this event:
==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''clipSize'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''createProjectile'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

:Spawnclasses responding to this event: ''Seed''
==== scriptEvent void '''customDeath'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

:Spawnclasses responding to this event: ''idBrittleFracture''
==== scriptEvent void '''deathMenu'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''disableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropTorch'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''ejectBrass'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''enableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange2D'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''error'''(string text); ====

:Issues an error.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''exitTeleporter'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''faceEnemy'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''facingIdeal'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''flashlight'''(float enable); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated''
==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getAudThresh'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCombatNode'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

:Spawnclasses responding to this event: ''CFrobDoorHandle''
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getIdealWeapon'''(); ====

:No description

:Spawnclasses responding to this event:
==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

:Spawnclasses responding to this event: ''CFrobLockHandle''
==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive):
::{|
|-
|gamePlayTime||gameplay time in seconds
|-
|damageDealt||damage dealt to enemies
|-
|damageReceived||damage received by player
|-
|healthReceived||health received by player
|-
|pocketsPicked||pockets picked by player
|-
|foundLoot||loot found by player
|-
|missionLoot||total loot available in mission
|-
|totalTimePlayerSeen||total time the player was seen by enemies in seconds
|-
|numberTimesPlayerSeen||number of times player was seen by enemies
|-
|numberTimesAISuspicious||number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score.
|-
|numberTimesAISearched||number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score.
|-
|sightingScore||sighting score (number of times player was seen * weight)
|-
|stealthScore||stealth score (sighting score + alerts * weights)
|-
|killedByPlayer||number of enemies killed by player
|-
|knockedOutByPlayer||number of enemies knocked out by player
|-
|bodiesFound||number of times enemies have spotted a body
|}

:Spawnclasses responding to this event: ''idThread''

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getState'''(); ====

:Gets the current state.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTurnDelta'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Gibbable'', ''idMoveableItem''
==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''hideByLODBias'''(); ====

:internal

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInvisible'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''isLight'''(); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''kill'''(); ====

:Kills the monster.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

:Spawnclasses responding to this event: ''idCombatNode''
==== scriptEvent float '''melee'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''missionFailed'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''missionSuccess'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''moveStatus'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCover'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''netEndReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''netReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''nextWeapon'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''On'''(); ====

:Turns the entity on.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

:Spawnclasses responding to this event: ''CFrobButton'', ''CFrobLever''
==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''playStartSound'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''preBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''randomPath'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI'', ''idPathCorner''
==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

:Spawnclasses responding to this event: ''idClass''
==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''respawn'''(); ====

:Respawn

:Spawnclasses responding to this event: ''idItem''
==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restartPatrol'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''restoreMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''saveGame'''(string filename); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''saveMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setStartedOff'''(); ====

:no description

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''shrivel'''(float time); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''stopFxFov'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopThinking'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

:Spawnclasses responding to this event: ''CFrobLever''
==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

:Spawnclasses responding to this event: ''CFrobHandle''
==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock'', ''idProjectile''
==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testChargeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''throwAF'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''throwMoveable'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

:Spawnclasses responding to this event: ''idForceField''
==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitAction'''(string name); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wander'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''weaponHolstered'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponLowering'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReady'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReloading'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponRising'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''

== Events by Spawnclass / Entity Type ==
=== idActor ===
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

==== scriptEvent string '''getState'''(); ====

:Gets the current state.

==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

=== idAFEntity_Base ===
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

=== idAFEntity_Gibbable ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idAFEntity_Generic ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idAFEntity_WithAttachedHead ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CAIVehicle ===
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

=== idCombatNode ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

=== idAI ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

==== scriptEvent void '''attackEnd'''(); ====

:no description

==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

==== scriptEvent void '''becomeSolid'''(); ====

:no description

==== scriptEvent void '''burn'''(); ====

:no description

==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

==== scriptEvent float '''canHitEnemy'''(); ====

:no description

==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

==== scriptEvent float '''canSee'''(entity ent); ====

:no description

==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

==== scriptEvent void '''clearBurn'''(); ====

:no description

==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

==== scriptEvent void '''disableAFPush'''(); ====

:no description

==== scriptEvent void '''disableClip'''(); ====

:no description

==== scriptEvent void '''disableGravity'''(); ====

:no description

==== scriptEvent void '''dropTorch'''(); ====

:no description

==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

==== scriptEvent void '''enableAFPush'''(); ====

:no description

==== scriptEvent void '''enableClip'''(); ====

:no description

==== scriptEvent void '''enableGravity'''(); ====

:no description

==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

==== scriptEvent float '''enemyRange'''(); ====

:no description

==== scriptEvent float '''enemyRange2D'''(); ====

:no description

==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

==== scriptEvent void '''faceEnemy'''(); ====

:No description

==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

==== scriptEvent float '''facingIdeal'''(); ====

:No description

==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

==== scriptEvent float '''getAudThresh'''(); ====

:no description

==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

==== scriptEvent entity '''getCombatNode'''(); ====

:No description

==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

==== scriptEvent entity '''getEnemy'''(); ====

:no description

==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

==== scriptEvent float '''getTurnDelta'''(); ====

:no description

==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

==== scriptEvent void '''kill'''(); ====

:Kills the monster.

==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

==== scriptEvent float '''moveStatus'''(); ====

:no description

==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

==== scriptEvent void '''moveToCover'''(); ====

:no description

==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

==== scriptEvent void '''moveToEnemy'''(); ====

:no description

==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

==== scriptEvent void '''preBurn'''(); ====

:no description

==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

==== scriptEvent entity '''randomPath'''(); ====

:no description

==== scriptEvent void '''restartPatrol'''(); ====

:no description

==== scriptEvent void '''restoreMove'''(); ====

:no description

==== scriptEvent void '''saveMove'''(); ====

:no description

==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

==== scriptEvent void '''shrivel'''(float time); ====

:no description

==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

==== scriptEvent void '''stopMove'''(); ====

:no description

==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

==== scriptEvent void '''stopThinking'''(); ====

:no description

==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

==== scriptEvent float '''testChargeAttack'''(); ====

:no description

==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

==== scriptEvent void '''throwAF'''(); ====

:no description

==== scriptEvent void '''throwMoveable'''(); ====

:no description

==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

==== scriptEvent void '''waitAction'''(string name); ====

:no description

==== scriptEvent void '''waitMove'''(); ====

:no description

==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

==== scriptEvent void '''wander'''(); ====

:no description

=== idTestModel ===
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

=== CBinaryFrobMover ===
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

=== idBrittleFracture ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

=== idCameraView ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idCameraAnim ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

=== idFuncEmitter ===
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

=== idEntity ===
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

==== scriptEvent void '''checkAbsence'''(); ====

:description missing

==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

==== scriptEvent void '''hideByLODBias'''(); ====

:internal

==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

==== scriptEvent float '''isLight'''(); ====

:No description

==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''StimRemove'''(float type); ====

:No description

==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

=== idAnimatedEntity ===
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

=== CFrobButton ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

=== CFrobDoor ===
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

=== CFrobDoorHandle ===
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

=== CFrobHandle ===
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

=== CFrobLever ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

=== CFrobLock ===
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

=== CFrobLockHandle ===
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

=== tdmFuncShooter ===
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

=== idEntityFx ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idClass ===
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

=== idItem ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''respawn'''(); ====

:Respawn

=== idMoveableItem ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idLight ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

==== scriptEvent void '''setStartedOff'''(); ====

:no description

==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

=== idPlayerStart ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idActivator ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPathCorner ===
==== scriptEvent entity '''randomPath'''(); ====

:no description

=== idDamagable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idExplodable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idForceField ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

=== idAnimated ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

=== idStaticEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncSmoke ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idVacuumSeparatorEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalEntity ===
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

=== idBeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idShaking ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idEarthQuake ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASObstacle ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPhantomObjects ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalSky ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== tdmVine ===
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

=== idMoveable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

=== idMover ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

=== idMover_Binary ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

=== idRotater ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idRiser ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPlayer ===
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

==== scriptEvent void '''checkAAS'''(); ====

:No description

==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

==== scriptEvent void '''customDeath'''(); ====

:No description

==== scriptEvent void '''deathMenu'''(); ====

:No description

==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

==== scriptEvent void '''exitTeleporter'''(); ====

:No description

==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

==== scriptEvent void '''missionFailed'''(); ====

:No description

==== scriptEvent void '''missionSuccess'''(); ====

:No description

==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

==== scriptEvent void '''playStartSound'''(); ====

:No description

==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

==== scriptEvent void '''saveGame'''(string filename); ====

:No description

==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

==== scriptEvent void '''stopFxFov'''(); ====

:No description

==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

=== idProjectile ===
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

=== CProjectileResult ===
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

=== CTarget_SetRelations ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idThread ===
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

==== scriptEvent void '''error'''(string text); ====

:Issues an error.

==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive): gamePlayTime: gameplay time in seconds damageDealt: damage dealt to enemies damageReceived: damage received by player healthReceived: health received by player pocketsPicked: pockets picked by player foundLoot: loot found by player missionLoot: total loot available in mission totalTimePlayerSeen: total time the player was seen by enemies in seconds. Updates only when AI lose sight of player numberTimesPlayerSeen: number of times player was seen by enemies numberTimesAISuspicious: number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score. numberTimesAISearched: number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score. sightingScore: sighting score (number of times player was seen * weight) stealthScore: stealth score (sighting score + alerts * weights) killedByPlayer: number of enemies killed by player knockedOutByPlayer: number of enemies knocked out by player bodiesFound: number of times enemies have spotted a body

==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

=== Seed ===
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idSound ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

=== idTarget_Remove ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Show ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Damage ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SessionCommand ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EndLevel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_WaitForButton ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetGlobalShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderParm ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeIn ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeOut ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Give ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetModel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetInfluence ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetKeyVal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetFov ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_CallObjectFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_PostScriptEvent ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EnableLevelWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_RemoveWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeSoundClass ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_AddObjectives ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveVisibility ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveComponentState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_StartConversation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetFrobable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_CallScriptFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeLockState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeTarget ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_InterMissionTrigger ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetTeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger ===
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idTrigger_Multi ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_EntityName ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Timer ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Count ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Hurt ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Fade ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Touch ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idWeapon ===
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

==== scriptEvent float '''ammoInClip'''(); ====

:No description

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''clipSize'''(); ====

:No description

==== scriptEvent entity '''createProjectile'''(); ====

:no description

==== scriptEvent void '''ejectBrass'''(); ====

:no description

==== scriptEvent void '''flashlight'''(float enable); ====

:no description

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

==== scriptEvent float '''isInvisible'''(); ====

:no description

==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

==== scriptEvent float '''melee'''(); ====

:no description

==== scriptEvent void '''netEndReload'''(); ====

:no description

==== scriptEvent void '''netReload'''(); ====

:no description

==== scriptEvent void '''nextWeapon'''(); ====

:No description

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

==== scriptEvent void '''weaponHolstered'''(); ====

:no description

==== scriptEvent void '''weaponLowering'''(); ====

:no description

==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

==== scriptEvent void '''weaponReady'''(); ====

:no description

==== scriptEvent void '''weaponReloading'''(); ====

:no description

==== scriptEvent void '''weaponRising'''(); ====

:no description

==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

[[Category:Scripting]]

Talk:TDM Script Reference/2.03

2015-01-01T23:32:51Z

SteveL: Manual amendments to the generated text

== Manual amendments to the generated text ==
# Added a table to format the parameter description of idThread.GetMissionStatistic(). The information is too complex to format readably in the source code, given that 3 output methods are supported so no markup can be used. [[User:SteveL|SteveL]] ([[User talk:SteveL|talk]]) 23:32, 1 January 2015 (UTC)

TDM Script Reference/2.03

2015-01-01T23:25:21Z

SteveL: updating for release

This page has been generated automatically by the tdm_gen_script_event_doc console command.

'''This is a pre-release page for TDM 2.03: Not all script events on this page are available in the current TDM version 2.02 and this page does ''not'' have the manual amendments to the current documentation.'''

Generated by The Dark Mod 2.03, code revision 6439, last update: 2015-01-01 23:22

{{tdm-scripting-reference-intro}}
<div class="toclimit-4">
__TOC__
</div>
= TDM Script Event Reference =

== All Events ==
=== Alphabetic List ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''CTarget_AddObjectives'', ''CTarget_CallScriptFunction'', ''CTarget_ChangeEntityRelation'', ''CTarget_ChangeLockState'', ''CTarget_ChangeTarget'', ''CTarget_InterMissionTrigger'', ''CTarget_SetEntityRelation'', ''CTarget_SetFrobable'', ''CTarget_SetObjectiveComponentState'', ''CTarget_SetObjectiveState'', ''CTarget_SetObjectiveVisibility'', ''CTarget_SetRelations'', ''CTarget_SetTeam'', ''CTarget_StartConversation'', ''idAFEntity_Generic'', ''idAFEntity_WithAttachedHead'', ''idAI'', ''idActivator'', ''idAnimated'', ''idBeam'', ''idBrittleFracture'', ''idCameraAnim'', ''idCameraView'', ''idCombatNode'', ''idDamagable'', ''idEarthQuake'', ''idEntityFx'', ''idExplodable'', ''idForceField'', ''idFuncAASObstacle'', ''idFuncAASPortal'', ''idFuncPortal'', ''idFuncSmoke'', ''idItem'', ''idLight'', ''idMoveable'', ''idMover'', ''idMover_Binary'', ''idPhantomObjects'', ''idPlayerStart'', ''idPortalSky'', ''idRiser'', ''idRotater'', ''idShaking'', ''idSound'', ''idStaticEntity'', ''idTarget_CallObjectFunction'', ''idTarget_Damage'', ''idTarget_EnableLevelWeapons'', ''idTarget_EndLevel'', ''idTarget_FadeEntity'', ''idTarget_FadeSoundClass'', ''idTarget_Give'', ''idTarget_LightFadeIn'', ''idTarget_LightFadeOut'', ''idTarget_PostScriptEvent'', ''idTarget_Remove'', ''idTarget_RemoveWeapons'', ''idTarget_SessionCommand'', ''idTarget_SetFov'', ''idTarget_SetGlobalShaderTime'', ''idTarget_SetInfluence'', ''idTarget_SetKeyVal'', ''idTarget_SetModel'', ''idTarget_SetShaderParm'', ''idTarget_SetShaderTime'', ''idTarget_Show'', ''idTarget_WaitForButton'', ''idTrigger_Count'', ''idTrigger_EntityName'', ''idTrigger_Fade'', ''idTrigger_Hurt'', ''idTrigger_Multi'', ''idTrigger_Timer'', ''idTrigger_Touch'', ''idVacuumSeparatorEntity''
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''ammoInClip'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''attackEnd'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

:Spawnclasses responding to this event: ''idAI'', ''idMoveable''
==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''becomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''burn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canHitEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSee'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''checkAAS'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''checkAbsence'''(); ====

:description missing

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearSignal'''(float signalNum); ====

:Disables the callback function on the specified signal.
::''signalNum'': signal number

:Spawnclasses responding to this event:
==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''clipSize'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''createProjectile'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

:Spawnclasses responding to this event: ''Seed''
==== scriptEvent void '''customDeath'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

:Spawnclasses responding to this event: ''idBrittleFracture''
==== scriptEvent void '''deathMenu'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''disableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''dropTorch'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''ejectBrass'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

:Spawnclasses responding to this event: ''idFuncEmitter''
==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

:Spawnclasses responding to this event: ''Seed'', ''idMover_Binary'', ''idTrigger''
==== scriptEvent void '''enableAFPush'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableClip'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableGravity'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''enemyRange2D'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''error'''(string text); ====

:Issues an error.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''exitTeleporter'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''faceEnemy'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''facingIdeal'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''flashlight'''(float enable); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated''
==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getAudThresh'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCombatNode'''(); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

:Spawnclasses responding to this event: ''CFrobDoorHandle''
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getIdealWeapon'''(); ====

:No description

:Spawnclasses responding to this event:
==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

:Spawnclasses responding to this event: ''CFrobLockHandle''
==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive): gamePlayTime: gameplay time in seconds damageDealt: damage dealt to enemies damageReceived: damage received by player healthReceived: health received by player pocketsPicked: pockets picked by player foundLoot: loot found by player missionLoot: total loot available in mission totalTimePlayerSeen: total time the player was seen by enemies in seconds. Updates only when AI lose sight of player numberTimesPlayerSeen: number of times player was seen by enemies numberTimesAISuspicious: number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score. numberTimesAISearched: number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score. sightingScore: sighting score (number of times player was seen * weight) stealthScore: stealth score (sighting score + alerts * weights) killedByPlayer: number of enemies killed by player knockedOutByPlayer: number of enemies knocked out by player bodiesFound: number of times enemies have spotted a body

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent string '''getState'''(); ====

:Gets the current state.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''getTurnDelta'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Gibbable'', ''idMoveableItem''
==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''hideByLODBias'''(); ====

:internal

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

:Spawnclasses responding to this event: ''idMoveable''
==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isInvisible'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''isLight'''(); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

:Spawnclasses responding to this event: ''CProjectileResult''
==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''kill'''(); ====

:Kills the monster.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

:Spawnclasses responding to this event: ''idProjectile''
==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

:Spawnclasses responding to this event: ''idCombatNode''
==== scriptEvent float '''melee'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''missionFailed'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''missionSuccess'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''moveStatus'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCover'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemy'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''netEndReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''netReload'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''nextWeapon'''(); ====

:No description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''On'''(); ====

:Turns the entity on.

:Spawnclasses responding to this event: ''idLight'', ''idSound''
==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

:Spawnclasses responding to this event: ''CFrobDoor''
==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

:Spawnclasses responding to this event: ''idMover'', ''idMover_Binary''
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

:Spawnclasses responding to this event: ''CFrobButton'', ''CFrobLever''
==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''playStartSound'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''preBurn'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''randomPath'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI'', ''idPathCorner''
==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

:Spawnclasses responding to this event: ''idClass''
==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''respawn'''(); ====

:Respawn

:Spawnclasses responding to this event: ''idItem''
==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restartPatrol'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''restoreMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

:Spawnclasses responding to this event: ''idActor'', ''idAnimated'', ''idTestModel''
==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''saveGame'''(string filename); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''saveMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

:Spawnclasses responding to this event: ''CAIVehicle''
==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

:Spawnclasses responding to this event: ''idAnimatedEntity''
==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

:Spawnclasses responding to this event: ''idLight'', ''idWeapon''
==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

:Spawnclasses responding to this event: ''idAFEntity_Base''
==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

:Spawnclasses responding to this event: ''idPortalEntity''
==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setStartedOff'''(); ====

:no description

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

:Spawnclasses responding to this event: ''tdmVine''
==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

:Spawnclasses responding to this event: ''tdmFuncShooter''
==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

:Spawnclasses responding to this event: ''idActor'', ''idWeapon''
==== scriptEvent void '''shrivel'''(float time); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

:Spawnclasses responding to this event: ''idLight''
==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

:Spawnclasses responding to this event: ''idAnimated''
==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''StimRemove'''(float type); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

:Spawnclasses responding to this event: ''idCameraAnim''
==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''stopFxFov'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''stopMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''stopThinking'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

:Spawnclasses responding to this event: ''CFrobLever''
==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

:Spawnclasses responding to this event: ''idActor''
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

:Spawnclasses responding to this event: ''CFrobHandle''
==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock'', ''idProjectile''
==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testChargeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''throwAF'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''throwMoveable'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

:Spawnclasses responding to this event: ''idMover''
==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

:Spawnclasses responding to this event: ''idForceField''
==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitAction'''(string name); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

:Spawnclasses responding to this event: ''idEntity'', ''idThread''
==== scriptEvent void '''waitMove'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''wander'''(); ====

:no description

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''weaponHolstered'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponLowering'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReady'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponReloading'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponRising'''(); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''
==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

:Spawnclasses responding to this event: ''idWeapon''

== Events by Spawnclass / Entity Type ==
=== idActor ===
==== scriptEvent float '''animDistance'''(float channel, string animName); ====

:Returns the distance that the anim travels. If the entity has multiple anims with animName, the distance may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animDistance.

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''animLength'''(float channel, string animName); ====

:Returns the length of the anim in seconds. If the entity has multiple anims with animName, length may not match the anim that is played. Use chooseAnim to get a non-random anim and pass that string into animLength.

==== scriptEvent void '''animState'''(float channel, string stateFunction, float blendFrame); ====

:Sets a new animation state script function for the given channel.

==== scriptEvent void '''attach'''(entity ent, string attName); ====

:Attach an entity to the AI. Entity spawnArgs checked for attachments are: - "origin", "angles", and "joint". These must be set prior to calling attach.
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''attachToPos'''(entity ent, string position, string attName); ====

:Attach an entity to the AI, using a named attachment position
::''attName'': the desired name of the attachment, e.g., 'melee_weapon'

==== scriptEvent void '''checkAnim'''(float channel, string animName); ====

:Ensures that the animation exists and causes an error if it doesn't.

==== scriptEvent string '''chooseAnim'''(float channel, string animName); ====

:Chooses a random anim and returns the name. Useful for doing move tests on anims.

==== scriptEvent entity '''closestEnemyToPoint'''(vector point); ====

:Returns the enemy closest to the given location.

==== scriptEvent void '''disableAnimchannel'''(float channel); ====

:Used to disable a certain animchannel (for example if the ai is dead)

==== scriptEvent void '''disableEyeFocus'''(); ====

:Disables eye focus.

==== scriptEvent void '''DisableLegIK'''(float num); ====

:disables leg IK

==== scriptEvent void '''disablePain'''(); ====

:Disables pain animations.

==== scriptEvent void '''DisableWalkIK'''(); ====

:disables walk IK

==== scriptEvent void '''dropAttachment'''(string attName); ====

:Drop the attachment for the given attachment name.

==== scriptEvent void '''dropAttachmentInd'''(float index); ====

:Drop the attachment for the given index.
::''index'': starts at 0

==== scriptEvent void '''enableAnim'''(float channel, float blendFrames); ====

:Enables animation on the given channel.

==== scriptEvent void '''enableEyeFocus'''(); ====

:Enables eye focus.

==== scriptEvent void '''EnableLegIK'''(float num); ====

:enables leg IK

==== scriptEvent void '''enablePain'''(); ====

:Enables pain animations.

==== scriptEvent void '''EnableWalkIK'''(); ====

:enables walk IK

==== scriptEvent void '''finishAction'''(string action); ====

:Finishes the given wait action.

==== scriptEvent void '''finishChannelAction'''(float channel, string animname); ====

:Overloaded finishAction function for setting the waitstate on each channel separately

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent string '''getAnimState'''(float channel); ====

:Returns the name of the current animation state script function used for the given channel.

==== scriptEvent entity '''getAttachment'''(string attName); ====

:Get the attached entity with the given attachment name Will be NULL if the name is invalid or if the entity no longer exists

==== scriptEvent entity '''getAttachmentInd'''(float index); ====

:Get the attached entity at the given index. Will be NULL if the index is invalid or the entity no longer exists
::''index'': starts at 0

==== scriptEvent float '''getAttackFlag'''(float combatType); ====

:Returns 1 if the given attack flag is activated.
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent vector '''getEyePos'''(); ====

:Get eye position of the player and the AI

==== scriptEvent entity '''getHead'''(); ====

:Returns the entity used for the character's head, if it has one.

==== scriptEvent float '''getHealth'''(); ====

:Returns the current health.

==== scriptEvent float '''getMeleeActPhase'''(); ====

:Returns the current melee action phase (holding,recovering,etc).

==== scriptEvent float '''getMeleeActState'''(); ====

:Returns the current melee action state (attacking/defending).

==== scriptEvent float '''getMeleeActType'''(); ====

:Returns the current melee action type (overhead,thrust,etc.).

==== scriptEvent float '''getMeleeLastActTime'''(); ====

:Returns the melee type of the last attack to hit this actor. Defaults to MELEETYPE_UNBLOCKABLE if we were not hit before.

==== scriptEvent float '''getMeleeLastHitByType'''(); ====

:Returns the game time that the most recent melee action ended (in ms)

==== scriptEvent float '''getMeleeResult'''(); ====

:Get the result of the last melee action Follows MELEERESULT_* enum defined in tdm_defs.script

==== scriptEvent float '''getNumAttachments'''(); ====

:Return the number of attachments on an AI. Used to iterate through the attachments if desired.

==== scriptEvent float '''getNumMeleeWeapons'''(); ====

:Returns the number of melee weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_melee' set to '1'.

==== scriptEvent float '''getNumRangedWeapons'''(); ====

:Returns the number of ranged weapons attached to an actor. This refers to the TDM-style attachments with the spawnarg 'is_weapon_ranged' set to '1'.

==== scriptEvent string '''getPainAnim'''(); ====

:Returns the name of the pain animation.

==== scriptEvent string '''getState'''(); ====

:Gets the current state.

==== scriptEvent float '''hasAnim'''(float channel, string animName); ====

:Returns true when an entity has a specific animation.

==== scriptEvent float '''hasEnemies'''(); ====

:Returns true if the actor has one or more enemies.

==== scriptEvent float '''idleAnim'''(float channel, string animName); ====

:Plays the given idle animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''inAnimState'''(float channel, string stateFunc); ====

:Returns true if the given animation state script function is currently used for the given channel.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent string '''lookupReplacementAnim'''(string anim); ====

:Returns the current replacement animation for "anim". Returns empty if no replacement anim

==== scriptEvent void '''meleeActionFinished'''(); ====

:Called when the animation for the melee action has finished.

==== scriptEvent void '''meleeActionHeld'''(); ====

:Called when the melee action reaches the "hold" point.

==== scriptEvent void '''meleeActionReleased'''(); ====

:Called when the melee action is released from the hold point.

==== scriptEvent void '''meleeAttackStarted'''(float attType); ====

:Registers the start of a given melee attack Intended to be called from a script that also starts the animation

==== scriptEvent float '''meleeBestParry'''(); ====

:Returns the melee type integer of the best parry given the enemy attacks at the time If no attacking enemy is found, returns default of MELEETYPE_RL Follows MELEETYPE_* enum defined in tdm_defs.script

==== scriptEvent string '''meleeNameForNum'''(float num); ====

:Converts a melee type integer to a string name suffix Used for finding the right animation for a given type, etc. Possible names are, in order: "Over, LR, RL, Thrust, General" Where general blocks all attacks types except unblockable

==== scriptEvent void '''meleeParryStarted'''(float parType); ====

:Registers the start of a given melee parry Intended to be called from a script that also starts the animation

==== scriptEvent entity '''nextEnemy'''(entity lastEnemy); ====

:Returns the next enemy the actor has acquired.

==== scriptEvent void '''overrideAnim'''(float channel); ====

:Disables the animation currently playing on the given channel and syncs the animation with the animation of the nearest animating channel.

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''preventPain'''(float duration); ====

:Prevents any pain animation from being played for the given time in seconds.
::''duration'': time in seconds

==== scriptEvent void '''reAttachToCoords'''(string attName, string joint, vector offset, vector angles); ====

:Reattach an existing attachment
::''attName'': the name of the attachment we want to reattach.
::''joint'': the name of the joint to attach to
::''offset'': the translation offset from joint
::''angles'': a (pitch, yaw, roll) angle vector that defines the rotation of the attachment relative to the joint's orientation

==== scriptEvent void '''reAttachToPos'''(string attName, string position); ====

:Reattach an existing attachment to a named attachment position. Example: reAttachToPos( melee_weapon, right_hand_held )
::''attName'': the name of the attachment we want to reattach.
::''position'': the new position we want to attach it to.

==== scriptEvent void '''reloadTorchReplacementAnims'''(); ====

:If actor has a torch, reload the torch's replacement anims.

==== scriptEvent void '''removeReplacementAnim'''(string anim); ====

:Removes the replacement for the given "anim"

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''setAnimPrefix'''(string prefix); ====

:Sets a string which is placed in front of any animation names.

==== scriptEvent void '''setAttackFlag'''(float combatType, float enabled); ====

:Activate or deactivate the given attack flag
::''combatType'': see tdm_defs.script for possible enum values

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

==== scriptEvent void '''setNextState'''(string stateFunc); ====

:Sets the next state and waits until thread exits, or a frame delay before calling it. Handy for setting the state in the constructor.

==== scriptEvent void '''setReplacementAnim'''(string animToReplace, string replacement); ====

:Replaces the animation "animToReplace" with "replacement"

==== scriptEvent void '''setState'''(string stateFunc); ====

:Sets the next state and goes to it immediately

==== scriptEvent void '''setSyncedAnimWeight'''(float channel, float animindex, float weight); ====

:Sets the blend amount on multi-point anims.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''stopAnim'''(float channel, float frames); ====

:Stops the animation currently playing on the given channel over the given number of frames.

==== scriptEvent void '''syncAnimChannels'''(float fromChannel, float toChannel, float blendFrames); ====

:Synchronises the channels

=== idAFEntity_Base ===
==== scriptEvent vector '''getAngularVelocityB'''(float id); ====

:Get the angular velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent vector '''getLinearVelocityB'''(float id); ====

:Get the linear velocitiy of a particular body Returns (0,0,0) if the body ID is invalid.

==== scriptEvent float '''getNumBodies'''(); ====

:Returns the number of bodies in the AF. If the AF physics pointer is NULL, it returns 0.

==== scriptEvent void '''restoreAddedEnts'''(); ====

:No description

==== scriptEvent void '''setAngularVelocityB'''(vector velocity, float id); ====

:Set the angular velocity of a particular body

==== scriptEvent void '''SetConstraintPosition'''(string constraintName, vector position); ====

:Moves the constraint with the given name that binds this entity to another entity.

==== scriptEvent void '''setLinearVelocityB'''(vector velocity, float id); ====

:Set the linear velocity of a particular body

=== idAFEntity_Gibbable ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idAFEntity_Generic ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idAFEntity_WithAttachedHead ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CAIVehicle ===
==== scriptEvent void '''clearController'''(); ====

:Need separate clearController because scripting doesn't like passing in $null_entity? (greebo: one could remove this function and set the argument type of setController to 'E'.

==== scriptEvent void '''frobRidable'''(entity playerController); ====

:Called when a player directly mounts or dismounts a ridable AI.

==== scriptEvent string '''getMoveAnim'''(); ====

:Returns the name of the player-requested movement anim for a player controlled AI vehicle

==== scriptEvent void '''setController'''(entity playerController); ====

:Let a player assume movement control of an AI vehicle (may be remote control as in a player on a coach pulled by a horse)

=== idCombatNode ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''markUsed'''(); ====

:Disables the combat node if "use_once" is set on the entity.

=== idAI ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''alert'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''alertAI'''(string type, float amount, entity actor); ====

:internal
::''type'': alert type
::''amount'': alert amount
::''actor'': actor causing alert

==== scriptEvent void '''allowDamage'''(); ====

:The AI can take damage again.

==== scriptEvent void '''allowHiddenMovement'''(float enable); ====

:Normally, when hidden, monsters do not run physics. This enables physics when hidden.

==== scriptEvent void '''allowMovement'''(float allow); ====

:No description

==== scriptEvent void '''animTurn'''(float angle); ====

:Enable/disable animation controlled turning.
::''angle'': Pass in the maximum # of degrees the animation turns. Use an amount of 0 to disable.

==== scriptEvent void '''attackBegin'''(string damageDef); ====

:no description

==== scriptEvent void '''attackEnd'''(); ====

:no description

==== scriptEvent float '''attackMelee'''(string damageDef); ====

:Returns true if the attack hit

==== scriptEvent entity '''attackMissile'''(string jointName); ====

:returns projectile fired

==== scriptEvent void '''bark'''(string sound); ====

:Let the AI bark a certain sound.
::''sound'': sound name, e.g. 'snd_warn_response'

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent float '''becomeRagdoll'''(); ====

:enables the ragdoll if the entity has one

==== scriptEvent void '''becomeSolid'''(); ====

:no description

==== scriptEvent void '''burn'''(); ====

:no description

==== scriptEvent float '''canBecomeSolid'''(); ====

:no description

==== scriptEvent float '''canHitEnemy'''(); ====

:no description

==== scriptEvent float '''canHitEnemyFromAnim'''(string anim); ====

:no description

==== scriptEvent float '''canHitEnemyFromJoint'''(string jointname); ====

:no description

==== scriptEvent float '''canReachEnemy'''(); ====

:Returns true if character can walk to enemy's position. For walking monsters, enemy should be near the floor.

==== scriptEvent float '''canReachEntity'''(entity ent); ====

:Returns true if character can walk to entity's position. For walking monsters, entity should be near the floor.

==== scriptEvent float '''canReachPosition'''(vector pos); ====

:Returns true if character can walk to specified position. For walking monsters, position should be near the floor.

==== scriptEvent float '''canSee'''(entity ent); ====

:no description

==== scriptEvent float '''canSeeExt'''(entity ent, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSee that can optionally choose to use field of vision and lighting calculations.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If b_useLighting is 0 the entity will be visible in complete darkness. If it is 1, the entity will only be visible if there is light shining on it, but the slightest light is enought. Use "isEntityHidden" as a script event with a threshold instead.

==== scriptEvent float '''canSeePositionExt'''(vector position, float b_useFOV, float b_useLighting); ====

:This is an alternate version of canSeeExt that tests a location rather than an entity. Note that any actor at the position may make it not seeable from a distance.
::''b_useFOV'': If 0 the entity will be visible even if the AI's back is turned to it
::''b_useLighting'': If 0 the entity will be visible in complete darkness

==== scriptEvent void '''chargeAttack'''(string damageDef); ====

:no description

==== scriptEvent void '''clearBurn'''(); ====

:no description

==== scriptEvent void '''clearEnemy'''(); ====

:Clears the enemy entity

==== scriptEvent void '''clearFlyOffset'''(); ====

:Sets the preferred height relative to the player's view height to fly at to the value set in the def file.

==== scriptEvent entity '''closestReachableEnemy'''(); ====

:Used for determining tactile alert targets

==== scriptEvent entity '''closestReachableEnemyOfEntity'''(entity team_mate); ====

:Finds another character's closest reachable enemy

==== scriptEvent entity '''createMissile'''(string jointname); ====

:returns projectile created

==== scriptEvent entity '''createMissileFromDef'''(string defName, string jointName); ====

:No description

==== scriptEvent void '''directDamage'''(entity damageTarget, string damageDef); ====

:no description

==== scriptEvent void '''disableAFPush'''(); ====

:no description

==== scriptEvent void '''disableClip'''(); ====

:no description

==== scriptEvent void '''disableGravity'''(); ====

:no description

==== scriptEvent void '''dropTorch'''(); ====

:no description

==== scriptEvent void '''emptyHand'''(string hand); ====

:no description

==== scriptEvent void '''enableAFPush'''(); ====

:no description

==== scriptEvent void '''enableClip'''(); ====

:no description

==== scriptEvent void '''enableGravity'''(); ====

:no description

==== scriptEvent float '''endState'''(); ====

:Ends the current state with the given name, returns TRUE if more than one state is remaining.

==== scriptEvent float '''enemyInCombatCone'''(entity combatNode, float use_current_enemy_location); ====

:no description

==== scriptEvent float '''enemyPositionValid'''(); ====

:no description

==== scriptEvent float '''enemyRange'''(); ====

:no description

==== scriptEvent float '''enemyRange2D'''(); ====

:no description

==== scriptEvent float '''entityInAttackCone'''(entity ent); ====

:no description

==== scriptEvent void '''faceEnemy'''(); ====

:No description

==== scriptEvent void '''faceEntity'''(entity ent); ====

:No description

==== scriptEvent float '''facingIdeal'''(); ====

:No description

==== scriptEvent entity '''findActorsInBounds'''(vector mins, vector maxs); ====

:Returns an entity within the bounds specified

==== scriptEvent entity '''findEnemy'''(float onlyInFov); ====

:Finds enemy player in PVS

==== scriptEvent entity '''findEnemyAI'''(float onlyInFov); ====

:Finds enemy monster in PVS

==== scriptEvent entity '''findEnemyInCombatNodes'''(); ====

:Finds enemy player in attack cones

==== scriptEvent entity '''findFriendlyAI'''(float team); ====

:Use this to find a visible AI friendly to ourselves. It basically iterates over all active entities in the map and looks for friendly actors. The pythagorean distance is taken to evaluate the distance. Don't call this every frame, this might get expensive in larger maps. Returns the nearest visible actor entity or the $null_entity, if none was found.
::''team'': used to constrain the search to a given team. Set this to -1 to let the code ignore this argument

==== scriptEvent entity '''fireMissileAtTarget'''(string jointname, string targetname); ====

:Launches a missile at entity specified by 'attack_target'. returns projectile fired

==== scriptEvent float '''flee'''(entity entToFleeFrom, float algorithm, float distanceOption); ====

:Flee from the given entity. Pass the escape point lookup algorithm (e.g. EP_FIND_GUARDED) and the distanceOption (e.g. EP_DIST_NEAREST) to specify how the best escape point can be found. Refer to the tdm_defs.script file to see all the constants. When algorithm is set to EP_FIND_AAS_AREA_FAR_FROM_THREAT, the distanceOption is interpreted as minimum threat distance. Returns FALSE if no escape point could be found.

==== scriptEvent void '''foundBody'''(entity body); ====

:Objective callback for when an AI finds a body.

==== scriptEvent void '''Gas_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': the entity causing the knockout, can be the $null_entity

==== scriptEvent float '''getAcuity'''(string type); ====

:ai generalized alerts

==== scriptEvent entity '''getAlertActor'''(); ====

:Get the actor that alerted the AI in this frame.

==== scriptEvent float '''getAlertLevelOfOtherAI'''(entity otherEntity); ====

:This event gets the alert number of another AI (AI_AlertLevel variable value) Returns the alert number of the other AI, 0.0 if its not an AI or is NULL
::''otherEntity'': the other AI entity who's alert number is being queried

==== scriptEvent entity '''getAttacker'''(); ====

:Returns the attacking entity

==== scriptEvent float '''getAudThresh'''(); ====

:no description

==== scriptEvent entity '''getClosestHiddenTarget'''(string entity_type); ====

:Finds the closest targeted entity of the specified type.

==== scriptEvent entity '''getCombatNode'''(); ====

:No description

==== scriptEvent float '''getCurrentYaw'''(); ====

:no description

==== scriptEvent entity '''getEnemy'''(); ====

:no description

==== scriptEvent vector '''getEnemyEyePos'''(); ====

:no description

==== scriptEvent vector '''getEnemyPos'''(); ====

:no description

==== scriptEvent vector '''getJumpVelocity'''(vector pos, float speed, float max_jump_height); ====

:no description

==== scriptEvent float '''getMoveType'''(); ====

:Returns the current movetype

==== scriptEvent string '''getNextIdleAnim'''(); ====

:This returns the name of the next idle anim to be played on this AI (used by AnimState scripts).

==== scriptEvent vector '''getObservationPosition'''(vector targetPoint, float visualAcuityZeroToOne); ====

:This event is used to get a position that the AI can move to observe a given position. It is useful for looking at hiding spots that can't be reached, and performing other investigation functions. Returns a world position from which the observation can take place. Returns the current AI origin if no such point is found. @sideEffect This uses the AI_DEST_UNREACHABLE flag variable to indicate if a point was found. It will be true if none was found, false if one was found.
::''targetPoint'': the world position to be observed
::''visualAcuityZeroToOne'': the visual acuity of the AI on a scale of 0.0 to 1.0 where 0.0 is blind and 1.0 is perfect vision.

==== scriptEvent entity '''getObstacle'''(); ====

:Gets the obstacle in the character's path

==== scriptEvent entity '''getRandomTarget'''(string entity_type); ====

:Finds a random targeted entity of the specified type.

==== scriptEvent vector '''getReachableEntityPosition'''(entity ent); ====

:Returns the position of the entity within the AAS if possible, otherwise just the entity position.

==== scriptEvent float '''getRelationEnt'''(entity ent); ====

:no description

==== scriptEvent vector '''getSndDir'''(); ====

:ai hearing of sound

==== scriptEvent entity '''getTactEnt'''(); ====

:ai sense of touch

==== scriptEvent entity '''getTalkTarget'''(); ====

:Returns the entity (player) trying to talk to the character

==== scriptEvent float '''getTurnDelta'''(); ====

:no description

==== scriptEvent float '''getTurnRate'''(); ====

:Gets the rate the character turns.

==== scriptEvent vector '''getVisDir'''(); ====

:Returns position of the last visual alert.

==== scriptEvent float '''hasSeenEvidence'''(); ====

:This returns 1 when the AI has seen evidence of intruders before (an enemy, a body...)

==== scriptEvent void '''ignoreDamage'''(); ====

:The AI can no longer take damage.

==== scriptEvent float '''isEntityHidden'''(entity ent, float f_sightThreshold); ====

:This is an alternate version of canSee, using FOV, distance and lighting.
::''f_sightThreshold'': goes from 0.0 (entity visible in complete darkness) to 1.0 (entity only visible if completely lit up).

==== scriptEvent float '''isPlayerResponsibleForDeath'''(); ====

:Returns true if the player was responsible for the AI's caller's death.

==== scriptEvent void '''kickObstacles'''(entity kickEnt, float force); ====

:Kicks any obstacle in the character's path.
::''kickEnt'': pass in $null_entity if you don't have a specific entity to kick

==== scriptEvent void '''kill'''(); ====

:Kills the monster.

==== scriptEvent void '''KO_Knockout'''(entity inflictor); ====

:AI knockout
::''inflictor'': is the entity causing the knockout, can be the $null_entity

==== scriptEvent entity '''launchMissile'''(vector origin, vector angles); ====

:Returns the projectile entity

==== scriptEvent void '''locateEnemy'''(); ====

:Updates the last known position of the enemy independent from whether or not the enemy is visible.

==== scriptEvent void '''lookAt'''(entity focusEntity, float duration); ====

:Aims the character's eyes and head toward an entity for a period of time.

==== scriptEvent void '''lookAtAngles'''(float yawAngleClockwise, float pitchAngleUp, float rollAngle, float durationInSeconds); ====

:A look at event that just looks at a set of angles relative to the current body facing of the AI. This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but it looks at the specified angles from the current body facing of the AI.
::''yawAngleClockwise'': Negative angles are to the left of the AIs body and positive angles are to the right.
::''pitchAngleUp'': Negative values are down and positive values are up where down and up are defined by the body axis.
::''rollAngle'': This is currently unused and does nothing.
::''durationInSeconds'': The duration to look in seconds.

==== scriptEvent void '''lookAtEnemy'''(float duration); ====

:Aims the character's eyes and head toward the current enemy for a period of time.

==== scriptEvent void '''lookAtPosition'''(vector lookAtWorldPosition, float durationInSeconds); ====

:This method is just like the vanilla Doom3 lookAt and lookAtEnemy methods, but instead of looking at an entity, it looks at a position in worldspace. That is, it turns the head of the AI to look at the position.
::''lookAtWorldPosition'': position in space to look at
::''durationInSeconds'': duration to look in seconds

==== scriptEvent float '''meleeAttackToJoint'''(string joint, string damageDef); ====

:no description

==== scriptEvent void '''moveOutOfRange'''(entity ent, float range); ====

:no description

==== scriptEvent float '''moveStatus'''(); ====

:no description

==== scriptEvent void '''moveToAttackPosition'''(entity ent, string attack_anim); ====

:No description

==== scriptEvent void '''moveToCover'''(); ====

:no description

==== scriptEvent void '''moveToCoverFrom'''(entity ent); ====

:no description

==== scriptEvent void '''moveToEnemy'''(); ====

:no description

==== scriptEvent void '''moveToEnemyHeight'''(); ====

:no description

==== scriptEvent void '''moveToEntity'''(entity destination); ====

:No description

==== scriptEvent void '''moveToPosition'''(vector position); ====

:No description

==== scriptEvent void '''muzzleFlash'''(string jointname); ====

:no description

==== scriptEvent float '''numSmokeEmitters'''(); ====

:Returns the # of emitters defined by 'smokeParticleSystem' in the entitydef

==== scriptEvent void '''performRelight'''(); ====

:Deal with doused lights.

==== scriptEvent float '''playAndLipSync'''(string soundName, string animName); ====

:Play the given sound, using the given lipsync animation. The lipsync animation should just be a simple non-loopable animation of the mouth opening in a linear fashion. The code will select individual frames from this to construct a simple lipsyncing effect which is in time with the sound. Returns the length of the played sound in seconds.

==== scriptEvent void '''preBurn'''(); ====

:no description

==== scriptEvent vector '''predictEnemyPos'''(float time); ====

:Tries to predict the player's movement based on the AAS and his direction of movement.

==== scriptEvent void '''processBlindStim'''(entity stimSource, float skipVisibilityCheck); ====

:No description

==== scriptEvent void '''processVisualStim'''(entity stimSource); ====

:Use this call to let the AI react to a visual stim (coming from the source entity).

==== scriptEvent vector '''pushPointIntoAAS'''(vector post); ====

:Tries to push the point into a valid AAS area

==== scriptEvent void '''pushState'''(string stateName); ====

:Pushes the state with the given name, current one is postponed.

==== scriptEvent void '''radiusDamageFromJoint'''(string jointname, string damageDef); ====

:no description

==== scriptEvent entity '''randomPath'''(); ====

:no description

==== scriptEvent void '''restartPatrol'''(); ====

:no description

==== scriptEvent void '''restoreMove'''(); ====

:no description

==== scriptEvent void '''saveMove'''(); ====

:no description

==== scriptEvent void '''setAcuity'''(string type, float val); ====

:ai generalized alerts

==== scriptEvent void '''setAlertGracePeriod'''(float frac, float duration, float count); ====

:This starts the alert grace period for an AI. Should be called in the same frame as the alert that pushes them into a higher state.
::''frac'': the fraction of the alert below which they should ignore alerts during the grace period.
::''duration'': the duration of the period in seconds
::''count'': the number of alerts ignored above which the grace period is invalid

==== scriptEvent void '''setAlertLevel'''(float newLevel); ====

:Set the alert level (AI_AlertLevel). This should always be called instead of setting AI_AlertLevel directly.

==== scriptEvent void '''setAudThresh'''(float val); ====

:no description

==== scriptEvent void '''setBoneMod'''(float allowBoneMod); ====

:Enables or disables head looking (may be obsolete).

==== scriptEvent void '''setEnemy'''(entity enemy); ====

:Make the given entity an enemy.

==== scriptEvent void '''setFlyOffset'''(float offset); ====

:Sets the preferred height relative to the player's view height to fly at.

==== scriptEvent void '''setFlySpeed'''(float speed); ====

:Set the speed flying creatures move at. Also sets speed for moveTypeSlide.

==== scriptEvent void '''setMoveType'''(float movetype); ====

:Set the current movetype. movetypes are defined in tdm_ai.script

==== scriptEvent void '''setSmokeVisibility'''(float particle_num, float on); ====

:enables/disables smoke particles on bones. pass in the particle #, or ALL_PARTICLES for turning on/off all particle systems. particles are spawned in the order they appear in the entityDef

==== scriptEvent void '''setTalkState'''(float state); ====

:Sets whether the player can talk to this character or not.

==== scriptEvent void '''setTalkTarget'''(entity target); ====

:Sets the entity (player) trying to talk to the character

==== scriptEvent void '''setTurnRate'''(float rate); ====

:Set the rate the character turns at

==== scriptEvent void '''shrivel'''(float time); ====

:no description

==== scriptEvent void '''slideTo'''(vector position, float time); ====

:No description

==== scriptEvent entity '''spawnThrowableProjectile'''(string projectileName, string jointName); ====

:This method spawns a projectile of the type named by the caller and attaches it to the joint given by the caller. The projectile becomes the AI's firable projectile. Returns a pointer to a projectile entity that can be thrown by the AI. You can use AI_LaunchMissle (e* = launchMissle(v,v) ) to throw the stone.
::''projectileName'': The name of the projectile to spawn (as seen in a .def file) Must be descended from idProjectile
::''jointName'': The name of the joint on the model to which the particle should be attached for throwing. If this is NULL or the empty string, then it is attached to the model center.

==== scriptEvent void '''stopMove'''(); ====

:no description

==== scriptEvent void '''stopRagdoll'''(); ====

:turns off the ragdoll

==== scriptEvent void '''stopThinking'''(); ====

:no description

==== scriptEvent void '''switchState'''(string stateName); ====

:Switches to the state with the given name, current one is ended.

==== scriptEvent float '''testAnimAttack'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMove'''(string animname); ====

:no description

==== scriptEvent float '''testAnimMoveTowardEnemy'''(string animname); ====

:no description

==== scriptEvent float '''testChargeAttack'''(); ====

:no description

==== scriptEvent float '''testMeleeAttack'''(); ====

:no description

==== scriptEvent float '''testMoveToPosition'''(vector position); ====

:no description

==== scriptEvent void '''throwAF'''(); ====

:no description

==== scriptEvent void '''throwMoveable'''(); ====

:no description

==== scriptEvent float '''travelDistanceBetweenEntities'''(entity source, entity dest); ====

:Approximate travel distance between two entities.

==== scriptEvent float '''travelDistanceBetweenPoints'''(vector source, vector dest); ====

:Approximate travel distance between two points.

==== scriptEvent float '''travelDistanceToEntity'''(entity destination); ====

:Approximate travel distance to entity.

==== scriptEvent float '''travelDistanceToPoint'''(vector destination); ====

:Approximate travel distance to point.

==== scriptEvent void '''triggerParticles'''(string jointName); ====

:no description

==== scriptEvent void '''turnTo'''(float yaw); ====

:no description

==== scriptEvent void '''turnToEntity'''(entity ent); ====

:no description

==== scriptEvent void '''turnToPos'''(vector pos); ====

:no description

==== scriptEvent entity '''visScan'''(); ====

:Checks for enemies or player in the AI's FOV, using light level and distance. For now the check is only done on the player. Returns a reference to the sighted actor.

==== scriptEvent void '''waitAction'''(string name); ====

:no description

==== scriptEvent void '''waitMove'''(); ====

:no description

==== scriptEvent void '''wakeOnFlashlight'''(float enable); ====

:Tells the monster to activate when flashlight shines on them.

==== scriptEvent void '''wander'''(); ====

:no description

=== idTestModel ===
==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

=== CBinaryFrobMover ===
==== scriptEvent void '''Close'''(); ====

:Closes the frobmover, regardless of its previous state. Mover must be open, otherwise nothing happens.

==== scriptEvent float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

==== scriptEvent float '''IsOpen'''(); ====

:Returns true (nonzero) if the mover is open, which is basically the same as "not closed". A mover is considered closed when it is at its close position.

==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

==== scriptEvent void '''Lock'''(); ====

:Locks the mover. Calls to Open() will not succeed after this call.

==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

==== scriptEvent void '''ToggleLock'''(); ====

:Toggles the lock state. Unlocked movers will be locked and vice versa. The notes above concerning Unlock() still apply if this call unlocks the mover.

==== scriptEvent void '''ToggleOpen'''(); ====

:Toggles the mover state. Closes when fully open, opens when fully closed. If the mover is "interrupted" (e.g. when the player frobbed the mover in between), the move direction depends on the state of the internal "intent_open" flag.

==== scriptEvent void '''Unlock'''(); ====

:Unlocks the mover. Calls to Open() will succeed after this call. Depending on the value of the spawnarg "open_on_unlock" the mover might automatically open after this call.

=== idBrittleFracture ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''dampenSound'''(float dampen); ====

:Toggle whether the shattering sound is dampened on the window, e.g., when covered by moss.
::''dampen'': 1 = dampened, 0 = not dampened

=== idCameraView ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idCameraAnim ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''start'''(); ====

:Starts a spline or anim camera moving.

==== scriptEvent void '''stop'''(); ====

:Stops a spline or anim camera moving.

=== idFuncEmitter ===
==== scriptEvent void '''emitterAddModel'''(string modelName, vector modelOffset); ====

:Adds a new particle (or regular, if you wish) model to the emitter, located at modelOffset units away from the emitter's origin.

==== scriptEvent float '''emitterGetNumModels'''(); ====

:Returns the number of models/particles this emitter has. Always >= 1.

=== idEntity ===
==== scriptEvent void '''activateContacts'''(); ====

:Activate objects sitting on this object.

==== scriptEvent void '''activateTargets'''(entity activator); ====

:Causes this entity to activate all it's targets. Similar to how a trigger activates entities.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''addInvItem'''(entity inv_item); ====

:Adds the given item to the inventory. Depending on the type the passed entity will be removed from the game (as for loot items) or hidden.

==== scriptEvent void '''addItemToInv'''(entity target); ====

:Adds the entity to the given entity's inventory. Depending on the type the entity will be removed from the game (as for loot items) or hidden. Example: $book->addItemToInv($player1);

==== scriptEvent void '''addTarget'''(entity target); ====

:Add a target to this entity.
::''target'': the entity to add as target

==== scriptEvent void '''applyImpulse'''(entity source, float bodyid, vector point, vector impulse); ====

:Applies an impulse to the entity. Example: entity.applyImpulse($player1, 0, entity.getOrigin(), '0 0 2');
::''source'': Pass $null_entity or the entity that applies the impulse
::''bodyid'': For articulated figures, ID of the body, 0 for the first (main) body. Otherwise use 0.
::''point'': Point on the body where the impulse is applied to
::''impulse'': Vector of the impulse

==== scriptEvent void '''bind'''(entity master); ====

:Fixes this entity's position and orientation relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindPosition'''(entity master); ====

:Fixes this entity's position (but not orientation) relative to another entity, such that when the master entity moves, so does this entity.
::''master'': the entity to bind to

==== scriptEvent void '''bindToBody'''(entity master, float bodyID, float orientated); ====

:Bind to AF body
::''master'': entity to bind to
::''bodyID'': AF body ID to bind to
::''orientated'': binds the orientation as well as position, if set to 1

==== scriptEvent void '''bindToJoint'''(entity master, string boneName, float rotateWithMaster); ====

:Fixes this entity's position and orientation relative to a bone on another entity, such that when the master's bone moves, so does this entity.
::''master'': the entity to bind to
::''boneName'': the bone name
::''rotateWithMaster'': -

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent void '''callFunction'''(string functionName); ====

:Calls a function on an entity's script object. See also callGlobalFunction().

==== scriptEvent void '''callGlobalFunction'''(string functionName, entity other); ====

:calls a global function and passes the other entity along as the first argument calls the function in a new thread, so it continues executing in the current thread right away (unlike entity.callFunction( "blah"))

==== scriptEvent void '''callGui'''(float handle, string namedEvent); ====

:Calls a named event in a GUI.

==== scriptEvent float '''canBeUsedBy'''(entity ent); ====

:Returns true if the entity can be used by the argument entity

==== scriptEvent float '''canSeeEntity'''(entity target, float useLighting); ====

:This is a general version of idAI::canSee, that can be used by all entities. It doesn't regard FOV, it just performs a trace to check whether the target is occluded by world geometry. Is probably useful for stim/response as well Pass useLighting = true to take the lighting of the target entity into account. Use "isEntityHidden" as a script event with a threshold. The constant threshold value for useLighting is defined within the SDK in game/entity.h.

==== scriptEvent void '''changeEntityRelation'''(entity ent, float relationChange); ====

:This changes the current relation to an entity by adding the new amount.

==== scriptEvent void '''changeInvIcon'''(string name, string category, string icon); ====

:Sets the inventory icon of the given item in the given category to <icon>.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvItemCount'''(string name, string category, float amount); ====

:Decreases the inventory item stack count by amount. The item is addressed using the name and category of the item. These are usually defined on the inventory item entity ("inv_name", "inv_category") Amount can be both negative and positive.
::''name'': name of the item
::''category'': the item's category

==== scriptEvent void '''changeInvLightgemModifier'''(string name, string category, float amount); ====

:Sets the lightgem modifier value of the given item. Valid arguments are between 0 and 32 (which is the maximum lightgem value).
::''name'': name of the item
::''category'': the item's category

==== scriptEvent float '''changeLootAmount'''(float type, float amount); ====

:Changes the loot amount of the given Type (e.g. GOODS) by <amount>. The mission statisic for loot found gets changed too. The new value of the changed type is returned (e.g. the new GOODS value if this has been changed). Note: The LOOT_TOTAL type can't be changed and 0 is returned.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY
::''amount'': can be negative

==== scriptEvent void '''checkAbsence'''(); ====

:description missing

==== scriptEvent void '''copyBind'''(entity other); ====

:copy bind information of other to this entity (i.e., bind this entity to the same entity that other is bound to)

==== scriptEvent float '''createOverlay'''(string guiFile, float layer); ====

:Creates a GUI overlay. (must be used on the player)

==== scriptEvent void '''CreateTimer'''(float stimId, float hour, float minutes, float seconds, float milliseconds); ====

:No description

==== scriptEvent void '''damage'''(entity inflictor, entity attacker, vector dir, string damageDefName, float damageScale); ====

:Deals damage to this entity (gets translated into the idEntity::Damage() method within the SDK).
::''inflictor'': the entity causing the damage (maybe a projectile)
::''attacker'': the "parent" entity of the inflictor, the one that is responsible for the inflictor (can be the same)
::''dir'': the direction the attack is coming from.
::''damageDefName'': the name of the damage entityDef to know what damage is being dealt to <self> (e.g. "damage_lava")
::''damageScale'': the scale of the damage (pass 1.0 as default, this should be ok).

==== scriptEvent void '''destroyOverlay'''(float handle); ====

:Destroys a GUI overlay. (must be used on the player)

==== scriptEvent float '''distanceTo'''(entity other); ====

:Returns the distance of this entity to another entity.

==== scriptEvent float '''distanceToPoint'''(vector point); ====

:Returns the distance of this entity to a point.

==== scriptEvent void '''extinguishLights'''(); ====

:Extinguishes all lights (i.e. the <self> entity plus all bound lights)

==== scriptEvent void '''fadeSound'''(float channel, float newLevel, float fadeTime); ====

:Fades the sound on this entity to a new level over a period of time. Use SND_CHANNEL_ANY for all currently playing sounds.

==== scriptEvent float '''frob'''(); ====

:Frobs the entity (i.e. simulates a frob action performed by the player). Returns TRUE if the entity is frobable, FALSE otherwise.

==== scriptEvent void '''frobHilight'''(float state); ====

:ishtvan: Tries to make the entity frobhilight or not

==== scriptEvent vector '''getAngles'''(); ====

:Returns the current orientation of this entity (relative to bind parent if any).

==== scriptEvent vector '''getAngularVelocity'''(); ====

:Gets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent entity '''getBindChild'''(float ind); ====

:Returns the ind_th bind child of this entity or NULL if index is invalid. NOTE: indices start at zero
::''ind'': child index

==== scriptEvent entity '''getBindMaster'''(); ====

:Returns the entity's bindmaster

==== scriptEvent float '''getBoolKey'''(string key); ====

:Retrieves the boolean value of a specific spawn arg, defaulting to false.
::''key'': spawnarg name

==== scriptEvent float '''getClipMask'''(); ====

:Returns the clipmask of the physics object.

==== scriptEvent vector '''getColor'''(); ====

:Gets the color of this entity (shader parms Parm0, Parm1, Parm2).

==== scriptEvent float '''getContents'''(); ====

:Returns the contents of the physics object.

==== scriptEvent string '''getCurInvCategory'''(); ====

:Returns the name of the currently highlighted inventory category.

==== scriptEvent string '''getCurInvIcon'''(); ====

:Returns the icon of the currently highlighted inventory item.

==== scriptEvent entity '''getCurInvItemEntity'''(); ====

:Returns the currently highlighted inventory item entity.

==== scriptEvent string '''getCurInvItemId'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_item_id"). Most items will return an empty string, unless the "inv_item_id" is set on purpose.

==== scriptEvent string '''getCurInvItemName'''(); ====

:Returns the name of the currently highlighted inventory item (the one defined in "inv_name").

==== scriptEvent entity '''getEntityKey'''(string key); ====

:Retrieves the entity specified by the spawn arg.
::''key'': spawnarg name

==== scriptEvent float '''getFloatKey'''(string key); ====

:Retrieves the floating point value of a specific spawn arg, defaulting to 0.0f.
::''key'': spawnarg name

==== scriptEvent string '''getGui'''(float handle); ====

:Returns the file currently loaded by a GUI.

==== scriptEvent float '''getGuiFloat'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getGuiInt'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent string '''getGuiString'''(float handle, string key); ====

:Returns a GUI parameter.

==== scriptEvent float '''getIntKey'''(string key); ====

:Retrieves the integer value of a specific spawn arg, defaulting to 0.
::''key'': spawnarg name

==== scriptEvent string '''getKey'''(string key); ====

:Retrieves the value of a specific spawn arg, defaulting to ''.
::''key'': spawnarg name

==== scriptEvent vector '''getLightInPVS'''(float falloff, float scaling); ====

:Computes the sum of all light in the PVS of the entity you call this on, and returns a vector with the sum.
::''falloff'': 0: no falloff with distance 0.5: sqrt(linear) falloff (dist 100 => 1/10) 1: linear falloff (dist 100 => 1/100) 2: square falloff (dist 100 => 1/10000)
::''scaling'': factor to scale the distance, can be used to lower/raise distance factor after the linear or square scaling has been used good looking values are approx: sqrt(linear): 0.01, linear: 0.1, square 1.0

==== scriptEvent vector '''getLinearVelocity'''(); ====

:Gets the current linear velocity of this entity. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent entity '''getLocation'''(); ====

:Returns the idLocation entity corresponding to the entity's current location. This was player-specific before, but is now available to all entities.

==== scriptEvent float '''getLootAmount'''(float type); ====

:Returns the amount of loot for the given type (e.g. LOOT_GOODS). Pass LOOT_TOTAL to return the sum of all loot types.
::''type'': one of: LOOT_GOLD, LOOT_GOODS, LOOT_JEWELRY, LOOT_TOTAL

==== scriptEvent float '''getMass'''(float body); ====

:Gets mass of a body for an entity

==== scriptEvent vector '''getMaxs'''(); ====

:Gets the maximum corner of this entity's bounding box.

==== scriptEvent vector '''getMins'''(); ====

:Gets the minimum corner of this entity's bounding box.

==== scriptEvent string '''getName'''(); ====

:Returns the name of this entity.

==== scriptEvent entity '''getNextInvItem'''(); ====

:Cycles the standard cursor to the next inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent string '''getNextKey'''(string prefix, string lastMatch); ====

:Searches for the name of a spawn arg that matches the prefix. For example, passing in "attack_target" matches "attack_target1", "attack_targetx", "attack_target_enemy", etc. The returned string is the name of the key which can then be passed into functions like getKey() to lookup the value of that spawn arg. This is useful for when you have multiple values to look up, like when you target multiple objects. To find the next matching key, pass in the previous result and the next key returned will be the first one that matches after the previous result. Pass in "" to get the first match. Passing in a non-existent key is the same as passing in "". Returns "" when no more keys match.

==== scriptEvent vector '''getOrigin'''(); ====

:Returns the current position of this entity (relative to bind parent if any).

==== scriptEvent entity '''getPrevInvItem'''(); ====

:Cycles the standard cursor to the previous inventory item. Returns the item entity pointed to after the operation is complete.

==== scriptEvent entity '''GetResponseEntity'''(); ====

:Returns the entity which should take the response. Some entities like AI heads are not responding themselves to stims, but relay it to another entity (i.e. the bodies they're attached to).

==== scriptEvent float '''getShaderParm'''(float parm); ====

:Gets the value of the specified shader parm.
::''parm'': shader parm index

==== scriptEvent vector '''getSize'''(); ====

:Gets the size of this entity's bounding box.

==== scriptEvent float '''getSoundVolume'''(string soundName); ====

:Get the volume of the sound to play.
::''soundName'': the name of the sound

==== scriptEvent entity '''getTarget'''(float num); ====

:Returns the requested target entity.
::''num'': The target number. Starts at 0.

==== scriptEvent float '''getTeam'''(); ====

:Returns the current team number.

==== scriptEvent vector '''getVectorKey'''(string key); ====

:Retrieves the vector value of a specific spawn arg, defaulting to '0 0 0'.
::''key'': spawnarg name

==== scriptEvent vector '''getVinePlantLoc'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getVinePlantNormal'''(); ====

:Event important to the growing of vines from vine arrows

==== scriptEvent vector '''getWorldOrigin'''(); ====

:Returns the current world-space position of this entity (regardless of any bind parent).

==== scriptEvent float '''hasFunction'''(string functionName); ====

:checks if an entity's script object has a specific function

==== scriptEvent float '''heal'''(string healDefName, float healScale); ====

:Heals the entity this is called on using the specified healing entityDef. Returns 1 if the entity could be healed, 0 otherwise (if the entity is already at full health, for ex.)
::''healDefName'': the name of the entityDef containing the healing information (e.g. "heal_potion")
::''healScale'': the scaling value to be applied to the healAmount found in the healEntityDef

==== scriptEvent void '''hide'''(); ====

:Makes this entity invisible.

==== scriptEvent void '''hideByLODBias'''(); ====

:internal

==== scriptEvent float '''inPVS'''(); ====

:Returns non-zero if this entity is in PVS. For lights, it will return true when the light's bounding box is in PVS, even though the light may not actually be in PVS. (an unmoved shadowcasting light may not be visible to PVS areas its bounding box intersects with)

==== scriptEvent float '''isDroppable'''(); ====

:Get whether an item may be dropped from the inventory

==== scriptEvent float '''isEnemy'''(entity ent); ====

:Returns true if the given entity is an enemy.
::''ent'': The entity in question

==== scriptEvent float '''isFriend'''(entity ent); ====

:Returns true if the given entity is a friend.
::''ent'': The entity in question

==== scriptEvent float '''isFrobable'''(); ====

:Get whether the entity is frobable

==== scriptEvent float '''isHidden'''(); ====

:checks if the entity's model is invisible.

==== scriptEvent float '''isHilighted'''(); ====

:Returns true if entity is currently frobhilighted.

==== scriptEvent float '''isInLiquid'''(); ====

:Returns 1 if the entity is in or touching a liquid.

==== scriptEvent float '''isLight'''(); ====

:No description

==== scriptEvent float '''isNeutral'''(entity ent); ====

:Returns true if the given entity is neutral.
::''ent'': The entity in question

==== scriptEvent float '''isType'''(string spawnclass); ====

:Returns true if this entity is of the given type.
::''spawnclass'': spawn class name

==== scriptEvent float '''loadExternalData'''(string declFile, string prefix); ====

:Load an external xdata declaration.

==== scriptEvent void '''noShadows'''(float noShadows); ====

:Sets the noShadow property on the entity to true/false, turning shadowcasting on or off for this entity.
::''noShadows'': 1 = disable shadows, 0 = enable shadows

==== scriptEvent void '''noShadowsDelayed'''(float noShadows, float delay); ====

:Sets the noShadow property on the entity to true/false after delay in ms, turning shadows cast by this entity on or off.
::''noShadows'': 1 = disable shadows, 0 = enable shadows
::''delay'': delay in ms

==== scriptEvent float '''numBindChildren'''(); ====

:Returns the number of bound entities lower down in the bind chain than this entity

==== scriptEvent float '''numTargets'''(); ====

:Returns the number of entities this entity has targeted.

==== scriptEvent void '''propagateSound'''(string soundName, float propVolMod, float msgTag); ====

:Generates a propagated sound

==== scriptEvent void '''propSound'''(string name); ====

:Sound propagation scriptfunctions on all entities propagate a sound directly without playing an audible sound

==== scriptEvent void '''propSoundMod'''(string name, float volMod); ====

:propagate a sound directly with a volume modifier

==== scriptEvent entity '''randomTarget'''(string ignoreName); ====

:Returns a random targeted entity. Pass in an entity name to skip that entity.
::''ignoreName'': the name of an entity to ignore

==== scriptEvent float '''rangedThreatTo'''(entity target); ====

:Could this entity threaten the given (target) entity from a distance?

==== scriptEvent void '''removeBinds'''(); ====

:Removes all attached entities from the game

==== scriptEvent void '''removeKey'''(string key); ====

:Removes a key from an object's spawnargs, so things like getNextKey() don't retrieve it.
::''key'': the spawnarg to remove

==== scriptEvent void '''removeTarget'''(entity target); ====

:Remove a target from this entity.
::''target'': the entity to remove from the targets

==== scriptEvent float '''replaceInvItem'''(entity oldItem, entity newItem); ====

:Replaces the entity <oldItem> with <newItem> in the inventory, while keeping <oldItem>'s inventory position intact. Note: The position guarantee only applies if <oldItem> and newItem share the same category. If the categories are different, the position of <newItem> is likely to be different than the one of <oldItem>. Note that <oldItem> will be removed from the inventory. If <newItem> is the $null_entity, <oldItem> is just removed and no replacement happens. Returns 1 if the operation was successful, 0 otherwise.
::''newItem'': can be $null_entity

==== scriptEvent void '''ResetTimer'''(float stimId); ====

:No description

==== scriptEvent void '''ResponseAdd'''(float type); ====

:No description

==== scriptEvent void '''ResponseAllow'''(float type, entity responder); ====

:No description

==== scriptEvent void '''ResponseEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''ResponseIgnore'''(float type, entity responder); ====

:This functions must be called on the stim entity. It will add the response to the ignore list, so that subsequent stims, should not trigger the stim anymore.

==== scriptEvent void '''ResponseRemove'''(float type); ====

:No description

==== scriptEvent void '''ResponseSetAction'''(float type, string action); ====

:No description

==== scriptEvent void '''ResponseTrigger'''(entity source, float stimType); ====

:Fires a response on this entity, without a stim (a stand-alone response, so to say)

==== scriptEvent void '''RestartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''restorePosition'''(); ====

:Returns this entity to the position stored in the "origin" spawn arg. This is the position the entity was spawned in unless the "origin" key is changed. Note that there is no guarantee that the entity won't be stuck in another entity when moved, so care should be taken to make sure that isn't possible.

==== scriptEvent void '''setAngles'''(vector angles); ====

:Sets the current orientation of this entity (relative to bind parent if any)
::''angles'': the new orientation

==== scriptEvent void '''setAngularVelocity'''(vector velocity); ====

:Sets the current angular velocity of this entity. The angular velocity of a physics object is a vector that passes through the center of mass. The direction of this vector defines the axis of rotation and the magnitude defines the rate of rotation about the axis in radians per second.

==== scriptEvent void '''setClipMask'''(float clipMask); ====

:Sets the clipmask of the physics object.

==== scriptEvent void '''setColor'''(float parm0, float parm1, float parm2); ====

:Sets the RGB color of this entity (shader parms Parm0, Parm1, Parm2).
::''parm0'': red
::''parm1'': green
::''parm2'': blue

==== scriptEvent void '''setContents'''(float contents); ====

:Sets the contents of the physics object.

==== scriptEvent float '''setCurInvCategory'''(string categoryName); ====

:Sets the inventory cursor to the first item of the named category. Returns 1 on success, 0 on failure (e.g. wrong category name)

==== scriptEvent entity '''setCurInvItem'''(string itemName); ====

:Sets the inventory cursor to the named item. Returns: the item entity of the newly selected item (can be $null_entity).

==== scriptEvent void '''setDroppable'''(float droppable); ====

:Set whether an item may be dropped from the inventory.
::''droppable'': if non-zero the item becomes droppable, when called with 0 the item becomes non-droppable

==== scriptEvent void '''setEntityRelation'''(entity ent, float relation); ====

:Set a relation to another entity, this can be friendly (>0), neutral(0) or hostile (<0)

==== scriptEvent void '''setFrobable'''(float frobable); ====

:Set whether the entity is frobable

==== scriptEvent void '''setGui'''(float handle, string guiFile); ====

:Loads a new file into an existing GUI.

==== scriptEvent void '''setGuiFloat'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiInt'''(float handle, string key, float val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiString'''(float handle, string key, string val); ====

:Sets a GUI parameter.

==== scriptEvent void '''setGuiStringFromKey'''(float handle, string key, entity src, string srcKey); ====

:This is a kludge. It is equivelant to: setGuiString( handle, key, src.getKey(srcKey) ) However, it's used to bypass the 127 char size limit on script strings.

==== scriptEvent void '''setKey'''(string key, string value); ====

:Sets a key on this entity's spawn args. Note that most spawn args are evaluated when this entity spawns in, so this will not change the entity's behavior in most cases. This is chiefly for saving data the script needs in an entity for later retrieval.
::''key'': the spawnarg to set
::''value'': the value to store

==== scriptEvent void '''setLinearVelocity'''(vector velocity); ====

:Sets the current linear velocity of this entity in units per second. The linear velocity of a physics object is a vector that defines the translation of the center of mass in units per second.

==== scriptEvent void '''setModel'''(string modelName); ====

:Sets the model this entity uses

==== scriptEvent void '''setName'''(string name); ====

:Sets the name of this entity.
::''name'': the new name

==== scriptEvent void '''setNeverDormant'''(float enable); ====

:enables or prevents an entity from going dormant
::''enable'': 1 = enable, 0 = disable

==== scriptEvent void '''setOrigin'''(vector origin); ====

:Sets the current position of this entity (relative to it's bind parent if any)
::''origin'': the new origin

==== scriptEvent void '''setOwner'''(entity owner); ====

:Sets the owner of this entity. Entities will never collide with their owner.
::''owner'': the entity which will be made owner of this entity

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setShaderParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets shader parms Parm0, Parm1, Parm2, and Parm3 (red, green, blue, and alpha respectively).
::''parm0'': red
::''parm1'': green
::''parm2'': blue
::''parm3'': alpha

==== scriptEvent void '''setSize'''(vector min, vector max); ====

:Sets the size of this entity's bounding box.
::''min'': minimum corner coordinates
::''max'': maximum corner coordinates

==== scriptEvent void '''setSkin'''(string skinName); ====

:Sets the skin this entity uses. Set to "" to turn off the skin.

==== scriptEvent void '''setSoundVolume'''(float newLevel); ====

:Set the volume of the sound to play, must be issued before startSoundShader.

==== scriptEvent void '''setTeam'''(float newTeam); ====

:Sets the team number of this entity.

==== scriptEvent void '''SetTimerState'''(float stimId, float state); ====

:No description

==== scriptEvent void '''setWorldOrigin'''(vector origin); ====

:Sets the current position of this entity (regardless of any bind parent).

==== scriptEvent void '''show'''(); ====

:Makes this entity visible if it has a model.

==== scriptEvent void '''startFx'''(string fx); ====

:Starts an FX on this entity.

==== scriptEvent float '''startSound'''(string sound, float channel, float netSync); ====

:Plays the sound specified by the snd_* key/value pair on the channel and returns the length of the sound in seconds. This is the preferred method for playing sounds on an entity since it ensures that the sound is precached.
::''sound'': the spawnarg to reference, e.g. 'snd_move'
::''channel'': the channel to play on
::''netSync'': -

==== scriptEvent float '''startSoundShader'''(string shaderName, float channel); ====

:Plays a specific sound shader on the channel and returns the length of the sound in seconds. This is not the preferred method of playing a sound since you must ensure that the sound is loaded.
::''shaderName'': the sound shader to play
::''channel'': the channel to play the sound on

==== scriptEvent void '''StartTimer'''(float stimId); ====

:No description

==== scriptEvent void '''StimAdd'''(float type, float radius); ====

:No description

==== scriptEvent void '''StimClearIgnoreList'''(float type); ====

:This clears the ignore list for the stim of the given type It can be used if an entity changes state in some way that it would no longer be ignored

==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''StimRemove'''(float type); ====

:No description

==== scriptEvent void '''stopSound'''(float channel, float netSync); ====

:Stops a specific sound shader on the channel.
::''channel'': the channel to stop playback on
::''netSync'': -

==== scriptEvent void '''StopTimer'''(float stimId); ====

:No description

==== scriptEvent void '''teleportTo'''(entity other); ====

:Teleports the entity to the position of the other entity, plus a possible offset and random offset (defined on the spawnargs of the entity to be teleported)

==== scriptEvent float '''touches'''(entity other); ====

:Returns true if this entity touches the other entity.
::''other'': the entity to check against

==== scriptEvent void '''unbind'''(); ====

:Detaches this entity from its master.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

=== idAnimatedEntity ===
==== scriptEvent void '''clearAllJoints'''(); ====

:Removes any custom transforms on all joints.

==== scriptEvent void '''clearJoint'''(float jointnum); ====

:Removes any custom transforms on the specified joint.

==== scriptEvent vector '''getJointAngle'''(float jointnum); ====

:Returns the angular orientation of the joint in world space.

==== scriptEvent float '''getJointHandle'''(string jointname); ====

:Looks up the number of the specified joint. Returns INVALID_JOINT if the joint is not found.

==== scriptEvent vector '''getJointPos'''(float jointnum); ====

:Returns the position of the joint in world space.

==== scriptEvent void '''setJointAngle'''(float jointnum, float transform_type, vector angles); ====

:Modifies the orientation of the joint based on the transform type.

==== scriptEvent void '''setJointPos'''(float jointnum, float transform_type, vector pos); ====

:Modifies the position of the joint based on the transform type.

=== CFrobButton ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

=== CFrobDoor ===
==== scriptEvent entity '''GetDoorhandle'''(); ====

:Returns the handle entity of this door. Can return NULL (== $null_entity)

==== scriptEvent void '''OpenDoor'''(float master); ====

:The OpenDoor method is necessary to give the FrobDoorHandles a "low level" open routine. The CFrobDoor::Open() call is re-routed to the FrobDoorHandle::Tap() method, so there must be a way to actually let the door open. Which is what this method does. Note: Shouldn't be called directly by scripters, call handle->Tap() instead. Unless you know what you're doing.

=== CFrobDoorHandle ===
==== scriptEvent entity '''GetDoor'''(); ====

:Returns the associated door entity for this handle.

=== CFrobHandle ===
==== scriptEvent void '''Tap'''(); ====

:Operates this handle.

=== CFrobLever ===
==== scriptEvent void '''Operate'''(); ====

:Call this to operate this entity.

==== scriptEvent void '''Switch'''(float newState); ====

:Move the lever to the on or off position (0 = off).

=== CFrobLock ===
==== scriptEvent void '''Open'''(); ====

:Opens the frobmover, regardless of its previous state. The mover will not move when it's locked.

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

==== scriptEvent void '''TDM_Lock_StatusUpdate'''(); ====

:internal

=== CFrobLockHandle ===
==== scriptEvent entity '''GetLock'''(); ====

:Returns the associated lock of this handle.

=== tdmFuncShooter ===
==== scriptEvent void '''shooterFireProjectile'''(); ====

:Fires a projectile.

==== scriptEvent float '''shooterGetAmmo'''(); ====

:Get the ammonition

==== scriptEvent float '''shooterGetState'''(); ====

:Returns the current state of this shooter.

==== scriptEvent void '''shooterSetAmmo'''(float newAmmo); ====

:Set the ammonition

==== scriptEvent void '''shooterSetState'''(float state); ====

:Activates / deactivates the shooter entity.
::''state'': 1 = active, 0 = inactive

=== idEntityFx ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idClass ===
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

=== idItem ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''respawn'''(); ====

:Respawn

=== idMoveableItem ===
==== scriptEvent void '''gib'''(string damageDefName); ====

:No description

=== idLight ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''fadeInLight'''(float time); ====

:Turns the light on over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOutLight'''(float time); ====

:Turns the light out over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeToLight'''(vector color, float time); ====

:Fades the light to the given color over a given time.

==== scriptEvent float '''getLightLevel'''(); ====

:Get level (intensity) of a light, <= 0.0 indicates it is off

==== scriptEvent vector '''getLightOrigin'''(); ====

:Get the light origin (independent of its visual model)

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent vector '''getRadius'''(); ====

:Returns the light radius.

==== scriptEvent string '''getShader'''(); ====

:Gets the shader name used by the light.

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

==== scriptEvent void '''setLightOrigin'''(vector pos); ====

:Set origin of lights independent of model origin

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''setRadius'''(float radius); ====

:Sets the size of the bounding box, x=y=z=radius.

==== scriptEvent void '''setRadiusXYZ'''(float x, float y, float z); ====

:Sets the width/length/height of the light bounding box.

==== scriptEvent void '''setShader'''(string shader); ====

:Sets the shader to be used for the light.

==== scriptEvent void '''setStartedOff'''(); ====

:no description

==== scriptEvent void '''smoking'''(float state); ====

:flame is now smoking (1), or not (0)
::''state'': 1 = smoking, 0 = not smoking

=== idPlayerStart ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idActivator ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPathCorner ===
==== scriptEvent entity '''randomPath'''(); ====

:no description

=== idDamagable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idExplodable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idForceField ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Toggle'''(); ====

:Turns the forcefield on and off.

=== idAnimated ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''footstep'''(); ====

:Plays footstep sound.

==== scriptEvent void '''launchMissiles'''(string projectilename, string sound, string launchbone, string targetbone, float numshots, float framedelay); ====

:Launches a projectile.

==== scriptEvent void '''leftFoot'''(); ====

:Changes to left foot and plays footstep sound.

==== scriptEvent void '''rightFoot'''(); ====

:Changes to right foot and plays footstep sound.

==== scriptEvent void '''startRagdoll'''(); ====

:Switches to a ragdoll taking over the animation.

=== idStaticEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncSmoke ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idVacuumSeparatorEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalEntity ===
==== scriptEvent float '''getPortalHandle'''(); ====

:Returns the portal handle.

==== scriptEvent float '''getSoundLoss'''(); ====

:Returns the sound loss value (dB).

==== scriptEvent void '''setSoundLoss'''(float loss); ====

:Sets the sound loss value (dB).

=== idBeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idShaking ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idEarthQuake ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASPortal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idFuncAASObstacle ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPhantomObjects ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPortalSky ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== tdmVine ===
==== scriptEvent void '''addDescendant'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent float '''canWater'''(); ====

:Event called using vine.*()

==== scriptEvent void '''clearWatered'''(); ====

:Event called using vine.*()

==== scriptEvent entity '''getPrime'''(); ====

:Event called using vine.*()

==== scriptEvent void '''scaleVine'''(float factor); ====

:Event called using vine.*()

==== scriptEvent void '''setPrime'''(entity vine); ====

:Event called using vine.*()

==== scriptEvent void '''setWatered'''(); ====

:Event called using vine.*()

=== idMoveable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''becomeNonSolid'''(); ====

:Makes the moveable non-solid for other entities.

==== scriptEvent void '''enableDamage'''(float enable); ====

:enable/disable damage

==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

=== idMover ===
==== scriptEvent void '''accelSound'''(string sound); ====

:Sets the sound to be played when the mover accelerates.

==== scriptEvent void '''accelTime'''(float time); ====

:Sets the acceleration time. Set this acceleration time before initiating a new move.

==== scriptEvent void '''accelTo'''(float speed, float time); ====

:Initiates an acceleration to the given speed over the given time in seconds.

==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''bob'''(float speed, float phase, vector distance); ====

:Initiates a translation back and forth along the given vector with the given speed and phase.

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''decelSound'''(string sound); ====

:Sets the sound to be played when the mover decelerates.

==== scriptEvent void '''decelTime'''(float time); ====

:Sets the deceleration time. Set this deceleration time before initiating a new move.

==== scriptEvent void '''decelTo'''(float speed, float time); ====

:Initiates a deceleration to the given speed over the given time in seconds.

==== scriptEvent void '''disableSplineAngles'''(); ====

:Disables aligning the mover with the spline direction.

==== scriptEvent void '''enableSplineAngles'''(); ====

:Enables aligning the mover with the spline direction.

==== scriptEvent float '''getMoveSpeed'''(); ====

:Get the movement speed.

==== scriptEvent float '''getMoveTime'''(); ====

:Gets the movement time.

==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

==== scriptEvent float '''isRotating'''(); ====

:Returns true if a mover is rotating

==== scriptEvent void '''move'''(float angle, float distance); ====

:Initiates a translation with the given distance in the given yaw direction. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveSound'''(string sound); ====

:Sets the sound to be played when the moving.

==== scriptEvent void '''moveTo'''(entity targetEntity); ====

:Initiates a translation to the position of an entity. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''moveToPos'''(vector pos); ====

:Initiates a translation to an absolute position. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

==== scriptEvent void '''removeInitialSplineAngles'''(); ====

:Subtracts the initial spline angles to maintain the initial orientation of the mover.

==== scriptEvent void '''rotate'''(vector angleSpeed); ====

:Initiates a rotation with the given angular speed. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateDownTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by decreasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateOnce'''(vector angles); ====

:Initiates a rotation towards the current angles plus the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateTo'''(vector angles); ====

:Initiates a rotation towards the given Euler angles. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''rotateUpTo'''(float axis, float angle); ====

:Initiates a rotation about the given axis by increasing the current angle towards the given angle. Uses the current speed/time and acceleration and deceleration settings.

==== scriptEvent void '''speed'''(float speed); ====

:Sets the movement speed. Set this speed before initiating a new move.

==== scriptEvent void '''startSpline'''(entity spline); ====

:Starts moving along a spline stored on the given entity.

==== scriptEvent void '''stopMoving'''(); ====

:Stops any translational movement.

==== scriptEvent void '''stopRotating'''(); ====

:Stops any rotational movement.

==== scriptEvent void '''stopSpline'''(); ====

:Stops moving along a spline.

==== scriptEvent void '''sway'''(float speed, float phase, vector angles); ====

:Initiates a rotation back and forth along the given angles with the given speed and phase.

==== scriptEvent void '''time'''(float time); ====

:Sets the movement time. Set this time before initiating a new move.

=== idMover_Binary ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''closePortal'''(); ====

:Closes the renderer portal associated with this mover.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

==== scriptEvent void '''openPortal'''(); ====

:Opens the renderer portal associated with this mover.

=== idRotater ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idRiser ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idPlayer ===
==== scriptEvent void '''changeWeaponName'''(string weaponName, string displayName); ====

:Changes the display name of the given weapon item to something different. Pass an empty string to reset the display name to the definition as found in the weaponDef.

==== scriptEvent void '''changeWeaponProjectile'''(string weaponName, string projectileDefName); ====

:Changes the projectile entityDef name of the given weapon (e.g. "broadhead") to the specified entityDef (e.g. "atdm:projectile_broadhead").

==== scriptEvent void '''checkAAS'''(); ====

:No description

==== scriptEvent void '''clearActiveInventoryMap'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearActiveInventoryMapEnt'''(); ====

:Clear the active inventory map entity

==== scriptEvent void '''clearMouseDeadTime'''(); ====

:No description

==== scriptEvent void '''customDeath'''(); ====

:No description

==== scriptEvent void '''deathMenu'''(); ====

:No description

==== scriptEvent void '''disableWeapon'''(); ====

:Lowers and disables the player weapon.

==== scriptEvent void '''enableWeapon'''(); ====

:Enables the player weapon.

==== scriptEvent void '''endZoom'''(float duration); ====

:Starts the zoom out event, which performs a gradual transition back to the default FOV. May be called during a transition as well to intercept a pending zoom in transition.
::''duration'': duration of the transition in msec

==== scriptEvent void '''exitTeleporter'''(); ====

:No description

==== scriptEvent float '''getButtons'''(); ====

:Returns the button state from the current user command.

==== scriptEvent string '''getCurrentWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player is currently holding.

==== scriptEvent string '''getCurWeaponName'''(); ====

:Returns the name of the current weapon, as defined by "inv_weapon_name" in the weaponDef.

==== scriptEvent entity '''getDragged'''(); ====

:Returns the currently dragged body. Returns $null_entity if the body is shouldered, the player has nothing in his hands, or he has a non-AF entity in his hands. See also getShouldered(), getGrabbed() and getFrobbed().

==== scriptEvent float '''getFov'''(); ====

:This returns the current FOV of the player. You can modify the current FOV with startZoom() and endZoom().

==== scriptEvent entity '''getFrobbed'''(); ====

:Returns the currently frobhilighted entity. This includes entities the player has in his hands. Sets "frob only used by" mode

==== scriptEvent entity '''getGrabbed'''(); ====

:Returns the currently entity in the players hands. Returns $null_entity if the player has nothing in his hands Dragging or shouldering a body counts as grabbing it. See also getDragged(), getShouldered(), getFrobbed().

==== scriptEvent vector '''getHinderance'''(string source); ====

:Used to get hinderance from a source.

==== scriptEvent float '''getImmobilization'''(string source); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent float '''getInventoryOverlay'''(); ====

:Gets the default inventory overlay for the player. All other entities will return an invalid value.

==== scriptEvent float '''getMouseGesture'''(); ====

:Returns the results of the last mouse gesture in enum form. (see the definition for MOUSEDIR_* for which numbers correspond to which directions)

==== scriptEvent vector '''getMove'''(); ====

:Returns the movement relative to the player's view angles from the current user command. vector_x = forward, vector_y = right, vector_z = up

==== scriptEvent string '''getNextHinderance'''(string prefix, string lastMatch); ====

:Used to get the next hinderance from a source.

==== scriptEvent string '''getNextImmobilization'''(string prefix, string lastMatch); ====

:Used to get immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent string '''getNextTurnHinderance'''(string prefix, string lastMatch); ====

:Get the next hinderance on the view turning from a source

==== scriptEvent float '''getObjectiveComp'''(float ObjNum, float CompNum); ====

:Used to get the state of custom objective components
::''ObjNum'': Starts counting at 1
::''CompNum'': Starts counting at 1

==== scriptEvent float '''getObjectiveState'''(float ObjNum); ====

:Returns the current state of the objective with the number ObjNum. State is one of the following: OBJ_INCOMPLETE = 0, OBJ_COMPLETE = 1, OBJ_INVALID = 2, OBJ_FAILED = 3
::''ObjNum'': Starts counting at 1

==== scriptEvent string '''getPreviousWeapon'''(); ====

:Returns weaponX where X is the number of the weapon the player was previously holding.

==== scriptEvent entity '''getShouldered'''(); ====

:Returns the currently shouldered body, otherwise $null_entity. See also getDragged(), getGrabbed() and getFrobbed().

==== scriptEvent vector '''getTurnHinderance'''(string source); ====

:* Get the hinderance on the view turning from a source

==== scriptEvent vector '''getViewAngles'''(); ====

:Returns the player view angles.

==== scriptEvent entity '''getWeaponEntity'''(); ====

:Returns the entity for the player's weapon

==== scriptEvent void '''giveHealthPool'''(float amount); ====

:This increases/decreases the healthpool of the player by the given amount. The healthpool is gradually decreased over time, healing (damaging?) the player.

==== scriptEvent entity '''heldEntity'''(); ====

:Returns the entity currently being held, or $null_entity if the player's hands are empty.

==== scriptEvent float '''holdEntity'''(entity entity); ====

:Forces the player to hold an entity (e.g. puts it into the grabber). Drops whatever is in the player's hands if $null_entity is passed to it. Returns 1 if successful, 0 if not.

==== scriptEvent void '''missionFailed'''(); ====

:No description

==== scriptEvent void '''missionSuccess'''(); ====

:No description

==== scriptEvent float '''mouseGestureFinished'''(); ====

:Returns true if the player is not currently doing a mouse gesture.

==== scriptEvent void '''objectiveCompUnlatch'''(float ObjNum, float CompNum); ====

:Unlatch an irreversible objective component that has latched into a state

==== scriptEvent void '''objectiveUnlatch'''(float ObjNum); ====

:Unlatch an irreversible objective that has latched into a state

==== scriptEvent void '''pauseGame'''(); ====

:Pauses the game. This should only be called for threads that are explicitly maintained by a special SDK method, because ordinary threads won't get executed during g_stopTime == true. Note: This is used by the objective GUI threads. Note: Must be called on the player entity, not the sys entity.

==== scriptEvent void '''playStartSound'''(); ====

:No description

==== scriptEvent void '''readLightgemModifierFromWorldspawn'''(); ====

:No description

==== scriptEvent void '''resetWeaponProjectile'''(string weaponName); ====

:Reloads the original projectile def name from the weaponDef. Used to revert a change made by the event changeWeaponProjectile().

==== scriptEvent void '''resetZoom'''(); ====

:Cancels any pending zoom transitions and resets the FOV to normal.

==== scriptEvent void '''ropeRemovalCleanup'''(entity ropeEnt); ====

:Called when rope arrow ropes are removed, removes stale pointers on the player object.

==== scriptEvent void '''saveGame'''(string filename); ====

:No description

==== scriptEvent void '''selectWeapon'''(string weapon); ====

:Selects the weapon the player is holding.

==== scriptEvent void '''setActiveInventoryMapEnt'''(entity mapEnt); ====

:Notify the player about a new active map entity. This clears out any previously active maps.

==== scriptEvent void '''setFrobOnlyUsedByInv'''(float OnOff); ====

:Engages or disengages a mode where we only frobhilight entities that can be used by our current inventory item. This also disables general frobactions and only allows "used by" frob actions.

==== scriptEvent void '''setHinderance'''(string source, float mCap, float fCap); ====

:Used to set hinderance from a source.
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setImmobilization'''(string source, float type); ====

:Used to set immobilization from a source. Warning: Not a finalized version. It's subject to change, so use it at your own risk.)

==== scriptEvent void '''setLightgemModifier'''(string modifierName, float value); ====

:Sets the named lightgem modifier to a certain value. An example would be the player lantern: setLightgemModifier("lantern", 32). This way multiple modifiers can be set by concurrent script threads.

==== scriptEvent void '''setObjectiveComp'''(float ObjNum, float CompNum, float state); ====

:Used to set the state of custom objective components
::''ObjNum'': objective number. Starts counting at 1
::''CompNum'': component number. Starts counting at 1
::''state'': 1 or 0 for true or false

==== scriptEvent void '''setObjectiveEnabling'''(float ObjNum, string strIn); ====

:Set an objective's enabling objectives (objectives that must be completed before that objective may be completed).
::''strIn'': takes the form of a string that is a space-delimited list of integer objectives representing the new enabling objectives. E.g. : '1 2 3 4'

==== scriptEvent void '''setObjectiveOngoing'''(float ObjNum, float val); ====

:Sets objective ongoing.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveOptional'''(float ObjNum, float val); ====

:Sets objective mandatory.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setObjectiveState'''(float ObjNum, float State); ====

:Used to set the state of objectives from the script. For example, use this to invalidate an objective when something happens in your mission. The first argument is the numerical index of the objective (taking 'user' objective indices, starting at 1). Choose from the following for the second argument: OBJ_INCOMPLETE, OBJ_COMPLETE, OBJ_INVALID, OBJ_FAILED. Use this on $player1 like $player1.setObjectiveState(1, OBJ_COMPLETE);
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveText'''(float ObjNum, string newText); ====

:Modify the displayed text for an objective. Can also be a string template like #str_20000
::''ObjNum'': Starts counting at 1

==== scriptEvent void '''setObjectiveVisible'''(float ObjNum, float val); ====

:Sets objective visibility.
::''val'': 1 for true, 0 for false

==== scriptEvent void '''setSavePermissions'''(float permission); ====

:No description
::''permission'': 0

==== scriptEvent void '''setSpyglassOverlayBackground'''(); ====

:Sets the background overlay for the spyglass, depending on aspect ratio.

==== scriptEvent void '''setTurnHinderance'''(string source, float mCap, float fCap); ====

:Set the hinderance on the view turning from a source
::''mCap'': mCap values from all sources are multiplied together to define a cap
::''fCap'': fCap values are not additive, the smallest one among all the sources is used

==== scriptEvent void '''setViewAngles'''(vector angles); ====

:Sets the player view angles, e.g. make the player facing this direction. 0 0 0 is east (along the X axis in DR), 0 90 0 north (along the Y axis in DR) 0 180 0 west, 0 270 0 south.

==== scriptEvent void '''startGamePlayTimer'''(); ====

:Resets the game play timer to zero and (re)starts it.

==== scriptEvent void '''startMouseGesture'''(float key, float thresh, float test, float inverted, float turnHinderance, float decideTime, float deadTime); ====

:Start tracking a mouse gesture that started when the key impulse was pressed. Discretizes analog mouse movement into a few different gesture possibilities. Impulse arg can also be a button, see the UB_* enum in usercmdgen.h. For now, only one mouse gesture check at a time.
::''thresh'': Waits until the threshold mouse input thresh is reached before deciding.
::''test'': determines which test to do (0 = up/down, 1 = left/right, 2 = 4 directions, 3 = 8 directions).
::''inverted'': inverts the movement if set to 1, does not if 0
::''turnHinderance'': Sets the max player view turn rate when checking this mouse gesture (0 => player view locked, 1.0 => no effect on view turning)
::''decideTime'': time in milliseconds after which the mouse gesture is auto-decided, in the event that the mouse movement threshold was not reached. A DecideTime of -1 means wait forever until the button is released.
::''deadTime'': how long after attack is pressed that mouse control remains dampened by the fraction turnHinderance.

==== scriptEvent void '''startZoom'''(float duration, float startFOV, float endFOV); ====

:Call this to start the zoom in event. The player FOV is gradually zoomed in until over the given timespan.
::''duration'': duration of the transition in msec
::''startFOV'': The start FOV, this is clamped to [1..179]
::''endFOV'': The end FOV, this is clamped to [1..179]

==== scriptEvent void '''stopFxFov'''(); ====

:No description

==== scriptEvent void '''stopMouseGesture'''(); ====

:No description

==== scriptEvent void '''triggerMissionEnd'''(); ====

:No description

==== scriptEvent void '''unpauseGame'''(); ====

:Unpauses the game. Most scripts are not executed during g_stopTime == true and won't get into the position of calling this.

==== scriptEvent float '''wasDamaged'''(); ====

:Check if the player was damaged this frame.

=== idProjectile ===
==== scriptEvent float '''getProjectileState'''(); ====

:Gets the current state of the projectile. States are defined in tdm_defs.script

==== scriptEvent void '''launch'''(vector start, vector dir, vector velocity); ====

:Launches the projectile from <start> in direction <dir> with the given <velocity>

==== scriptEvent void '''TDM_Lock_OnLockPicked'''(); ====

:internal

=== CProjectileResult ===
==== scriptEvent entity '''getActualStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getAxialDir'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalAngVel'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getFinalVel'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getIncidenceAngle'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''getProjMass'''(); ====

:Getter for projectile result variable

==== scriptEvent entity '''getStruckEnt'''(); ====

:Getter for projectile result variable

==== scriptEvent vector '''getSurfNormal'''(); ====

:Getter for projectile result variable

==== scriptEvent string '''getSurfType'''(); ====

:Getter for projectile result variable

==== scriptEvent float '''isVineFriendly'''(); ====

:Vine-arrow event

=== CTarget_SetRelations ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeEntityRelation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idThread ===
==== scriptEvent vector '''angToForward'''(vector angles); ====

:Returns a forward vector for the given Euler angles.

==== scriptEvent vector '''angToRight'''(vector angles); ====

:Returns a right vector for the given Euler angles.

==== scriptEvent vector '''angToUp'''(vector angles); ====

:Returns an up vector for the given Euler angles.

==== scriptEvent void '''assert'''(float condition); ====

:Breaks if the condition is zero. (Only works in debug builds.)

==== scriptEvent void '''cacheSoundShader'''(string shaderName); ====

:Ensure the specified sound shader is loaded by the system. Prevents cache misses when playing sound shaders.
::''shaderName'': the sound shader to cache

==== scriptEvent float '''canPlant'''(vector traceStart, vector traceEnd, entity ignore, entity vine); ====

:No description

==== scriptEvent float '''ceil'''(float x); ====

:Returns the smallest integer that is greater than or equal to the given value.

==== scriptEvent void '''clearPersistantArgs'''(); ====

:Clears data that persists between maps.

==== scriptEvent void '''clearSignalThread'''(float signalNum, entity ent); ====

:Clears the script callback function set for when the given signal is raised on the given entity.

==== scriptEvent void '''copySpawnArgs'''(entity ent); ====

:copies the spawn args from an entity

==== scriptEvent float '''cos'''(float degrees); ====

:Returns the cosine of the given angle in degrees.

==== scriptEvent vector '''CrossProduct'''(vector vec1, vector vec2); ====

:Returns the cross product of the two vectors.

==== scriptEvent void '''debugArrow'''(vector color, vector start, vector end, float size, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugBounds'''(vector color, vector mins, vector maxs, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugCircle'''(vector color, vector origin, vector dir, float radius, float numSteps, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debugLine'''(vector color, vector start, vector end, float lifetime); ====

:line drawing for debug visualization. lifetime of 0 == 1 frame.

==== scriptEvent void '''debug_tdm_material'''(string file); ====

:For temporary debuging purposes only. Should be removed eventually.

==== scriptEvent float '''DotProduct'''(vector vec1, vector vec2); ====

:Returns the dot product of the two vectors.

==== scriptEvent void '''drawText'''(string text, vector origin, float scale, vector color, float align, float lifetime); ====

:text drawing for debugging. lifetime of 0 == 1 frame.
::''align'': 0 = left, 1 = center, 2 = right

==== scriptEvent float '''emitParticle'''(string particle, float startTime, float diversity, vector origin, vector angle); ====

:Start a particle effect in the world without using an entity emitter. Will emit one quad per particle stage when first called with sys.getTime() as the start time. Designed to be called once per frame with the same startTime each call to achieve a normal particle effect, or on demand with sys.getTime() as the startTime for finer grained control, 1 quad at a time. Returns True (1) if there are more particles to be emitted from the stage, False (0) if the stage has released all its quads.
::''particle'': String: name of particle effect.
::''startTime'': Game seconds since map start: use sys.getTime() for the first call unless you want to back-date the particle so that it starts part way through its cycle.
::''diversity'': Randomizer value between 0 and 1. All particles with the same diversity will have the same path and rotation. Use sys.random(1) for a random path.
::''origin'': Origin of the particle effect.
::''angle'': Axis for the particle effect. Use $<entityname>.getAngles() to align the particle to an entity. use '0 0 0' for an upright (world-aligned) particle effect.

==== scriptEvent void '''error'''(string text); ====

:Issues an error.

==== scriptEvent void '''fadeIn'''(vector color, float time); ====

:Fades towards the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeOut'''(vector color, float time); ====

:Fades from the given color over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''fadeTo'''(vector color, float alpha, float time); ====

:Fades to the given color up to the given alpha over the given time in seconds.
::''time'': in seconds

==== scriptEvent void '''firstPerson'''(); ====

:Returns view control to the player entity.

==== scriptEvent float '''floor'''(float x); ====

:Returns the largest integer that is less than or equal to the given value.

==== scriptEvent float '''getCurrentMissionNum'''(); ====

:Returns the number of the current mission (0-based, the first mission has number 0).

==== scriptEvent string '''getcvar'''(string name); ====

:Returns the string for a cvar.

==== scriptEvent float '''getDifficultyLevel'''(); ====

:Returns 0 (Easy), 1 (Medium) or 2 (Hard), depending on the difficulty level of the current mission.

==== scriptEvent string '''getDifficultyName'''(float difficultyLevel); ====

:Returns the (translated) name of the difficulty level passed as the argument.
::''difficultyLevel'': 0 (Easy), 1 (Medium), 2 (Hard)

==== scriptEvent entity '''getEntity'''(string name); ====

:Returns a reference to the entity with the specified name.

==== scriptEvent float '''getFrameTime'''(); ====

:returns the length of time between game frames. this is not related to renderer frame rate.

==== scriptEvent entity '''getMainAmbientLight'''(); ====

:Returns the entity of the main ambient light.

==== scriptEvent float '''getMissionStatistic'''(string statisticName); ====

:Returns current mission statistic.
::''statisticName'': Can be one of (case insensitive): gamePlayTime: gameplay time in seconds damageDealt: damage dealt to enemies damageReceived: damage received by player healthReceived: health received by player pocketsPicked: pockets picked by player foundLoot: loot found by player missionLoot: total loot available in mission totalTimePlayerSeen: total time the player was seen by enemies in seconds. Updates only when AI lose sight of player numberTimesPlayerSeen: number of times player was seen by enemies numberTimesAISuspicious: number of times AI was 'observant' or 'suspicious'. A single AI passing through both alert levels will add 2 to the score. numberTimesAISearched: number of times AI was 'investigating' or 'searching'. A single AI passing through both alert levels will add 2 to the score. sightingScore: sighting score (number of times player was seen * weight) stealthScore: stealth score (sighting score + alerts * weights) killedByPlayer: number of enemies killed by player knockedOutByPlayer: number of enemies knocked out by player bodiesFound: number of times enemies have spotted a body

==== scriptEvent entity '''getNextEntity'''(string key, string value, entity lastMatch); ====

:Discover all entities in the map. Returns $null_entity when no more found.
::''key'': Optional string: prefix for spawnarg key match. E.g. "target" will match "target", "target1" etc.
::''value'': Optional string: spawnarg value to match. Can be used independently of ''key''. If ''key'' is not set, all spawnargs will be checked for the value.
::''lastMatch'': Last match: search will start after this entity. Use $null_entity or pass an uninitialized entity variable to start a new search.

==== scriptEvent float '''getPersistantFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

==== scriptEvent string '''getPersistantString'''(string key); ====

:Returns the string for the given persistent arg

==== scriptEvent vector '''getPersistantVector'''(string key); ====

:Returns the vector for the given persistent arg

==== scriptEvent float '''getPortAISoundLoss'''(float handle); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent float '''getPortPlayerSoundLoss'''(float handle); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent float '''getPortSoundLoss'''(float handle); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent float '''getRelation'''(float team1, float team2); ====

:No description

==== scriptEvent float '''getTDMVersion'''(); ====

:Get the current TDM version as integer. The value will be 108 for v1.08, 109 for v1.09 and 200 for v2.00 etc.

==== scriptEvent float '''getTicsPerSecond'''(); ====

:returns the number of game frames per second. this is not related to renderer frame rate.

==== scriptEvent float '''getTime'''(); ====

:Returns the current game time in seconds.

==== scriptEvent string '''getTraceBody'''(); ====

:Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceEndPos'''(); ====

:Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint

==== scriptEvent entity '''getTraceEntity'''(); ====

:Returns a reference to the entity which was hit during the last call to trace or tracePoint

==== scriptEvent float '''getTraceFraction'''(); ====

:Returns the fraction of movement completed during the last call to trace or tracePoint.

==== scriptEvent string '''getTraceJoint'''(); ====

:Returns the number of the skeletal joint closest to the location on the entity which was hit during the last call to trace or tracePoint

==== scriptEvent vector '''getTraceNormal'''(); ====

:Returns the normal of the hit plane during the last call to trace or tracePoint

==== scriptEvent void '''handleMissionEvent'''(entity objEnt, float eventType, string argument); ====

:Generic interface for passing on mission events from scripts to the SDK. Available since TDM 1.02
::''objEnt'': the entity that triggered this event (e.g. a readable)
::''eventType'': a numeric identifier (enumerated both in MissionData.h and tdm_defs.script) specifying the type of event
::''argument'': an optional string parameter, eventtype-specific.

==== scriptEvent float '''influenceActive'''(); ====

:Checks if an influence is active

==== scriptEvent float '''isClient'''(); ====

:networking - checks for client

==== scriptEvent float '''isMultiplayer'''(); ====

:checks if it's a multiplayer game

==== scriptEvent void '''killthread'''(string threadName); ====

:Kills all threads with the specified name

==== scriptEvent float '''log'''(float x); ====

:Returns the log of the given argument.

==== scriptEvent void '''logString'''(float logClass, float logType, string output); ====

:This is the script counterpart to DM_LOG

==== scriptEvent void '''music'''(string shaderName); ====

:Starts playing background music.

==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''onSignal'''(float signalNum, entity ent, string functionName); ====

:Sets a script callback function for when the given signal is raised on the given entity.

==== scriptEvent void '''pause'''(); ====

:Pauses the current thread.

==== scriptEvent float '''pointInLiquid'''(vector point, entity ignoreEntity); ====

:Checks if a point is in a liquid, returns 1 if this is the case.

==== scriptEvent float '''pow'''(float x, float y); ====

:Returns the power of x to y.

==== scriptEvent void '''print'''(string text); ====

:Prints the given string to the console.

==== scriptEvent void '''println'''(string text); ====

:Prints the given line to the console.

==== scriptEvent void '''radiusDamage'''(vector origin, entity inflictor, entity attacker, entity ignore, string damageDefName, float dmgPower); ====

:damages entities within a radius defined by the damageDef. inflictor is the entity causing the damage and can be the same as the attacker (in the case of projectiles, the projectile is the inflictor, while the attacker is the character that fired the projectile).
::''inflictor'': the entity causing the damage
::''ignore'': an entity to not cause damage to
::''dmgPower'': scales the damage (for cases where damage is dependent on time)

==== scriptEvent float '''random'''(float range); ====

:Returns a random value X where 0 <= X < range.

==== scriptEvent void '''say'''(string text); ====

:Multiplayer - Print this line on the network

==== scriptEvent void '''sessionCommand'''(string cmd); ====

:Sends the sessioncommand to the game

==== scriptEvent void '''setCamera'''(entity cameraEnt); ====

:Turns over view control to the given camera entity.

==== scriptEvent void '''setcvar'''(string name, string value); ====

:Sets a cvar.

==== scriptEvent void '''setPersistantArg'''(string key, string value); ====

:Sets a key/value pair that persists between maps

==== scriptEvent void '''setPortAISoundLoss'''(float handle, float value); ====

:AI sound propagation scriptfunction on the sys object

==== scriptEvent void '''setPortPlayerSoundLoss'''(float handle, float value); ====

:Player sound loss scriptfunction on the sys object

==== scriptEvent void '''setPortSoundLoss'''(float handle, float value); ====

:Sound propagation scriptfunction on the sys object

==== scriptEvent void '''setRelation'''(float team1, float team2, float val); ====

:No description

==== scriptEvent void '''setShaderParm'''(float parm, float value); ====

:Sets the value of the specified shader parm.
::''parm'': shader parm index
::''value'': new value

==== scriptEvent void '''setSpawnArg'''(string key, string value); ====

:Sets a key/value pair to be used when a new entity is spawned.

==== scriptEvent float '''sin'''(float degrees); ====

:Returns the sine of the given angle in degrees.

==== scriptEvent entity '''spawn'''(string classname); ====

:Creates an entity of the specified classname and returns a reference to the entity.

==== scriptEvent float '''SpawnFloat'''(string key, float default); ====

:Returns the floating point value for the given spawn argument.

==== scriptEvent string '''SpawnString'''(string key, string default); ====

:Returns the string for the given spawn argument.

==== scriptEvent vector '''SpawnVector'''(string key, vector default); ====

:Returns the vector for the given spawn argument.

==== scriptEvent float '''sqrt'''(float square); ====

:Returns the square root of the given number.

==== scriptEvent float '''strFind'''(string text, string find, float casesensitive, float start, float end); ====

:Return the position of the given substring, counting from 0, or -1 if not found.
::''casesensitive'': 0
::''start'': 0
::''end'': -1

==== scriptEvent string '''strLeft'''(string text, float num); ====

:Returns a string composed of the first num characters

==== scriptEvent float '''strLength'''(string text); ====

:Returns the number of characters in the string

==== scriptEvent string '''strMid'''(string text, float start, float num); ====

:Returns a string composed of the characters from start to start + num

==== scriptEvent string '''strRemove'''(string text, string remove); ====

:Replace all occurances of the given substring with "". Example: StrRemove("abba","bb") results in "aa".

==== scriptEvent string '''strReplace'''(string text, string remove, string replace); ====

:Replace all occurances of the given string with the replacement string. Example: StrRemove("abba","bb","ccc") results in "accca".

==== scriptEvent string '''strRight'''(string text, float num); ====

:Returns a string composed of the last num characters

==== scriptEvent string '''strSkip'''(string text, float num); ====

:Returns the string following the first num characters

==== scriptEvent float '''strToFloat'''(string text); ====

:Returns the numeric value of the given string.

==== scriptEvent float '''strToInt'''(string text); ====

:Returns the integer value of the given string.

==== scriptEvent void '''terminate'''(float threadNumber); ====

:Terminates a thread.

==== scriptEvent void '''threadname'''(string name); ====

:Sets the name of the current thread.

==== scriptEvent float '''trace'''(vector start, vector end, vector mins, vector maxs, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the box from 'mins' to 'maxs' hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent float '''tracePoint'''(vector start, vector end, float contents_mask, entity passEntity); ====

:Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid during the move.

==== scriptEvent string '''translate'''(string input); ====

:Translates a string (like #str_12345) into the current language

==== scriptEvent void '''trigger'''(entity entityToTrigger); ====

:Triggers the given entity.

==== scriptEvent float '''vecLength'''(vector vec); ====

:Returns the length of the given vector.

==== scriptEvent vector '''vecNormalize'''(vector vec); ====

:Returns the normalized version of the given vector.

==== scriptEvent vector '''VecToAngles'''(vector vec); ====

:Returns Euler angles for the given direction.

==== scriptEvent void '''wait'''(float time); ====

:Suspends execution of the current thread for the given number of seconds.

==== scriptEvent void '''waitFor'''(entity mover); ====

:Waits for the given entity to complete its move.

==== scriptEvent void '''waitForRender'''(entity e); ====

:Suspends the current thread until 'e' might have been rendered. It's event based, so it doesn't waste CPU repeatedly checking inPVS(). e.inPVS() will very likely be true when the thread resumes. If e.inPVS() is true, calling waitForRender() will probably just wait a frame, unless D3 can figure out that the entity doesn't need to be rendered. Optimizations regarding shadowcasting lights may not apply to this function - it is based purely off whether or not the entity's bounding box is visible.

==== scriptEvent void '''waitForThread'''(float threadNumber); ====

:Waits for the given thread to terminate.

==== scriptEvent void '''waitFrame'''(); ====

:Suspends execution of current thread for one game frame.

==== scriptEvent void '''warning'''(string text); ====

:Issues a warning.

=== Seed ===
==== scriptEvent void '''cullAll'''(); ====

:Cull (remove from world) all entities.

==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idSound ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

==== scriptEvent void '''Off'''(); ====

:Turns the entity off.

==== scriptEvent void '''On'''(); ====

:Turns the entity on.

=== idTarget_Remove ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Show ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Damage ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SessionCommand ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EndLevel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_WaitForButton ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetGlobalShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderParm ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetShaderTime ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeEntity ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeIn ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_LightFadeOut ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_Give ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetModel ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetInfluence ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetKeyVal ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_SetFov ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_CallObjectFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_PostScriptEvent ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_EnableLevelWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_RemoveWeapons ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTarget_FadeSoundClass ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_AddObjectives ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveVisibility ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetObjectiveComponentState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_StartConversation ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetFrobable ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_CallScriptFunction ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeLockState ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_ChangeTarget ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_InterMissionTrigger ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== CTarget_SetTeam ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger ===
==== scriptEvent void '''disable'''(); ====

:Disables the mover/trigger

==== scriptEvent void '''enable'''(); ====

:Enables the mover/trigger

=== idTrigger_Multi ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_EntityName ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Timer ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Count ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Hurt ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Fade ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idTrigger_Touch ===
==== scriptEvent void '''activate'''(entity activator); ====

:Activates this entity as if it was activated by a trigger.
::''activator'': the entity that caused the action (usually the player)

=== idWeapon ===
==== scriptEvent void '''addToClip'''(float amount); ====

:No description

==== scriptEvent void '''allowDrop'''(float allow); ====

:no description

==== scriptEvent float '''ammoAvailable'''(); ====

:Number of shots left in inventory

==== scriptEvent float '''ammoInClip'''(); ====

:No description

==== scriptEvent float '''animDone'''(float channel, float blendOutFrames); ====

:Returns true if the animation playing on the given channel is completed considering a number of blend frames.

==== scriptEvent float '''animIsPaused'''(float channel); ====

:Return whether the given anim channel is paused

==== scriptEvent float '''clipSize'''(); ====

:No description

==== scriptEvent entity '''createProjectile'''(); ====

:no description

==== scriptEvent void '''ejectBrass'''(); ====

:no description

==== scriptEvent void '''flashlight'''(float enable); ====

:no description

==== scriptEvent float '''getBlendFrames'''(float channel); ====

:Returns the number of frames to blend between animations on the given channel.

==== scriptEvent float '''getLightParm'''(float parmNum); ====

:Gets a shader parameter.

==== scriptEvent entity '''getOwner'''(); ====

:Returns the owning entity

==== scriptEvent entity '''getWorldModel'''(); ====

:Returns the entity that controls the world model

==== scriptEvent float '''isInvisible'''(); ====

:no description

==== scriptEvent void '''launchProjectiles'''(float num_projectiles, float spread, float fuseOffset, float launchPower, float dmgPower); ====

:no description

==== scriptEvent float '''melee'''(); ====

:no description

==== scriptEvent void '''netEndReload'''(); ====

:no description

==== scriptEvent void '''netReload'''(); ====

:no description

==== scriptEvent void '''nextWeapon'''(); ====

:No description

==== scriptEvent void '''pauseAnim'''(float channel, float bPause); ====

:Pause all animations playing on the given channel. NOTE: Can also be used used by idWeapons
::''bPause'': true = pause, false = unpause

==== scriptEvent float '''playAnim'''(float channel, string animName); ====

:Plays the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent float '''playCycle'''(float channel, string animName); ====

:Continuously repeats the given animation on the given channel. Returns false if anim doesn't exist.

==== scriptEvent void '''setBlendFrames'''(float channel, float blendFrame); ====

:Sets the number of frames to blend between animations on the given channel.

==== scriptEvent void '''setLightParm'''(float parmNum, float value); ====

:Sets a shader parameter.

==== scriptEvent void '''setLightParms'''(float parm0, float parm1, float parm2, float parm3); ====

:Sets the red/green/blue/alpha shader parms on the light and the model.

==== scriptEvent void '''showAttachment'''(string attName, float show); ====

:Show or hide an attachment.
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent void '''showAttachmentInd'''(float index, float show); ====

:Show or hide an attachment by array index.
::''index'': starts at 0
::''show'': 1 shows attachment, 0 hides it.

==== scriptEvent float '''totalAmmoCount'''(); ====

:Amount of ammo in inventory. since each shot may use more than 1 ammo, this is different than ammoAvailable()

==== scriptEvent void '''useAmmo'''(float amount); ====

:Eats the specified amount of ammo

==== scriptEvent void '''weaponHolstered'''(); ====

:no description

==== scriptEvent void '''weaponLowering'''(); ====

:no description

==== scriptEvent void '''weaponOutOfAmmo'''(); ====

:no description

==== scriptEvent void '''weaponReady'''(); ====

:no description

==== scriptEvent void '''weaponReloading'''(); ====

:no description

==== scriptEvent void '''weaponRising'''(); ====

:no description

==== scriptEvent void '''weaponState'''(string stateFunction, float blendFrames); ====

:no description

[[Category:Scripting]]