The DarkMod Wiki - User contributions [en]

VMWare: Virtual machine with Linux

2026-03-24T12:04:23Z

Stgatilov: Update about shared directories

This guide is originally written for TDM 2.07.

== Intro ==

It is very convenient for a Windows-centric developer to have a Linux virtual machine in his arcenal.

You can read how to set up VirtualBox VM in the article [[VirtualBox: Virtual machine with Linux for TDM]].
This article is about setting up a VMware VM, which has some benefits over VirtualBox: better performance and OpenGL support.

== Install VMware ==

While Oracle's VirtualBox is open-source, the VMware product is proprietary in its full sense. As of year 2019, there is [https://www.vmware.com/products/workstation-player.html VMware Workstation Player], which is '''free for non-commercial use'''. You can download it on [https://my.vmware.com/en/web/vmware/free#desktop_end_user_computing/vmware_workstation_player this page] (choose Windows version).

Installation is trivial. Most likely, you do '''not''' need the "Enhanced Keyboard Driver".

== Create VM ==

Start VMware Workstation, click on "Create a New Virtual Machine".

Point "Installer disc image file" to the ISO image of the Linux distro which you want to install (by default it would be [https://www.ubuntu.com/download/desktop Ubuntu LTS]). Click Next.

Choose a name like "Ubuntu XX.YY x64", set user and password, click Next. Don't forget to set Location: a typical VM takes 5-10 GB. Leave Disk Capacity settings in defaults: do '''not''' use monolithic disk, because it would make some configuring much harder!

As long as you choose reasonable settings and ISO, you should be eligible for "Easy Install", which means that you'll get Ubuntu installed for you automatically, along with open-vm-tools. Make sure you have '''internet access''' through the whole process, otherwise your installation will be incomplete.

== Client Tools ==

In order to use shared directories and shared clipboard, you need to install some sort of client tools. Unfortunately, this topic is quite messy in VMware world. First of all, there are two such tools available: ''VMware Tools'' is distributed with VMware Player, and ''open-vm-tools'' is intended to be distributed by Linux package manager. Second, default installations of the tools are often buggy and don't work.

<s>In my case, open-vm-tools 2:10.2.0-3~ubuntu0.16.04.1 was installed automatically by VMware Player 15.0.2 during Easy Install procedure and it did not work well. It mounted the shared folder properly when I added it, but after a full reboot the shared folder was absent. Installing the patches from [https://askubuntu.com/a/726906/918615 this answer] helped. Of course, you need to do "<tt>sudo apt-get install git</tt>" first.</s>

'''UPDATE:''' Still have the same issue with shared directories on Ubuntu 20.04, but the patches installer referenced above does not work anymore. It seems that the only real problem is that shared directories are not added to auto-mount settings of the guest OS. [https://superuser.com/a/1762262/734756 This answer] worked perfectly for me (i.e. adding vmhgfs-fuse to /etc/fstab).

In order to create shared folder, open "Virtual Machine Settings" (in "Player" -> "Manage").
Go to "Options" -> "Shared Folders", and set it to "Always enabled". Now "Add" your TDM root directory to make it accessible from within VM. Check that it is available at <tt>/mnt/hgfs/[name_of_share]</tt>. If it is not there, then I wish you good luck!

== Configure VM ==

When your VM is '''not''' running, right-click on VM and go to "Settings".

Choose "Memory", and increase the amount of Memory available to 4096 MB.

Choose "Processors", and increase "Number of processor cores" to make TDM build faster. I advise setting it to the number of physical cores you have (6 for me).

Choose "Display", increase "Graphics memory" to 2 GB.

Click OK to apply changes.

== Clean backup ==

I prefer having the clean VM backed up so that I could restart with a fresh and configured VM at any moment. VMware Player does not support cloning and snapshots, but you can find the directory with your VM data and simply copy the whole directory.

== Build and run TDM ==

Open terminal, change dir to the root source code directory in the shared folder, e.g.:

cd /mnt/hgfs/thedarkmod/darkmod_src

From here you can build TDM in the usual way, as described in the [[The Dark Mod - Compilation Guide#Linux]]. Of course, you have to install some packages before first build.

In order to run TDM, go to assets root directory, e.g.:

cd /mnt/hgfs/thedarkmod/darkmod

Run TDM from there:

./thedarkmod.x64

For TDM 2.07, you also have to do "<tt>sudo apt-get install libopenal1</tt>" beforehand.

Currently VMware seems to support OpenGL 3.0 in general and OpenGL 3.3 Core profile only.

== Mouse look ==

VMware breaks mouse cursor warping in the same way as VirtualBox does. Warping is critical for mouse-look in FPS games, including TDM. Without it, you won't be able even to navigate through menus.

There are two ways to fix it in case of VMware Player:

'''VMware-side solution'''. Make sure the VM is shutdown, open the <tt>.vmx</tt>-file of your VM and add the following magic lines to it:

usb.generic.allowHID = "TRUE"
mouse.vusb.useBasicMouse = "FALSE"
mouse.vusb.enable = "TRUE"

Strangely, this is already enough to fix the problem. If your mouse is crazy in TDM, press Ctrl+Alt and click back to VM, and mouse look should return to normal.

Also with these lines, you can passthrough your mouse and keyboard exclusively to VM. In order to do that, click "Player" -> "Removable Devices", find your mouse/keyboard there and click "Connect". Make sure that you have spare USB mouse or keyboard connected to computer so that at least some control is left on the host side.

'''TDM-side hack'''. Open game console and set "<tt>in_nowarp 1</tt>" there.
After that you have a limited mouse-look. You cannot really play with it, but it is enough for clicking through menu and a bit of in-game testing. Use "turn left/right" keys as additional workaround.

== The game runs very slow ==

I have to set cvar "<tt>r_gpuBufferNonpersistentUpdateMode 1</tt>" locally to get normal performance (supposedly since TDM 2.09).
With default value of this cvar, TDM rendering is very slow inside VM for some reason.
Note that this cvar is internal and does not affect normal installations that much.

[[Category: Coding]]

What's new in TDM 2.14

2026-03-21T11:51:26Z

Stgatilov: Removed one more line about ACES tonemapping.

{{released|2.14|2026-03-20}}
See the [https://bugs.thedarkmod.com/changelog_page.php?version_id=113 changelog] on our bugtracker.
Source Revision 11208

 
'''The Dark Mod 2.14 Stability Release'''
 


 
A major focus for The Dark Mod 2.14 development cycle was fixing lingering issues seen with some of the larger 2.13 changes and complete work started in 2.13.
 The new AI visibility feature in 2.13 was found to have a few issues with performance and object awareness that were not seen in 2.13 beta testing
 so many players reverted settings to the 2.12 mode. Now the feature is working better than ever with improved performance!
 
 A few longstanding major bugs were finally solved!
* Frequent saving on large missions no longer results in AI getting stuck in walls or obstructions.
* The entity "suicide" script meant to cleanup unused objects has been fixed or removed from AI and Weapon animation cycles where it was causing random crashes.
* Item Inventory icons no longer randomly show as stacked on top of each other in the HUD
 
 Tone-mapping is now only applied to the 3D engine so the menus remain legible regardless of what extremity the user configures in the game.
 ( We had this fix in 2.08 but it was reverted due to other bugs \ issues that it caused. Welcome back! )
 
 Non-Elite AI can be knocked out after a flashbomb blinds them!
 
 The LOD menu has been given a new FULL option which disables all distance optimizations including ones not controlled by the LOD system.
 This is a pretty punishing setting on some missions but is offered for players who want a no compromises visual option if they have the hardware.
 It also serves as a debug option for visual anomalies are not LOD related and it fixes the brief portalsky bug when exiting underwater while swimming
 
 Guard animations have been improved to better handle transition states. Also a new "Old Man" AI has been added!
 
 Menu GUI's can now render a snapshot of the last in-game 3D screen. This is used to great effect in the new mission "Displacement"
 
 More Dhewm3 code has been ported into TDM and the Dhewm3 project maintainer has been actively involved in TDM development.
 Of note (other than some code stability changes), MD3 and MD5 animations fixes and improvements have been incorporated.
 
 Projected Decals are now light interactive! Footprints, blood splats, projectile holes, all can have normalmaps and lighting interactions!
 
 You can now enable SSAO in subviews such as mirrors / camera views so they will look more accurate. ( r_ssao_insubview )
 
 '''OPTIMIZATIONS'''
* Further optimization to the parallel model rendering code have been introduced. Now the operations broken into chunks and load-balanced better. More demanding missions like "Scroll of Remembrance" should run better for most players now.
* Mirror and Remote Render surfaces can now have lower resolution rendering ( this optimization was broken some time after 2.05 )
* Portal distance closure now follows the LOD menu distance settings

'''See our [https://forums.thedarkmod.com/index.php?/topic/23106-214-feature-discussion-threads/ Feature Discuss Threads] for more details about substantial changes.'''



----
 

== '''Important CVARS''' ==

=== PLAYER ===
 

r_ssao_insubview ( can enable ambient occlusion in subviews (mirrors, remotes, etc.) )

tdm_frob_item_selects_item ( allows to not select an item immediately after player picks it up. )

r_decalInteractive ( whether projected decals are lit with light interactions. Set to 0 to disable all interactions with lights for decals, to restore behavior of 2.13.)

{{clear}}

=== TROUBLESHOOTING ===
 

'''MAJOR'''

g_lightQuotientAlgo ( which light estimate system is used by AI. It has been changed from "1" (hybrid) to "2" (only use the new system). If you suspect you have some problems with light evaluation by AI, can try to set it back to 1 or 0.)

r_decalInteractive ( whether projected decals are lit with light interactions. Set to 0 to disable all interactions with lights for decals, to restore behavior of 2.13. )

g_newSmokeParticles ( whether use the new system for emitting smoke particles. Set to 0 to switch the old smoke emitting code.)

'''MINOR'''

r_useParallelAddModels ( controls internal parallelization in renderer frontend, also known as "Frontend Acceleration" in the main menu. If you want to disable the new dynamic scheduling, then you can change it from "2" to "1". A related cvar for tweaking is r_parallelAddModelsChunk. )

r_copyRenderUseScissor, r_remoteLimitResolutionByScreenSize ( control new subview optimizations. )

r_useCachedDecalModels ( control optimization in interactible decals implementation. )

{{clear}}
 

== '''Graphics''' ==

* Tone-mapping is no longer applied to menu GUIs.
* New FULL LOD mode, with all distance based optimizations disabled
* Mirrors and Remote Renders can be rendered with lower resolution for performance
* Projected Decals are light interactive now
* Func Portals now respect LOD distance settings
* SSAO can be applied to subviews
* Fixed Linux crash when material with custom GLSL shader is loaded during gameplay
* Fixed shadow culling bug with volumetric lights
* Fixed shadow maps bug when light only lights noselfshadow and translucent surfaces.
* Fixed overbright surfaces in fog in some module models

{{clear}}
 

== '''AI''' ==

* AI ( non-elite ) can be knocked out after a flashbomb
* AI no longer get stuck in map geometry due to frequent saving
* AI should now notice absence and blood markers again
* Fixed backface shadows for parallel lights in AI light estimate system

{{clear}}
 

== '''Mapping''' ==

* Now the engine defines macros TDM_VERSION/TDM_REVISION/TDM_VERSION_FULL in game scripts and GUI scripts. This adds more flexibility in making a mission compatible with several versions of the game despite occasional breaking changes
* The smoke particle generation system was reimplemented, fixing several discrepancies with particle generation for particle models and particle deform. In particular, it is now possible to use proper cycling, although this needs use_cycles spawnarg
* Dmap should no longer leave some files from the previous compilation, which used to cause confusion previously
* Removed collision from func_cameraTarget
* Increased radius of AAS visualization tool.
* Added editor description for efx_preset spawnarg.
* Now it is possible to use larger mesh models... at least static ones.

{{clear}}

== '''Coding''' ==

* ParallelAddModels now has a chunking feature and load balances work better
* MD3 and MD5 Animation fixes and improvements ( MD5 skin scale effect, MD3 Shadows ) from the Dhewm3 project
* Crash fixes and code hardening ported from Dhewm3
* Fixed major issues in using OBJ meshes from Blender.
* Fixed promoting mission override into user value for some cvars
* Cvars from mission.cfg converted into mission overrides, even outside gameplay
* Fixed crash from having many localization packs
* Fixed too many decals spawned by brittle fracture sometimes
* Fixed saving/loading the special liquid model.
* Added sys.unsetcvar script event
* Some stim/response timer now uses game time instead of CPU clocks.

{{clear}}
 

== '''Assets''' ==

See:

https://forums.thedarkmod.com/index.php?/topic/23080-214-new-and-updated-assets/

{{clear}}
 

 

== '''GUIs''' ==

* The last game frame can now be used in menu guis
* Inventory icons no longer encounter random stacking visuals in the HUD
* Tone-mapping no longer affects menus
* Various campaign fixes: GUI of wrong mission being shown, next mission not starting if some menu screens were disabled, shortsword name in tdm_campaign.def

{{clear}}
 

== '''Sound''' ==

* Fixed dynamically started looping sounds with leadin, including main menu ones
* OpenAL build recipe adjusted for CMake 4
* Proper sounds will be played on certain frames where idle animations replacement were used.

{{clear}}
 

== '''Translation''' ==

* Font improvements for Cyrillic and Romanian character support
* Font visuals and formatting been improved

{{whatsnew|sort=214}}

What's new in TDM 2.14

2026-03-21T11:50:27Z

Stgatilov: Removed the line about ACES tonemapping

{{released|2.14|2026-03-20}}
See the [https://bugs.thedarkmod.com/changelog_page.php?version_id=113 changelog] on our bugtracker.
Source Revision 11208

 
'''The Dark Mod 2.14 Stability Release'''
 


 
A major focus for The Dark Mod 2.14 development cycle was fixing lingering issues seen with some of the larger 2.13 changes and complete work started in 2.13.
 The new AI visibility feature in 2.13 was found to have a few issues with performance and object awareness that were not seen in 2.13 beta testing
 so many players reverted settings to the 2.12 mode. Now the feature is working better than ever with improved performance!
 
 A few longstanding major bugs were finally solved!
* Frequent saving on large missions no longer results in AI getting stuck in walls or obstructions.
* The entity "suicide" script meant to cleanup unused objects has been fixed or removed from AI and Weapon animation cycles where it was causing random crashes.
* Item Inventory icons no longer randomly show as stacked on top of each other in the HUD
 
 Tone-mapping is now only applied to the 3D engine so the menus remain legible regardless of what extremity the user configures in the game.
 ( We had this fix in 2.08 but it was reverted due to other bugs \ issues that it caused. Welcome back! )
 
 Non-Elite AI can be knocked out after a flashbomb blinds them!
 
 The LOD menu has been given a new FULL option which disables all distance optimizations including ones not controlled by the LOD system.
 This is a pretty punishing setting on some missions but is offered for players who want a no compromises visual option if they have the hardware.
 It also serves as a debug option for visual anomalies are not LOD related and it fixes the brief portalsky bug when exiting underwater while swimming
 
 Guard animations have been improved to better handle transition states. Also a new "Old Man" AI has been added!
 
 Menu GUI's can now render a snapshot of the last in-game 3D screen. This is used to great effect in the new mission "Displacement"
 
 More Dhewm3 code has been ported into TDM and the Dhewm3 project maintainer has been actively involved in TDM development.
 Of note (other than some code stability changes), MD3 and MD5 animations fixes and improvements have been incorporated.
 
 Projected Decals are now light interactive! Footprints, blood splats, projectile holes, all can have normalmaps and lighting interactions!
 
 You can now enable SSAO in subviews such as mirrors / camera views so they will look more accurate. ( r_ssao_insubview )
 
 '''OPTIMIZATIONS'''
* Further optimization to the parallel model rendering code have been introduced. Now the operations broken into chunks and load-balanced better. More demanding missions like "Scroll of Remembrance" should run better for most players now.
* Mirror and Remote Render surfaces can now have lower resolution rendering ( this optimization was broken some time after 2.05 )
* Portal distance closure now follows the LOD menu distance settings

'''See our [https://forums.thedarkmod.com/index.php?/topic/23106-214-feature-discussion-threads/ Feature Discuss Threads] for more details about substantial changes.'''



----
 

== '''Important CVARS''' ==

=== PLAYER ===
 

r_ssao_insubview ( can enable ambient occlusion in subviews (mirrors, remotes, etc.) )

tdm_frob_item_selects_item ( allows to not select an item immediately after player picks it up. )

r_decalInteractive ( whether projected decals are lit with light interactions. Set to 0 to disable all interactions with lights for decals, to restore behavior of 2.13.)

{{clear}}

=== TROUBLESHOOTING ===
 

'''MAJOR'''

g_lightQuotientAlgo ( which light estimate system is used by AI. It has been changed from "1" (hybrid) to "2" (only use the new system). If you suspect you have some problems with light evaluation by AI, can try to set it back to 1 or 0.)

r_decalInteractive ( whether projected decals are lit with light interactions. Set to 0 to disable all interactions with lights for decals, to restore behavior of 2.13. )

g_newSmokeParticles ( whether use the new system for emitting smoke particles. Set to 0 to switch the old smoke emitting code.)

'''MINOR'''

r_useParallelAddModels ( controls internal parallelization in renderer frontend, also known as "Frontend Acceleration" in the main menu. If you want to disable the new dynamic scheduling, then you can change it from "2" to "1". A related cvar for tweaking is r_parallelAddModelsChunk. )

r_copyRenderUseScissor, r_remoteLimitResolutionByScreenSize ( control new subview optimizations. )

r_useCachedDecalModels ( control optimization in interactible decals implementation. )

{{clear}}
 

== '''Graphics''' ==

* New ACES Style Tone-Mapping with less blowout. Tone-mapping is no longer applied to menu GUIs.
* New FULL LOD mode, with all distance based optimizations disabled
* Mirrors and Remote Renders can be rendered with lower resolution for performance
* Projected Decals are light interactive now
* Func Portals now respect LOD distance settings
* SSAO can be applied to subviews
* Fixed Linux crash when material with custom GLSL shader is loaded during gameplay
* Fixed shadow culling bug with volumetric lights
* Fixed shadow maps bug when light only lights noselfshadow and translucent surfaces.
* Fixed overbright surfaces in fog in some module models

{{clear}}
 

== '''AI''' ==

* AI ( non-elite ) can be knocked out after a flashbomb
* AI no longer get stuck in map geometry due to frequent saving
* AI should now notice absence and blood markers again
* Fixed backface shadows for parallel lights in AI light estimate system

{{clear}}
 

== '''Mapping''' ==

* Now the engine defines macros TDM_VERSION/TDM_REVISION/TDM_VERSION_FULL in game scripts and GUI scripts. This adds more flexibility in making a mission compatible with several versions of the game despite occasional breaking changes
* The smoke particle generation system was reimplemented, fixing several discrepancies with particle generation for particle models and particle deform. In particular, it is now possible to use proper cycling, although this needs use_cycles spawnarg
* Dmap should no longer leave some files from the previous compilation, which used to cause confusion previously
* Removed collision from func_cameraTarget
* Increased radius of AAS visualization tool.
* Added editor description for efx_preset spawnarg.
* Now it is possible to use larger mesh models... at least static ones.

{{clear}}

== '''Coding''' ==

* ParallelAddModels now has a chunking feature and load balances work better
* MD3 and MD5 Animation fixes and improvements ( MD5 skin scale effect, MD3 Shadows ) from the Dhewm3 project
* Crash fixes and code hardening ported from Dhewm3
* Fixed major issues in using OBJ meshes from Blender.
* Fixed promoting mission override into user value for some cvars
* Cvars from mission.cfg converted into mission overrides, even outside gameplay
* Fixed crash from having many localization packs
* Fixed too many decals spawned by brittle fracture sometimes
* Fixed saving/loading the special liquid model.
* Added sys.unsetcvar script event
* Some stim/response timer now uses game time instead of CPU clocks.

{{clear}}
 

== '''Assets''' ==

See:

https://forums.thedarkmod.com/index.php?/topic/23080-214-new-and-updated-assets/

{{clear}}
 

 

== '''GUIs''' ==

* The last game frame can now be used in menu guis
* Inventory icons no longer encounter random stacking visuals in the HUD
* Tone-mapping no longer affects menus
* Various campaign fixes: GUI of wrong mission being shown, next mission not starting if some menu screens were disabled, shortsword name in tdm_campaign.def

{{clear}}
 

== '''Sound''' ==

* Fixed dynamically started looping sounds with leadin, including main menu ones
* OpenAL build recipe adjusted for CMake 4
* Proper sounds will be played on certain frames where idle animations replacement were used.

{{clear}}
 

== '''Translation''' ==

* Font improvements for Cyrillic and Romanian character support
* Font visuals and formatting been improved

{{whatsnew|sort=214}}

TDM Script Reference

2026-01-14T19:25:42Z

Stgatilov: Regenerated script reference for 2.14.

This page has been generated automatically by the tdm_gen_script_event_doc console command.

Generated by The Dark Mod 2.14, code revision 11087, last update: 2026-01-14 19:24

{{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 float '''acos'''(float cosine); ====

:Returns the angle in degrees with the given cosine.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''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_ItemRemove'', ''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'', ''idListener'', ''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 '''addFrobPeer'''(entity peer); ====

:Adds the passed entity as a frob peer.

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''angRotate'''(vector angles1, vector angles2); ====

:Rotates the given Euler angles by each other.

:Spawnclasses responding to this event: ''idThread''
==== 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 float '''asin'''(float sine); ====

:Returns the angle in degrees with the given sine.

:Spawnclasses responding to this event: ''idThread''
==== 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 '''attack'''(entity enemy, float ignoreCollisions); ====

:Direct the turret to manually attack the specified entity. Use disableManualAttack() to disable.
::''enemy'': enemy to attack
::''ignoreCollisions'': whether to ignore obstacles in the way to the enemy when planning to attack

:Spawnclasses responding to this event: ''idTurret''
==== 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 '''attackPosition'''(vector targetPos, float ignoreCollisions); ====

:Direct the turret to manually attack a position. Use disableManualAttack() to disable.
::''targetPos'': position to attack
::''ignoreCollisions'': whether to ignore obstacles in the way to the target position when planning to attack. Recommended true for this event.

:Spawnclasses responding to this event: ''idTurret''
==== 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 '''callFunctionsByWildcard'''(string functionName); ====

:Calls global functions with names matching the specified wildcard in separate threads (in lexicographical order). INTERNAL: don't use in mission scripting!

:Spawnclasses responding to this event: ''idThread''
==== 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'', ''idSecurityCamera''
==== 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 '''clearPersistentArgs'''(); ====

: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 float '''createXrayOverlay'''(string guiFile); ====

:Creates a GUI overlay with X-ray material. (must be used on the player)

: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 '''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 '''disableManualAttack'''(); ====

:Stop attacking the manually specified enemy or position and return to automatic target acquisition mode.

:Spawnclasses responding to this event: ''idTurret''
==== 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 void '''flee'''(entity entToFleeFrom); ====

:Flee from the given entity.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''fleeFromPoint'''(vector pos); ====

:Flee from the given position.

: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 '''getAnimList'''(float channel); ====

:Returns a list of all animations and their anim rates.

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

:Returns the rate for the given animation. Returns -1 if animation cannot be found.
::''animName'': The name of the animation.

:Spawnclasses responding to this event: ''idActor''
==== 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 '''getCalibratedLightgemValue'''(); ====

:Returns the calibrated light gem value.

: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 float '''getCurInvItemCount'''(); ====

:Returns the item count of the currently highlighted inventory Item, if stackable.Returns - 1 if non - stackable

: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 '''getcvarf'''(string name); ====

:Returns float value 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'', ''idSecurityCamera''
==== 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 float '''getEntityFlag'''(string flagName); ====

:Returns the value of the specified entity flag.
::''flagName'': Can be one of (case insensitive): notarget: if true never attack or target this entity noknockback: if true no knockback from hits takedamage: if true this entity can be damaged hidden: if true this entity is not visible bindOrientated: if true both the master orientation is used for binding solidForTeam: if true this entity is considered solid when a physics team mate pushes entities forcePhysicsUpdate: if true always update from the physics whether the object moved or not selected: if true the entity is selected for editing neverDormant: if true the entity never goes dormant isDormant: if true the entity is dormant hasAwakened: before a monster has been awakened the first time, use full PVS for dormant instead of area-connected invisible: if true this entity cannot be seen inaudible: if true this entity cannot be heard

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''GetFractionalPosition'''(); ====

:Returns a fraction between 0.00 (closed) and 1.00 (open).

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== 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: ''idEntity''
==== 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 '''getInterceptTime'''(vector velocityTarget, float speedInterceptor, vector positionTarget, vector positionInterceptor); ====

:Returns how much time it will take for an interceptor like a projectile to intercept a moving target at the earliest possible opportunity. Returns 0 if an intercept is not possible or the speed of the target and interceptor are too similar.
::''velocityTarget'': current velocity of target
::''speedInterceptor'': speed of interceptor
::''positionTarget'': current position of target
::''positionInterceptor'': starting position of interceptor

:Spawnclasses responding to this event: ''idThread''
==== 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 vector '''getListenLoc'''(); ====

:Retrieves the location of the listener when leaning.

:Spawnclasses responding to this event: ''idPlayer''
==== 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 '''getLocationPoint'''(vector point); ====

:Returns the idLocation entity corresponding to the specified point's location.
::''point'': point whose location to check

:Spawnclasses responding to this event: ''idThread''
==== 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 float '''getMaxHealth'''(); ====

:Gets the max health of this 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 secretsFound: number of secrets found by the player secretsTotal: total number of secrets in the mission

: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 '''getNextEnemy'''(entity lastMatch); ====

:Returns the next enemy that the security camera can see.
::''lastMatch'': search will start after this entity.Use $null_entity or pass an uninitialized entity variable to start a new search.The first result in a new search will be the player, if the camera can see him.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 float '''getObjectiveVisible'''(float ObjNum); ====

:Returns the current visibility of the objective with the number ObjNum.
::''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 '''getPersistentFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getPersistentString'''(string key); ====

:Returns the string for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getPersistentVector'''(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 float '''getSecurityCameraState'''(); ====

:Returns the security camera's state. 1 = unalerted, 2 = suspicious, 3 = fully alerted, 4 = inactive, 5 = destroyed.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 entity '''getSpotLight'''(); ====

:Returns the spotlight used by the camera. Returns null_entity if none is used.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 string '''getTraceSurfType'''(); ====

:Returns the type of the surface (i.e. metal, snow) which was hit 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 float '''getTurretState'''(); ====

:Returns the turret's state. 0 = passive: no active security cameras connected. 1 = unalerted, 2 = suspicious, 3 = fully alerted, 4 = power off, 5 = destroyed.

:Spawnclasses responding to this event: ''idTurret''
==== 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 '''getVectorToIdealOrigin'''(); ====

:Returns the vector from where the AI is to where he ideally should be

:Spawnclasses responding to this event: ''idAI''
==== 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 '''hasInvItem'''(entity item); ====

:Tests whether the player has the specified item entity in his inventory.

: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 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 '''isAirborne'''(); ====

:Checks whether the player is in the air.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

:Spawnclasses responding to this event: ''idMoveable''
==== 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 '''isLeaning'''(); ====

:Get whether the player is leaning

:Spawnclasses responding to this event: ''idPlayer''
==== 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'', ''CFrobLock''
==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

:Spawnclasses responding to this event: ''idMover''
==== 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 '''isPeekLeaning'''(); ====

:Get whether the player is peek leaning (against a keyhole or crack)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== 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 void '''launchGuided'''(vector start, vector dir, vector velocity, entity target); ====

:Launches the guided projectile from <start> in direction <dir> with the given <velocity> at <target entity>. Pass $null_entity to fire an unguided projectile.

:Spawnclasses responding to this event: ''idGuidedProjectile''
==== 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'', ''CFrobLock''
==== 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 '''max'''(float x, float y); ====

:returns the larger of two provided float values.

:Spawnclasses responding to this event: ''idThread''
==== 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 float '''min'''(float x, float y); ====

:returns the smaller of two provided float values.

:Spawnclasses responding to this event: ''idThread''
==== 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, but be sure to give it the topmost bindmaster

: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'''(); ====

:Switches the emitter off.

:Spawnclasses responding to this event: ''idFuncEmitter'', ''idLight'', ''idSecurityCamera'', ''idSound''
==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

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

:Switches the emitter on.

:Spawnclasses responding to this event: ''idFuncEmitter'', ''idLight'', ''idSecurityCamera'', ''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); ====

:Do not use, this is part of TDM's internal mechanics. Use playCustomAnim() on AI.in scripts instead of this. Plays the given animation on the given channel. Returns false if anim doesn't exist.

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

:Plays the given animation on legs and torso. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idAI''
==== 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 '''pointIsInBounds'''(vector point, vector mins, vector maxs); ====

:Returns true if the point is within the bounds specified.
::''point'': test whether this point is in the bounds
::''mins'': minimal corner of the bounds
::''maxs'': maximal corner of the bounds

: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 '''projectDecal'''(vector traceOrigin, vector traceEnd, entity passEntity, string decal, float decalSize, float angle); ====

:Performs a trace from the specified origin and end positions, then projects a decal in that direction.
::''traceOrigin'': Start of the trace.
::''traceEnd'': End of the trace.
::''passEntity'': This entity will be considered non-solid by the trace.
::''decal'': Decal to be projected.
::''decalSize'': Size of the decal quad.
::''angle'': Angle of the decal quad.

:Spawnclasses responding to this event: ''idThread''
==== 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 '''removeFrobPeer'''(entity peer); ====

:Removes the passed entity as a frob peer.

: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 '''reskinCollisionModel'''(); ====

:For use after setSkin() on moveables and static models, if the CM needs to be refreshed to update surface properties after a skin change. CM will be regenerated from the original model file with the new skin.

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''saveConDump'''(string cmd, string cmd); ====

:Saves condump into FM directory; first argument is appended to dump filename, everything before last occurence of second argument is removed

:Spawnclasses responding to this event: ''idThread''
==== 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 '''setAirAccelerate'''(float newAccelerate); ====

:Sets a multiplier for the player's horizontal acceleration while airborne. Default is 1.0.

:Spawnclasses responding to this event: ''idPlayer''
==== 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 float '''setAnimRate'''(float channel, string animName, float animRate); ====

:Sets the animation rate to the given value. Returns 1 if successful, otherwise -1
::''animName'': The name of the animation.
::''animRate'': The rate to set the animation to.

: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). See also setColorVec for a variant that accepts a vector instead.
::''parm0'': red
::''parm1'': green
::''parm2'': blue

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setColorVec'''(vector newColor); ====

:Similar to setColor, but accepts the new RGB color as a vector instead of 3 different floats.

: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 '''setFrobActionScript'''(string frobActionScript); ====

:Changes the frob action script of this entity. Also updates the 'frob_action_script' spawnarg.
::''frobActionScript'': the new script to call when the entity is frobbed

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

:Sets the passed entity as the frob master. Pass null_entity to remove the current frob master, if any.

: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 '''setGravity'''(vector newGravity); ====

:Sets a new gravity vector for this entity. Note that non-upright vectors are poorly supported at present.

:Spawnclasses responding to this event: ''idEntity''
==== 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: ''idEntity''
==== 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 '''setMaxHealth'''(float maxHealth); ====

:Use these to set the max health of AI or players. Note that the health bar GUI is limited to showing a max health of 100. If health exceeds max health after this, health will be set to be equal to max health (which would also update the AI_DEAD flag)

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''setObjectiveNotification'''(float ObjNote); ====

:Turns the notifications (sound ++ text) for objectives on/off.
::''ObjNote'': Turn notifications on/off

: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 '''setPeekOverlayBackground'''(); ====

:Sets the background overlay for peeking, depending on aspect ratio.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setPeekView'''(float OnOff, vector origin); ====

:Toggle whether we should use a view from a peek entity as the player's view

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setPersistentArg'''(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 '''setSecretsFound'''(float secrets); ====

:Set how many secrets the player has found. Use getMissionStatistic() for getting the current value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setSecretsTotal'''(float secrets); ====

:Set how many secrets exist in the map in total. Use getMissionStatistic() for getting the current value.

:Spawnclasses responding to this event: ''idThread''
==== 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 '''setSightThreshold'''(float sightThreshold); ====

:Set the sight threshold of the security camera: how lit up the player's lightgem needs to be in order to be seen. 0.0 to 1.0

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 '''setSmoke'''(string particleDef); ====

:Changes the smoke particle of a func_smoke.

:Spawnclasses responding to this event: ''idFuncSmoke''
==== 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 '''setSolid'''(float solidity); ====

:Set the solidity of the entity. If the entity has never been solid before it will be assigned solid and opaque contents/clip masks.

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''setUsedBy'''(entity ent, float b_canUse); ====

:Allows to change which entities can use this entity.
::''ent'': specify an entity here, like a key
::''b_canUse'': whether the specified entity can use this entity

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''state_light'''(float set); ====

:Switches the spotlight on or off. Respects the security camera's power state.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_see_AI'''(float set); ====

:Set whether the camera can see AIs.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_see_animals'''(float set); ====

:Set whether the camera can see animals. Checked after seeAI or seeBodies.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_see_bodies'''(float set); ====

:Set whether the camera can see bodies.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_see_player'''(float set); ====

:Set whether the camera can see the player.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_sweep'''(float set); ====

:Enables or disables the camera's sweeping.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 '''StimEmit'''(float type, float radius, vector stimOrigin); ====

:Emits a stim in a radius around the specified origin. The entity from which this event is called needs to have the corresponding stim setup on itself, it does not need to be active.
::''type'': Index ID of the stim to emit, i.e. 21 or STIM_TRIGGER for a trigger stim.
::''radius'': How far the stim will reach. Pass negative to use the radius settings on the entity.
::''stimOrigin'': Emit the stim from here.

: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 '''StimSetScriptBased'''(float type, float state); ====

:Converts a stim to being script-based. It will only be emitted when a script calls StimEmit on the entity.
::''type'': Index ID of the stim to alter, i.e. 21 or STIM_TRIGGER for a trigger stim.
::''state'': New state.

: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 '''stopPatrol'''(); ====

:Stops an AI from patrolling

:Spawnclasses responding to this event: ''idAI''
==== 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 '''testEvent1'''(float float_pi, float int_beef, float float_exp, string string_tdm, float float_exp10, float int_food); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''testEvent2'''(float int_prevres, vector vec_123, float int_food, entity ent_player, entity ent_null, float float_pi, float float_exp); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''testEvent3'''(entity ent_prevres, vector vec_123, float float_pi, entity ent_player); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== 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 '''toggle_light'''(); ====

:Toggles the spotlight on/off.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_see_AI'''(); ====

:Toggles whether the camera can see AIs.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_see_animals'''(); ====

:Toggles whether the camera can see bodies. Checked after seeAI or seeBodies.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_see_bodies'''(); ====

:Toggles whether the camera can see bodies.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_see_player'''(); ====

:Toggles whether the camera can see the player.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_sweep'''(); ====

:Toggles the camera sweep.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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'', ''CFrobLock''
==== 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'', ''CFrobLock''
==== 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 '''VecRotate'''(vector vector, vector angles); ====

:Rotates a vector by the specified angles.

: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 ==
=== idClass ===
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

=== 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 '''getAnimList'''(float channel); ====

:Returns a list of all animations and their anim rates.

==== scriptEvent float '''getAnimRate'''(float channel, string animName); ====

:Returns the rate for the given animation. Returns -1 if animation cannot be found.
::''animName'': The name of the animation.

==== 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 '''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); ====

:Do not use, this is part of TDM's internal mechanics. Use playCustomAnim() on AI.in scripts instead of this. 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 float '''setAnimRate'''(float channel, string animName, float animRate); ====

:Sets the animation rate to the given value. Returns 1 if successful, otherwise -1
::''animName'': The name of the animation.
::''animRate'': The rate to set the animation to.

==== 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 '''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 void '''flee'''(entity entToFleeFrom); ====

:Flee from the given entity.

==== scriptEvent void '''fleeFromPoint'''(vector pos); ====

:Flee from the given position.

==== 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 '''getVectorToIdealOrigin'''(); ====

:Returns the vector from where the AI is to where he ideally should be

==== 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 float '''playCustomAnim'''(string animName); ====

:Plays the given animation on legs and torso. Returns false if anim doesn't exist.

==== 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 '''stopPatrol'''(); ====

:Stops an AI from patrolling

==== 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 '''GetFractionalPosition'''(); ====

:Returns a fraction between 0.00 (closed) and 1.00 (open).

==== 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.

==== scriptEvent void '''Off'''(); ====

:Switches the emitter off.

==== scriptEvent void '''On'''(); ====

:Switches the emitter on.

=== 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 '''addFrobPeer'''(entity peer); ====

:Adds the passed entity as a frob peer.

==== 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 float '''createXrayOverlay'''(string guiFile); ====

:Creates a GUI overlay with X-ray material. (must be used on the player)

==== 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 float '''getCurInvItemCount'''(); ====

:Returns the item count of the currently highlighted inventory Item, if stackable.Returns - 1 if non - stackable

==== 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 float '''getEntityFlag'''(string flagName); ====

:Returns the value of the specified entity flag.
::''flagName'': Can be one of (case insensitive): notarget: if true never attack or target this entity noknockback: if true no knockback from hits takedamage: if true this entity can be damaged hidden: if true this entity is not visible bindOrientated: if true both the master orientation is used for binding solidForTeam: if true this entity is considered solid when a physics team mate pushes entities forcePhysicsUpdate: if true always update from the physics whether the object moved or not selected: if true the entity is selected for editing neverDormant: if true the entity never goes dormant isDormant: if true the entity is dormant hasAwakened: before a monster has been awakened the first time, use full PVS for dormant instead of area-connected invisible: if true this entity cannot be seen inaudible: if true this entity cannot be heard

==== 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 '''getHealth'''(); ====

:Returns the current health.

==== 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 float '''getMaxHealth'''(); ====

:Gets the max health of this 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 '''hasInvItem'''(entity item); ====

:Tests whether the player has the specified item entity in his inventory.

==== 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 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, but be sure to give it the topmost bindmaster

==== 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 '''removeFrobPeer'''(entity peer); ====

:Removes the passed entity as a frob peer.

==== 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 '''reskinCollisionModel'''(); ====

:For use after setSkin() on moveables and static models, if the CM needs to be refreshed to update surface properties after a skin change. CM will be regenerated from the original model file with the new skin.

==== 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). See also setColorVec for a variant that accepts a vector instead.
::''parm0'': red
::''parm1'': green
::''parm2'': blue

==== scriptEvent void '''setColorVec'''(vector newColor); ====

:Similar to setColor, but accepts the new RGB color as a vector instead of 3 different floats.

==== 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 '''setFrobActionScript'''(string frobActionScript); ====

:Changes the frob action script of this entity. Also updates the 'frob_action_script' spawnarg.
::''frobActionScript'': the new script to call when the entity is frobbed

==== scriptEvent void '''setFrobMaster'''(entity master); ====

:Sets the passed entity as the frob master. Pass null_entity to remove the current frob master, if any.

==== scriptEvent void '''setGravity'''(vector newGravity); ====

:Sets a new gravity vector for this entity. Note that non-upright vectors are poorly supported at present.

==== 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 '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

==== 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 '''setMaxHealth'''(float maxHealth); ====

:Use these to set the max health of AI or players. Note that the health bar GUI is limited to showing a max health of 100. If health exceeds max health after this, health will be set to be equal to max health (which would also update the AI_DEAD flag)

==== 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 '''setSolid'''(float solidity); ====

:Set the solidity of the entity. If the entity has never been solid before it will be assigned solid and opaque contents/clip masks.

==== 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 '''setUsedBy'''(entity ent, float b_canUse); ====

:Allows to change which entities can use this entity.
::''ent'': specify an entity here, like a key
::''b_canUse'': whether the specified entity can use this entity

==== 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 '''StimEmit'''(float type, float radius, vector stimOrigin); ====

:Emits a stim in a radius around the specified origin. The entity from which this event is called needs to have the corresponding stim setup on itself, it does not need to be active.
::''type'': Index ID of the stim to emit, i.e. 21 or STIM_TRIGGER for a trigger stim.
::''radius'': How far the stim will reach. Pass negative to use the radius settings on the entity.
::''stimOrigin'': Emit the stim from here.

==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''StimRemove'''(float type); ====

:No description

==== scriptEvent void '''StimSetScriptBased'''(float type, float state); ====

:Converts a stim to being script-based. It will only be emitted when a script calls StimEmit on the entity.
::''type'': Index ID of the stim to alter, i.e. 21 or STIM_TRIGGER for a trigger stim.
::''state'': New state.

==== 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 float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

==== 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 '''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.

=== 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)

=== 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'''(); ====

:Switches the emitter off.

==== scriptEvent void '''On'''(); ====

:Switches the emitter 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

=== idListener ===
==== scriptEvent void '''activate'''(entity activator); ====

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

=== 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)

==== scriptEvent void '''setSmoke'''(string particleDef); ====

:Changes the smoke particle of a func_smoke.

=== 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 float '''getCalibratedLightgemValue'''(); ====

:Returns the calibrated light gem value.

==== 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 vector '''getListenLoc'''(); ====

:Retrieves the location of the listener when leaning.

==== 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 float '''getObjectiveVisible'''(float ObjNum); ====

:Returns the current visibility of the objective with the number ObjNum.
::''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 float '''isAirborne'''(); ====

:Checks whether the player is in the air.

==== scriptEvent float '''isLeaning'''(); ====

:Get whether the player is leaning

==== scriptEvent float '''isPeekLeaning'''(); ====

:Get whether the player is peek leaning (against a keyhole or crack)

==== 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 '''setAirAccelerate'''(float newAccelerate); ====

:Sets a multiplier for the player's horizontal acceleration while airborne. Default is 1.0.

==== 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 '''setObjectiveNotification'''(float ObjNote); ====

:Turns the notifications (sound ++ text) for objectives on/off.
::''ObjNote'': Turn notifications on/off

==== 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 '''setPeekOverlayBackground'''(); ====

:Sets the background overlay for peeking, depending on aspect ratio.

==== scriptEvent void '''setPeekView'''(float OnOff, vector origin); ====

:Toggle whether we should use a view from a peek entity as the player's view

==== 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 float '''testEvent1'''(float float_pi, float int_beef, float float_exp, string string_tdm, float float_exp10, float int_food); ====

:No description

==== scriptEvent entity '''testEvent2'''(float int_prevres, vector vec_123, float int_food, entity ent_player, entity ent_null, float float_pi, float float_exp); ====

:No description

==== scriptEvent vector '''testEvent3'''(entity ent_prevres, vector vec_123, float float_pi, entity ent_player); ====

: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

=== idGuidedProjectile ===
==== scriptEvent void '''launchGuided'''(vector start, vector dir, vector velocity, entity target); ====

:Launches the guided projectile from <start> in direction <dir> with the given <velocity> at <target entity>. Pass $null_entity to fire an unguided projectile.

=== 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 float '''acos'''(float cosine); ====

:Returns the angle in degrees with the given cosine.

==== scriptEvent vector '''angRotate'''(vector angles1, vector angles2); ====

:Rotates the given Euler angles by each other.

==== 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 float '''asin'''(float sine); ====

:Returns the angle in degrees with the given sine.

==== 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 void '''callFunctionsByWildcard'''(string functionName); ====

:Calls global functions with names matching the specified wildcard in separate threads (in lexicographical order). INTERNAL: don't use in mission scripting!

==== 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 '''clearPersistentArgs'''(); ====

: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 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 '''getcvarf'''(string name); ====

:Returns float value 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 float '''getInterceptTime'''(vector velocityTarget, float speedInterceptor, vector positionTarget, vector positionInterceptor); ====

:Returns how much time it will take for an interceptor like a projectile to intercept a moving target at the earliest possible opportunity. Returns 0 if an intercept is not possible or the speed of the target and interceptor are too similar.
::''velocityTarget'': current velocity of target
::''speedInterceptor'': speed of interceptor
::''positionTarget'': current position of target
::''positionInterceptor'': starting position of interceptor

==== scriptEvent entity '''getLocationPoint'''(vector point); ====

:Returns the idLocation entity corresponding to the specified point's location.
::''point'': point whose location to check

==== 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 secretsFound: number of secrets found by the player secretsTotal: total number of secrets in the mission

==== 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 '''getPersistentFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

==== scriptEvent string '''getPersistentString'''(string key); ====

:Returns the string for the given persistent arg

==== scriptEvent vector '''getPersistentVector'''(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 string '''getTraceSurfType'''(); ====

:Returns the type of the surface (i.e. metal, snow) which was hit 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 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 float '''max'''(float x, float y); ====

:returns the larger of two provided float values.

==== scriptEvent float '''min'''(float x, float y); ====

:returns the smaller of two provided float values.

==== 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 '''pointIsInBounds'''(vector point, vector mins, vector maxs); ====

:Returns true if the point is within the bounds specified.
::''point'': test whether this point is in the bounds
::''mins'': minimal corner of the bounds
::''maxs'': maximal corner of the bounds

==== 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 '''projectDecal'''(vector traceOrigin, vector traceEnd, entity passEntity, string decal, float decalSize, float angle); ====

:Performs a trace from the specified origin and end positions, then projects a decal in that direction.
::''traceOrigin'': Start of the trace.
::''traceEnd'': End of the trace.
::''passEntity'': This entity will be considered non-solid by the trace.
::''decal'': Decal to be projected.
::''decalSize'': Size of the decal quad.
::''angle'': Angle of the decal quad.

==== 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 '''saveConDump'''(string cmd, string cmd); ====

:Saves condump into FM directory; first argument is appended to dump filename, everything before last occurence of second argument is removed

==== 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 '''setPersistentArg'''(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 '''setSecretsFound'''(float secrets); ====

:Set how many secrets the player has found. Use getMissionStatistic() for getting the current value.

==== scriptEvent void '''setSecretsTotal'''(float secrets); ====

:Set how many secrets exist in the map in total. Use getMissionStatistic() for getting the current value.

==== 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 '''VecRotate'''(vector vector, vector angles); ====

:Rotates a vector by the specified angles.

==== 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.

=== idSecurityCamera ===
==== scriptEvent float '''canSee'''(entity ent); ====

:no description

==== scriptEvent entity '''getEnemy'''(); ====

:no description

==== scriptEvent entity '''getNextEnemy'''(entity lastMatch); ====

:Returns the next enemy that the security camera can see.
::''lastMatch'': search will start after this entity.Use $null_entity or pass an uninitialized entity variable to start a new search.The first result in a new search will be the player, if the camera can see him.

==== scriptEvent float '''getSecurityCameraState'''(); ====

:Returns the security camera's state. 1 = unalerted, 2 = suspicious, 3 = fully alerted, 4 = inactive, 5 = destroyed.

==== scriptEvent entity '''getSpotLight'''(); ====

:Returns the spotlight used by the camera. Returns null_entity if none is used.

==== scriptEvent void '''Off'''(); ====

:Switches the emitter off.

==== scriptEvent void '''On'''(); ====

:Switches the emitter on.

==== scriptEvent void '''setSightThreshold'''(float sightThreshold); ====

:Set the sight threshold of the security camera: how lit up the player's lightgem needs to be in order to be seen. 0.0 to 1.0

==== scriptEvent void '''state_light'''(float set); ====

:Switches the spotlight on or off. Respects the security camera's power state.

==== scriptEvent void '''state_see_AI'''(float set); ====

:Set whether the camera can see AIs.

==== scriptEvent void '''state_see_animals'''(float set); ====

:Set whether the camera can see animals. Checked after seeAI or seeBodies.

==== scriptEvent void '''state_see_bodies'''(float set); ====

:Set whether the camera can see bodies.

==== scriptEvent void '''state_see_player'''(float set); ====

:Set whether the camera can see the player.

==== scriptEvent void '''state_sweep'''(float set); ====

:Enables or disables the camera's sweeping.

==== scriptEvent void '''toggle_light'''(); ====

:Toggles the spotlight on/off.

==== scriptEvent void '''toggle_see_AI'''(); ====

:Toggles whether the camera can see AIs.

==== scriptEvent void '''toggle_see_animals'''(); ====

:Toggles whether the camera can see bodies. Checked after seeAI or seeBodies.

==== scriptEvent void '''toggle_see_bodies'''(); ====

:Toggles whether the camera can see bodies.

==== scriptEvent void '''toggle_see_player'''(); ====

:Toggles whether the camera can see the player.

==== scriptEvent void '''toggle_sweep'''(); ====

:Toggles the camera sweep.

=== 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'''(); ====

:Switches the emitter off.

==== scriptEvent void '''On'''(); ====

:Switches the emitter 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)

=== CTarget_ItemRemove ===
==== scriptEvent void '''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)

=== idTurret ===
==== scriptEvent void '''attack'''(entity enemy, float ignoreCollisions); ====

:Direct the turret to manually attack the specified entity. Use disableManualAttack() to disable.
::''enemy'': enemy to attack
::''ignoreCollisions'': whether to ignore obstacles in the way to the enemy when planning to attack

==== scriptEvent void '''attackPosition'''(vector targetPos, float ignoreCollisions); ====

:Direct the turret to manually attack a position. Use disableManualAttack() to disable.
::''targetPos'': position to attack
::''ignoreCollisions'': whether to ignore obstacles in the way to the target position when planning to attack. Recommended true for this event.

==== scriptEvent void '''disableManualAttack'''(); ====

:Stop attacking the manually specified enemy or position and return to automatic target acquisition mode.

==== scriptEvent float '''getTurretState'''(); ====

:Returns the turret's state. 0 = passive: no active security cameras connected. 1 = unalerted, 2 = suspicious, 3 = fully alerted, 4 = power off, 5 = destroyed.

=== 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); ====

:Do not use, this is part of TDM's internal mechanics. Use playCustomAnim() on AI.in scripts instead of this. 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]]

Analyze a Memory Dump

2025-04-26T21:01:32Z

Stgatilov: Debug symbols exist for Linux builds too.

You received a crash dump and don't know how to analyze it?
That's not a big deal, really.
Don't get scared by numerous references to WinDbg and CDB in relation to memory dumps!
You can open dumps directly in Visual Studio debugger.

Before starting, you might want to read [https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/user-mode-dump-files Microsoft docs about memory dumps], so that understand what it is and what is included.

===== Learn version =====
First of all, you need to know which exact version of program the memory dump was obtained from. You should learn the exact state of source code, and build platform + configuration.

Here are some options:
* TheDarkMod final release: ask the TDM version, like 2.07.
* TheDarkMod beta release: ask when player has updated TDM last time. Or ask him to attach console dump. Or ask him to open game console and look at the revision number there.
* TheDarkMod developer build: ask developer about source code revision, platform and configuration.

Bitness is not important: you will know it immediately when you open the dump.

===== Get source code =====
Get the matching version of source code. In the case of TDM game or updater, you most likely need to switch to specific revision on the release branch/tag.

===== Get debug symbols =====
This is the hardest part: you need the debug symbols (i.e. the PDB files) for the binaries from which the memory dump was saved.

Here are some options:
* TheDarkMod final release: find PDBs in <tt>devel/release/debugging/X.YZ/</tt> in assets SVN, and unpack them.
* TheDarkMod beta release: ask release manager to upload PDBs somewhere (he usually saves them).
* TheDarkMod developer build: ask developer to upload the matching PDB.

The situation is the same for Linux builds as well.
All the Linux builds produce debug symbols in a separate file (e.g. <tt>thedarkmod.x64.debug</tt>), and this file is treated just like PDB.

On Windows, every PDB and DMP file contains checksum of executable, and normally you cannot use PDB for memory dump if the checksums don't match, just like you cannot use a PDB to debug a program if it does not match. Merely rebuilding the project is enough to break PDB compatibility. Not sure if the same problem exists for Linux + GDB.

If you cannot get the original PDB but have the original executable, then you can also try to force-load freshly built PDBs. Here are the steps:
# Get exactly matching source code, compiler, target, configuration, whatever else.
# Build new binaries (fresh rebuild advised).
# Find the created PDB files and use [http://www.debuginfo.com/tools/chkmatch.html chkmatch -m] to substitute checksum inside PDB.

Of course, using mismatched PDB can lead to all sort of issues during debugging.

=== Action ===

Open the solution in Visual Studio (instructions written against VS2017).

In menu: "File -> Open -> File...". Choose the memory dump file.

[[File:crashdump_1_open.png|border|700px]]

You will see some general info, most of which is useless. Click Debug with Native Only link in the top-right corner.

[[File:crashdump_2_pdb.png|border|700px]]

Most likely you will see this screen about missing PDB. Click on Browse and find xxx.pdb... link. Find the directory where the PDB file is located.

Visual Studio will accept debug symbols immediately when you open the directory containing them. Make sure the PDB files are unpacked.

[[File:crashdump_3_result.png|border|700px]]

Now you should see where execution stopped, probably exception code also, You can navigate readable call stack, inspect global and local variables.

Everything you can normally do in Visual Studio when program is paused, you can also do with memory dump.

Happy debugging!

=== Linux core dumps ===

In case of Linux core dump, the initial steps are mostly the same:
# Learn the exact version of TDM.
# Get the source code of this version.
# Get debug symbols for this version (named like <tt>thedarkmod.x64.debug</tt>).
# Also obtain TDM executable of this version (e.g. <tt>thedarkmod.x64</tt>).

Put core dump, executable, debug symbols into current directory, then:
# Run gdb (without any program).
# Execute (within gdb): <tt>file thedarkmod.x64</tt>
# Make sure gdb reads debug symbols successfully.
# Load core dump like this: <tt>core core.27372</tt>
# Now you are ready to see stacktrace: <tt>bt</tt>

Here is how it looks in action:

[[File:Coredump 3 analyze.png|border|1000px]]

You might also need to set source code path if gdb cannot display the source code.
I suppose it is done using <tt>directory</tt> command... (can't test right now).

===== System libraries issue =====

In order to display stacktrace, GDB starts at the current stack position and moves towards less nested functions calls.
To achieve it, it needs to somehow detect a chunk of stack which corresponds to the current function call.

Under normal circumstances, it is done using the standard structure of "frame pointers".
But unfortunately, binaries in modern Linux distros are often built with "omit frame pointers" flag, because this way they run a tiny little bit faster.
An alternative way to stack unwinding is to use debug information, which is usually preserved in some capacity even for the system binaries deployed to our machines.
In case of TDM engine it resides in a separate file, but system libraries usually contain debug info within itself.

When you analyze a core dump, it might happen that you don't see a complete backtrace, because GDB can't unwind beyond a function from some system library (usually libc or libpthread).
In order to unwind through such a library, you need to obtain its binary, exactly as it was on the machine when/where the core dump was recorded.
Note that your local binary most likely has different version and does not match!
And the core dump does not contain this info either, so you need to ask these binaries from the person who provided the core dump.

Unfortunately, loading these extra libraries into GDB is very painful!
Here is a list of GDB commands which I used the only time I had to do it:

# note: all the .so files obtained from user machine must be put into local directory.
#
# most importantly, the following files are necessary:
# 1. libthread_db.so.1 and libpthread.so.0: required for thread debugging.
# 2. other .so files are required if they occur in call stack.
#
# these files must also be renamed exactly as the symlinks
# i.e. libpthread-2.28.so should be renamed to libpthread.so.0

# load executable file
file ./thedarkmod.x64

# force gdb to forget about local system!
# load all .so files using local directory as root
set sysroot .

# drop dump-recorded paths to .so files
# i.e. load ./libpthread.so.0 instead of ./lib/x86_64-linux-gnu/libpthread.so.0
set solib-search-path .
# disable damn security protection
set auto-load safe-path /

# load core dump file
core core.6487

# print stacktrace
bt

You can see more information about that painful experience in the [https://forums.thedarkmod.com/index.php?/topic/21060-mission-downloader-issue/page/2/#findComment-465439 forum thread Mission downloader issue].

[[Category:Coding]]

Analyze a Memory Dump

2025-04-12T00:44:03Z

Stgatilov: Added a section about analysing Linux core dumps

You received a crash dump and don't know how to analyze it?
That's not a big deal, really.
Don't get scared by numerous references to WinDbg and CDB in relation to memory dumps!
You can open dumps directly in Visual Studio debugger.

Before starting, you might want to read [https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/user-mode-dump-files Microsoft docs about memory dumps], so that understand what it is and what is included.

===== Learn version =====
First of all, you need to know which exact version of program the memory dump was obtained from. You should learn the exact state of source code, and build platform + configuration.

Here are some options:
* TheDarkMod final release: ask the TDM version, like 2.07.
* TheDarkMod beta release: ask when player has updated TDM last time. Or ask him to attach console dump. Or ask him to open game console and look at the revision number there.
* TheDarkMod developer build: ask developer about source code revision, platform and configuration.

Bitness is not important: you will know it immediately when you open the dump.

===== Get source code =====
Get the matching version of source code. In the case of TDM game or updater, you most likely need to switch to specific revision on the release branch/tag.

===== Get debug symbols =====
This is the hardest part: you need the debug symbols (i.e. the PDB files) for the binaries from which the memory dump was saved.

Every PDB and DMP file contains checksum of executable, and normally you cannot use PDB for memory dump if the checksums don't match, just like you cannot use a PDB to debug a program if it does not match. Merely rebuilding the project is enough to break PDB compatibility.

Here are some options:
* TheDarkMod final release: find PDBs in <tt>devel/release/debugging/X.YZ/</tt> in assets SVN, and unpack them.
* TheDarkMod beta release: ask release manager to upload PDBs somewhere (he usually saves them).
* TheDarkMod developer build: ask developer to upload the matching PDB.

If you cannot get the original PDB but have the original executable, then you can also try to force-load freshly built PDBs. Here are the steps:
# Get exactly matching source code, compiler, target, configuration, whatever else.
# Build new binaries (fresh rebuild advised).
# Find the created PDB files and use [http://www.debuginfo.com/tools/chkmatch.html chkmatch -m] to substitute checksum inside PDB.

Of course, using mismatched PDB can lead to all sort of issues during debugging.

=== Action ===

Open the solution in Visual Studio (instructions written against VS2017).

In menu: "File -> Open -> File...". Choose the memory dump file.

[[File:crashdump_1_open.png|border|700px]]

You will see some general info, most of which is useless. Click Debug with Native Only link in the top-right corner.

[[File:crashdump_2_pdb.png|border|700px]]

Most likely you will see this screen about missing PDB. Click on Browse and find xxx.pdb... link. Find the directory where the PDB file is located.

Visual Studio will accept debug symbols immediately when you open the directory containing them. Make sure the PDB files are unpacked.

[[File:crashdump_3_result.png|border|700px]]

Now you should see where execution stopped, probably exception code also, You can navigate readable call stack, inspect global and local variables.

Everything you can normally do in Visual Studio when program is paused, you can also do with memory dump.

Happy debugging!

=== Linux core dumps ===

In case of Linux core dump, the initial steps are mostly the same:
# Learn the exact version of TDM.
# Get the source code of this version.
# Get debug symbols for this version (named like <tt>thedarkmod.x64.debug</tt>).
# Also obtain TDM executable of this version (e.g. <tt>thedarkmod.x64</tt>).

Put core dump, executable, debug symbols into current directory, then:
# Run gdb (without any program).
# Execute (within gdb): <tt>file thedarkmod.x64</tt>
# Make sure gdb reads debug symbols successfully.
# Load core dump like this: <tt>core core.27372</tt>
# Now you are ready to see stacktrace: <tt>bt</tt>

Here is how it looks in action:

[[File:Coredump 3 analyze.png|border|1000px]]

You might also need to set source code path if gdb cannot display the source code.
I suppose it is done using <tt>directory</tt> command... (can't test right now).

===== System libraries issue =====

In order to display stacktrace, GDB starts at the current stack position and moves towards less nested functions calls.
To achieve it, it needs to somehow detect a chunk of stack which corresponds to the current function call.

Under normal circumstances, it is done using the standard structure of "frame pointers".
But unfortunately, binaries in modern Linux distros are often built with "omit frame pointers" flag, because this way they run a tiny little bit faster.
An alternative way to stack unwinding is to use debug information, which is usually preserved in some capacity even for the system binaries deployed to our machines.
In case of TDM engine it resides in a separate file, but system libraries usually contain debug info within itself.

When you analyze a core dump, it might happen that you don't see a complete backtrace, because GDB can't unwind beyond a function from some system library (usually libc or libpthread).
In order to unwind through such a library, you need to obtain its binary, exactly as it was on the machine when/where the core dump was recorded.
Note that your local binary most likely has different version and does not match!
And the core dump does not contain this info either, so you need to ask these binaries from the person who provided the core dump.

Unfortunately, loading these extra libraries into GDB is very painful!
Here is a list of GDB commands which I used the only time I had to do it:

# note: all the .so files obtained from user machine must be put into local directory.
#
# most importantly, the following files are necessary:
# 1. libthread_db.so.1 and libpthread.so.0: required for thread debugging.
# 2. other .so files are required if they occur in call stack.
#
# these files must also be renamed exactly as the symlinks
# i.e. libpthread-2.28.so should be renamed to libpthread.so.0

# load executable file
file ./thedarkmod.x64

# force gdb to forget about local system!
# load all .so files using local directory as root
set sysroot .

# drop dump-recorded paths to .so files
# i.e. load ./libpthread.so.0 instead of ./lib/x86_64-linux-gnu/libpthread.so.0
set solib-search-path .
# disable damn security protection
set auto-load safe-path /

# load core dump file
core core.6487

# print stacktrace
bt

You can see more information about that painful experience in the [https://forums.thedarkmod.com/index.php?/topic/21060-mission-downloader-issue/page/2/#findComment-465439 forum thread Mission downloader issue].

[[Category:Coding]]

File:Coredump 3 analyze.png

2025-04-12T00:22:20Z

Stgatilov: Stgatilov uploaded a new version of File:Coredump 3 analyze.png

File:Coredump 3 analyze.png

2025-04-12T00:15:52Z

Stgatilov:

Save a Memory Dump for debugging Crashes

2025-04-12T00:00:39Z

Stgatilov: Cleaning the GDB section

DarkRadiant or TheDarkMod crashed? If you don't want that to happen again, you need to help the team to debug this malfunction 
You can do this by dumping process memory to a file, which can then be used by developers to debug and inspect the application's state at the point in time it crashed.

If a crash is reproducible, it might be enough to describe the exact steps that lead up to the fault and file a bug report on the [http://bugs.thedarkmod.com bugtracker]. 
But more often than sometimes crashes occur out of seemingly nothing and are barely reproducible, and in this case a saved memory dump is even more valuable for debugging purposes.

In principle, recording memory dumps is not limited to crashed applications. 
It is possible to record memory dump of alive process, although in most cases such dump would be useless. 

= Windows =

== Enable Memory Dumps ==
When application crashes, it usually shows a dialog like this:

[[File:Dr has stopped working.png]]
 
If you don't get that window showing up for you, please check the WER flag in registry editor:
* Run the Registry Editor
* Find path: <tt>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting</tt>
* Create <tt>DWORD</tt> (32bit) key with name <tt>DontShowUI</tt> and value <tt>0</tt>

See alternative method here: https://superuser.com/a/1349113

== Record Memory Dumps ==

# When the dialog appears, keep that window open, '''don't close that dialog''', instead open your Task Manager. To open the Task Manager, press Ctrl + Shift + Escape. Another way is to hit Windows + R and type "taskmgr" and click OK.
# In the Task Manager, switch to the Processes tab and locate the program which crashed (DarkRadiant.exe, TheDarkModx64.exe or tdm_installer.exe). It should be in that list since you still have the "XXX has stopped working" dialog open in the background.
# Now right-click the line with the name of the crashed program and select "Create dump file":
# It will work a bit and then show you something like this: "The file has been sucessfully created. The file is located at: location"
# Open Windows Explorer and head to the location indicated in the dialog. Note that you can mark and copy the location from that dialog using your mouse, so you don't have to type it in entirely.
 
[[File:Dr process in task manager.png]]
 
[[File:Dr process create dump.png]]
 
[[File:Dr dump created.png]]
 
 

== Compress and upload the dump ==

Depending on what you had opened in DarkRadiant or what FM you loaded in the game itself, the .dmp file might end up very large, 
so it's best to compress it by right-clicking it and selecting "Send to..." > "Compressed (zip) folder". (Or use 7-zip to compress the file) 
Upload that folder to some place in the web, and please go to the forums to tell the devs about your crash dump.
 
'''Thanks for your time''', we know that recording and uploading crash dumps might be tedious, but without we really can't do much about the crash, so your help is appreciated!

== Debugging / Analysis ==
Coders might want to check out the article on [[Analyze_a_Memory_Dump|analyzing a memory dump.]]

== Record Memory Dumps automatically (alternative approach) ==

When the "darkradiant has stopped working" popup doesnt appear, when the program crashes, 
then is possible to enable automatic saving of crash dumps, 
This way is not recommended since it is more complicated to setup. 
It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].

# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
# A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
# Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_SZ /v "DumpFolder" /d "c:\temp\CrashDumps"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpCount" /d "0x1"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpType" /d "0x2"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "CustomDumpFlags" /d "0"</tt>
# <tt>net start WerSvc</tt> (if there is a windows service named "Windows Error Reporting Service")
# Close the console, you don't need it anymore.
 
Now you can run TDM as usual (run executable TheDarkModx64.exe). 
If it crashes, a dump will be recorded and saved at <tt>C:\temp\CrashDumps</tt>. 
 
After this you need to disable automatic saving of memory dumps for TheDarkModx64.exe:
# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
# A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
# Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
# <tt>reg delete "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe"</tt>
 
Alternatively, you can add/remove registry keys directly in Registry Editor if you like.
In this case, restart Windows instead of starting WerSvc service. 

= Linux =

== Record with GDB ==

Make sure GDB is installed. Usually it is installed by default.

[[File:Coredump-_start_gdb.png|thumb]]
[[File:Coredump-_save_core_dump.png|thumb]]

# Run the game under GDB: <tt>gdb ./thedarkmod.x64</tt>
# Within GDB, type <tt>run</tt> and hit Enter to start the program.
# When the game crashes, gdb will most likely break.
# Record core dump with a command: <tt>generate-core-file</tt>
# The dump should be in the current directory, usually named like <tt>core.27372</tt>.

Note that core dumps are pretty large, but they compress well.
Make sure to put it into zip/gz/whatever before uploading.

Unfortunately, sometimes core dump alone is not enough to inspect the crash on the other machine.
A developer might need some system binaries in order to properly decipher stack trace.
The following libraries are known to be necessary sometimes:
* <tt>libc</tt>
* <tt>libpthread</tt>
* <tt>libthread_db</tt>

These files are usually named something like <tt>libpthread-2.26.so</tt>, <tt>libc-2.26.so</tt>, <tt>libthread_db.so.1</tt> and are located in <tt>/lib/x86_64-linux-gnu</tt>.
Beware of symlinks! The developer needs the target file with real contents.

See also: [https://forums.thedarkmod.com/index.php?/topic/21060-mission-downloader-issue "Mission downloader issue" on the forum]

[[Category:DarkRadiant]]
[[Category:Coding]]

Save a Memory Dump for debugging Crashes

2025-04-11T19:32:42Z

Stgatilov: More info about Linux core dumps.

DarkRadiant or TheDarkMod crashed? If you don't want that to happen again, you need to help the team to debug this malfunction 
You can do this by dumping process memory to a file, which can then be used by developers to debug and inspect the application's state at the point in time it crashed.

If a crash is reproducible, it might be enough to describe the exact steps that lead up to the fault and file a bug report on the [http://bugs.thedarkmod.com bugtracker]. 
But more often than sometimes crashes occur out of seemingly nothing and are barely reproducible, and in this case a saved memory dump is even more valuable for debugging purposes.

In principle, recording memory dumps is not limited to crashed applications. 
It is possible to record memory dump of alive process, although in most cases such dump would be useless. 

= Windows =

== Enable Memory Dumps ==
When application crashes, it usually shows a dialog like this:

[[File:Dr has stopped working.png]]
 
If you don't get that window showing up for you, please check the WER flag in registry editor:
* Run the Registry Editor
* Find path: <tt>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting</tt>
* Create <tt>DWORD</tt> (32bit) key with name <tt>DontShowUI</tt> and value <tt>0</tt>

See alternative method here: https://superuser.com/a/1349113

== Record Memory Dumps ==

# When the dialog appears, keep that window open, '''don't close that dialog''', instead open your Task Manager. To open the Task Manager, press Ctrl + Shift + Escape. Another way is to hit Windows + R and type "taskmgr" and click OK.
# In the Task Manager, switch to the Processes tab and locate the program which crashed (DarkRadiant.exe, TheDarkModx64.exe or tdm_installer.exe). It should be in that list since you still have the "XXX has stopped working" dialog open in the background.
# Now right-click the line with the name of the crashed program and select "Create dump file":
# It will work a bit and then show you something like this: "The file has been sucessfully created. The file is located at: location"
# Open Windows Explorer and head to the location indicated in the dialog. Note that you can mark and copy the location from that dialog using your mouse, so you don't have to type it in entirely.
 
[[File:Dr process in task manager.png]]
 
[[File:Dr process create dump.png]]
 
[[File:Dr dump created.png]]
 
 

== Compress and upload the dump ==

Depending on what you had opened in DarkRadiant or what FM you loaded in the game itself, the .dmp file might end up very large, 
so it's best to compress it by right-clicking it and selecting "Send to..." > "Compressed (zip) folder". (Or use 7-zip to compress the file) 
Upload that folder to some place in the web, and please go to the forums to tell the devs about your crash dump.
 
'''Thanks for your time''', we know that recording and uploading crash dumps might be tedious, but without we really can't do much about the crash, so your help is appreciated!

== Debugging / Analysis ==
Coders might want to check out the article on [[Analyze_a_Memory_Dump|analyzing a memory dump.]]

== Record Memory Dumps automatically (alternative approach) ==

When the "darkradiant has stopped working" popup doesnt appear, when the program crashes, 
then is possible to enable automatic saving of crash dumps, 
This way is not recommended since it is more complicated to setup. 
It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].

# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
# A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
# Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_SZ /v "DumpFolder" /d "c:\temp\CrashDumps"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpCount" /d "0x1"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpType" /d "0x2"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "CustomDumpFlags" /d "0"</tt>
# <tt>net start WerSvc</tt> (if there is a windows service named "Windows Error Reporting Service")
# Close the console, you don't need it anymore.
 
Now you can run TDM as usual (run executable TheDarkModx64.exe). 
If it crashes, a dump will be recorded and saved at <tt>C:\temp\CrashDumps</tt>. 
 
After this you need to disable automatic saving of memory dumps for TheDarkModx64.exe:
# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
# A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
# Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
# <tt>reg delete "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe"</tt>
 
Alternatively, you can add/remove registry keys directly in Registry Editor if you like.
In this case, restart Windows instead of starting WerSvc service. 

= Linux =

== Record with GDB ==

Make sure GDB is installed. Usually it is installed by default.

[[File:Coredump-_start_gdb.png|thumb]]
[[File:Coredump-_save_core_dump.png|thumb]]

# Run the game under GDB: <tt>gdb ./thedarkmod.x64</tt>
# Within GDB, type <tt>run</tt> and hit Enter to start the program.
# When the game crashes, gdb will most likely break.
# Record core dump with a command: <tt>generate-core-file</tt>
# The dump should be in the current directory, usually named like <tt>core.27372</tt>.

Note that core dumps are pretty large, but they compress well.
Make sure to put it into zip/gz/whatever before uploading.

Unfortunately, sometimes core dump alone is not enough to inspect the crash on the other machine.
Sometimes the system binaries are also necessary to properly decipher stack trace.
The following libraries are necessary sometimes:
* <tt>libc</tt>
* <tt>libpthread</tt>
* <tt>libthread_db</tt>

These files can be named something like <tt>libthread_db.so.1</tt>, <tt>libc.so.6</tt>, <tt>libc-2.26.so</tt> and be located in <tt>/lib/x86_64-linux-gnu</tt>
Before of symlinks! The developer needs the target file with real contents.

See also: [https://forums.thedarkmod.com/index.php?/topic/21060-mission-downloader-issue "Mission downloader issue" on the forum].

[[Category:DarkRadiant]]
[[Category:Coding]]

File:Coredump- save core dump.png

2025-04-11T19:19:34Z

Stgatilov:

TDM switches to gdb on crash, and we can record core dump.

File:Coredump- start gdb.png

2025-04-11T19:18:30Z

Stgatilov:

Example of starting TDM under gdb.

Save a Memory Dump for debugging Crashes

2025-04-11T08:18:59Z

Stgatilov:

DarkRadiant or TheDarkMod crashed? If you don't want that to happen again, you need to help the team to debug this malfunction 
You can do this by dumping process memory to a file, which can then be used by developers to debug and inspect the application's state at the point in time it crashed.

If a crash is reproducible, it might be enough to describe the exact steps that lead up to the fault and file a bug report on the [http://bugs.thedarkmod.com bugtracker]. 
But more often than sometimes crashes occur out of seemingly nothing and are barely reproducible, and in this case a saved memory dump is even more valuable for debugging purposes.

In principle, recording memory dumps is not limited to crashed applications. 
It is possible to record memory dump of alive process, although in most cases such dump would be useless. 

= Windows =

== Enable Memory Dumps ==
When application crashes, it usually shows a dialog like this:

[[File:Dr has stopped working.png]]
 
If you don't get that window showing up for you, please check the WER flag in registry editor:
* Run the Registry Editor
* Find path: <tt>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting</tt>
* Create <tt>DWORD</tt> (32bit) key with name <tt>DontShowUI</tt> and value <tt>0</tt>

See alternative method here: https://superuser.com/a/1349113

== Record Memory Dumps ==

# When the dialog appears, keep that window open, '''don't close that dialog''', instead open your Task Manager. To open the Task Manager, press Ctrl + Shift + Escape. Another way is to hit Windows + R and type "taskmgr" and click OK.
# In the Task Manager, switch to the Processes tab and locate the program which crashed (DarkRadiant.exe, TheDarkModx64.exe or tdm_installer.exe). It should be in that list since you still have the "XXX has stopped working" dialog open in the background.
# Now right-click the line with the name of the crashed program and select "Create dump file":
# It will work a bit and then show you something like this: "The file has been sucessfully created. The file is located at: location"
# Open Windows Explorer and head to the location indicated in the dialog. Note that you can mark and copy the location from that dialog using your mouse, so you don't have to type it in entirely.
 
[[File:Dr process in task manager.png]]
 
[[File:Dr process create dump.png]]
 
[[File:Dr dump created.png]]
 
 

== Compress and upload the dump ==

Depending on what you had opened in DarkRadiant or what FM you loaded in the game itself, the .dmp file might end up very large, 
so it's best to compress it by right-clicking it and selecting "Send to..." > "Compressed (zip) folder". (Or use 7-zip to compress the file) 
Upload that folder to some place in the web, and please go to the forums to tell the devs about your crash dump.
 
'''Thanks for your time''', we know that recording and uploading crash dumps might be tedious, but without we really can't do much about the crash, so your help is appreciated!

== Debugging / Analysis ==
Coders might want to check out the article on [[Analyze_a_Memory_Dump|analyzing a memory dump.]]

== Record Memory Dumps automatically (alternative approach) ==

When the "darkradiant has stopped working" popup doesnt appear, when the program crashes, 
then is possible to enable automatic saving of crash dumps, 
This way is not recommended since it is more complicated to setup. 
It is also described in [https://docs.microsoft.com/en-us/windows/win32/wer/collecting-user-mode-dumps Windows User-Mode Dumps].

# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
# A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
# Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_SZ /v "DumpFolder" /d "c:\temp\CrashDumps"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpCount" /d "0x1"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "DumpType" /d "0x2"</tt>
# <tt>reg add "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe" /t REG_DWORD /v "CustomDumpFlags" /d "0"</tt>
# <tt>net start WerSvc</tt> (if there is a windows service named "Windows Error Reporting Service")
# Close the console, you don't need it anymore.
 
Now you can run TDM as usual (run executable TheDarkModx64.exe). 
If it crashes, a dump will be recorded and saved at <tt>C:\temp\CrashDumps</tt>. 
 
After this you need to disable automatic saving of memory dumps for TheDarkModx64.exe:
# Press Windows-key + R, type in "cmd", and press Ctrl+Shift+Enter to run it with admin rights.
# A black window of console will appear. Check the title bar and make sure it is running with administrator rights.
# Execute the following commands in the console (copy/paste them with Ctrl+C / Ctrl+V):
# <tt>reg delete "HKLM\SOFTWARE\Microsoft\Windows\Windows Error Reporting\LocalDumps\TheDarkModx64.exe"</tt>
 
Alternatively, you can add/remove registry keys directly in Registry Editor if you like.
In this case, restart Windows instead of starting WerSvc service. 

= Linux =

== Record with GDB ==

Make sure GDB is installed. Usually it is installed by default.

# Run the game under GDB: <tt>gdb ./thedarkmod.x64</tt>
# Within GDB, type <tt>run</tt> and hit Enter to start the program.
# When the game crashes, gdb will most likely break.
# Record core dump with a command: <tt>generate-core-file</tt>
# TODO: where is the dump?

TODO: issues with system libraries

TODO: references

[[Category:DarkRadiant]]
[[Category:Coding]]

What's new in TDM 2.13

2025-03-24T09:47:08Z

Stgatilov: Tonemapping changes were reverted at the start of beta phase.

{{released|2.13|2025-03-23}}
See the [https://bugs.thedarkmod.com/changelog_page.php?version_id=111 changelog] on our bugtracker.
Source Revision 10946

 
'''The Dark Mod 2.13 Enhanced AI and GUI Edition!'''
 


 
A major focus for The Dark Mod 2.13 development cycle was improving how AI see bodies, loot, and other non-player objects.
 While our lightgem system is possibly one of the most effective ways to calculate player visibility, it would not be practical
 to give all in-game objects, ragdolls, etc their own lightgem calculations. As such, we have historically used a simplified and less
 accurate design to determine visibility of non-player items. With 2.13 we reach near parity to the accuracy of the lightgem due to
 an improved stochastic sampling system for all objects that an AI can possibly see. ( Thanks stgatilov )
 
 Now that the AI are more perceptive, why not dull them down again? That is exactly what Amadeus decided and he worked tirelessly on figuring
 how to make the "drunken" AI work more reliably and easier to implement for mission authors. Now we have both more and less perceptive AI!
 
 The long requested Parallax Map feature is now available in TDM! While it was possible to offer this before Doom 3 source was released,
 it is quite an expensive effect. With POM integrated into TDM it is now optimized enough for production use. WellingtonCrab has already
 created a large set of POM textures ready for inclusion in TDM 2.13 missions!
 
 Finally, the TDM community restarted it's perennial debate about how mission names should be displayed and sorted in the mission list.
 Previously, there was a compromise where the missions would display naturally but would be sorted ignoring "the" and "a" in the title.
 This was the status quo for quite some time but players have emerged to request that we revert to "Mission Name, The" in the GUI.
 Daft Mugi solved this by creating a toggle that allows either sorting style. He also made the whole debate pretty much moot by implementing
 a search window so you can easily find the desired mission by typing all or part of it's name! Mission management is has never been smoother!
 

'''See our [https://forums.thedarkmod.com/index.php?/topic/22641-213-feature-discussion-threads/ Feature Discuss Threads] for more details about substantial changes.'''



----
 

== '''Important CVARS''' ==

=== PLAYER ===
 

g_lightQuotientAlgo 0 ( revert to the old AI vision system )

g_showLightQuotient and g_les* --- can be used for debugging of the new system.

{{clear}}

=== TROUBLESHOOTING ===
 

jobs_numThreadsRealtime 2 ( force 2 threads )

r_subviewMaxDepth 1 ( no subview recursion )

r_skipParallax 1 ( disable POM effect )

r_envmapBumpyBehavior 0 ( revert to old environment map behavior )

s_overrideParmsMode --- selects the behavior of zero value in sound emitter parameters (0 for the old behavior, 1 for the new one).

r_materialNewParse --- how are material stages grouped into interaction groups (0 for the old behavior, 1 for the new one).

s_levelLoadParallel 0 --- disables parallel loading of sound samples.

image_downSizeAll 0 --- Applies to all texture types ( diffuse, bump, specular ). 0 = Full texture quality, anything above 0 counts as the texture dimensions ( eg. 256 = 256-by-256 )

{{clear}}
 

== '''Graphics''' ==

* Parallax Occlusion Mapping support ( See [https://forums.thedarkmod.com/index.php?/topic/22574-experimental-support-of-parallax-mapping-in-213/ thread] )
* Environment mapped textures with bumpmaps now properly respond to stage keywords ( See [https://forums.thedarkmod.com/index.php?/topic/22402-213-environment-mapping-bumpmap/ thread] )
* Nested subviews (mirrors, remotes, sky, etc.) now work properly (6434).
* Fixed rendering of volumetric light and particles in X-ray views and mirrors (6538).
* Shadow Map specific features are enabled by default in "Maps" mode ( alpha tested shadows, etc)
* Minor change in shadow map acne / blur radius computation (6571).
* Refactored the "HeatHaze" shaders so that one shader can produce multiple variations via parameters
* Disabled texture compression for light images: falloff and IBL cubemaps.
* Fixed light culling bug on elongated models with non-identity rotation (6557).
{{clear}}
 

== '''AI''' ==

* AI now have a more accurate vision system ( see [https://forums.thedarkmod.com/index.php?/topic/22639-213-ai-vision-uses-different-light-estimate-system/ thread] )
* Major improvements in drunk AIs: setting "drunk" spawnarg is enough now; new sounds, animation improvements, greetings, etc. (6507).
* Fixed drunk women AI (5047).

{{clear}}
 

== '''Mapping''' ==

* Added improved editor images for textures/darkmod/metal/detailed materials (6575)
* Added editor spawnarg for "parallelsky" (6496)
* Added "particle collision-ready" weather materials (6545)
* Added min/max builtin functions to game scripts.
* Added script events about gravity, health, in-air movement.
* Added script events setUserBy, setFrobActionScript.
* Added "distance_follower_reached", "distance_follower_catchup_distance" and "distance_follower_stop_running" spawnargs allowing mappers to customize AI follower distances (6552)
* Added "def_vocal_set_drunk" spawnarg to allow mappers to specify which drunk vocal set an AI should use (6507).
* Added "idle_bark_interval_max_drunk" "idle_bark_interval_min_drunk" spawnargs allowing mappers to customize drunk bark intervals (6507).
* Added "snd_greeting_generic_drunk" spawnarg for drunk AI (6507)
* Added cm_allocator debug cvar (6505).
* Added r_lockView debug rendering cvar ( [https://forums.thedarkmod.com/index.php?/topic/22388-r_lockview-debug-cvar/ thread] ).
* Added proper dmap error message if map file contains an entity before worldspawn.
* Fixed dmap making almost axis-aligned visportals buggy (6480)

{{clear}}

== '''Coding''' ==

* Auto-detect number of parallel threads to use in jobs system (6503)
* Vsync now properly works on Linux
* FPS limit code has been improved
* Level loading is further accelerated with better utilization of multicore CPUs and parallel loading of sound samples.
* CVAR system has been made fully thread safe
* Missions can now safely override CVAR values via config or script operations
* The system for third-party dependencies has been moved to Conan 2 and extended. Now the CI server regularly builds TDM and its dependencies completely from source code.
* Deleted a lot of old rendering code under useNewRenderPasses + some cleanup (6271).
* Core missions are now stored uncompressed in assets SVN (6498).
* Optimization: don't render interaction groups with black diffuse & specular.
{{clear}}
 

== '''Assets''' ==

* Added several parallax materials, as well as their non-parallax equivalents
* Added 17 modular industrial pipe models from Polyhaven
* Added combined lampion light entity
* Added several factory_machines models (6537)
* Added textures/darkmod/decals/distant_cityscape_01_tiling material (6487)
* Added missing normalmap to stainglass_saint_03 (6521)
* Added missing textures for rough_boards_scratched material (4157)
* Added [[Creating_textures_from_Ornate_Photos|ornate]] wood/panels/mary_panel texture
* Added [[Creating_textures_from_Ornate_Photos|ornate]] stone/sculpted/girard_relief texture
* Added colored versions of gen3 environment cubemaps for metallic materials.
* Added new environment cubemaps: sparkles, studio, blurry.
* Added skybox materials clouds3 and clouds_4_small + prefabs.
* Added new smoking animation.
* Added praying animation.
* Fixed several issues with largesquare01 window textures (6579)
* Fixed broken material for stove_open02.lwo (6580)
* Fixed floating decals for ext_timber01_window01.lwo (5782)
* Fixed gaps in mesh and UV for generator_big.lwo and warehouse_front_doorframe.lwo (6581)
* Fixed broken UV for longbanner_ragged.lwo (6573)
* Fixed issues with newspaper01.lwo (6568)
* Fixed normal map of ornament_relief_mold_eaglelshield (6585).
* Fixed handle_curved02_latch prefab, deleted pull_handle (6286).
* Improved "scepter" material ( [https://forums.thedarkmod.com/index.php?/topic/22586-better-looking-metals-in-darkmod/page/4/#comment-498297 thread] ).

{{clear}}
 

== '''Gameplay and Interaction''' ==

* Updated Training Mission with Vine Arrow tutorial, graphics enhancements, and EFX Reverb
* Added entityDef archery_target01 with hit detection, it is now used in Training Mission.
* Added gas mine playertool
* Added slowfall potion
* Added invisibility potion by Kingsal
* Fixed frob interaction with candle holder that's initially extinguished (6577).
* Improved lightgem calculations while leaning ( [https://forums.thedarkmod.com/index.php?/topic/22587-bug-lean-light-calculation/#comment-498247 post] ).

{{clear}}
 

== '''GUIs''' ==

* Massive improvements in mission select & download menus, added search (6339 6570 6449).
* Loading progress bar has been re-implemented to reflect all the loading optimizations of the past years.
* Mission Notes ( readme data ) can now be scrolled
* Mission Debriefing feature ( See [https://forums.thedarkmod.com/index.php?/topic/21831-support-for-gui-based-debrief/ thread] )
* Stone font improvements, in spacing, stray mark elimination, and character set coverage
* Toughest-to-read characters in FM fonts Medusa, Treasure Map, Camberic improved
* Reduced font size of mission list, which allows to see more missions and longer names
* Texture Quality option for lowend players
* Added menu options to disable volumetric lights and parallax mapping.
* Added TDM version + engine revision in lower-left corner of main menu.
* Increased size of secret message overlay GUI.
* Fixed map immobilization not applied if opening map with inv use key.
* Forbid adding missions to download when download is in progress (6368).
* Changed install/uninstall mission to select/deselect in main menu.

{{clear}}
 

== '''Sound''' ==

* EFX reverb presets can now be set on location entities using the '''efx_preset''' spawnarg, rather than requiring an .efx file (6273).
* Fixed sleeping sounds for drunk AIs (6539), and other sounds for them too (6507).
* Added improved footstep sounds for broken glass and ice material surfaces (6551).
* Fixed water_medium_running soundshader (5384)
* Subtitles volume estimation is much better now, subtitles for too quiet sounds are no longer shown.
* Visual appearance of the subtitles font has been greatly improved.
* Added two drunk AI vocalsets voiced by Goldwell and Bikerdude: Drunk Moor and Drunk Jack

{{clear}}
 

== '''Translation''' ==

* Nolok added his Catalan translation to the menus

{{whatsnew|sort=213}}

File formats

2025-01-06T21:13:40Z

Stgatilov: Out of compressed texture formats we support, only DXT3 supports transparency well enough

A list of file formats usable in TDM:

== Models ==

=== LWO ===

* somewhat default
* small uncompressed size since it is binary
* loading code can be slow and (some people have reported) it can sometimes break your model (smoothing groups might be a pain)

=== ASE ===

* somewhat default
* larger uncompressed size since it is text
* loading code can be slow and (some people have reported) it can sometimes break your model (smoothing groups might be a pain)

=== OBJ ===

* the only format added specifically for TDM, so not very widespread
* uncompressed size is large because it is text (compressed size is smaller than ASE and LWO formats)
* loading is very fast and does not "fix"/break your model, you'll get exactly the topology & smoothing you exported

== Ragdolls ==

The only format is '''.af''' text format, which is handmade for Doom 3.
No changes here since Doom 3.

It is notoriously hard to create/edit.
The only tool is the Windows-only builtin command editAFs, and this is the only in-game editor which has no outside alternatives. We wanted to port it to either DarkRadiant or at least better GUI framework, but it did not happen (yet).

== Animation ==

=== MD5 ===
* md5mesh --- Doom 3 custom text format which represents a mesh attached to skeleton (joints, weights, etc.)
* md5anim --- custom text format that represents an animation of a skeleton.



=== MD3 ===
This is Doom 3 custom text format which represents linear vertex morphing. 
It is rarely used, but it is a perfect fit in case animation is clearly not "skeletal" (e.g. animated grass or water).



=== Others ===
* Some hardcoded pieces of code which transform a mesh into something else, that are enabled via "deform" keyword in a material. The most known example is particles. All of this is very specific and uses custom formats.
* Maya ascii format (.ma, mb), currently no further known info on it.
* OpenFlight model (.flt), currently no further known info on it.

== Video ==

* The mainstream format is mp4 + h264 + aac for FMV.
* There is also still legacy support for ROQ which is an old format used in Doom 3.
I think all the other formats are disabled in the FFmpeg build that we use.

=== In-game videos ===
One specific case is animated textures (e.g. water), and they are usually implemented as a pack of copy/pasted if-s in a material file, which point to different frame images. Something like "Motion JPEG/TGA/PNG/DDS" 😃 Maybe one day we will make this approach easier to use...

== Textures and images ==

(Images inside guis (briefing, readables) use the same material loading system, so they should support all the same image formats.)

=== TGA ===
The simplest uncompressed format, basically default in case compression is not used.
* Supports transparency.

=== PNG ===
* Lossless compression, but pretty slow to load.
* Supports transparency.
* Should therefore be OK for some GUI images for example, but not used on a large scale.

=== JPG ===
Lossy format, pretty small and rather fast to load.
* '''Does not''' supports transparency.
I think it is usually used for screenshots and maybe GUI images, otherwise not popular.

=== DDS ===
This is container which can in principle store both compressed and uncompressed data, but I think we use it only for precompressed textures. TDM supports DXT1, DXT3, DXT5, RGTC compressed formats (each of these formats has a bunch of pseudonymes).
DXT3 supports transparency.

If you use compressed DDS, then you can be sure it will be displayed as is, as no further processing it applied to it. Sometimes it is good, sometimes it is bad.
The engine has fast compressor/decompressed for all texture compression formats, so if you supply TGAs and they are compressed on load, you only lose in mission size.

== Sound files ==

=== OGG ===
* Relatively widespread open format with lossy compression.
* Default used format
* OGG files are loaded on level start, but decompressed on the fly.

=== WAV ===
* Simple uncompressed sound file.
* Larger than OGG. Potentially higher quality.
* The "shakes" feature of materials specifically asks for WAV.

Briefing

2025-01-06T20:59:37Z

Stgatilov: Controlling Where the Player Starts: renamed gui variable for 2.13

Scribbled by Sotha

==Introduction==
A briefing is a short introduction to your mission to brief the player about what he is supposed to do, and why. It gives purpose and meaning to the formal objectives. It is a very important part of every fan mission, because it tells the player what to expect.

Briefings should:

* introduce any important background information (where am I?)
* introduce any significant characters
* give the character valid motivations (why am I doing this?)
* set the tone of the upcoming mission (spooky, tense, comical, etc)
* give hints about what equipment the player might want to buy, if applicable

Don't underestimate the importance of setting a tone. If you want players to take your mission seriously, DON'T make jokes in the briefing! A poorly edited briefing with spelling errors will set a negative tone...if you're not a native English speaker, have someone else look over your text.

==Which Briefing to Choose?==
Three ways the mapper can implement their briefings are covered here:
*Text-only Briefing
*Button Controlled Animated Briefing
*Timed Flowing Briefing

In addition, [[Video Briefing]] is considered separately.

Mappers can choose any briefing they prefer. Text-only Briefing is the most easy to implement technically, but offers no possibility for images. The briefing is operated by arrows which turn briefing pages. The Timed Flowing Briefing is the most difficult one to implement due to demanding trial and error process to get the timings right. The player cannot control this briefing as it flows like a movie based on timings set by the mapper. This briefing can show beautiful briefing pictures which build up atmosphere. The Button Controlled works between the Text-only Briefing and Timed Flowing Briefing, offering eye candy and easy control. The briefing can show text and images, but is controlled by next/previous page buttons like the Text-only Briefing. No timings need to be set with Button Controlled Animated Briefing.

==Text-only Briefing==
To create a Text-only Briefing for your mission, create a plain text file suffixed .xd (not .txt) and put it in the xdata folder, for example briefing.xd. In the file type your briefing. It must be in the following format in this example:
<mapname> must be replaced with the exact name of your map.

maps/<mapname>/mission_briefing
{
"num_pages": "1"

"page1_body" :
{
" TITLE (if wanted.)"
""
"I got a tip last night from..."
""
"I found a map..."
}

"page2_body" :
{
"extra pages do the same way as page 1 above but then change the value in num_pages above"
}

}

If your page text is too long then it will truncate on the display, so test it out and see if you need to go to multiple pages. If you have multiple pages then up/down scroll arrows will automagically appear.

It doesn't matter which .xd file this xdata entry goes into, as long as the xdata entry's name matches the format specified above ("maps/<mapname>/mission_briefing"). See [[XData File Creation]] for details on .xd files.

==Button Controlled Animated Briefing==
To set up the Button Controlled Animated Briefing, please download this package, which contains basic .gui file and placeholder images which the mapper edits to create their own briefing. You can get the package from

*[https://forums.thedarkmod.com/index.php?/topic/12083-briefing-wiki/#comment-494652 The Dark Mod forum]

Extract the files into your FM folder (ie. doom3/your-near-ready-FM-folder/guis). The "guis"-folder should now contain "mainmenu_briefing.gui"-file and a folder "assets" which contains tga-image files.

Now when you install you mission in TDM and run it, you will see a placeholder briefing. In simplest form, you now need to edit the mainmenu_briefing.gui and replace the tga briefing images.
===Editing mainmenu_briefing.gui for the Button Controlled Briefing===
Add your own briefing text in the section windowDef BriefingText1, etc. Simply replace the text with your own.

By default, this briefing goes to sixth screenful of text. It is possible the mappers briefing requires only four or five pages, so it would look bad if there was an empty page. To shorten the briefing to, for example to the fifth screen (stage), do the following:
Find the previous section to the one you want to be the last. If you want the 5th stage to be the last one, go for stage 4 (find "stage 4" with your text editor search function). Find the "windowDef NextButton4" and prevent the system from revealing the stage 5 nextbutton.
Simply do the following change: set "NextButton5::visible" "1"; -> set "NextButton5::visible" "0";
If you want 3rd screenful to be the last one, find stage 2 and edit Nextbutton2 and prevent it from showing NextButton3.

===Editing the Briefing Images===
Simply replace the /assets/briefingX images with our own images. I recommend that the images are 512x512 resolution, since the briefing shows
all images in 1x1 ratio. It might be a good idea to pack your .tga files into .dds to save disk space, but it is not mandatory. Going DDS provides significant reduction in file size!
Simply convert you .tga:s with The Compressonator or GIMP/photoshop plugins. See [[DDS creation]] for instructions.

You can easily create nice briefing images by building the scene you want to show in the briefing using DR and taking in-game screenshots. Edit your screenshots into a nice 512x512 image. And now comes an important part. See the placeholder briefing again. Look at images 1 and 2. See how image 2 fits better in the scene? Image 1 seems blocky. You can make this nice blending using alpha gradient in your image. Basically you want you image to fade into transparency from the middle. Here is how to do it:

1) get GIMP (a image processor)
2) open your image
3) layer->transparency->add alpha channel
4) Go to Layer>Mask>Add Layer mask
5) when prompted to select a type, select "Layer's Alpha channel"
6) check to make sure you're set to edit the layer mask (it should default to this)
NOTE: What's going on is the "White" of your mask is the "visible", the "black" is the "invisible", and of course the greys are in between.
7) Set your foreground color to White and your Background color to Black.
8) Choose the gradient tool.
9) Set your Gradient to "FG to BG (RGB)"
10) Your White-to-black gradient is now the visible-to-invisible alpha channel gradient. You'll have to work with that to get the effect you desire. It helps if you set the gradient tool shape into radial and then play around with transition. Check the toolbox for these parameters.

==Timed Flowing Briefing==
To set up this kind of briefing, please download this package, which contains basic .gui file and placeholder images which the mapper edits to create their own briefing. You can get the package from

*[https://forums.thedarkmod.com/index.php?/topic/12083-briefing-wiki/#comment-494652 The Dark Mod forum]

Extract the files into your FM folder (ie. doom3/your-near-ready-FM-folder/guis). The "guis"-folder should now contain "mainmenu_briefing.gui"-file and a folder "assets" which contains tga-image files.

Now when you install you mission in TDM and run it, you will see a placeholder briefing. In simplest form, you now need to edit the mainmenu_briefing.gui and replace the tga briefing images.
===Editing mainmenu_briefing.gui for the Timed Flowing Briefing===
Replace "windowDef BriefingText1" -> "windowDef BriefingText5" with your own text.
Find windowDef BriefingAnimation in your .gui file. Under this part there are many entries "onTime X". Basically you need to alter the X in each segments so that your text and images are shown in the order and timings you prefer. X is the time in milliseconds.

===Editing the Briefing Images===
Everything said in the Button Controlled Briefing image editing applies here.

==Advanced Briefing Editing==
It is quite possible you are not happy with the way the images move in both Button Controlled and Timed Flowing Briefings. This section tells you how you change the way images move around the screen.

===Advanced Editing for Button Controlled Briefing===
Briefing text position and other properties can be changed in sections "windowDef BriefingText1" - "WindowDef BriefingText6."

Changing image movements: In your .gui file find the different stages which control the images and text. It is easy to find them by searching the word "stage". Close to this entry there should be commented parts which say "put image x in motion." Near this text there should be something like:
//put image2 in motion
set "BriefingMovingPicture2::rect" "440 -200 400 400";
transition "BriefingMovingPicture2::matcolor" "1 1 1 0" "1 1 1 .4" "4000";
transition "BriefingMovingPicture2::rect" "440 -200 400 400" "5 160 200 200" "27000";
set "BriefingMovingPicture2::visible" "1";

The first part sets the briefing picture 2 in coordinates 440, -200 (x,y) (outside the right boundary of the screen, high) and makes it into size 400x400pixels.
The second part makes the image slowly change transparency towards solid (0.4) during 4000 milliseconds.
The third part puts the image in the same coordinates as in the first part and then moves it towards coordinates (5, 160) and makes it shrink into 200x200 pixels and this all occurs softly during 27000 milliseconds.
The fourth part makes the image visible.

Change all these sections to values you like.

Please note that the first image is put in motion in the section "windowDef BriefingStateInit" section when the briefing is intialized.

===Advanced Editing for Timed Flow Briefing===
Briefing text position and other properties can be changed in sections "windowDef BriefingText1" - "WindowDef BriefingText6."

In the "windowDef BriefingAnimation" change the transition values to your liking. Here's an example.
// Show Picture 1
onTime 1000
{
transition "BriefingMovingPicture1::matcolor" "1 1 1 0" "1 1 1 .4" "4000";
transition "BriefingMovingPicture1::rect" "0 -200 300 300" "430 500 20 20" "27000";
transition "BriefingMovingPicture1::rotate" "5" "-60" "33000";
set "BriefingMovingPicture1::visible" "1";
}

After 1000 milliseconds.
First part tells the image to sink into visibility from alpha 0->0.4 during 4000 milliseconds.
Second part puts the image from coords (0,-200) in size (300x300 pixels) and then moves it to 430,500 and shrinks it into 20x20 pixels during 27000 milliseconds.
Third parts puts the image rotating a bit.

===General Tips for Advanced Briefing Editing===
When playing with transition values, it might be helpful to know that the whole screen is 640x480. Note that the coordinates are always the left top corner of the image. To get a feeling for what coordinates are where on screen: open gimp, create new 640x480 image and draw a box there with the rectangle select tool where you would like to see your images. Pay attention to the location mentioned in the toolbox for the rectangle x,y coords and size. Then enter these values in your gui file and the image should appear at the same area on screen.

==Controlling Where the Player Starts==

{{infobox|text= The "Controlling Where the Player Starts" functionality was broken in TDM 2.10 and 2.11 and was fixed in 2.12, but then changed again in 2.13.
The example gui file was missing, but a new version is made. Documentation currently might be partly outdated. This will be updated at a later stage. }}

Beginning with TDM 1.08, map authors can offer more than one start point to players. This could increase re-playability of a map, allowing the player to replay the map with a different starting point.

This is an extension to the Button-Controlled Menu Briefing, so you should first obtain and install that package (see above) and become familiar with how it works.

===mainmenu_briefing.gui===
Obtain a new version of mainmenu_briefing.gui from this location:
*[https://forums.thedarkmod.com/index.php?/topic/13210-controlling-where-the-player-starts-a-mission/&do=findComment&comment=485997 Forum post with attached file]

This version of mainmenu_briefing.gui adds new definitions to the final briefing screen (screen 6), two for each optional start point.

In the sample gui, you'll see these new definitions:

*windowDef StartPointBox1
*windowDef StartPointBox2
*windowDef StartPointBox3
*windowDef StartPointText1
*windowDef StartPointText2
*windowDef StartPointText3

StartPointTextN defines the starting point text for point N and handles highlighting and mouse events.

StartPointBoxN defines a checkbox to the left of the text describing starting point N.

Though the template provides three starting points, you can change it to offer any number you wish. They don't need to appear on the last briefing screen, either, though you may find that's the most logical place to offer them.

===What the Player Sees===
When the player hovers the mouse over either the checkbox or text for a starting point, the text highlights.

When the player clicks on either the checkbox or text, a checkmark appears in the box and the text remains highlighted. Selecting a different starting position will unhighlight the previous selection and highlight the new one.

When the player starts the mission, he'll start at the selected location.

If the player makes no selection, he'll start at the info_player_start in the map that has the lowest entity number.

===Making It Your Own===
Three sample starting point descriptions are provided. Change these to match the briefing and starting points for your map. Look for and change these lines:
text "Start next to the sack with grain coming out."
.
.
.
text "Start next to the empty bucket."
.
.
.
text "Start next to the wine barrel."

Each selection is tied to a specific info_player_start in your map. Look for these lines and change them to match the names of your info_player_starts:
set "gui::persistent_builtin_playerStartEntity" "startpos1";
.
.
.
set "gui::persistent_builtin_playerStartEntity" "startpos2";
.
.
.
set "gui::persistent_builtin_playerStartEntity" "startpos3";

That's all you need to do to offer three starting points.

If you want to offer only two starting points, comment out the third checkbox and text windowDef definitions, as well as any other lines that reference those definitions.

If you want to offer four starting points, copy/paste the StartPointBox3 and StartPointText3 definitions, rename the copies as StartPointBox4 and StartPointText4, adjust (x,y) locations on the screen, and extend the first three box/text definitions so they know about the new definitions.

Make similar changes where needed by searching the file for StartPointBox3 and StartPointText3 to find all the places where box/text definitions are referenced.

If you have questions, you can contact datiswous on the TDM forums by either sending a PM or posting to this thread: [http://forums.thedarkmod.com/topic/13210-controlling-where-the-player-starts-a-mission/ Controlling where the player starts a mission]

==Video Briefing==
This is explained in [[Video Briefing]].

==Conclusion==
With these instructions new mappers can really easily create any kind of briefing they prefer by downloading the basic briefing creation package and editing the files to suit their needs. If you have difficulties do not hesitate to ask in our friendly forums, preferably in this thread http://forums.thedarkmod.com/topic/12083-briefing-wiki/

{{GUI}}

Setting up Campaigns

2025-01-05T18:58:15Z

Stgatilov: Game & gui: Added link to bugtracker.

This article is an attempt to describe the various options mappers need to consider when setting up campaigns or multi-mission packages (I'll refer to campaigns for both of these for the sake of simplicity). Campaign support has been added in TDM 1.06.

= Map Files =
Regular, single-map TDM missions are packed in PK4 files, campaigns are no different. If your campaign consists of three missions ("red.map", "blue.map" and "green.map"), all three of them still go into the same maps folder in your PK4 file.

The actual order in which the missions are to be played is defined through the <tt>tdm_mapsequence.txt</tt> file, which should be added to the PK4 (just next to the readme.txt). Following the example of the "red", "blue" and "green" maps above the map sequence file would look like this:

Mission 1: red
Mission 2: blue
Mission 3: green

Looking at that, the syntax of the file is pretty much self-explanatory. The first mission has the number one, the map file is mentioned after the colon and the following space. You don't need to specify the ".map" extension of the map file that is handled automatically. See the main [[tdm_mapsequence.txt]] article for further reference, for this article it's enough to have the above lines I suppose.

= Briefings =
Once the map sequence is defined one needs to take care of the briefing. If you like to keep it simple, just refer to the Briefing article in the [[Briefing#Text-only_Briefing|Text-only Briefing]] section. Each map needs its own xdata block with the briefing and you'll be done.

For advanced setups like the "Timed Flowing Briefing" mentioned in the [[Briefing]] article there are a few modifications to be made to your GUI code. As the mainmenu_briefing.gui file is the same for the whole campaign your GUI needs to know which map the player is about to play next. For this purpose a new GUI variable <tt>gui::CurrentMission</tt> has been introduced which can be used in if-else GUI code blocks in the BriefingStateInit windowDef. For single-missions, mappers just called the GUI animation block like this:

windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

set "BriefingAnimation::visible" "1";
resetTime "BriefingAnimation" 0;

// ... stuff
}
}
For multi-mission setups an if-else block should be added to switch to the correct briefing animation for the current map:
windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "1";
resetTime "BriefingMission1Animation" 0;
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}

// ... stuff
}
}

Of course you'll need to define a <tt>BriefingMissionXAnimation</tt> block for each mission. You can use the instructions in the [[Briefing]] article to learn how to do that, just keep in mind to change the windowDef's name such that you don't end up with duplicate names for your windowDefs (this will lead to warnings in the console at game startup at best).

Starting the correct mission briefing animation is only half the rent, you'll need to stop the correct animation as well when the player proceeds to the objectives screen:
windowDef BriefingStateEnd
{
noTime 1

onTime 0
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "0";
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "0";
set "BriefingMission2Animation::notime" "1";
}

// ... stuff
}
}
If you don't do that the player might see remnants of the previous mission's briefing when proceeding to the next map briefing.

The same holds analogously for the BriefingSkip windowDef which is used to skip the briefing on mouse clicks:

windowDef BriefingSkip
{
notime 1

onTime 0
{
// ... stuff

// Stop the animation
if ("gui::CurrentMission" == 1)
{
resetTime "BriefingMission1Animation" 0;
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}
}
}

= Briefing Videos =
It's possible to define briefing/intro videos for each mission in a campaign. To enable videos mappers need to include a mainmenu_custom_defs.gui file in their PK4 and define a few variables in there. You can look at the default file in the TDM PK4s to get more info and read some comments. I'll include the most important settings briefly here:

Enable SDK-controlled briefing videos by adding this line to your mainmenu_custom_defs.gui file (or uncomment the line if it is present already but commented out):
#define BRIEFING_VIDEO_CONTROLLED_BY_SDK 1

Next you'll need to specify which video to be played for each mission. These are bit more complex:

#define MM_BRIEFING_1_VIDEO_MATERIALS "video/tdm_briefing_video;guis/video/credits/typing_sequence01;"
#define MM_BRIEFING_1_VIDEO_LENGTHS "4000;5000"
#define MM_BRIEFING_1_VIDEO_SOUND_CMD "music video/tdm_briefing_video_sound;"

Easy to see, these three definitions refer to the first mission in the campaign, the prefix is "MM_BRIEFING_1".

The MM_BRIEFING_1_VIDEO_MATERIALS line specifies the various ROQ materials that should be played (in this order). ROQ files have a maximum length of 60 seconds, so TDM added support to a sequence of ROQs to allow for longer videos. The materials should be separated by semicolons. Be sure to define the playback duration of each clip in the VIDEO_LENGTHS line.

The next line MM_BRIEFING_1_VIDEO_LENGTHS corresponds to the MATERIALS line above and contains the playback duration of each ROQ clip. The time is specified in milliseconds, multiple times are separated by semicolons.

The last line in this triple is defining the sound to be played along the video: MM_BRIEFING_1_VIDEO_SOUND_CMD. Sounds don't have a length limit, so there is no need to define multiple sounds like with the ROQ clips. Be sure to include the "music" command in the string and to refer to a valid sound shader.

The original TDM mainmenu_custom_defs.gui file contains a lot of comments about these defs, please take a look there to learn more.

Side note: the SDK-controlled video is also available in ordinary (single) mission packs. You don't need to build a full-blown campaign (with tdm_mapsequence.txt, etc.) to use this option, it's enough to make the correct #DEFINE statements above.

= De-Briefing Videos =
With TDM 1.06 and upwards it's possible to have a video played back immediately after "Mission Complete", so-called de-briefings.

The mechanism to set these up is very similar to the above "SDK-controlled" briefing videos, all you need is to add the correct #DEFINE lines in your mainmenu_custom_defs.gui file:

#define MM_DEBRIEFING_1_VIDEO_MATERIALS "guis/video/credits/typing_sequence01;"
#define MM_DEBRIEFING_1_VIDEO_LENGTHS "2000;"
#define MM_DEBRIEFING_1_VIDEO_SOUND_CMD "music tdm_mainmenu_background_music;"

This example will play a credits video after "Mission Complete" for 2 seconds (= 2000 milliseconds). Please refer to the above "Briefings" section to learn about the precise meaning of these lines, they are pretty much analogous.

Side note: this option is not exclusive to campaigns, you can have a de-briefing video in single-mission setups just as well.

= Conditional Objectives =
You can have your mission objectives depend on the state of objectives in previous missions. It's possible to set an objective in the second mission to "COMPLETE" if the player managed to fulfill an objective in the first mission.

[[Image:Objective conditions editor.png|400px|right]]

Consider a campaign consisting of two maps: red.map and blue.map, played in this order. You have an optional objective in red.map telling the player to find 50 loot in gold. If the player manages to complete that objective the mandatory objective in mission 2 ''"Find enough gold for your rent"'' should already be marked as ''"Completed"''. Such a thing can be achieved through a set of spawnargs that have been introduced in TDM 1.06 (see the [[Objectives#Objective_Conditions|Objectives]] article for reference), but you can do it through the Objectives Editor just as fine.

I'll assume the use of the Conditions editor is fairly straightforward, but feel free to ask specific questions in our forums.

= Scripting =
There are a few script methods which are specifically designed to be used in maps. See the file tdm_events.script for more details about them.

===== mission number =====
Use the getCurrentMission() method on the sys entity to retrieve the current mission number. Note that the mission numbers are 0-based in the code, the function will return 0 for the first mission in a campaign. The following snippet will print the number to the console:
sys.println("Current Mission: " + sys.getCurrentMissionNum());

===== persistent info =====
There are a couple of script events that can be used to store data in between missions. This data is stored in the so-called "persistent level info", which is designed to store key/value pairs.
See <tt>tdm_events.script</tt> file for further reference:

void setPersistentArg( string key, string value );
string getPersistentString( string key );
float getPersistentFloat( string key );
vector getPersistentVector( string key );

For example, you can store a number value like this (all values are stored as strings):
sys.setPersistentArg("dummyvar", "20");

Later on you receive the number value like this:
float testvar = sys.getPersistentFloat("dummyvar");

If you ever need to clear out the entire level info there's a separate routine for that:
sys.clearPersistentArgs();

===== game & gui =====

Starting with '''TDM 2.13''', persistent information is also provided as GUI variables ([https://bugs.thedarkmod.com/view.php?id=6509 #6509]).
The information is automatically synchronized between game script variables and GUI variables.

For example, here is how you access "killed_berny" persistent argument in game script:
sys.setPersistentArg("killed_berny", "1");
float value = sys.getPersistentFloat("killed_berny");

And here is how you access it in GUI script:
set "gui::persistent_killed_berny" "1";
if ("gui::persistent_killed_berny" == 0) { ... }

You can add a custom checkbox in GUI briefing, and then customize the game depending on whether the player enabled it or not.
Or you can implement game script functions <tt>on_mission_complete</tt> and <tt>on_mission_failed</tt> and save some info about game state in order to customize debriefing.
This feature can be useful for single missions as well.

= Inventory Items =
The player's inventory contains all the keys, tools, lockpicks, lantern as well as all the weapons. The mapper can define which of these should be kept when proceeding to the next mission. Items that are allowed to be kept are called "persistent", and the corresponding spawnarg controlling that property is called "inv_persistent".

== Tools & Items ==
By default regular inventory items are not marked as persistent, i.e. the inv_persistent key is set to "0". Once the mapper flips that spawnarg to "1" the item will be kept throughout the following missions. The item will be kept until the end of the whole campaign, unless:
* the player drops the item
* it is removed from the inventory by script or other events
* a rule on the atdm:campaign_info entity is forcing the item to be removed after "Mission Complete" (see below).

Even though TDM 2.02+ will resolve naming conflicts across maps, map authors should try to make sure that persistent items have unique names. For example, if the first map has a persistent item named "My Water Bottle", none of the subsequent maps should have an item named "My Water Bottle". If you must have a second water bottle, name it "My Second Water Bottle", or something along those lines.

If you have a persistent stackable item in map N, and you don't consume it in that map, and you have another instance of the same stackable item in map N+1 (whether it's marked 'persistent' or not), when you pick it up, it will be added to the stack count of map N's item and become persistent.

== Weapons & Arrows ==
All weapon inventory items are persistent by default including their ammo, so without further action the player will keep all his weapons and all the arrows when proceeding to the next mission. However it's possible to define ammo limits on the atdm:campaign_info entity, which is described below.

Important: it's not advisable to mess with the inv_persistent spawnarg on weapon items - it's recommended to leave that spawnarg at the default value and control the carry-over by the rules on the campaign info entity.

== Inventory Item and Weapon Limits ==
An [[atdm:campaign_info]] entity can be placed in a map to control which items make it to the next mission (and their amount) - and which should be dropped. The rules defined on the [[atdm:campaign_info]] entity will be enforced after the "Mission Complete" event, when the map is still active, i.e. it's "filtering" outgoing items. Each map can have its own campaign info entity to define its own set of rules.

Please refer to the main [[atdm:campaign_info]] article to get precise info on how to set up these rules.

= Loot Limits =
Special handling is possible for the amount of loot that is carried over and usable in the shop of the next mission. These so-called "loot carry-over" rules are defined on the shop entity of the respective map, e.g. the shop entity in Mission B will define the loot carry-over roles applicable to the loot collected in Mission A.

Refer to the [[Shop#Limiting_the_Loot_from_previous_Missions|Shop]] article for further reference.

{{editing}}
[[Category:Campaigns]]

Setting up Campaigns

2025-01-05T18:56:07Z

Stgatilov: Refined section about persistent info and added a subsection about passing information between game and GUI.

This article is an attempt to describe the various options mappers need to consider when setting up campaigns or multi-mission packages (I'll refer to campaigns for both of these for the sake of simplicity). Campaign support has been added in TDM 1.06.

= Map Files =
Regular, single-map TDM missions are packed in PK4 files, campaigns are no different. If your campaign consists of three missions ("red.map", "blue.map" and "green.map"), all three of them still go into the same maps folder in your PK4 file.

The actual order in which the missions are to be played is defined through the <tt>tdm_mapsequence.txt</tt> file, which should be added to the PK4 (just next to the readme.txt). Following the example of the "red", "blue" and "green" maps above the map sequence file would look like this:

Mission 1: red
Mission 2: blue
Mission 3: green

Looking at that, the syntax of the file is pretty much self-explanatory. The first mission has the number one, the map file is mentioned after the colon and the following space. You don't need to specify the ".map" extension of the map file that is handled automatically. See the main [[tdm_mapsequence.txt]] article for further reference, for this article it's enough to have the above lines I suppose.

= Briefings =
Once the map sequence is defined one needs to take care of the briefing. If you like to keep it simple, just refer to the Briefing article in the [[Briefing#Text-only_Briefing|Text-only Briefing]] section. Each map needs its own xdata block with the briefing and you'll be done.

For advanced setups like the "Timed Flowing Briefing" mentioned in the [[Briefing]] article there are a few modifications to be made to your GUI code. As the mainmenu_briefing.gui file is the same for the whole campaign your GUI needs to know which map the player is about to play next. For this purpose a new GUI variable <tt>gui::CurrentMission</tt> has been introduced which can be used in if-else GUI code blocks in the BriefingStateInit windowDef. For single-missions, mappers just called the GUI animation block like this:

windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

set "BriefingAnimation::visible" "1";
resetTime "BriefingAnimation" 0;

// ... stuff
}
}
For multi-mission setups an if-else block should be added to switch to the correct briefing animation for the current map:
windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "1";
resetTime "BriefingMission1Animation" 0;
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}

// ... stuff
}
}

Of course you'll need to define a <tt>BriefingMissionXAnimation</tt> block for each mission. You can use the instructions in the [[Briefing]] article to learn how to do that, just keep in mind to change the windowDef's name such that you don't end up with duplicate names for your windowDefs (this will lead to warnings in the console at game startup at best).

Starting the correct mission briefing animation is only half the rent, you'll need to stop the correct animation as well when the player proceeds to the objectives screen:
windowDef BriefingStateEnd
{
noTime 1

onTime 0
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "0";
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "0";
set "BriefingMission2Animation::notime" "1";
}

// ... stuff
}
}
If you don't do that the player might see remnants of the previous mission's briefing when proceeding to the next map briefing.

The same holds analogously for the BriefingSkip windowDef which is used to skip the briefing on mouse clicks:

windowDef BriefingSkip
{
notime 1

onTime 0
{
// ... stuff

// Stop the animation
if ("gui::CurrentMission" == 1)
{
resetTime "BriefingMission1Animation" 0;
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}
}
}

= Briefing Videos =
It's possible to define briefing/intro videos for each mission in a campaign. To enable videos mappers need to include a mainmenu_custom_defs.gui file in their PK4 and define a few variables in there. You can look at the default file in the TDM PK4s to get more info and read some comments. I'll include the most important settings briefly here:

Enable SDK-controlled briefing videos by adding this line to your mainmenu_custom_defs.gui file (or uncomment the line if it is present already but commented out):
#define BRIEFING_VIDEO_CONTROLLED_BY_SDK 1

Next you'll need to specify which video to be played for each mission. These are bit more complex:

#define MM_BRIEFING_1_VIDEO_MATERIALS "video/tdm_briefing_video;guis/video/credits/typing_sequence01;"
#define MM_BRIEFING_1_VIDEO_LENGTHS "4000;5000"
#define MM_BRIEFING_1_VIDEO_SOUND_CMD "music video/tdm_briefing_video_sound;"

Easy to see, these three definitions refer to the first mission in the campaign, the prefix is "MM_BRIEFING_1".

The MM_BRIEFING_1_VIDEO_MATERIALS line specifies the various ROQ materials that should be played (in this order). ROQ files have a maximum length of 60 seconds, so TDM added support to a sequence of ROQs to allow for longer videos. The materials should be separated by semicolons. Be sure to define the playback duration of each clip in the VIDEO_LENGTHS line.

The next line MM_BRIEFING_1_VIDEO_LENGTHS corresponds to the MATERIALS line above and contains the playback duration of each ROQ clip. The time is specified in milliseconds, multiple times are separated by semicolons.

The last line in this triple is defining the sound to be played along the video: MM_BRIEFING_1_VIDEO_SOUND_CMD. Sounds don't have a length limit, so there is no need to define multiple sounds like with the ROQ clips. Be sure to include the "music" command in the string and to refer to a valid sound shader.

The original TDM mainmenu_custom_defs.gui file contains a lot of comments about these defs, please take a look there to learn more.

Side note: the SDK-controlled video is also available in ordinary (single) mission packs. You don't need to build a full-blown campaign (with tdm_mapsequence.txt, etc.) to use this option, it's enough to make the correct #DEFINE statements above.

= De-Briefing Videos =
With TDM 1.06 and upwards it's possible to have a video played back immediately after "Mission Complete", so-called de-briefings.

The mechanism to set these up is very similar to the above "SDK-controlled" briefing videos, all you need is to add the correct #DEFINE lines in your mainmenu_custom_defs.gui file:

#define MM_DEBRIEFING_1_VIDEO_MATERIALS "guis/video/credits/typing_sequence01;"
#define MM_DEBRIEFING_1_VIDEO_LENGTHS "2000;"
#define MM_DEBRIEFING_1_VIDEO_SOUND_CMD "music tdm_mainmenu_background_music;"

This example will play a credits video after "Mission Complete" for 2 seconds (= 2000 milliseconds). Please refer to the above "Briefings" section to learn about the precise meaning of these lines, they are pretty much analogous.

Side note: this option is not exclusive to campaigns, you can have a de-briefing video in single-mission setups just as well.

= Conditional Objectives =
You can have your mission objectives depend on the state of objectives in previous missions. It's possible to set an objective in the second mission to "COMPLETE" if the player managed to fulfill an objective in the first mission.

[[Image:Objective conditions editor.png|400px|right]]

Consider a campaign consisting of two maps: red.map and blue.map, played in this order. You have an optional objective in red.map telling the player to find 50 loot in gold. If the player manages to complete that objective the mandatory objective in mission 2 ''"Find enough gold for your rent"'' should already be marked as ''"Completed"''. Such a thing can be achieved through a set of spawnargs that have been introduced in TDM 1.06 (see the [[Objectives#Objective_Conditions|Objectives]] article for reference), but you can do it through the Objectives Editor just as fine.

I'll assume the use of the Conditions editor is fairly straightforward, but feel free to ask specific questions in our forums.

= Scripting =
There are a few script methods which are specifically designed to be used in maps. See the file tdm_events.script for more details about them.

===== mission number =====
Use the getCurrentMission() method on the sys entity to retrieve the current mission number. Note that the mission numbers are 0-based in the code, the function will return 0 for the first mission in a campaign. The following snippet will print the number to the console:
sys.println("Current Mission: " + sys.getCurrentMissionNum());

===== persistent info =====
There are a couple of script events that can be used to store data in between missions. This data is stored in the so-called "persistent level info", which is designed to store key/value pairs.
See <tt>tdm_events.script</tt> file for further reference:

void setPersistentArg( string key, string value );
string getPersistentString( string key );
float getPersistentFloat( string key );
vector getPersistentVector( string key );

For example, you can store a number value like this (all values are stored as strings):
sys.setPersistentArg("dummyvar", "20");

Later on you receive the number value like this:
float testvar = sys.getPersistentFloat("dummyvar");

If you ever need to clear out the entire level info there's a separate routine for that:
sys.clearPersistentArgs();

===== game & gui =====

Starting with '''TDM 2.13''', persistent information is also provided as GUI variables.
The information is automatically synchronized between game script variables and GUI variables.

For example, here is how you access "killed_berny" persistent argument in game script:
sys.setPersistentArg("killed_berny", "1");
float value = sys.getPersistentFloat("killed_berny");

And here is how you access it in GUI script:
set "gui::persistent_killed_berny" "1";
if ("gui::persistent_killed_berny" == 0) { ... }

You can add a custom checkbox in GUI briefing, and then customize the game depending on whether the player enabled it or not.
Or you can implement game script functions <tt>on_mission_complete</tt> and <tt>on_mission_failed</tt> and save some info about game state in order to customize debriefing.
This feature can be useful for single missions as well.

= Inventory Items =
The player's inventory contains all the keys, tools, lockpicks, lantern as well as all the weapons. The mapper can define which of these should be kept when proceeding to the next mission. Items that are allowed to be kept are called "persistent", and the corresponding spawnarg controlling that property is called "inv_persistent".

== Tools & Items ==
By default regular inventory items are not marked as persistent, i.e. the inv_persistent key is set to "0". Once the mapper flips that spawnarg to "1" the item will be kept throughout the following missions. The item will be kept until the end of the whole campaign, unless:
* the player drops the item
* it is removed from the inventory by script or other events
* a rule on the atdm:campaign_info entity is forcing the item to be removed after "Mission Complete" (see below).

Even though TDM 2.02+ will resolve naming conflicts across maps, map authors should try to make sure that persistent items have unique names. For example, if the first map has a persistent item named "My Water Bottle", none of the subsequent maps should have an item named "My Water Bottle". If you must have a second water bottle, name it "My Second Water Bottle", or something along those lines.

If you have a persistent stackable item in map N, and you don't consume it in that map, and you have another instance of the same stackable item in map N+1 (whether it's marked 'persistent' or not), when you pick it up, it will be added to the stack count of map N's item and become persistent.

== Weapons & Arrows ==
All weapon inventory items are persistent by default including their ammo, so without further action the player will keep all his weapons and all the arrows when proceeding to the next mission. However it's possible to define ammo limits on the atdm:campaign_info entity, which is described below.

Important: it's not advisable to mess with the inv_persistent spawnarg on weapon items - it's recommended to leave that spawnarg at the default value and control the carry-over by the rules on the campaign info entity.

== Inventory Item and Weapon Limits ==
An [[atdm:campaign_info]] entity can be placed in a map to control which items make it to the next mission (and their amount) - and which should be dropped. The rules defined on the [[atdm:campaign_info]] entity will be enforced after the "Mission Complete" event, when the map is still active, i.e. it's "filtering" outgoing items. Each map can have its own campaign info entity to define its own set of rules.

Please refer to the main [[atdm:campaign_info]] article to get precise info on how to set up these rules.

= Loot Limits =
Special handling is possible for the amount of loot that is carried over and usable in the shop of the next mission. These so-called "loot carry-over" rules are defined on the shop entity of the respective map, e.g. the shop entity in Mission B will define the loot carry-over roles applicable to the loot collected in Mission A.

Refer to the [[Shop#Limiting_the_Loot_from_previous_Missions|Shop]] article for further reference.

{{editing}}
[[Category:Campaigns]]

Adding new Cvars

2025-01-05T17:37:19Z

Stgatilov:

{{Original_Reference|Ishtvan & Domarius|2600}}

To add a new console variable (cvar) the files that must be changed are /game/gamesys/syscvar.*

Let's use the example of adding a cvar to globally lower the volume of sounds that AI hear. We want to add a cvar called dm_ai_sndvol so we can adjust the volume of sounds that AI hear in realtime in the console.

= Add a declaration of the cvar in game/gamesys/syscvar.cpp =

idCVar cv_tdm_ai_sndvol( "tdm_ai_sndvol", "0.0", CVAR_GAME | CVAR_ARCHIVE | CVAR_FLOAT,
"Modifier to the volume of suspcious sounds that AI's hear. Defaults to 0.0 dB" );

The syntax is:

idCVar <SDK variable name>( "<variable name ingame>", "<default value>", <FLAGS>,
"<Brief description of the variable>" );

Our naming convention for the SDK variable name is "cv_*", where the cv indicates it's a cvar. This should be followed. The name ingame can be whatever you want but it has to include the tdm_ prefix at least. I've been using the format tdm_ai_ .. for stuff having to do with the AI, etc.

Note that the default value is stored as a string. These things are parsed just like key/value pairs, so the name and default value are both strings.

== Type Flags ==
These flags define the Cvar type. If one of them is not set on your cvar, it will default to type string.

* CVAR_BOOL
* CVAR_INTEGER
* CVAR_FLOAT
* CVAR_ROM (not sure what this is used for)

== Other Flags ==
* CVAR_GAME, CVAR_RENDERER : Identifies the CVar as having to do with the game, or having to do with the renderer. Since we can't add anything to the renderer, I'm guessing we'll always ue CVAR_GAME.
* CVAR_GUI : Used by the GUI (the difference to "CVAR_GAME" is unclear)
* CVAR_ARCHIVE : If set, the value of this CVAR will be stored to your Darkmod.cfg file, and saved. When you next start the game, the CVAR will have the same value, it will NOT go back to the default. (You can see what the default value was and set it back yourself by using listcvars <the cvar>).
* CVAR_NETWORKSYNC : Probably means that in multiplayer games, this is read from the server, so individuals cannot change it to a different setting on their client. Examples include jump height, walking speed, etc.
* CVAR_SERVERINFO : Server settings
* CVAR_USERINFO : User settings
* CVAR_INIT : ???
* CVAR_NOCHEAT : ??? It's set on password and g_fov. Maybe if cheats are enabled, it still doesn't let people change it?

This is from the Id documentation on the matter:
CVars are always considered cheats except when CVAR_NOCHEAT, CVAR_INIT, CVAR_ROM,
CVAR_ARCHIVE, CVAR_USERINFO, CVAR_SERVERINFO, CVAR_NETWORKSYNC is set.

= Adding extern declaration in game/gamesys/syscvar.h =

extern idCVar cv_tdm_ai_sndvol;

This step is pretty self explanatory, just add the extern declaration in syscvar.h. (Unfortunately, changing syscvar.h requires a recompile of all the src, since it is included in game_local.h, and that is included in pretty much everything.)

= Step 3. Using the CVar in the SDK =
To set and read the variable: use the appropriate idCvar::Set* and idCVar::Get* functions, where the * is replaced with the CVar type that you declared before.

For example, suppose we want to use our cv_tdm_ai_sndvol in the code. Suppose we want to subtract it from some value InitialVolume.

float AdjustedVolume = InitialVolume - cv_tdm_ai_sndvol.GetFloat();

Similarly, to set it in the SDK;

cv_tdm_ai_sndvol.SetFloat( 5.0f );

== Side note: Manipulating cvars ingame in the console ==
* To see a list of cvars ingame, use "listcvars <your search string>"
* To see a description of a cvar, use "listcvars -help <your search string>"
* To see the current and default value of the cvar, just type the cvar name in the console.
* To set the value of a cvar, use "set <cvar name> <value>"

I believe you can also omit the "set" and just type "<cvar name> <value>" to set the value.

More info can be found in: '''framework/cvarsystem.h'''. This file actually contains a lot of documentation in the form of comments.

= Create or override CVAR using game script =

If you want to create a new cvar for use with game script, you can do it dynamically during gameplay.
This command will create a new cvar or modify the value of existing cvar:

sys.setcvar("name", value);

where 'name' is the actual name of the cvar that the user will type in the console, and 'value' is the string you want to assign.

User will see this cvar and will be able to modify its value.
You can read the current effective value of the cvar by executing:

string value = sys.getcvar("name");
float value = sys.getcvarf("name");

Starting from TDM 2.13, <tt>sys.setcvar</tt> sets '''mission override''' for a cvar but does not modify the user-specified value.

Mission override has special behavior and is considered to be part of gameplay state: it is saved/restored in savefiles, cleared on game start/end, and never saved into darkmod.cfg even for archived cvars.
This is not important for cvars that you create dynamically, but very important if you modify the existing predefined cvars. See also [https://bugs.thedarkmod.com/view.php?id=5453 #5453].

= CVARs and the GUI =

It is possible to bind an input field directly to a CVAR via:

choices "#str_07213" // Aspect ratio
values "0;1;4;2;3"
cvar "r_aspectRatio"

The user is presented with the list of choices from "choices", and for each of these, the appropriate value from "values" is set into "r_aspectRatio". So when this field is changed, the value of r_aspectRatio is automatically changed, too.

{{infobox|'''Note: Choices are limited to ASCII strings and the values are limited to valid choices for this CVAR. See [[I18N]] for details and how to work around that limitation.'''}}

{{sdk}} [[Category:CVARS]]

Setting up Campaigns

2025-01-05T17:32:09Z

Stgatilov: TDM 2.13: "persistant" is renamed to "persistent" in script function names

This article is an attempt to describe the various options mappers need to consider when setting up campaigns or multi-mission packages (I'll refer to campaigns for both of these for the sake of simplicity). Campaign support has been added in TDM 1.06.

= Map Files =
Regular, single-map TDM missions are packed in PK4 files, campaigns are no different. If your campaign consists of three missions ("red.map", "blue.map" and "green.map"), all three of them still go into the same maps folder in your PK4 file.

The actual order in which the missions are to be played is defined through the <tt>tdm_mapsequence.txt</tt> file, which should be added to the PK4 (just next to the readme.txt). Following the example of the "red", "blue" and "green" maps above the map sequence file would look like this:

Mission 1: red
Mission 2: blue
Mission 3: green

Looking at that, the syntax of the file is pretty much self-explanatory. The first mission has the number one, the map file is mentioned after the colon and the following space. You don't need to specify the ".map" extension of the map file that is handled automatically. See the main [[tdm_mapsequence.txt]] article for further reference, for this article it's enough to have the above lines I suppose.

= Briefings =
Once the map sequence is defined one needs to take care of the briefing. If you like to keep it simple, just refer to the Briefing article in the [[Briefing#Text-only_Briefing|Text-only Briefing]] section. Each map needs its own xdata block with the briefing and you'll be done.

For advanced setups like the "Timed Flowing Briefing" mentioned in the [[Briefing]] article there are a few modifications to be made to your GUI code. As the mainmenu_briefing.gui file is the same for the whole campaign your GUI needs to know which map the player is about to play next. For this purpose a new GUI variable <tt>gui::CurrentMission</tt> has been introduced which can be used in if-else GUI code blocks in the BriefingStateInit windowDef. For single-missions, mappers just called the GUI animation block like this:

windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

set "BriefingAnimation::visible" "1";
resetTime "BriefingAnimation" 0;

// ... stuff
}
}
For multi-mission setups an if-else block should be added to switch to the correct briefing animation for the current map:
windowDef BriefingStateInit
{
noTime 1

// Init methods have onTime 10 instead of onTime 0.
onTime 10
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "1";
resetTime "BriefingMission1Animation" 0;
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}

// ... stuff
}
}

Of course you'll need to define a <tt>BriefingMissionXAnimation</tt> block for each mission. You can use the instructions in the [[Briefing]] article to learn how to do that, just keep in mind to change the windowDef's name such that you don't end up with duplicate names for your windowDefs (this will lead to warnings in the console at game startup at best).

Starting the correct mission briefing animation is only half the rent, you'll need to stop the correct animation as well when the player proceeds to the objectives screen:
windowDef BriefingStateEnd
{
noTime 1

onTime 0
{
// ... stuff

if ("gui::CurrentMission" == 1)
{
set "BriefingMission1Animation::visible" "0";
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "0";
set "BriefingMission2Animation::notime" "1";
}

// ... stuff
}
}
If you don't do that the player might see remnants of the previous mission's briefing when proceeding to the next map briefing.

The same holds analogously for the BriefingSkip windowDef which is used to skip the briefing on mouse clicks:

windowDef BriefingSkip
{
notime 1

onTime 0
{
// ... stuff

// Stop the animation
if ("gui::CurrentMission" == 1)
{
resetTime "BriefingMission1Animation" 0;
set "BriefingMission1Animation::notime" "1";
}
else if ("gui::CurrentMission" == 2)
{
set "BriefingMission2Animation::visible" "1";
resetTime "BriefingMission2Animation" 0;
}
}
}

= Briefing Videos =
It's possible to define briefing/intro videos for each mission in a campaign. To enable videos mappers need to include a mainmenu_custom_defs.gui file in their PK4 and define a few variables in there. You can look at the default file in the TDM PK4s to get more info and read some comments. I'll include the most important settings briefly here:

Enable SDK-controlled briefing videos by adding this line to your mainmenu_custom_defs.gui file (or uncomment the line if it is present already but commented out):
#define BRIEFING_VIDEO_CONTROLLED_BY_SDK 1

Next you'll need to specify which video to be played for each mission. These are bit more complex:

#define MM_BRIEFING_1_VIDEO_MATERIALS "video/tdm_briefing_video;guis/video/credits/typing_sequence01;"
#define MM_BRIEFING_1_VIDEO_LENGTHS "4000;5000"
#define MM_BRIEFING_1_VIDEO_SOUND_CMD "music video/tdm_briefing_video_sound;"

Easy to see, these three definitions refer to the first mission in the campaign, the prefix is "MM_BRIEFING_1".

The MM_BRIEFING_1_VIDEO_MATERIALS line specifies the various ROQ materials that should be played (in this order). ROQ files have a maximum length of 60 seconds, so TDM added support to a sequence of ROQs to allow for longer videos. The materials should be separated by semicolons. Be sure to define the playback duration of each clip in the VIDEO_LENGTHS line.

The next line MM_BRIEFING_1_VIDEO_LENGTHS corresponds to the MATERIALS line above and contains the playback duration of each ROQ clip. The time is specified in milliseconds, multiple times are separated by semicolons.

The last line in this triple is defining the sound to be played along the video: MM_BRIEFING_1_VIDEO_SOUND_CMD. Sounds don't have a length limit, so there is no need to define multiple sounds like with the ROQ clips. Be sure to include the "music" command in the string and to refer to a valid sound shader.

The original TDM mainmenu_custom_defs.gui file contains a lot of comments about these defs, please take a look there to learn more.

Side note: the SDK-controlled video is also available in ordinary (single) mission packs. You don't need to build a full-blown campaign (with tdm_mapsequence.txt, etc.) to use this option, it's enough to make the correct #DEFINE statements above.

= De-Briefing Videos =
With TDM 1.06 and upwards it's possible to have a video played back immediately after "Mission Complete", so-called de-briefings.

The mechanism to set these up is very similar to the above "SDK-controlled" briefing videos, all you need is to add the correct #DEFINE lines in your mainmenu_custom_defs.gui file:

#define MM_DEBRIEFING_1_VIDEO_MATERIALS "guis/video/credits/typing_sequence01;"
#define MM_DEBRIEFING_1_VIDEO_LENGTHS "2000;"
#define MM_DEBRIEFING_1_VIDEO_SOUND_CMD "music tdm_mainmenu_background_music;"

This example will play a credits video after "Mission Complete" for 2 seconds (= 2000 milliseconds). Please refer to the above "Briefings" section to learn about the precise meaning of these lines, they are pretty much analogous.

Side note: this option is not exclusive to campaigns, you can have a de-briefing video in single-mission setups just as well.

= Conditional Objectives =
You can have your mission objectives depend on the state of objectives in previous missions. It's possible to set an objective in the second mission to "COMPLETE" if the player managed to fulfill an objective in the first mission.

[[Image:Objective conditions editor.png|400px|right]]

Consider a campaign consisting of two maps: red.map and blue.map, played in this order. You have an optional objective in red.map telling the player to find 50 loot in gold. If the player manages to complete that objective the mandatory objective in mission 2 ''"Find enough gold for your rent"'' should already be marked as ''"Completed"''. Such a thing can be achieved through a set of spawnargs that have been introduced in TDM 1.06 (see the [[Objectives#Objective_Conditions|Objectives]] article for reference), but you can do it through the Objectives Editor just as fine.

I'll assume the use of the Conditions editor is fairly straightforward, but feel free to ask specific questions in our forums.

= Scripting =
There are a few script methods which are specifically designed to be used in maps. See the file tdm_events.script for more details about them.

Use the getCurrentMission() method on the sys entity to retrieve the current mission number. Note that the mission numbers are 0-based in the code, the function will return 0 for the first mission in a campaign. The following snippet will print the number to the console:
sys.println("Current Mission: " + sys.getCurrentMissionNum());

Furthermore there are a couple of script events that can be used to store data in between missions. This data is stored in the so-called "persistent level info", which is designed to store key/value pairs.

The script events are very similar to the routines used to query entity spawnargs (which is not surprising, as the persistent level info is using the same C++ class idDict to store the data). Since the persistent level info is not associated to any entity, these methods need to be called on the sys object. See doom_events.script file for further reference.

// Sets a key/value pair that persists between maps, overwriting existing keys with the same name
scriptEvent setPersistentArg( string key, string value );

// Returns the string for the given persistent arg
scriptEvent string getPersistentString( string key );

// Returns the floating point value for the given persistent arg
scriptEvent float getPersistentFloat( string key );

// Returns the vector for the given persistent arg
scriptEvent vector getPersistentVector( string key );

As example, you can store a number value like this (all values are stored as string)
sys.setPersistentArg("dummyvar", "20");

Later on you receive the number value like this:
float testvar = sys.getPersistentFloat("dummyvar");

If you ever need to clear out the entire level info there's a separate routine for that:
// clears data that persists between maps
sys.clearPersistentArgs();

= Inventory Items =
The player's inventory contains all the keys, tools, lockpicks, lantern as well as all the weapons. The mapper can define which of these should be kept when proceeding to the next mission. Items that are allowed to be kept are called "persistent", and the corresponding spawnarg controlling that property is called "inv_persistent".

== Tools & Items ==
By default regular inventory items are not marked as persistent, i.e. the inv_persistent key is set to "0". Once the mapper flips that spawnarg to "1" the item will be kept throughout the following missions. The item will be kept until the end of the whole campaign, unless:
* the player drops the item
* it is removed from the inventory by script or other events
* a rule on the atdm:campaign_info entity is forcing the item to be removed after "Mission Complete" (see below).

Even though TDM 2.02+ will resolve naming conflicts across maps, map authors should try to make sure that persistent items have unique names. For example, if the first map has a persistent item named "My Water Bottle", none of the subsequent maps should have an item named "My Water Bottle". If you must have a second water bottle, name it "My Second Water Bottle", or something along those lines.

If you have a persistent stackable item in map N, and you don't consume it in that map, and you have another instance of the same stackable item in map N+1 (whether it's marked 'persistent' or not), when you pick it up, it will be added to the stack count of map N's item and become persistent.

== Weapons & Arrows ==
All weapon inventory items are persistent by default including their ammo, so without further action the player will keep all his weapons and all the arrows when proceeding to the next mission. However it's possible to define ammo limits on the atdm:campaign_info entity, which is described below.

Important: it's not advisable to mess with the inv_persistent spawnarg on weapon items - it's recommended to leave that spawnarg at the default value and control the carry-over by the rules on the campaign info entity.

== Inventory Item and Weapon Limits ==
An [[atdm:campaign_info]] entity can be placed in a map to control which items make it to the next mission (and their amount) - and which should be dropped. The rules defined on the [[atdm:campaign_info]] entity will be enforced after the "Mission Complete" event, when the map is still active, i.e. it's "filtering" outgoing items. Each map can have its own campaign info entity to define its own set of rules.

Please refer to the main [[atdm:campaign_info]] article to get precise info on how to set up these rules.

= Loot Limits =
Special handling is possible for the amount of loot that is carried over and usable in the shop of the next mission. These so-called "loot carry-over" rules are defined on the shop entity of the respective map, e.g. the shop entity in Mission B will define the loot carry-over roles applicable to the loot collected in Mission A.

Refer to the [[Shop#Limiting_the_Loot_from_previous_Missions|Shop]] article for further reference.

{{editing}}
[[Category:Campaigns]]

Adding new Cvars

2025-01-05T17:27:53Z

Stgatilov: Updated Cvar interactions in game scripts: mission override, binding to variable deleted.

{{Original_Reference|Ishtvan & Domarius|2600}}

To add a new console variable (cvar) the files that must be changed are /game/gamesys/syscvar.*

Let's use the example of adding a cvar to globally lower the volume of sounds that AI hear. We want to add a cvar called dm_ai_sndvol so we can adjust the volume of sounds that AI hear in realtime in the console.

= Add a declaration of the cvar in game/gamesys/syscvar.cpp =

idCVar cv_tdm_ai_sndvol( "tdm_ai_sndvol", "0.0", CVAR_GAME | CVAR_ARCHIVE | CVAR_FLOAT,
"Modifier to the volume of suspcious sounds that AI's hear. Defaults to 0.0 dB" );

The syntax is:

idCVar <SDK variable name>( "<variable name ingame>", "<default value>", <FLAGS>,
"<Brief description of the variable>" );

Our naming convention for the SDK variable name is "cv_*", where the cv indicates it's a cvar. This should be followed. The name ingame can be whatever you want but it has to include the tdm_ prefix at least. I've been using the format tdm_ai_ .. for stuff having to do with the AI, etc.

Note that the default value is stored as a string. These things are parsed just like key/value pairs, so the name and default value are both strings.

== Type Flags ==
These flags define the Cvar type. If one of them is not set on your cvar, it will default to type string.

* CVAR_BOOL
* CVAR_INTEGER
* CVAR_FLOAT
* CVAR_ROM (not sure what this is used for)

== Other Flags ==
* CVAR_GAME, CVAR_RENDERER : Identifies the CVar as having to do with the game, or having to do with the renderer. Since we can't add anything to the renderer, I'm guessing we'll always ue CVAR_GAME.
* CVAR_GUI : Used by the GUI (the difference to "CVAR_GAME" is unclear)
* CVAR_ARCHIVE : If set, the value of this CVAR will be stored to your Darkmod.cfg file, and saved. When you next start the game, the CVAR will have the same value, it will NOT go back to the default. (You can see what the default value was and set it back yourself by using listcvars <the cvar>).
* CVAR_NETWORKSYNC : Probably means that in multiplayer games, this is read from the server, so individuals cannot change it to a different setting on their client. Examples include jump height, walking speed, etc.
* CVAR_SERVERINFO : Server settings
* CVAR_USERINFO : User settings
* CVAR_INIT : ???
* CVAR_NOCHEAT : ??? It's set on password and g_fov. Maybe if cheats are enabled, it still doesn't let people change it?

This is from the Id documentation on the matter:
CVars are always considered cheats except when CVAR_NOCHEAT, CVAR_INIT, CVAR_ROM,
CVAR_ARCHIVE, CVAR_USERINFO, CVAR_SERVERINFO, CVAR_NETWORKSYNC is set.

= Adding extern declaration in game/gamesys/syscvar.h =

extern idCVar cv_tdm_ai_sndvol;

This step is pretty self explanatory, just add the extern declaration in syscvar.h. (Unfortunately, changing syscvar.h requires a recompile of all the src, since it is included in game_local.h, and that is included in pretty much everything.)

= Step 3. Using the CVar in the SDK =
To set and read the variable: use the appropriate idCvar::Set* and idCVar::Get* functions, where the * is replaced with the CVar type that you declared before.

For example, suppose we want to use our cv_tdm_ai_sndvol in the code. Suppose we want to subtract it from some value InitialVolume.

float AdjustedVolume = InitialVolume - cv_tdm_ai_sndvol.GetFloat();

Similarly, to set it in the SDK;

cv_tdm_ai_sndvol.SetFloat( 5.0f );

== Side note: Manipulating cvars ingame in the console ==
* To see a list of cvars ingame, use "listcvars <your search string>"
* To see a description of a cvar, use "listcvars -help <your search string>"
* To see the current and default value of the cvar, just type the cvar name in the console.
* To set the value of a cvar, use "set <cvar name> <value>"

I believe you can also omit the "set" and just type "<cvar name> <value>" to set the value.

More info can be found in: '''framework/cvarsystem.h'''. This file actually contains a lot of documentation in the form of comments.

= Creating a CVAR using script =

If you need to create a cvar for use with game script, you're in for a much easier ride.
This command will create a new cvar or modify the value of existing cvar:

sys.setcvar("name", value);

where 'name' is the actual name of the cvar that the user will type in the console, and 'value' is the string you want to assign.

User will see this cvar and will be able to modify its value.
You can read the current effective value of the cvar by executing:

string value = sys.getcvar("name");
float value = sys.getcvarf("name");

Starting from TDM 2.13, <tt>sys.setcvar</tt> sets "mission override" for a cvar but does not modify the user-specified value.

Mission override has special behavior and is considered to be part of gameplay state: it is saved/restored in savefiles, cleared on game start/end, and never saved into darkmod.cfg even for archived cvars.
This is not important for cvars that you create dynamically, but very important if you modify the existing predefined cvars. See also [https://bugs.thedarkmod.com/view.php?id=5453 #5453].

= CVARs and the GUI =

It is possible to bind an input field directly to a CVAR via:

choices "#str_07213" // Aspect ratio
values "0;1;4;2;3"
cvar "r_aspectRatio"

The user is presented with the list of choices from "choices", and for each of these, the appropriate value from "values" is set into "r_aspectRatio". So when this field is changed, the value of r_aspectRatio is automatically changed, too.

{{infobox|'''Note: Choices are limited to ASCII strings and the values are limited to valid choices for this CVAR. See [[I18N]] for details and how to work around that limitation.'''}}

{{sdk}} [[Category:CVARS]]

Parallax mapping

2025-01-04T21:29:12Z

Stgatilov:

This article describes how to set up a material for parallax mapping, which was added in TDM 2.13.

=== Material ===

The new '''parallax stage''' is a part of an '''interaction group''', i.e. a group of stages which together define the reaction of the surface to the surrounding light sources.
This sample material contains only one interaction group that consists of diffuse, bump, and parallax stages (no specular):

textures/test/test_parallax
{
diffusemap textures/test_parallax/parallax_test2_d
bumpmap textures/test_parallax/parallax_test_local2
{
blend parallaxmap
map textures/test_parallax/parallax_test_height
min -0.2
max 0.0
}
}

Note that both height/parallax map (<tt>parallax_test_height</tt>) and normal/bump map (<tt>parallax_test_local2</tt>) are necessary!
Parallax stage alone only displaces the surface fragments according to the relief, but does not affect lighting in any way.
You need bump stage with matching normal map in order to make lighting behave properly according to the relief.

The <tt>min</tt> and <tt>max</tt> parameters specify how the colors in heightmap are converted into physical displacements.
In this specific case, fragments where heightmap = 1.0 (white) stay on the mesh geometry, while fragments where heightmap = 0.0 (black) are displaced inwards by 1/5 of texture tile length.

It is important to set correct value of (<tt>max</tt> - <tt>min</tt>), otherwise lighting will look incorrect.
Normally, you should get this number from the software when you bake height and normal maps.
And if you decide to change this value afterwards, then you need to rebake the normal map.

=== Amount of displacement ===

These parameters define the amount of displacements for full-black and full-white texels in the heightmap respectively:

min {expression} (default = -0.1)
max {expression} (default = 0.0)

Positive value corresponds to displacement along surface normal (outwards), while negative pushes the fragments in the opposite way (inwards).

The numbers specify the amount of displacement in UV space / in relative sense. If you have a quad of unit size which is covered by the texture exactly, then <tt>max = 0.35</tt> will displace full-white texels by 0.35. If the same quad is resized to 800 doom units, then <tt>max = 0.35</tt> will mean displacement by 0.35 * 800 = 280 doom units. So if you stretch the texture, the displacements are magnified proportionally in order to keep the match between heightmap and normalmap.

Generally speaking, the case <tt>max = 0</tt> and <tt>min < 0</tt> is the most useful, because it pushes the fragments inside the wall, which is usually solid and impassable by the player. Sometimes <tt>max > 0</tt> might make more sense, but special case should be taken to ensure the player cannot cross the relief.

These parameters are the most important, and you need to set at least one of them explicitly in most cases.

=== Falling shadows ===

Parallax mapping is a hack, the mesh geometry is still used for many purposes, even inside rendering.
For example, if you let a cubic crate case shadow onto parallax-mapped wall, the shadow edges are still straight lines by default, so the surface relief does not affect the shadows falling onto it.

This flag deforms the shadow falling onto the parallax-mapped surface according to the relief:

offsetExternalShadows {0 or 1} (default = 0)

However, it has two additional caveats:
# It does not work with stencil shadows.
# It also disables shadows cast by the parallax-mapped surface itself.

=== Grazing angles ===

The parallax algorithm does not work well under grazing viewing angles.
That's why the parallax effect is gradually reduced to zero for low angles.

It is controlled by the parameter:

grazingAngle {float} (default = 0.3)

The parallax gets flattened under view angles lower than this value in radians.

=== Quality and complexity ===

The engine uses simple Parallax Occlusion Mapping algorithm, which intersects a ray with height map per each fragment. The raycasting algorithm is approximate and can miss intersections sometimes. This usually results in visual artifacts along the silhouette edges of relief, which look like staircases.

===== Displacement =====

These parameters controls how many iterations are performed:

linearSteps {integer} (default = 20)
refineSteps {integer} (default = 5)

The first parameter is more important. Increasing it reduces the number of missed intersections, making raycasting more reliable but slower.
The second parameter makes detected intersections more precise, but does not help with missed intersections.

Normally, you should not touch this, but sometimes you might get away with low values without breakage.

===== Shadows =====

The self-shadows of parallax-mapped surface are rendered with special algorithm which involves raycasting again =)
This is how many linear iterations are performed when searching for shadow ray intersections:

shadowSteps {integer} (default = 20)

As usual, increasing it makes self-shadows more reliable but decreases performance.
If the number of shadow steps gets too low, then penumbra will become dithered, which can be annoying.

Setting shadowSteps = 0 completely disables self-shadows.

The following parameters defines how soft self-shadows are:

shadowSoftness {expression} (default = ?)

The default value is computed automatically from other parameters, and is around 0.005 if all the other parameters are at defaults.
Increasing softness can also help hide dithering from low shadowSteps.

=== Caveats ===

The edges of parallax-mapped material usually look weird, especially when you more camera around.
You can occlude the edges from the viewer with some other geometry. Or you can create such a heightmap which makes zero displacement on the edges.

As of now, parallax mapping only works on interactions, it does not affect the ambient stages of a material.

Parallax mapping

2025-01-04T21:28:54Z

Stgatilov:

Parallax mapping

2025-01-04T21:27:46Z

Stgatilov: /* Shadows */

This article describes how to set up a material for parallax mapping, which was added in TDM 2.13.

=== Material ===

The new '''parallax stage''' is a part of an '''interaction group''', i.e. a group of stages which together define the reaction of the surface to the surrounding light sources.
This sample material contains only one interaction group that consists of diffuse, bump, and parallax stages (no specular):

textures/test/test_parallax
{
diffusemap textures/test_parallax/parallax_test2_d
bumpmap textures/test_parallax/parallax_test_local2
{
blend parallaxmap
map textures/test_parallax/parallax_test_height
min -0.2
max 0.0
}
}

Note that both height/parallax map (<tt>parallax_test_height</tt>) and normal/bump map (<tt>parallax_test_local2</tt>) are necessary!
Parallax stage alone only displaces the surface fragments according to the relief, but does not affect lighting in any way.
You need bump stage with matching normal map in order to make lighting behave properly according to the relief.

The <tt>min</tt> and <tt>max</tt> parameters specify how the colors in heightmap are converted into physical displacements.
In this specific case, fragments where heightmap = 1.0 (white) stay on the mesh geometry, while fragments where heightmap = 0.0 (black) are displaced inwards by 1/5 of texture tile length.

It is important to set correct value of (<tt>max</tt> - <tt>min</tt>), otherwise lighting will look incorrect.
Normally, you should get this number from the software when you bake height and normal maps.
And if you decide to change this value afterwards, then you need to rebake the normal map.

=== Amount of displacement ===

These parameters define the amount of displacements for full-black and full-white texels in the heightmap respectively:

* min {expression} (default = -0.1)
* max {expression} (default = 0.0)

Positive value corresponds to displacement along surface normal (outwards), while negative pushes the fragments in the opposite way (inwards).

The numbers specify the amount of displacement in UV space / in relative sense. If you have a quad of unit size which is covered by the texture exactly, then <tt>max = 0.35</tt> will displace full-white texels by 0.35. If the same quad is resized to 800 doom units, then <tt>max = 0.35</tt> will mean displacement by 0.35 * 800 = 280 doom units. So if you stretch the texture, the displacements are magnified proportionally in order to keep the match between heightmap and normalmap.

Generally speaking, the case <tt>max = 0</tt> and <tt>min < 0</tt> is the most useful, because it pushes the fragments inside the wall, which is usually solid and impassable by the player. Sometimes <tt>max > 0</tt> might make more sense, but special case should be taken to ensure the player cannot cross the relief.

These parameters are the most important, and you need to set at least one of them explicitly in most cases.

=== Falling shadows ===

Parallax mapping is a hack, the mesh geometry is still used for many purposes, even inside rendering.
For example, if you let a cubic crate case shadow onto parallax-mapped wall, the shadow edges are still straight lines by default, so the surface relief does not affect the shadows falling onto it.

This flag deforms the shadow falling onto the parallax-mapped surface according to the relief:

* offsetExternalShadows {0 or 1} (default = 0)

However, it has two additional caveats:
# It does not work with stencil shadows.
# It also disables shadows cast by the parallax-mapped surface itself.

=== Grazing angles ===

The parallax algorithm does not work well under grazing viewing angles.
That's why the parallax effect is gradually reduced to zero for low angles.

It is controlled by the parameter:

* grazingAngle {float} (default = 0.3)

The parallax gets flattened under view angles lower than this value in radians.

=== Quality and complexity ===

The engine uses simple Parallax Occlusion Mapping algorithm, which intersects a ray with height map per each fragment. The raycasting algorithm is approximate and can miss intersections sometimes. This usually results in visual artifacts along the silhouette edges of relief, which look like staircases.

===== Displacement =====

These parameters controls how many iterations are performed:

* linearSteps {integer} (default = 20)
* refineSteps {integer} (default = 5)

The first parameter is more important. Increasing it reduces the number of missed intersections, making raycasting more reliable but slower.
The second parameter makes detected intersections more precise, but does not help with missed intersections.

Normally, you should not touch this, but sometimes you might get away with low values without breakage.

===== Shadows =====

The self-shadows of parallax-mapped surface are rendered with special algorithm which involves raycasting again =)
This is how many linear iterations are performed when searching for shadow ray intersections:

* shadowSteps {integer} (default = 20)

As usual, increasing it makes self-shadows more reliable but decreases performance.
If the number of shadow steps gets too low, then penumbra will become dithered, which can be annoying.

Setting shadowSteps = 0 completely disables self-shadows.

The following parameters defines how soft self-shadows are:

* shadowSoftness {expression} (default = ?)

The default value is computed automatically from other parameters, and is around 0.005 if all the other parameters are at defaults.
Increasing softness can also help hide dithering from low shadowSteps.

=== Caveats ===

The edges of parallax-mapped material usually look weird, especially when you more camera around.
You can occlude the edges from the viewer with some other geometry. Or you can create such a heightmap which makes zero displacement on the edges.

As of now, parallax mapping only works on interactions, it does not affect the ambient stages of a material.

Parallax mapping

2025-01-04T21:27:31Z

Stgatilov:

This article describes how to set up a material for parallax mapping, which was added in TDM 2.13.

=== Material ===

The new '''parallax stage''' is a part of an '''interaction group''', i.e. a group of stages which together define the reaction of the surface to the surrounding light sources.
This sample material contains only one interaction group that consists of diffuse, bump, and parallax stages (no specular):

textures/test/test_parallax
{
diffusemap textures/test_parallax/parallax_test2_d
bumpmap textures/test_parallax/parallax_test_local2
{
blend parallaxmap
map textures/test_parallax/parallax_test_height
min -0.2
max 0.0
}
}

Note that both height/parallax map (<tt>parallax_test_height</tt>) and normal/bump map (<tt>parallax_test_local2</tt>) are necessary!
Parallax stage alone only displaces the surface fragments according to the relief, but does not affect lighting in any way.
You need bump stage with matching normal map in order to make lighting behave properly according to the relief.

The <tt>min</tt> and <tt>max</tt> parameters specify how the colors in heightmap are converted into physical displacements.
In this specific case, fragments where heightmap = 1.0 (white) stay on the mesh geometry, while fragments where heightmap = 0.0 (black) are displaced inwards by 1/5 of texture tile length.

It is important to set correct value of (<tt>max</tt> - <tt>min</tt>), otherwise lighting will look incorrect.
Normally, you should get this number from the software when you bake height and normal maps.
And if you decide to change this value afterwards, then you need to rebake the normal map.

=== Amount of displacement ===

These parameters define the amount of displacements for full-black and full-white texels in the heightmap respectively:

* min {expression} (default = -0.1)
* max {expression} (default = 0.0)

Positive value corresponds to displacement along surface normal (outwards), while negative pushes the fragments in the opposite way (inwards).

The numbers specify the amount of displacement in UV space / in relative sense. If you have a quad of unit size which is covered by the texture exactly, then <tt>max = 0.35</tt> will displace full-white texels by 0.35. If the same quad is resized to 800 doom units, then <tt>max = 0.35</tt> will mean displacement by 0.35 * 800 = 280 doom units. So if you stretch the texture, the displacements are magnified proportionally in order to keep the match between heightmap and normalmap.

Generally speaking, the case <tt>max = 0</tt> and <tt>min < 0</tt> is the most useful, because it pushes the fragments inside the wall, which is usually solid and impassable by the player. Sometimes <tt>max > 0</tt> might make more sense, but special case should be taken to ensure the player cannot cross the relief.

These parameters are the most important, and you need to set at least one of them explicitly in most cases.

=== Falling shadows ===

Parallax mapping is a hack, the mesh geometry is still used for many purposes, even inside rendering.
For example, if you let a cubic crate case shadow onto parallax-mapped wall, the shadow edges are still straight lines by default, so the surface relief does not affect the shadows falling onto it.

This flag deforms the shadow falling onto the parallax-mapped surface according to the relief:

* offsetExternalShadows {0 or 1} (default = 0)

However, it has two additional caveats:
# It does not work with stencil shadows.
# It also disables shadows cast by the parallax-mapped surface itself.

=== Grazing angles ===

The parallax algorithm does not work well under grazing viewing angles.
That's why the parallax effect is gradually reduced to zero for low angles.

It is controlled by the parameter:

* grazingAngle {float} (default = 0.3)

The parallax gets flattened under view angles lower than this value in radians.

=== Quality and complexity ===

The engine uses simple Parallax Occlusion Mapping algorithm, which intersects a ray with height map per each fragment. The raycasting algorithm is approximate and can miss intersections sometimes. This usually results in visual artifacts along the silhouette edges of relief, which look like staircases.

===== Displacement =====

These parameters controls how many iterations are performed:

* linearSteps {integer} (default = 20)
* refineSteps {integer} (default = 5)

The first parameter is more important. Increasing it reduces the number of missed intersections, making raycasting more reliable but slower.
The second parameter makes detected intersections more precise, but does not help with missed intersections.

Normally, you should not touch this, but sometimes you might get away with low values without breakage.

===== Shadows =====

The self-shadows of parallax-mapped surface are rendered with special algorithm which involves raycasting again =)
This is how many linear iterations are performed when searching for shadow ray intersections:

* shadowSteps {integer} (default = 20)

As usual, increasing it makes self-shadows more reliable but decreases performance.
If the number of shadow steps gets too low, then penumbra will become dithered, which can be annoying.

Setting shadowSteps = 0 completely disables self-shadows.

The following parameters defines how soft self-shadows are:

* shadowSoftness {expression} (default = ?)

The default value is computed automatically from other parameters, and is around 0.005 if all the other parameters are at defaults.
Increasing softness can also help hide dithering from low shadowSteps.

=== Caveats ===

The edges of parallax-mapped material usually look weird, especially when you more camera around.
You can occlude the edges from the viewer with some other geometry. Or you can create such a heightmap which makes zero displacement on the edges.

As of now, parallax mapping only works on interactions, it does not affect the ambient stages of a material.

Parallax mapping

2025-01-04T21:27:11Z

Stgatilov: First version

This article describes how to set up a material for parallax mapping, which was added in TDM 2.13.

=== Material ===

The new '''parallax stage''' is a part of an '''interaction group''', i.e. a group of stages which together define the reaction of the surface to the surrounding light sources.
This sample material contains only one interaction group that consists of diffuse, bump, and parallax stages (no specular):

textures/test/test_parallax
{
diffusemap textures/test_parallax/parallax_test2_d
bumpmap textures/test_parallax/parallax_test_local2
{
blend parallaxmap
map textures/test_parallax/parallax_test_height
min -0.2
max 0.0
}
}

Note that both height/parallax map (<tt>parallax_test_height</tt>) and normal/bump map (<tt>parallax_test_local2</tt>) are necessary!
Parallax stage alone only displaces the surface fragments according to the relief, but does not affect lighting in any way.
You need bump stage with matching normal map in order to make lighting behave properly according to the relief.

The <tt>min</tt> and <tt>max</tt> parameters specify how the colors in heightmap are converted into physical displacements.
In this specific case, fragments where heightmap = 1.0 (white) stay on the mesh geometry, while fragments where heightmap = 0.0 (black) are displaced inwards by 1/5 of texture tile length.

It is important to set correct value of (<tt>max</tt> - <tt>min</tt>), otherwise lighting will look incorrect.
Normally, you should get this number from the software when you bake height and normal maps.
And if you decide to change this value afterwards, then you need to rebake the normal map.

=== Amount of displacement ===

These parameters define the amount of displacements for full-black and full-white texels in the heightmap respectively:

* min {expression} (default = -0.1)
* max {expression} (default = 0.0)

Positive value corresponds to displacement along surface normal (outwards), while negative pushes the fragments in the opposite way (inwards).

The numbers specify the amount of displacement in UV space / in relative sense. If you have a quad of unit size which is covered by the texture exactly, then <tt>max = 0.35</tt> will displace full-white texels by 0.35. If the same quad is resized to 800 doom units, then <tt>max = 0.35</tt> will mean displacement by 0.35 * 800 = 280 doom units. So if you stretch the texture, the displacements are magnified proportionally in order to keep the match between heightmap and normalmap.

Generally speaking, the case <tt>max = 0</tt> and <tt>min < 0</tt> is the most useful, because it pushes the fragments inside the wall, which is usually solid and impassable by the player. Sometimes <tt>max > 0</tt> might make more sense, but special case should be taken to ensure the player cannot cross the relief.

These parameters are the most important, and you need to set at least one of them explicitly in most cases.

=== Falling shadows ===

Parallax mapping is a hack, the mesh geometry is still used for many purposes, even inside rendering.
For example, if you let a cubic crate case shadow onto parallax-mapped wall, the shadow edges are still straight lines by default, so the surface relief does not affect the shadows falling onto it.

This flag deforms the shadow falling onto the parallax-mapped surface according to the relief:

* offsetExternalShadows {0 or 1} (default = 0)

However, it has two additional caveats:
# It does not work with stencil shadows.
# It also disables shadows cast by the parallax-mapped surface itself.

=== Grazing angles ===

The parallax algorithm does not work well under grazing viewing angles.
That's why the parallax effect is gradually reduced to zero for low angles.

It is controlled by the parameter:

* grazingAngle {float} (default = 0.3)

The parallax gets flattened under view angles lower than this value in radians.

=== Quality and complexity ===

The engine uses simple Parallax Occlusion Mapping algorithm, which intersects a ray with height map per each fragment. The raycasting algorithm is approximate and can miss intersections sometimes. This usually results in visual artifacts along the silhouette edges of relief, which look like staircases.

===== Displacement =====

These parameters controls how many iterations are performed:

* linearSteps {integer} (default = 20)
* refineSteps {integer} (default = 5)

The first parameter is more important. Increasing it reduces the number of missed intersections, making raycasting more reliable but slower.
The second parameter makes detected intersections more precise, but does not help with missed intersections.

Normally, you should not touch this, but sometimes you might get away with low values without breakage.

===== Shadows =====

The self-shadows of parallax-mapped surface are rendered with special algorithm which involves raycasting again =)
This is how many linear iterations are performed when searching for shadow ray intersections:

* shadowSteps {integer} (default = 20)

As usual, increasing it makes self-shadows more reliable but decreases performance.
If the number of shadow steps gets too low, then penumbra will become dithered, which can be annoying.

Setting shadowSteps = 0 completely disables self-shadows.

The following parameters defines how soft self-shadows are:

* shadowSoftness {expression} (default = ?)

The default value is computed automatically from other parameters, and is around 0.005 if all the other parameters are at defaults.
Increasing softness can also help hide dithering from low shadowSteps.

=== Caveats ===

The edges of parallax-mapped material usually look weird, especially when you more camera around.
You can occlude the edges from the viewer with some other geometry. Or you can create such a heightmap which makes zero displacement on the edges.

As of now, parallax mapping only works on interactions, it does not affect the ambient stages of a material.

TDM Script Reference

2025-01-01T19:36:07Z

Stgatilov: Regenerated script reference before 2.13 beta.

This page has been generated automatically by the tdm_gen_script_event_doc console command.

Generated by The Dark Mod 2.13, code revision 10920, last update: 2025-01-01 19:39

{{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 float '''acos'''(float cosine); ====

:Returns the angle in degrees with the given cosine.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''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_ItemRemove'', ''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'', ''idListener'', ''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 '''addFrobPeer'''(entity peer); ====

:Adds the passed entity as a frob peer.

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''angRotate'''(vector angles1, vector angles2); ====

:Rotates the given Euler angles by each other.

:Spawnclasses responding to this event: ''idThread''
==== 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 float '''asin'''(float sine); ====

:Returns the angle in degrees with the given sine.

:Spawnclasses responding to this event: ''idThread''
==== 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 '''attack'''(entity enemy, float ignoreCollisions); ====

:Direct the turret to manually attack the specified entity. Use disableManualAttack() to disable.
::''enemy'': enemy to attack
::''ignoreCollisions'': whether to ignore obstacles in the way to the enemy when planning to attack

:Spawnclasses responding to this event: ''idTurret''
==== 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 '''attackPosition'''(vector targetPos, float ignoreCollisions); ====

:Direct the turret to manually attack a position. Use disableManualAttack() to disable.
::''targetPos'': position to attack
::''ignoreCollisions'': whether to ignore obstacles in the way to the target position when planning to attack. Recommended true for this event.

:Spawnclasses responding to this event: ''idTurret''
==== 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 '''callFunctionsByWildcard'''(string functionName); ====

:Calls global functions with names matching the specified wildcard in separate threads (in lexicographical order). INTERNAL: don't use in mission scripting!

:Spawnclasses responding to this event: ''idThread''
==== 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'', ''idSecurityCamera''
==== 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 '''clearPersistentArgs'''(); ====

: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 '''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 '''disableManualAttack'''(); ====

:Stop attacking the manually specified enemy or position and return to automatic target acquisition mode.

:Spawnclasses responding to this event: ''idTurret''
==== 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 void '''flee'''(entity entToFleeFrom); ====

:Flee from the given entity.

:Spawnclasses responding to this event: ''idAI''
==== scriptEvent void '''fleeFromPoint'''(vector pos); ====

:Flee from the given position.

: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 '''getAnimList'''(float channel); ====

:Returns a list of all animations and their anim rates.

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

:Returns the rate for the given animation. Returns -1 if animation cannot be found.
::''animName'': The name of the animation.

:Spawnclasses responding to this event: ''idActor''
==== 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 '''getCalibratedLightgemValue'''(); ====

:Returns the calibrated light gem value.

: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 float '''getCurInvItemCount'''(); ====

:Returns the item count of the currently highlighted inventory Item, if stackable.Returns - 1 if non - stackable

: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 '''getcvarf'''(string name); ====

:Returns float value 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'', ''idSecurityCamera''
==== 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 float '''getEntityFlag'''(string flagName); ====

:Returns the value of the specified entity flag.
::''flagName'': Can be one of (case insensitive): notarget: if true never attack or target this entity noknockback: if true no knockback from hits takedamage: if true this entity can be damaged hidden: if true this entity is not visible bindOrientated: if true both the master orientation is used for binding solidForTeam: if true this entity is considered solid when a physics team mate pushes entities forcePhysicsUpdate: if true always update from the physics whether the object moved or not selected: if true the entity is selected for editing neverDormant: if true the entity never goes dormant isDormant: if true the entity is dormant hasAwakened: before a monster has been awakened the first time, use full PVS for dormant instead of area-connected invisible: if true this entity cannot be seen inaudible: if true this entity cannot be heard

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''GetFractionalPosition'''(); ====

:Returns a fraction between 0.00 (closed) and 1.00 (open).

:Spawnclasses responding to this event: ''CBinaryFrobMover''
==== 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: ''idEntity''
==== 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 '''getInterceptTime'''(vector velocityTarget, float speedInterceptor, vector positionTarget, vector positionInterceptor); ====

:Returns how much time it will take for an interceptor like a projectile to intercept a moving target at the earliest possible opportunity. Returns 0 if an intercept is not possible or the speed of the target and interceptor are too similar.
::''velocityTarget'': current velocity of target
::''speedInterceptor'': speed of interceptor
::''positionTarget'': current position of target
::''positionInterceptor'': starting position of interceptor

:Spawnclasses responding to this event: ''idThread''
==== 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 vector '''getListenLoc'''(); ====

:Retrieves the location of the listener when leaning.

:Spawnclasses responding to this event: ''idPlayer''
==== 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 '''getLocationPoint'''(vector point); ====

:Returns the idLocation entity corresponding to the specified point's location.
::''point'': point whose location to check

:Spawnclasses responding to this event: ''idThread''
==== 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 float '''getMaxHealth'''(); ====

:Gets the max health of this 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 secretsFound: number of secrets found by the player secretsTotal: total number of secrets in the mission

: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 '''getNextEnemy'''(entity lastMatch); ====

:Returns the next enemy that the security camera can see.
::''lastMatch'': search will start after this entity.Use $null_entity or pass an uninitialized entity variable to start a new search.The first result in a new search will be the player, if the camera can see him.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 float '''getObjectiveVisible'''(float ObjNum); ====

:Returns the current visibility of the objective with the number ObjNum.
::''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 '''getPersistentFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent string '''getPersistentString'''(string key); ====

:Returns the string for the given persistent arg

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent vector '''getPersistentVector'''(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 float '''getSecurityCameraState'''(); ====

:Returns the security camera's state. 1 = unalerted, 2 = suspicious, 3 = fully alerted, 4 = inactive, 5 = destroyed.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 entity '''getSpotLight'''(); ====

:Returns the spotlight used by the camera. Returns null_entity if none is used.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 string '''getTraceSurfType'''(); ====

:Returns the type of the surface (i.e. metal, snow) which was hit 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 float '''getTurretState'''(); ====

:Returns the turret's state. 0 = passive: no active security cameras connected. 1 = unalerted, 2 = suspicious, 3 = fully alerted, 4 = power off, 5 = destroyed.

:Spawnclasses responding to this event: ''idTurret''
==== 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 '''getVectorToIdealOrigin'''(); ====

:Returns the vector from where the AI is to where he ideally should be

:Spawnclasses responding to this event: ''idAI''
==== 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 '''hasInvItem'''(entity item); ====

:Tests whether the player has the specified item entity in his inventory.

: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 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 '''isAirborne'''(); ====

:Checks whether the player is in the air.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''isAtRest'''(); ====

:Returns true if object is not moving

:Spawnclasses responding to this event: ''idMoveable''
==== 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 '''isLeaning'''(); ====

:Get whether the player is leaning

:Spawnclasses responding to this event: ''idPlayer''
==== 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'', ''CFrobLock''
==== scriptEvent float '''isMoving'''(); ====

:Returns true if a mover is moving

:Spawnclasses responding to this event: ''idMover''
==== 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 '''isPeekLeaning'''(); ====

:Get whether the player is peek leaning (against a keyhole or crack)

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent float '''IsPickable'''(); ====

:Returns true (nonzero) if this frobmover is pickable.

:Spawnclasses responding to this event: ''CBinaryFrobMover'', ''CFrobLock''
==== 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 void '''launchGuided'''(vector start, vector dir, vector velocity, entity target); ====

:Launches the guided projectile from <start> in direction <dir> with the given <velocity> at <target entity>. Pass $null_entity to fire an unguided projectile.

:Spawnclasses responding to this event: ''idGuidedProjectile''
==== 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'', ''CFrobLock''
==== 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 '''max'''(float x, float y); ====

:returns the larger of two provided float values.

:Spawnclasses responding to this event: ''idThread''
==== 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 float '''min'''(float x, float y); ====

:returns the smaller of two provided float values.

:Spawnclasses responding to this event: ''idThread''
==== 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, but be sure to give it the topmost bindmaster

: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'''(); ====

:Switches the emitter off.

:Spawnclasses responding to this event: ''idFuncEmitter'', ''idLight'', ''idSecurityCamera'', ''idSound''
==== scriptEvent void '''offsetRelation'''(float team1, float team2, float val); ====

:No description

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

:Switches the emitter on.

:Spawnclasses responding to this event: ''idFuncEmitter'', ''idLight'', ''idSecurityCamera'', ''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); ====

:Do not use, this is part of TDM's internal mechanics. Use playCustomAnim() on AI.in scripts instead of this. Plays the given animation on the given channel. Returns false if anim doesn't exist.

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

:Plays the given animation on legs and torso. Returns false if anim doesn't exist.

:Spawnclasses responding to this event: ''idAI''
==== 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 '''pointIsInBounds'''(vector point, vector mins, vector maxs); ====

:Returns true if the point is within the bounds specified.
::''point'': test whether this point is in the bounds
::''mins'': minimal corner of the bounds
::''maxs'': maximal corner of the bounds

: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 '''projectDecal'''(vector traceOrigin, vector traceEnd, entity passEntity, string decal, float decalSize, float angle); ====

:Performs a trace from the specified origin and end positions, then projects a decal in that direction.
::''traceOrigin'': Start of the trace.
::''traceEnd'': End of the trace.
::''passEntity'': This entity will be considered non-solid by the trace.
::''decal'': Decal to be projected.
::''decalSize'': Size of the decal quad.
::''angle'': Angle of the decal quad.

:Spawnclasses responding to this event: ''idThread''
==== 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 '''removeFrobPeer'''(entity peer); ====

:Removes the passed entity as a frob peer.

: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 '''reskinCollisionModel'''(); ====

:For use after setSkin() on moveables and static models, if the CM needs to be refreshed to update surface properties after a skin change. CM will be regenerated from the original model file with the new skin.

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''saveConDump'''(string cmd, string cmd); ====

:Saves condump into FM directory; first argument is appended to dump filename, everything before last occurence of second argument is removed

:Spawnclasses responding to this event: ''idThread''
==== 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 '''setAirAccelerate'''(float newAccelerate); ====

:Sets a multiplier for the player's horizontal acceleration while airborne. Default is 1.0.

:Spawnclasses responding to this event: ''idPlayer''
==== 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 float '''setAnimRate'''(float channel, string animName, float animRate); ====

:Sets the animation rate to the given value. Returns 1 if successful, otherwise -1
::''animName'': The name of the animation.
::''animRate'': The rate to set the animation to.

: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). See also setColorVec for a variant that accepts a vector instead.
::''parm0'': red
::''parm1'': green
::''parm2'': blue

:Spawnclasses responding to this event: ''idEntity''
==== scriptEvent void '''setColorVec'''(vector newColor); ====

:Similar to setColor, but accepts the new RGB color as a vector instead of 3 different floats.

: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 '''setFrobActionScript'''(string frobActionScript); ====

:Changes the frob action script of this entity. Also updates the 'frob_action_script' spawnarg.
::''frobActionScript'': the new script to call when the entity is frobbed

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

:Sets the passed entity as the frob master. Pass null_entity to remove the current frob master, if any.

: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 '''setGravity'''(vector newGravity); ====

:Sets a new gravity vector for this entity. Note that non-upright vectors are poorly supported at present.

:Spawnclasses responding to this event: ''idEntity''
==== 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: ''idEntity''
==== 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 '''setMaxHealth'''(float maxHealth); ====

:Use these to set the max health of AI or players. Note that the health bar GUI is limited to showing a max health of 100. If health exceeds max health after this, health will be set to be equal to max health (which would also update the AI_DEAD flag)

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''setObjectiveNotification'''(float ObjNote); ====

:Turns the notifications (sound ++ text) for objectives on/off.
::''ObjNote'': Turn notifications on/off

: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 '''setPeekOverlayBackground'''(); ====

:Sets the background overlay for peeking, depending on aspect ratio.

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setPeekView'''(float OnOff, vector origin); ====

:Toggle whether we should use a view from a peek entity as the player's view

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent void '''setPersistentArg'''(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 '''setSecretsFound'''(float secrets); ====

:Set how many secrets the player has found. Use getMissionStatistic() for getting the current value.

:Spawnclasses responding to this event: ''idThread''
==== scriptEvent void '''setSecretsTotal'''(float secrets); ====

:Set how many secrets exist in the map in total. Use getMissionStatistic() for getting the current value.

:Spawnclasses responding to this event: ''idThread''
==== 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 '''setSightThreshold'''(float sightThreshold); ====

:Set the sight threshold of the security camera: how lit up the player's lightgem needs to be in order to be seen. 0.0 to 1.0

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 '''setSmoke'''(string particleDef); ====

:Changes the smoke particle of a func_smoke.

:Spawnclasses responding to this event: ''idFuncSmoke''
==== 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 '''setSolid'''(float solidity); ====

:Set the solidity of the entity. If the entity has never been solid before it will be assigned solid and opaque contents/clip masks.

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''setUsedBy'''(entity ent, float b_canUse); ====

:Allows to change which entities can use this entity.
::''ent'': specify an entity here, like a key
::''b_canUse'': whether the specified entity can use this entity

:Spawnclasses responding to this event: ''idEntity''
==== 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 '''state_light'''(float set); ====

:Switches the spotlight on or off. Respects the security camera's power state.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_see_AI'''(float set); ====

:Set whether the camera can see AIs.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_see_animals'''(float set); ====

:Set whether the camera can see animals. Checked after seeAI or seeBodies.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_see_bodies'''(float set); ====

:Set whether the camera can see bodies.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_see_player'''(float set); ====

:Set whether the camera can see the player.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''state_sweep'''(float set); ====

:Enables or disables the camera's sweeping.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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 '''StimEmit'''(float type, float radius, vector stimOrigin); ====

:Emits a stim in a radius around the specified origin. The entity from which this event is called needs to have the corresponding stim setup on itself, it does not need to be active.
::''type'': Index ID of the stim to emit, i.e. 21 or STIM_TRIGGER for a trigger stim.
::''radius'': How far the stim will reach. Pass negative to use the radius settings on the entity.
::''stimOrigin'': Emit the stim from here.

: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 '''StimSetScriptBased'''(float type, float state); ====

:Converts a stim to being script-based. It will only be emitted when a script calls StimEmit on the entity.
::''type'': Index ID of the stim to alter, i.e. 21 or STIM_TRIGGER for a trigger stim.
::''state'': New state.

: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 '''stopPatrol'''(); ====

:Stops an AI from patrolling

:Spawnclasses responding to this event: ''idAI''
==== 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 '''testEvent1'''(float float_pi, float int_beef, float float_exp, string string_tdm, float float_exp10, float int_food); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent entity '''testEvent2'''(float int_prevres, vector vec_123, float int_food, entity ent_player, entity ent_null, float float_pi, float float_exp); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== scriptEvent vector '''testEvent3'''(entity ent_prevres, vector vec_123, float float_pi, entity ent_player); ====

:No description

:Spawnclasses responding to this event: ''idPlayer''
==== 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 '''toggle_light'''(); ====

:Toggles the spotlight on/off.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_see_AI'''(); ====

:Toggles whether the camera can see AIs.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_see_animals'''(); ====

:Toggles whether the camera can see bodies. Checked after seeAI or seeBodies.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_see_bodies'''(); ====

:Toggles whether the camera can see bodies.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_see_player'''(); ====

:Toggles whether the camera can see the player.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== scriptEvent void '''toggle_sweep'''(); ====

:Toggles the camera sweep.

:Spawnclasses responding to this event: ''idSecurityCamera''
==== 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'', ''CFrobLock''
==== 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'', ''CFrobLock''
==== 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 '''VecRotate'''(vector vector, vector angles); ====

:Rotates a vector by the specified angles.

: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 ==
=== idClass ===
==== scriptEvent void '''remove'''(); ====

:Removes the entity from the game. For AI, use kill() instead.

=== 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 '''getAnimList'''(float channel); ====

:Returns a list of all animations and their anim rates.

==== scriptEvent float '''getAnimRate'''(float channel, string animName); ====

:Returns the rate for the given animation. Returns -1 if animation cannot be found.
::''animName'': The name of the animation.

==== 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 '''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); ====

:Do not use, this is part of TDM's internal mechanics. Use playCustomAnim() on AI.in scripts instead of this. 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 float '''setAnimRate'''(float channel, string animName, float animRate); ====

:Sets the animation rate to the given value. Returns 1 if successful, otherwise -1
::''animName'': The name of the animation.
::''animRate'': The rate to set the animation to.

==== 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 '''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 void '''flee'''(entity entToFleeFrom); ====

:Flee from the given entity.

==== scriptEvent void '''fleeFromPoint'''(vector pos); ====

:Flee from the given position.

==== 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 '''getVectorToIdealOrigin'''(); ====

:Returns the vector from where the AI is to where he ideally should be

==== 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 float '''playCustomAnim'''(string animName); ====

:Plays the given animation on legs and torso. Returns false if anim doesn't exist.

==== 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 '''stopPatrol'''(); ====

:Stops an AI from patrolling

==== 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 '''GetFractionalPosition'''(); ====

:Returns a fraction between 0.00 (closed) and 1.00 (open).

==== 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.

==== scriptEvent void '''Off'''(); ====

:Switches the emitter off.

==== scriptEvent void '''On'''(); ====

:Switches the emitter on.

=== 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 '''addFrobPeer'''(entity peer); ====

:Adds the passed entity as a frob peer.

==== 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 float '''getCurInvItemCount'''(); ====

:Returns the item count of the currently highlighted inventory Item, if stackable.Returns - 1 if non - stackable

==== 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 float '''getEntityFlag'''(string flagName); ====

:Returns the value of the specified entity flag.
::''flagName'': Can be one of (case insensitive): notarget: if true never attack or target this entity noknockback: if true no knockback from hits takedamage: if true this entity can be damaged hidden: if true this entity is not visible bindOrientated: if true both the master orientation is used for binding solidForTeam: if true this entity is considered solid when a physics team mate pushes entities forcePhysicsUpdate: if true always update from the physics whether the object moved or not selected: if true the entity is selected for editing neverDormant: if true the entity never goes dormant isDormant: if true the entity is dormant hasAwakened: before a monster has been awakened the first time, use full PVS for dormant instead of area-connected invisible: if true this entity cannot be seen inaudible: if true this entity cannot be heard

==== 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 '''getHealth'''(); ====

:Returns the current health.

==== 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 float '''getMaxHealth'''(); ====

:Gets the max health of this 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 '''hasInvItem'''(entity item); ====

:Tests whether the player has the specified item entity in his inventory.

==== 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 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, but be sure to give it the topmost bindmaster

==== 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 '''removeFrobPeer'''(entity peer); ====

:Removes the passed entity as a frob peer.

==== 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 '''reskinCollisionModel'''(); ====

:For use after setSkin() on moveables and static models, if the CM needs to be refreshed to update surface properties after a skin change. CM will be regenerated from the original model file with the new skin.

==== 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). See also setColorVec for a variant that accepts a vector instead.
::''parm0'': red
::''parm1'': green
::''parm2'': blue

==== scriptEvent void '''setColorVec'''(vector newColor); ====

:Similar to setColor, but accepts the new RGB color as a vector instead of 3 different floats.

==== 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 '''setFrobActionScript'''(string frobActionScript); ====

:Changes the frob action script of this entity. Also updates the 'frob_action_script' spawnarg.
::''frobActionScript'': the new script to call when the entity is frobbed

==== scriptEvent void '''setFrobMaster'''(entity master); ====

:Sets the passed entity as the frob master. Pass null_entity to remove the current frob master, if any.

==== scriptEvent void '''setGravity'''(vector newGravity); ====

:Sets a new gravity vector for this entity. Note that non-upright vectors are poorly supported at present.

==== 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 '''setHealth'''(float health); ====

:Use these to set the health of AI or players (this also updates the AI_DEAD flag)

==== 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 '''setMaxHealth'''(float maxHealth); ====

:Use these to set the max health of AI or players. Note that the health bar GUI is limited to showing a max health of 100. If health exceeds max health after this, health will be set to be equal to max health (which would also update the AI_DEAD flag)

==== 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 '''setSolid'''(float solidity); ====

:Set the solidity of the entity. If the entity has never been solid before it will be assigned solid and opaque contents/clip masks.

==== 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 '''setUsedBy'''(entity ent, float b_canUse); ====

:Allows to change which entities can use this entity.
::''ent'': specify an entity here, like a key
::''b_canUse'': whether the specified entity can use this entity

==== 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 '''StimEmit'''(float type, float radius, vector stimOrigin); ====

:Emits a stim in a radius around the specified origin. The entity from which this event is called needs to have the corresponding stim setup on itself, it does not need to be active.
::''type'': Index ID of the stim to emit, i.e. 21 or STIM_TRIGGER for a trigger stim.
::''radius'': How far the stim will reach. Pass negative to use the radius settings on the entity.
::''stimOrigin'': Emit the stim from here.

==== scriptEvent void '''StimEnable'''(float type, float state); ====

:No description
::''state'': 0 = disabled, 1 = enabled

==== scriptEvent void '''StimRemove'''(float type); ====

:No description

==== scriptEvent void '''StimSetScriptBased'''(float type, float state); ====

:Converts a stim to being script-based. It will only be emitted when a script calls StimEmit on the entity.
::''type'': Index ID of the stim to alter, i.e. 21 or STIM_TRIGGER for a trigger stim.
::''state'': New state.

==== 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 float '''IsLocked'''(); ====

:Returns true (nonzero) if the mover is currently locked.

==== 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 '''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.

=== 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)

=== 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'''(); ====

:Switches the emitter off.

==== scriptEvent void '''On'''(); ====

:Switches the emitter 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

=== idListener ===
==== scriptEvent void '''activate'''(entity activator); ====

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

=== 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)

==== scriptEvent void '''setSmoke'''(string particleDef); ====

:Changes the smoke particle of a func_smoke.

=== 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 float '''getCalibratedLightgemValue'''(); ====

:Returns the calibrated light gem value.

==== 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 vector '''getListenLoc'''(); ====

:Retrieves the location of the listener when leaning.

==== 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 float '''getObjectiveVisible'''(float ObjNum); ====

:Returns the current visibility of the objective with the number ObjNum.
::''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 float '''isAirborne'''(); ====

:Checks whether the player is in the air.

==== scriptEvent float '''isLeaning'''(); ====

:Get whether the player is leaning

==== scriptEvent float '''isPeekLeaning'''(); ====

:Get whether the player is peek leaning (against a keyhole or crack)

==== 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 '''setAirAccelerate'''(float newAccelerate); ====

:Sets a multiplier for the player's horizontal acceleration while airborne. Default is 1.0.

==== 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 '''setObjectiveNotification'''(float ObjNote); ====

:Turns the notifications (sound ++ text) for objectives on/off.
::''ObjNote'': Turn notifications on/off

==== 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 '''setPeekOverlayBackground'''(); ====

:Sets the background overlay for peeking, depending on aspect ratio.

==== scriptEvent void '''setPeekView'''(float OnOff, vector origin); ====

:Toggle whether we should use a view from a peek entity as the player's view

==== 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 float '''testEvent1'''(float float_pi, float int_beef, float float_exp, string string_tdm, float float_exp10, float int_food); ====

:No description

==== scriptEvent entity '''testEvent2'''(float int_prevres, vector vec_123, float int_food, entity ent_player, entity ent_null, float float_pi, float float_exp); ====

:No description

==== scriptEvent vector '''testEvent3'''(entity ent_prevres, vector vec_123, float float_pi, entity ent_player); ====

: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

=== idGuidedProjectile ===
==== scriptEvent void '''launchGuided'''(vector start, vector dir, vector velocity, entity target); ====

:Launches the guided projectile from <start> in direction <dir> with the given <velocity> at <target entity>. Pass $null_entity to fire an unguided projectile.

=== 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 float '''acos'''(float cosine); ====

:Returns the angle in degrees with the given cosine.

==== scriptEvent vector '''angRotate'''(vector angles1, vector angles2); ====

:Rotates the given Euler angles by each other.

==== 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 float '''asin'''(float sine); ====

:Returns the angle in degrees with the given sine.

==== 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 void '''callFunctionsByWildcard'''(string functionName); ====

:Calls global functions with names matching the specified wildcard in separate threads (in lexicographical order). INTERNAL: don't use in mission scripting!

==== 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 '''clearPersistentArgs'''(); ====

: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 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 '''getcvarf'''(string name); ====

:Returns float value 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 float '''getInterceptTime'''(vector velocityTarget, float speedInterceptor, vector positionTarget, vector positionInterceptor); ====

:Returns how much time it will take for an interceptor like a projectile to intercept a moving target at the earliest possible opportunity. Returns 0 if an intercept is not possible or the speed of the target and interceptor are too similar.
::''velocityTarget'': current velocity of target
::''speedInterceptor'': speed of interceptor
::''positionTarget'': current position of target
::''positionInterceptor'': starting position of interceptor

==== scriptEvent entity '''getLocationPoint'''(vector point); ====

:Returns the idLocation entity corresponding to the specified point's location.
::''point'': point whose location to check

==== 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 secretsFound: number of secrets found by the player secretsTotal: total number of secrets in the mission

==== 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 '''getPersistentFloat'''(string key); ====

:Returns the floating point value for the given persistent arg

==== scriptEvent string '''getPersistentString'''(string key); ====

:Returns the string for the given persistent arg

==== scriptEvent vector '''getPersistentVector'''(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 string '''getTraceSurfType'''(); ====

:Returns the type of the surface (i.e. metal, snow) which was hit 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 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 float '''max'''(float x, float y); ====

:returns the larger of two provided float values.

==== scriptEvent float '''min'''(float x, float y); ====

:returns the smaller of two provided float values.

==== 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 '''pointIsInBounds'''(vector point, vector mins, vector maxs); ====

:Returns true if the point is within the bounds specified.
::''point'': test whether this point is in the bounds
::''mins'': minimal corner of the bounds
::''maxs'': maximal corner of the bounds

==== 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 '''projectDecal'''(vector traceOrigin, vector traceEnd, entity passEntity, string decal, float decalSize, float angle); ====

:Performs a trace from the specified origin and end positions, then projects a decal in that direction.
::''traceOrigin'': Start of the trace.
::''traceEnd'': End of the trace.
::''passEntity'': This entity will be considered non-solid by the trace.
::''decal'': Decal to be projected.
::''decalSize'': Size of the decal quad.
::''angle'': Angle of the decal quad.

==== 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 '''saveConDump'''(string cmd, string cmd); ====

:Saves condump into FM directory; first argument is appended to dump filename, everything before last occurence of second argument is removed

==== 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 '''setPersistentArg'''(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 '''setSecretsFound'''(float secrets); ====

:Set how many secrets the player has found. Use getMissionStatistic() for getting the current value.

==== scriptEvent void '''setSecretsTotal'''(float secrets); ====

:Set how many secrets exist in the map in total. Use getMissionStatistic() for getting the current value.

==== 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 '''VecRotate'''(vector vector, vector angles); ====

:Rotates a vector by the specified angles.

==== 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.

=== idSecurityCamera ===
==== scriptEvent float '''canSee'''(entity ent); ====

:no description

==== scriptEvent entity '''getEnemy'''(); ====

:no description

==== scriptEvent entity '''getNextEnemy'''(entity lastMatch); ====

:Returns the next enemy that the security camera can see.
::''lastMatch'': search will start after this entity.Use $null_entity or pass an uninitialized entity variable to start a new search.The first result in a new search will be the player, if the camera can see him.

==== scriptEvent float '''getSecurityCameraState'''(); ====

:Returns the security camera's state. 1 = unalerted, 2 = suspicious, 3 = fully alerted, 4 = inactive, 5 = destroyed.

==== scriptEvent entity '''getSpotLight'''(); ====

:Returns the spotlight used by the camera. Returns null_entity if none is used.

==== scriptEvent void '''Off'''(); ====

:Switches the emitter off.

==== scriptEvent void '''On'''(); ====

:Switches the emitter on.

==== scriptEvent void '''setSightThreshold'''(float sightThreshold); ====

:Set the sight threshold of the security camera: how lit up the player's lightgem needs to be in order to be seen. 0.0 to 1.0

==== scriptEvent void '''state_light'''(float set); ====

:Switches the spotlight on or off. Respects the security camera's power state.

==== scriptEvent void '''state_see_AI'''(float set); ====

:Set whether the camera can see AIs.

==== scriptEvent void '''state_see_animals'''(float set); ====

:Set whether the camera can see animals. Checked after seeAI or seeBodies.

==== scriptEvent void '''state_see_bodies'''(float set); ====

:Set whether the camera can see bodies.

==== scriptEvent void '''state_see_player'''(float set); ====

:Set whether the camera can see the player.

==== scriptEvent void '''state_sweep'''(float set); ====

:Enables or disables the camera's sweeping.

==== scriptEvent void '''toggle_light'''(); ====

:Toggles the spotlight on/off.

==== scriptEvent void '''toggle_see_AI'''(); ====

:Toggles whether the camera can see AIs.

==== scriptEvent void '''toggle_see_animals'''(); ====

:Toggles whether the camera can see bodies. Checked after seeAI or seeBodies.

==== scriptEvent void '''toggle_see_bodies'''(); ====

:Toggles whether the camera can see bodies.

==== scriptEvent void '''toggle_see_player'''(); ====

:Toggles whether the camera can see the player.

==== scriptEvent void '''toggle_sweep'''(); ====

:Toggles the camera sweep.

=== 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'''(); ====

:Switches the emitter off.

==== scriptEvent void '''On'''(); ====

:Switches the emitter 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)

=== CTarget_ItemRemove ===
==== scriptEvent void '''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)

=== idTurret ===
==== scriptEvent void '''attack'''(entity enemy, float ignoreCollisions); ====

:Direct the turret to manually attack the specified entity. Use disableManualAttack() to disable.
::''enemy'': enemy to attack
::''ignoreCollisions'': whether to ignore obstacles in the way to the enemy when planning to attack

==== scriptEvent void '''attackPosition'''(vector targetPos, float ignoreCollisions); ====

:Direct the turret to manually attack a position. Use disableManualAttack() to disable.
::''targetPos'': position to attack
::''ignoreCollisions'': whether to ignore obstacles in the way to the target position when planning to attack. Recommended true for this event.

==== scriptEvent void '''disableManualAttack'''(); ====

:Stop attacking the manually specified enemy or position and return to automatic target acquisition mode.

==== scriptEvent float '''getTurretState'''(); ====

:Returns the turret's state. 0 = passive: no active security cameras connected. 1 = unalerted, 2 = suspicious, 3 = fully alerted, 4 = power off, 5 = destroyed.

=== 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); ====

:Do not use, this is part of TDM's internal mechanics. Use playCustomAnim() on AI.in scripts instead of this. 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]]

Mission Database

2024-07-17T18:41:41Z

Stgatilov: Some updates for unpacked missions

All released missions are stored in FM database, which defines what is available in mission downloader in-game.

= Requirements =

In order for a mission to be included in the database, it must satisfy the following conditions:
# It has gone through [[Your Mission - From Beta Testing to Release and Beyond|beta-testing]] by several forum members who did not take part in its creation.
#* As a rare exceptional case, a mission can be rejected from the database if the majority of beta-testers come to conclusion that it is unplayable or its quality is way too low.
# Does not contain any questionable material, potential intellectual property infridgements. Including:
#* using names from the original Thief games
#* using assets from other games
#* having content which is so bad that it is forbidden even on our forums ([https://forums.thedarkmod.com/index.php?/topic/16117-forum-rules/ link to forum rules])

A very few missions are installed along with the game, like Saint Lucia or Training Mission.
These official missions are considered to be part of the game, and are '''not''' included in the database.

= SVN =

Starting from 2021, the FM database is stored in SVN repository ([https://bugs.thedarkmod.com/view.php?id=5551 #5551]).
Only TDM team members have access to this SVN.

Here is the SVN address:
:: https://svn.thedarkmod.com/project/missions_unpacked/trunk/

'''But please don't rush to checkout the whole repo yet!'''

=== Checkout everything ===

Yes, you can simply copy the link above to SVN Checkout and get single working copy with all the FMs. But keep in mind that you will have to download ~35 GB of data and the working copy will take ~70 GB of space. In most cases you don't need everything in order to work with the database.

The typical reasons to checkout the whole repo are:
* You want to run automated search or tests over all released FMs.
* You are regular committer of the FM database, added a lot of new missions and updates, so the investment is worth it.

[[File:TortoiseSVN RepoBrowser.png|thumb|TortoiseSVN Repo-browser]]
[[File:FmDatabase_RepoBrowser.png|thumb|Accountant 2 FM in SVN]]

=== Checkout as needed ===

Instead of checking out the whole repo, you can checkout only the few FMs you are going to modify.
This is the recommended approach.

With this approach, you need the Repo-browser feature of TortoiseSVN.
It allows to look through all the directories and files on remote SVN without checking it out first.

The directory structure of SVN is show on the picture.
Most importantly, all information about FM with internal name "qwerty" is stored in <tt>fms/qwerty</tt> subdirectory of the repo.
You can checkout only this directory in order to work with FM, just put this checkout address:

:: https://svn.thedarkmod.com/project/missions_unpacked/trunk/fms/qwerty

Or find the FM directory in Repo-browser, right-click and select Checkout.

Detailed instructions in the rest of the article assume this approach.

= Add New Mission =

[[File:FmDatabase_AddDirectory.png|thumb|x100px|Add FM directory in Repo-browser]]
[[File:FmDatabase_FmCheckout.png|thumb|x80px|Checkout FM]]
[[File:FmDatabase_Commit2.png|thumb|x70px|Commit changes in FM directory]]
[[File:FmDatabase_CommitAddFiles.png|x120px|thumb|Add new files in Commit dialog]]
[[File:FmDatabase_PrecommitHookFailed.png|x120px|thumb|Precommit hook failed due to wrong value of "type"]]

Before adding new FM, negotiate internal name with FM author.
It must be different from names of all existing FMs, consist of only lowercase letters and digits, be rather short (aim for 10-20 letters).
Among many words in the mission title, prefer rare words and proper nouns over common words when composing the internal name.

Open SVN in Repo-browser, find </tt>fms</tt> directory which contains all the FMs.
Right-click on it and choose Add folder in the context menu.
Then enter the internal name of FM as the name of the new directory and proceed with commit.
Now that the directory has been created, you can checkout it: find the directory in Repo-browser, right-click it and Checkout.

The second step is to upload pk4 contents.
Create subdirectory named <tt>mission-name.pk4_dir</tt> under the mission checkout directory (replace mission-name with internal name).
Unpack all the pk4 files of FM pack into this subdirectory of the working copy directory (i.e. checkout directory).
Open the directory in Windows Explorer, right-click the parent folder and select SVN commit.
Select all files with Shift, right-click and select Add.
Also set checkboxes for these files.
Write commit message in the text area above: it should start with internal name of FM in brackets.
When everything is done, hit OK to do the actual commit.

While the pk4 contents are already in the repository, they are not yet visible in the database.
A mission is only added when its directory contains <tt>fminfo.xml</tt> file, so now you need to add it.
You can take this file from another FM (find it in Repo-browser, right-click, Open with, select text editor), and adjust it for the FM being added.
Here is explanation for some fields:
* '''internalName''' defines name of the directory and pk4 file.
* '''title''' is the name seen by players in-game.
* '''author''' is one or several people who made the mission.
* '''releaseDate''' shows when the very first version of the mission was added.
* '''type''' is <tt>multi</tt> if mission contains several playable .map files (i.e. is campaign), and <tt>single</tt> otherwise.
* '''size''' is size of the main pk4 file in megabytes displayed to users.
* '''version''' is natural number used by in-game downloader to decide whether update is available or not. Starts with 1.
* '''description''' contains text displayed in in-game downloader when player inspects mission details.
* '''mainPack''' points to the main pk4 file of the mission. Note that the name of file is fully determined by internal name.
* '''localisationPack''' points to _l10n.pk4 file if it exists.

Note that XML cannot directly contain some characters, thus they must be escaped:
* Ampersand (<tt>&amp;</tt>) quotes (<tt>&quot;</tt> or <tt>&apos;</tt>) and angle brackets (<tt>&lt;</tt> or <tt>&gt;</tt>): [https://stackoverflow.com/questions/1091945/what-characters-do-i-need-to-escape-in-xml-documents reference]
* Line break symbol can be inserted as <tt>&#10;</tt> according to [https://stackoverflow.com/questions/2004386/how-to-save-newlines-in-xml-attribute reference]
 Example:
<pre>

<fminfo>
<mission title="Closemouthed Shadows" releaseDate="2012-01-15" size="2.3" version="2" internalName="closemouthed_shadows" type="single" author="LordSavage, Bikerdude">
<description>Find Dougal's key, enter his place and kill him. Find the golden plate and key he stole from his neighbor. Get some loot including Lord Julian's Scepter.&#13;&#10;&#13;&#10;This is the original mission from 2008 (modified to run with TDM Version 1.07). Big thanks to b1k3rdude who has helped me to bring Closemouthed Shadows to TDM 1.07 (and improved some text and visuals).</description>
<mainPack filename="closemouthed_shadows.pk4"/>
<localisationPack filename="closemouthed_shadows_l10n.pk4"/>
</mission>
</fminfo>

</pre>

When you have created <tt>fminfo.xml</tt> file, double-check that all properties are correct.
Then use SVN to add and commit the file, just like you did with pk4 contents.

If you did something wrong (most likely), then you will see an error saying that "Commit blocked by pre-commit hook".
A long stacktrace from Python script is included, and the meaningful message should be at the end of it.
Typically, it is either XML validation error saying that something in fminfo.xml is wrong, or a message from some custom failed check.
You need to fix the errors and try to commit again --- until you manage to commit successfully.

As the last step, create subdirectory named <tt>screenshots</tt> in the working copy directory.
Put screenshots in .jpg or .png format into the directory: they will be displayed in in-game mission downloader.
Then add and commit all the screenshot files into the repository.

= Update Mission =

This section covers the case if mission has already been released, but new version should be uploaded.

First of all, make sure you have up-to-date working copy of the FM directory.
 If you already have working copy, do right-click and SVN Update in it in Windows Explorer.
 If you don't have it yet, then open Repo-browser, find the directory named by FM's internal name, right-click and select Checkout.
 If you don't know the internal name, you can learn it like this: install the FM in the game,
 then look what is written in the <tt>currentfm.txt</tt> file.
 Suppose internal name is "qwerty".
 If you know the author didn't remove any files from the new version, just extract the contents of the new PK4 to the query.pk4_dir and overwrite the contents.
 Then browse the sub-folders for any un-versioned new items ( usually will have a question mark indicator ) and right-click them and select SVN Add
 Then update the version number in the FM XML file as well as the file size
 Make sure no files or folders have spaces or special characters in their names
 Navigate to the parent directory of the querty folder and right-click querty then choose commit
 If the mission author removed files or you are unsure, you will need to compare the existing copy to the new version prior to merging
 For Windows users the program WinMerge is a good tool, Linux users can use "diff -r folderA, folderB"
 Identify additions and removals then overwrite the contents of the query.pk4_dir then perform SVN Add and SVN Delete actions to all relevant items
 Then update the FM XML and commit as described above

= RabbitVCS Steps =

Since TortoiseSVN does not have a Linux version, a good alternative is RabbitVCS.
 You will need to install the shell integration script that is compatible with your GUI File Manager
 If none exist you will need to install a secondary GUI File manager that is compatible with RabbitVCS integration

Here is a quick summary of the Mission management process on RabbitVCS

1) Create a parent folder such as mission-name_new

2) Inside the folder create a sub-folder named after the pk4 name ( eg if the mission name is elixir.pk4 the folder is "elixir" )

3) Insider the sub-folder will be 3 things:

An fminfo.xml with details about the mission ( see attached example)

A folder named "screenshots"

A folder named mission-name.pk4_dir which contains the unpacked data from the mission pack ( eg elixir.pk4_dir )

4) Right click on the parent folder and perform an SVN "Import" and choose https://svn.thedarkmod.com/project/missions_unpacked/trunk/fms/ as the Repository where you are importing

5) Visit the mission URL after the import has completed https://www.thedarkmod.com/missiondetails/?internalName=<mission-name> ( replace mission-name with whatever the pk4 name )

To update the mission it's best to delete the folder then create a new parent folder mission-name_update then perform an SVN checkout of https://svn.thedarkmod.com/project/missions_unpacked/trunk/fms/<mission-name>

Use "diff -r /path/to/checkout_dir/mission-name /path/to/extracted/new_pk4_folder/mission-name" in the console to identify changes

= References =
* Thread on developer subforum: https://forums.thedarkmod.com/index.php?/topic/20624-store-missions-archive-in-svn/
* Mission Database Management thread: https://forums.thedarkmod.com/index.php?/topic/11393-mission-archive-administration

What's new in TDM 2.12

2024-02-25T12:55:57Z

Stgatilov: Removed words in parentheses which were originally links.

{{notreleasedyet|2.12}}
See the [http://bugs.thedarkmod.com/roadmap_page.php roadmap] on our bugtracker.



 
'''The Dark Mod 2.12 Performance Edition!'''
 


 
A major focus for The Dark Mod 2.12 was to better handle light and shadow culling.
 Mappers often have to carefully arrange visportals and adjust light radius values to ensure
that invisible lights are not stealing performance from the scene.
 Many times such optimization work looks nonsensical or requires mappers to rebuild their scene until
they can make a sensible portal design.
 The new culling optimizations make TDM far more resilient to maps with poor portal design and bad lighting practices.
 With this new optimization in place, new mappers shouldn't need to reach out to veteran mappers for assistance with performance so often.
 
 A special thanks must go out to community member '''Geeps'''!
 Over the course of 2.12 development, this user has created Subtitles for nearly all AI barks
 along with developing testing tools and procedures for this gargantuan task!
 Geeps also provided substantial feedback for our GUI and Subtitle design process and edited font data to improve text quality overall
 
 Joebarnin identified a 2.11 bug that prevented arrows from colliding with AI and objects at certain angles and sent us a patch to fix it.
 Daft Mugi has taken on the task of improving movement, mantling, and frob operations to make them more seamless and closer to Thief 1/2 behavior
 Dragofer has added native support for Turrets to TDM 2.12, in addition to many asset and code change submissions



----
 

== '''Important CVARS''' ==

=== PLAYER ===
 
tdm_holdfrob_* --- set of variables that affect the reworked frob controls.

tdm_autosearch_bodies --- automatically take items attached to unconscious bodies on frob.

pm_headbob_mod, pm_lean_* --- allows to reduce some player movements.

{{clear}}

=== HELPER ===
 

tdm_show_viewpos, screenshot_viewpos --- embedding viewpos into screenshot for better bug reports.

tdm_open_doors, tdm_close_doors --- cheats to make mission testing faster.

{{clear}}

=== TROUBLESHOOTING ===
 

r_useLightPortalFlow, r_useLightPortalFlowCulling --- improved light-entity interaction culling. Most major effect on shadows. This cvar is responsible for causing light leaks with stencil shadows, please report all of them! (thread)

r_useNewRenderPasses --- selects from several renderer backend code paths. This is similar to the old r_useNewBackend cvar which has been deleted.

r_shadowMapSinglePass --- faster code path for filling shadow maps.

r_useEntityScissors, r_animationBounds --- improved bounds estimates for rendered entities.

r_postprocess_dither --- new dithering in tonemap postprocessing for less color banding.

r_shadowMapAlphaTested --- experimental mode for alpha-tested surfaces with shadow maps, where transparent areas of texture don't cast shadows.

s_realTimeDecoding --- selects code path for decoding sound samples.

tdm_subtitles_* --- many cvars for subtitle improvements (location cue, duration extension, debug text).

{{clear}}
 

== '''Graphics''' ==

* Optimized generation of light-entity interactions in rendering frontend. Also greatly optimized shadow processing, especially for moving lights. Unfortunately, many existing missions are not compatible with these changes, so you might see light leaking through walls (mainly with stencil shadows). Please report all such cases, we'll apply workaround on case by case basis.

* The "old" and "new" rendering backends are finally merged into one. It is as nice to program as the new backend, and as old-fashioned and reliable as the old backend. Single-pass shadow maps enabled by default and now respect noselfshadow.

* Materials with polygonoffset now interact with lights. So static decals can have bumpmap and specular lighting. Note however: dynamic decals still don't interact with lights.

* Revised parallelSky lights and marked shadowing parallel lights as deprecated.

* PNG image format now behaves equally to other supported formats. In particular, it is not required to explicitly specify its extension, and it can be referenced directly in GUI code.

* Added functions min/max to material expressions, which can be useful for clamping.

* Fixed minor culling bugs on animated entities and enabled entity scissors by default.

* Reduced color banding for fog with some dithering at tonemapping stage.

* Fixed and revised underwater "double vision" effect.

* Finally our C++ code can compress and decompress all texture formats we use, meaning that we no longer depend on occasionally buggy/slow vendor implementations.

{{clear}}
 

== '''AI''' ==

* Added automatic turrets, to be combined with security cameras (Thread).
* Fixed some issues with moor AI (6345).
* Added canCloseDoors spawnarg on AI, which allows to block closing only (6460).

{{clear}}
 

== '''Mapping''' ==

* Now light entities support noPortalFog spawnarg (6282).
* Extended dmap diagnostics to info_portalSettings, improved editor descriptions (6224).
* r_showportals 2 is easier to understand now
* Added r_skipEntities cvar, similar to "filter entities" in DR.
* Added editor spawnargs for volumetric light properties (6322).
* Added "forceShadowBehindOpaque" hack to workaround shadow leaks in old missions (5172).
* Can set spawnarg "douse 0" on damageDef to not extinguish lights from splash damage.
* Added setFrobMaster script event.
* Added script-based stim type, which triggers only when stimEmit script event is called.
* Added on/off script events to func_emitter entity.
* Added setSmoke script event to change particle decl for a func_smoke.
* Added hasInvItem script event to check if player has some item.
* Added launchGuided script event to start guided projectiles.
* Added getInterceptTime script event for shooting projectile and running target.
* Added "bounce_sound_min|max_velocity" spawnargs to control projectile bounce sounds.
* Added "postbounce_*" spawnargs to change projectile properties after bounce.
* Added mission.cfg as a temporary way for mission to override non-archived cvars (5453).

{{clear}}

== '''Coding''' ==

* Upgraded libpng and rebuilt third-party packages.
* Fixed some uninitialized values, float overflows and NaNs across the code.
* Now several script addons can coexist and work independently (thread).
* Default value of com_maxfps increased from 144 to 300.
* Improved idEntityPtr, fixed some warnings.
* Simplified flee script event, supported fleeing from non-actor entity and fleeFromPoint.
* CFrobLock now supports script events: Lock, Unlock, ToggleLock, IsLocked, IsPickable (6329).
* Added cvar to modify all head bobbing settings (6310).

{{clear}}
 

== '''Assets''' ==

* Added automatic turrets, to be combined with security cameras (Thread).

* Added more covered furniture models (6289).

* Added wall models from Seeking Lady Leicester (6293).

* New and fixed versions of atdm:lamp_electric_square_3_lit_unattached (6315).

* Fixed UV map on Stove models (6312).

* Added forest models from The Valley abandoned mission.

* Improved Merry Chest prefabs (6459).

* Improved normal map of long banners (6355).

* Fixed overbright skins for nature bushes (6478).

* Fixed Grandfather_clock_victorian_01 model (6383).

* Tweaked fogging of health potion.

{{clear}}
 

== '''Gameplay''' ==

* Frob controls have been reworked completely. Previously players were annoyed by having to do three presses to extinguish a light. Also, some player didn't even know that bodies could be shouldered and were limited with dragging bodies. Now simply clicking the frob button performs the action player needs most of the time, and pressing-and-holding the same button performs alternative actions like dragging bodies and extinguishing candles (thread).

* Several aspects of mantling has been improved: overhead mantling has become faster, mantling over low obstacles is allowed while carrying an item or a body. Also it is possible to switch weapon while being on rope/ladder or mantling. Pressing crouch button on rope/ladder now starts slide-down immediately.

* Some aspects of gameplay can be further simplified. Auto-search bodies is for players who don't want to waste time searching for keys and purses on guard bodies. Lockpicking "Auto" difficulty now indeed trivializes lockpicking (thread).

* Leaning animation has been improved with lower head tilt (thread).

* More settings to reduce camera bobbing/rolling/shaking, which is good for players who feel motion sickness from default camera animations.

* Added vine arrows to the Training Mission (4352).

* Optimized and fixed some issues with Tears of Saint Lucia

{{clear}}
 

== '''GUIs''' ==

* '''Subtitles have been added to all AI barks ( Courtesy of Geeps with a few additions by Datiswous and MirceaKitsune )'''

* Further improvements of subtitles: revised location and font to avoid overlapping with other GUI elements, added directional cue, better slot allocation. Each subtitle is now displayed for at least one second even if the sound is very short.

* Supported -durationExtend for inline subtitles (6262).

* Fixed text & background alignment in mission lists (6337)

* Support fonts aspect ratio correction (6283).

* Added 30 FPS option to max FPS selection in settings menu.

{{clear}}
 

== '''Sound''' ==

* Fixed bug that stereo sample plays for 2x duration due to length confusion.
* Fixed WAV sounds playing in main menu, all sounds are streaming now (6330)
* Fixed wench AI sounds (6284).
* Player footstep sounds have been rebalanced. Metal and water sounds were especially painful previously.
* Removed pause from looping sound machinery/machines/m3_loop (6384).
* Added EFX Reverb to the Training Mission

{{clear}}

{{whatsnew|sort=212}}

New light leaks in 2.12

2024-02-24T21:25:30Z

Stgatilov: soc3_sacricide fixed

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
|
-1283.53 -380.68 83.25 15.2 -38.6 0.0
-1044.74 -488.21 -74.51 0.1 89.2 0.0
-1354.18 -806.16 76.39 11.0 -149.0 0.0
-1077.75 240.02 -39.05 9.1 142.6 -0.0
-216.02 -157.15 74.66 -8.8 -43.7 -0.0
-86.51 380.53 87.05 -13.3 -65.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| svn rev 275: global workaround

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/page/3/#comment-492137 in beta212-06]

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| svn rev 274: workaround on func_static_46

|-
| gatehouse1_3
| -940.97 270.14 66.25 -3.97 146.34 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492373 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492510 other issue]

|}

New light leaks in 2.12

2024-02-24T21:16:48Z

Stgatilov: /* List of issues */

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
|
-1283.53 -380.68 83.25 15.2 -38.6 0.0
-1044.74 -488.21 -74.51 0.1 89.2 0.0
-1354.18 -806.16 76.39 11.0 -149.0 0.0
-1077.75 240.02 -39.05 9.1 142.6 -0.0
-216.02 -157.15 74.66 -8.8 -43.7 -0.0
-86.51 380.53 87.05 -13.3 -65.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/page/3/#comment-492137 in beta212-06]

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| svn rev 274: workaround on func_static_46

|-
| gatehouse1_3
| -940.97 270.14 66.25 -3.97 146.34 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492373 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492510 other issue]

|}

New light leaks in 2.12

2024-02-24T21:16:30Z

Stgatilov: /* List of issues */

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
|
-1283.53 -380.68 83.25 15.2 -38.6 0.0
-1044.74 -488.21 -74.51 0.1 89.2 0.0
-1354.18 -806.16 76.39 11.0 -149.0 0.0
-1077.75 240.02 -39.05 9.1 142.6 -0.0
-216.02 -157.15 74.66 -8.8 -43.7 -0.0
-86.51 380.53 87.05 -13.3 -65.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/page/3/#comment-492137 in beta212-06]

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| svn rev 274: workaround on func_static_46

|-
| gatehouse1_3
| -940.97 270.14 66.25 -3.97 146.34 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492373 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492510 other issue]

|}

New light leaks in 2.12

2024-02-24T21:16:17Z

Stgatilov: cos3: more locations

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
| -1283.53 -380.68 83.25 15.2 -38.6 0.0
-1044.74 -488.21 -74.51 0.1 89.2 0.0
-1354.18 -806.16 76.39 11.0 -149.0 0.0
-1077.75 240.02 -39.05 9.1 142.6 -0.0
-216.02 -157.15 74.66 -8.8 -43.7 -0.0
-86.51 380.53 87.05 -13.3 -65.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/page/3/#comment-492137 in beta212-06]

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| svn rev 274: workaround on func_static_46

|-
| gatehouse1_3
| -940.97 270.14 66.25 -3.97 146.34 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492373 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492510 other issue]

|}

New light leaks in 2.12

2024-02-24T20:46:02Z

Stgatilov: /* List of issues */

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
| -1283.53 -380.68 83.25 15.2 -38.6 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/page/3/#comment-492137 in beta212-06]

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| svn rev 274: workaround on func_static_46

|-
| gatehouse1_3
| -940.97 270.14 66.25 -3.97 146.34 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492373 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492510 other issue]

|}

New light leaks in 2.12

2024-02-24T20:18:00Z

Stgatilov:

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
| -1283.53 -380.68 83.25 15.2 -38.6 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/page/3/#comment-492137 in beta212-06]

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| svn rev 274: workaround on func_static_46

|-
| gatehouse1_3
| -940.97 270.14 66.25 -3.97 146.34 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492373 1]
| (not yet)

|}

New light leaks in 2.12

2024-02-24T20:13:58Z

Stgatilov: Fixed heartv2

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
| -1283.53 -380.68 83.25 15.2 -38.6 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/page/3/#comment-492137 in beta212-06]

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| svn rev 274: workaround on func_static_46

|-
| gatehouse1_3
| 940.97 270.14 66.25 -3.97 146.34 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492373 1]
| (not yet)

|}

New light leaks in 2.12

2024-02-11T12:26:29Z

Stgatilov: poets is fixed

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
| -1283.53 -380.68 83.25 15.2 -38.6 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/page/3/#comment-492137 in beta212-06]

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| (not yet)

|}

New light leaks in 2.12

2024-02-10T20:23:44Z

Stgatilov: ws2 fixed

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| svn rev 267: global workaround

|-
| cos3_sacricide
| -1283.53 -380.68 83.25 15.2 -38.6 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|-
| poets
| 1768.4 76.97 60.25 4.17 156.92 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22294-beta-testing-212/&do=findComment&comment=492045 1]
| (not yet)

|-
| heartv2
| 1736.48 3691.68 -137.75 -5.4 101.1 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=492047 1]
| (not yet)

|}

Profiling

2024-01-29T19:47:36Z

Stgatilov: Added reference to timeline profiler, added Windows sampling profiler instructions, deleted non-universal TIMING_BUILD and M_TIMINGS (use Tracy instead).

== Profiling ==

To find code parts that are too slow, The Dark Mod can be run under a profiler.

The two main types of profilers are:
* Sampling profiler: use platform tools
* Timeline profiler: see [[Tracy: timeline profiler]]

== Sampling ==

=== Windows ===

Sampling profiler is integrated into Visual C++ today:

* Run Release build of the game under debugger.
* Go to menu <tt>Debug -> Windows -> Diagnostic Tools</tt>.
* Switch to <tt>CPU Usage</tt> tab.
* Enable <tt>Record CPU Profile</tt> to start profiling.
* Break/pause execution to see profiling results since start. Preferably click on <tt>Open Details</tt>.

=== Linux ===

'''Note: This section is outdated!'''

==== gprof ====

gprof is part of the GNU tools just like gcc is, and is an application-level profiler.

To compile the TDM source for profiling, you can use

./linuxBuild BUILD=profile

Then run TDM normally:

cd .doom3/
./thedarkmod.x86

This will produce a file named "gmon.out", which can then after TDM exits, be analyzed with gprof:

gprof

For further information see the man page of <tt>gprof</tt>.

==== oprofile ====

Another method of profiling is by using '''oprofile'''. '''oprofile''' is a system-wide profiler, that can also profile the Linux kernel. It will by default profile everything that is running, so to avoid noise it is better to close as many applications (chat, Firefox etc) and shut down as many system services (f.i. Mysql, Postgres, Apache) as possible.

===== Preparing oprofile =====

* First, install the nec. packages:

sudo aptitude install oprofile oprofile-gui

The next step is not nec., so you could f.i. also profile a release build, however, the output will be less informative without symbols.

* Then, recompile the TDM source with debug to get symbol names.

./linuxBuild BUILD=debug

Note: '''"debug"''', not "release" nor "profile"!

There are two ways to use oprofile:

===== Using tdm_profile.sh =====

Instead of using tdm_launcher.linux, open a shell, change to the darkmod directory and run:

sudo ./tdm_profile.sh fm_name

where fm_name is a '''previously installed FM''', e.g. the directory it resides in, f.i:

sudo ./tdm_profile.sh builders_influence

It has not nec. to be the current installed FM, but it must have been installed already!

After loading a game, running around a bit and exiting TDM again, you can find a report in the file '''tdm_profile_report.txt''' inside the darkmod directory.

The disadvantage of this method is that you will also profile the mission load time, and for big missions that will easily swamp any work done during the mission run time unless you spent minutes there.

''' Sample output:'''

<pre>
CPU: AMD64 processors, speed 1800 MHz (estimated)
Counted CPU_CLK_UNHALTED events (Cycles outside of halt state) with a unit mask of 0x00 (No unit mask) count 100000
samples % image name app name symbol name
2034319 38.8674 doom.x86 doom.x86 /home/te/games/doom3/doom.x86
1303104 24.8969 libGLcore.so.185.18.36 doom.x86 /usr/lib32/libGLcore.so.185.18.36
154842 2.9584 libmozjs.so firefox /usr/lib/xulrunner-1.9.1.9/libmozjs.so
139323 2.6619 libasound_module_rate_speexrate.so doom.x86 /usr/lib32/alsa-lib/libasound_module_rate_speexrate.so
124850 2.3854 gamex86.so doom.x86 CImage::LoadImage(CRenderPipe*)
80195 1.5322 gamex86.so doom.x86 iReadLump
66593 1.2723 libxul.so firefox /usr/lib/xulrunner-1.9.1.9/libxul.so
62445 1.1931 gamex86.so doom.x86 idClip::ClipModelsTouchingBounds_r(clipSector_s const*, listParms_s&) const
56680 1.0829 zero doom.x86 /dev/zero
43315 0.8276 libc-2.10.1.so doom.x86 memcpy
41921 0.8009 libGLcore.so.185.18.36 kwin /usr/lib/libGLcore.so.185.18.36
38338 0.7325 firefox firefox /usr/lib/firefox-3.5.9/firefox
35118 0.6710 [vdso] (tgid:2583 range:0x7fffe1fff000-0x7fffe2000000) kwin [vdso] (tgid:2583 range:0x7fffe1fff000-0x7fffe2000000)
33020 0.6309 libc-2.10.1.so doom.x86 memset
30151 0.5761 gamex86.so doom.x86 idGameLocal::AnalyzeRenderImage(CRenderPipe*, float*)
27437 0.5242 no-vmlinux no-vmlinux /no-vmlinux
26936 0.5146 libasound.so.2.0.0 doom.x86 /usr/lib32/libasound.so.2.0.0
23572 0.4504 libQtCore.so.4.5.2 kwin /usr/lib/libQtCore.so.4.5.2
23031 0.4400 Xorg Xorg /usr/bin/Xorg
21347 0.4079 libQtGui.so.4.5.2 kdeinit4 /usr/lib/libQtGui.so.4.5.2
20301 0.3879 oprofiled oprofiled /usr/bin/oprofiled
19825 0.3788 gamex86.so doom.x86 idInterpreter::Execute()
19785 0.3780 libGL.so.185.18.36 doom.x86 /usr/lib32/libGL.so.185.18.36
19583 0.3742 gamex86.so doom.x86 idGameLocal::ProcessStimResponse(unsigned long)
18508 0.3536 nvidia_drv.so Xorg /usr/lib/xorg/modules/drivers/nvidia_drv.so
13580 0.2595 gamex86.so doom.x86 idGameLocal::RunFrame(usercmd_t const*)
</pre>

===== Using opcontrol manually =====

The '''opcontrol''' utility can be used to toggle the profiling on and off during runtime. Just start it, start TDM normally and after loading a mission, toggle back to a text-mode console with {{CTRL}}+{{ALT}}+{{F2}}, use:

opcontrol --init
opcontrol --start
opcontrol --reset

to start profiling, switch back to the desktop ({{CTRL}}+{{ALT}}+{{F7}}), then wait a bit, then turn profiling off again.

opcontrol --dump
opcontrol --stop
opreport --symbols --demangle=smart >tdm_profile_report.txt

''' Sample output:'''

After ack:

<pre>
samples % image name app name symbol name

67453 2.4265 gamex86.so doom.x86 CImage::LoadImage(CRenderPipe*)
42819 1.5403 gamex86.so doom.x86 iReadLump
31089 1.1184 gamex86.so doom.x86 idClip::ClipModelsTouchingBounds_r(clipSector_s const*, listParms_s&) const
16156 0.5812 gamex86.so doom.x86 idGameLocal::AnalyzeRenderImage(CRenderPipe*, float*)
10535 0.3790 gamex86.so doom.x86 idInterpreter::Execute()
10438 0.3755 gamex86.so doom.x86 idGameLocal::ProcessStimResponse(unsigned long)
7241 0.2605 gamex86.so doom.x86 idMD5Anim::GetInterpolatedFrame(frameBlend_t&, idJointQuat*, int const*, int) const
7134 0.2566 gamex86.so doom.x86 idGameLocal::RunFrame(usercmd_t const*)
6680 0.2403 gamex86.so doom.x86 idMoveable::Think()
5641 0.2029 gamex86.so doom.x86 idClipModel::Link_r(clipSector_s*)
5133 0.1846 gamex86.so doom.x86 idAnimator::CreateFrame(int, bool)
4836 0.1740 gamex86.so doom.x86 darkModLAS::updateLASState()
4725 0.1700 gamex86.so doom.x86 idQuat::Slerp(idQuat const&, idQuat const&, float)
4719 0.1698 gamex86.so doom.x86 idEntity::RunPhysics()
4501 0.1619 gamex86.so doom.x86 __i686.get_pc_thunk.bx
4365 0.1570 gamex86.so doom.x86 idSIMD_Generic::TransformJoints(idJointMat*, int const*, int, int)
4265 0.1534 gamex86.so doom.x86 idEntity::Present()
3844 0.1383 gamex86.so doom.x86 idStr::Icmp(char const*, char const*)
3755 0.1351 gamex86.so doom.x86 idAF::ChangePose(idEntity*, int)
3663 0.1318 gamex86.so doom.x86 idAnim::Name() const
3540 0.1273 gamex86.so doom.x86 idQuat::ToMat3() const
2953 0.1062 gamex86.so doom.x86 idInterpreter::CallEvent(function_t const*, int)
2755 0.0991 gamex86.so doom.x86 idEntity::Think()
2562 0.0922 gamex86.so doom.x86 idPhysics_RigidBody::SaveState()
2440 0.0878 gamex86.so doom.x86 idDict::FindKey(char const*) const
2429 0.0874 gamex86.so doom.x86 idIK_Walk::Evaluate()
2302 0.0828 gamex86.so doom.x86 idAnimator::SetJointAxis(jointHandle_t, jointModTransform_t, idMat3 const&)
</pre>

==== Tips ====

Use [http://search.cpan.org/~petdance/ack/ ack] (or grep) on the tdm_profile_report.txt to filter out anything not mentioning gamex86.so, this reduces the clutter:

ack gamex86.so tdm_profile_report.txt

== g_frametime ==

Set this [[CVAR]] to 1, and the code will emit how many milliseconds it took to do all the calculations for one frame, minus the render time. The output on the console will be something like this:

game 28080: all:0.2 th:0.2 ev:0.0 28 ents

The numbers are:

* game: The current frame time (always increasing from map start)
* all: The complete time to think + event handling
* th: The thinking time (without event handling)
* ev: The event handling time
* ents: The number of entities that did thinking

== g_timeentities ==

When set to > 0, shows entities whose <tt>Think()</tt> functions exceeded the number of milliseconds specified. Set it for instance to 2, and all entities that think longer than 2ms will be shown on the console.

== See also ==

* [[Coding in the SDK]]

{{coding}}

Reporting Problem

2024-01-29T19:14:44Z

Stgatilov: Added some new ways to get viewpos coordinates.

If TDM does not work properly for you, the best thing to do would be to report the problem.

You are welcome to post in Tech Support section of the [[The_Dark_Mod#Dark_Mod_Forums|forums]], even if you suspect the problem is with your machine or you want to get some help/clarifications.
When there is clearly a problem with TDM itself, an issue is usually created in the [[The_Dark_Mod#Bugtracker|bugtracker]].
But since the bugtracker is a rather technical place, it is more advised to report problems in the forum.
Sooner or later someone will create the issue anyway if it is really needed.

This article describes some general information typically requested from everyone who reports a problem.

== Baseline ==

This pieces of information are almost mandatory:

# Contents of <tt>darkmod.cfg</tt>.
# Contents of game console at some moment (known as "condump").
# In case of graphical issue, a screenshot showing the problem is often needed.

You can omit this information when writing a post on the forums: maybe your issue is trivial and someone will quickly explain what's wrong.
If it is not obvious, then you will soon be asked for it anyway =)

However, when creating an issue on the bugtracker, it is highly desirable to include all of these things, as well as the steps to reproduce.

=== darkmod.cfg ===

The file named <tt>darkmod.cfg</tt> should be located in the root directory of TDM installation.
If in doubt, you can locate this directory by checking what executable is run when you start the game: it is in the same directory.
Let's assume for the rest of the article that root directory is <tt>C:\games\thedarkmod</tt>

This file stores the values of all switches and tweaks that player can change.
The game may work in completely different ways depending on these values, thus they are very important for reproducing the problem.

When reporting the problem on forums, you can do one of:
* Attach it to a forum post. In this case rename it to something like <tt>darkmod_cfg.txt</tt>, the forum forbids anything except txt files.
* Copy/paste the full contents of the file into the post. In this case, please wrap it into "spoiler" tag, so that readers don't have to always scroll across the 5 pages of it.

When reporting on bugtracker, just attach the <tt>darkmod.cfg</tt> file to the issue.

=== condump ===

The term "condump" means all the text written to the game console.
You can usually open game console by pressing either Tilde(~) key or Ctrl+Alt+Tilde combo.

There are two ways to save the contents of game console into a file:

:'''1) condump.''' Open game console, type the following and hit Enter: <tt>condump unwrap my_nasty_issue</tt>
:Then find file named <tt>my_nasty_issue.txt</tt> in <tt>C:\games\thedarkmod</tt> (root TDM directory).
:Note: execute the command soon after the issue manifests itself.

:'''2) logfile.''' Open file <tt>darkmod.cfg</tt> in text editor.
:Find or create new line containing: <tt>seta logFile "?"</tt>
:Instead of the question mark, set digit 2 if you experience a crash. Otherwise digit 1 is also OK.
:Save the file, start TDM and reproduce the issue.
:Now find the file named <tt>qconsole.log</tt> in the directory of the currently installed FM, for instance in <tt>C:\games\thedarkmod\fms\newjob</tt>.

The first approach is better, but it is useless if TDM crashes or you cannot even get into game console.
In any of these cases, use the second approach.

When you have got the file, add it to your report just as you did with <tt>darkmod.cfg</tt>.

=== Screenshot ===

If something looks wrong for you, posting screenshot is a good thing to do.
Otherwise, the guy who tries to reproduce your issue and fails will have hard time guessing if he sees the same picture as you.
You can of course try to explain what you see with words, but it is vague and subjective.

There are two ways to get a screenshot:
# Press a key in-game (F12 by default). Then find the screenshot in <tt>C:\games\thedarkmod\screenshots</tt>
# Ensure that you run game in Windowed mode. Press Print-Screen key to copy screen to clipboard. Start Paint and paste (Ctrl+V) it there. Trim the TDM window in it and save.
The first approach is preferred, but sometimes it fails to capture the glitch.

When you want to share a picture on the forums, you can do one of:
* Add it as attachment to your forum post.
* Upload it to some free image hosting, and insert a link to it (click on Image icon) into the post. Surround the link/picture in spoiler tag (unless it is low-resolution) !

When reporting on bugtracker, simply attach the file to the issue and mention it somewhere in the text.

=== Coordinates ===

Typically, a problem happens in-game on at least one of the released fan missions. In such case, please write the name of the FM and the world coordinates where the problem happens.

In order to find world coordinates, execute <tt>getviewpos</tt> in the game console.
The coordinates will be printed in response: the first three are the coordinates, and the last three are the viewing angles. Copy them all to your report.
Since you cannot copy text directly from the game console, use [[Reporting Problem#condump|one of the methods described above to get a condump]].
In fact, it is a good idea to run <tt>getviewpos</tt> just before creating a condump.
By the way, you can execute <tt>setviewpos</tt> with these six arguments to teleport yourself to this specific location, e.g. to ensure that you have copied coords correctly.

Alternatively, you can set <tt>tdm_show_viewpos 1</tt> to display current coordinates on screen, so that they can be captured in screenshot.
Or you can call command <tt>screenshot_viewpos</tt> to make a special screenshot with coordinates visible on it.

== Advanced ==

Here are few more advanced tricks which may help debugging issues.

=== Crashdump ===

When TDM crashes, you can record a "memory dump" or "crash dump" of it.
It often contains information invaluable for coders, but it is only useful for debugging crashes.

The article [[Save a Memory Dump for debugging Crashes]] explains in detail how to record it.

=== Video ===

Some graphical issues are very obvious in dynamics, but when you take a still screenshot, it does not capture the tragedy well enough.

In such case you can record a video of the problem.
[https://obsproject.com/ Open Broadcast Software] is a free program which can easily record a high-quality and high-FPS game footage.
The program is quite complicated, but the main thing you need is to add a "source": either "Game Capture", or "Window Capture", or "Screen Capture".

When you have a video, you can either upload it to video hosting (like YouTube) and post a link, or upload it to cloud storage (like Google Drive) and post a shared link.
If you copy/paste a link to YouTube video into a forum post, the forum will show embedded player automatically.

=== Installation state ===

Sometimes there is a chance that your TDM installation is corrupt.
In such case it is great to give people a brief overview of it. 
Like generating a filelist of the gamefolder. 
 
To create a filelisting of the TDM gamefolder, in windows 10 

# Open file explorer, navigate to the tdm gamefolder.
# click "file" (menu) > "open in powershell" and a blue window will appear.
# Fill in the following command line in that window and hit the enter-key: dir /s > mytmdfolderandfiles.txt This command generate a textfile in your gamefolder.
# the content of this file mytmdfolderandfiles.txt you can give to people for research.
After this, just run the TDM installer to download the original files.

'''TODO''': write some simple way to get good textual representation of TDM installation directory.

Console Useful Controls

2024-01-29T19:10:19Z

Stgatilov: r_showSurfaceInfo added

==Introduction==

This is a list of common console commands and cvars that are of use to Dark Mod mappers and developers for testing etc. It is in order of key words and meaning. The console can be called by hitting "{{key|CTRL}}+{{key|ALT}}+{{key|~}}" ("{{key|CTRL}}+{{key|ALT}}+{{key|Key left of number 1}}" in general, e.g. "{{key|CTRL}}+{{key|ALT}}+{{key|^}}" on a German keyboard).

This will open the console to cover the upper 50% of the screen. To cover more (80%), also hold down the {{key|SHIFT}} key.

==Notes==

* Where a cvar or command is followed by a 1 (parameter) it can be taken that it is enabled by 1 and disabled by 0 unless otherwise stated. '''N''' indicates a range of values.
* The current value of a cvar can be shown by entering its name without a value.
* Parameters can be toggled between values by preceding the control with 'toggle' and following it with eg, 1 0. Example : toggle r_showtris 3 0
* Controls can be bound to keys to be used in-game, including the toggle command, eg, <tt>bind "v" "toggle r_showportals 1 0"</tt>
* Many controls can be included in the file '''Doomconfig.cfg''' in the darkmod folder so they are automatically effective.
* Some controls are disabled on exit from a map; others are permanent until manually changed.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|noclip
|Player flies through everything.

|-
!align=left|notarget
|AI will not know the player is there.

|-
!align=left|invisible
|AI will not see the player, but can still hear him.

|-
!align=left|inaudible
|AI will not hear the player, but can still see him.

|-
!align=left|god
|Player cannot be harmed.

|-
!align=left|killmonsters
|Removes all AI from a map.

|-
!align=left|tdm_open_doors
|Opens all doors on map: even locked and unpickable ones!

|-
!align=left|tdm_close_doors
|Closes all doors on map

|-
!align=left|tdm_show_loot
|Shows loot items through walls for a short time.

|-
!align=left|tdm_show_keys
|Shows keys through walls for a short time.

|-
!align=left|g_dragentity 1
|Aim at entity and hold attack control then pull back.

|-
!align=left|pm_noclipspeed N
|Changes the speed of player noclip movement.

|-
!align=left|g_fov N
|N=angle of field of view, eg, '''<code>g_fov 30</code>''' = zoom in to restrict field of view to 30 degrees. Default = 90.

|-
!align=left|g_showEntityInfo 1
|Show info about near entities (as box with classname).

|-
!align=left|com_showfps 1
|Show fps to test performance.

|-
!align=left|com_numQuickSaves N
|How many quicksaves to retain. Reducing the number won't delete any that you already have.

|-
!align=left|g_frametime 1
|Timing info for each frame, see [[Profiling#g_frametime|Profiling]].

|-
!align=left|r_showPrimitives 1
|Show info about number of [[drawcalls]] and tris/shadow tris rendered.

|-
!align=left|con_noprint 0
|Prints console messages to the screen as an overlay.

|-
!align=left|r_showSurfaceInfo 1
|Show info about closest rendered surface under crosshair: model name, index of surface in model, material name

|-
!align=left|r_showskel 1
|Shows skeleton in-game with joint names.

|-
!align=left|g_showCollisionModels 1
|Shows collision models. Use '''g_maxShowDistance N''' to increase the distance where they are shown to.

|-
!align=left|r_showtris N
|(1) Shows triangles being rendered directly. (2) Shows overdrawn tri's. (3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals N
|(1) Shows all portals in scene (red=closed, green=open). If your portals don't show up they are most likely not sealing. Yellow indicates a portal that is effectively closed but which connects to a visleaf visible through another portal.
(2) Also prints area numbers, mainly where player's eye is right now.

|-
!align=left|r_showlightcount 1
|Using colours, shows the number of lights hitting a surface, black = 0, red = 1, blue = 2... etc.

|-
!align=left|seta tdm_showsprop 1
|Shows the volume of sounds heard by AI.

|-
!align=left|tdm_ai_showbark 1
|Gives the def name (not the soundshader) of barks used by AI.

|-
!align=left|tdm_ai_showalert 1
|Shows the AI's current alert total and alert state.

|-
!align=left|tdm_ai_showdest 1
|Shows the AI's current path destination.

|-
!align=left|bind "f1" "_impulse27"
|Pressing F1 shows the AAS regions.

|-
!align=left|timescale 2
|Double speed, good for testing pathing, 1 = normal speed, 2 = double, 0.5 = half speed. To have an effect, the "Uncapped FPS" setting must be Off.

|-
!align=left|g_timeModifier 2
|Same as timescale 2 but somewhat different

|-
!align=left|g_stopTime 1
|Stops gameplay time, but player can move normally.

|-
!align=left|teleport "entity name"
|teleports the player to the named entity

|-
!align=left|teleportArea N
|teleports the player into the area with number N

|-
!align=left|getviewpos
|get player's position and orientation [[Reporting_Problem#Coordinates|coordinates]]

|-
!align=left|setviewpos X Y Z [P Y R]
|teleports the player to the coordinates and optionally sets camera orientation.

|}

== Spawning entities ==

Spawns entity in front of the player. Look up if entity gets spawned under the floor.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|spawn atdm:weapon_blackjack
|Spawns blackjack.

|-
!align=left|spawn atdm:weapon_shortsword
|Spawns a sword.

|-
!align=left|spawn atdm:ammo_broadhead
|Spawns one arrow.

|-
!align=left|spawn atdm:ammo_broadhead inv_ammo_amount 50
|Spawns 50 arrows (one entity with 50 ammo). Similar technique can be used for other ammo types.

|-
!align=left|spawn atdm:ammo_firearrow
|

|-
!align=left|spawn atdm:ammo_gasarrow
|

|-
!align=left|spawn atdm:ammo_mossarrow
|

|-
!align=left|spawn atdm:ammo_noisemaker
|

|-
!align=left|spawn atdm:ammo_ropearrow
|

|-
!align=left|spawn atdm:ammo_waterarrow
|

|}

With the TDM console you can press tab after typing something to autocomplete. For example <tt>spawn atdm:<tab></tt> will cycle through the various spawnables. You can also add additional spawnargs using the following syntax: <tt>spawn classname [key value] [key value] ...</tt>.

== Diagnostic information ==

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|listEntities
|lists all current entities followed by a count.

|-
!align=left|listEntities GLOB
|lists all alive entities whose names match given glob/wildcard (e.g. use asterisks like <tt>*func_static*</tt> to search for substring).

|-
!align=left|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!align=left|listCvars GLOB
|lists all cvars matching the given glob/wildcard (no argument = lists everything).

|-
!align=left|listCmds GLOB
|lists all console commands matching the given glob/wildcard (no argument = lists everything).

|-
!align=left|condump [unwrap] ''filename.txt''
|Writes the text content of the console to text file ''filename.txt'' (you can use any file name). If optional keyword ''unwrap'' is used, full lines from the console will be stitched together with the following line. Useful when exporting long file paths from the console, that have been broken up by its width limit. ''TDM 2.03+''

|}

==See Also==

[[Cvars in The Dark Mod]]

{{editing}}

[[Category:CVARS]]

Console Useful Controls

2024-01-29T19:02:22Z

Stgatilov: /* Diagnostic information */

==Introduction==

This is a list of common console commands and cvars that are of use to Dark Mod mappers and developers for testing etc. It is in order of key words and meaning. The console can be called by hitting "{{key|CTRL}}+{{key|ALT}}+{{key|~}}" ("{{key|CTRL}}+{{key|ALT}}+{{key|Key left of number 1}}" in general, e.g. "{{key|CTRL}}+{{key|ALT}}+{{key|^}}" on a German keyboard).

This will open the console to cover the upper 50% of the screen. To cover more (80%), also hold down the {{key|SHIFT}} key.

==Notes==

* Where a cvar or command is followed by a 1 (parameter) it can be taken that it is enabled by 1 and disabled by 0 unless otherwise stated. '''N''' indicates a range of values.
* The current value of a cvar can be shown by entering its name without a value.
* Parameters can be toggled between values by preceding the control with 'toggle' and following it with eg, 1 0. Example : toggle r_showtris 3 0
* Controls can be bound to keys to be used in-game, including the toggle command, eg, <tt>bind "v" "toggle r_showportals 1 0"</tt>
* Many controls can be included in the file '''Doomconfig.cfg''' in the darkmod folder so they are automatically effective.
* Some controls are disabled on exit from a map; others are permanent until manually changed.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|noclip
|Player flies through everything.

|-
!align=left|notarget
|AI will not know the player is there.

|-
!align=left|invisible
|AI will not see the player, but can still hear him.

|-
!align=left|inaudible
|AI will not hear the player, but can still see him.

|-
!align=left|god
|Player cannot be harmed.

|-
!align=left|killmonsters
|Removes all AI from a map.

|-
!align=left|tdm_open_doors
|Opens all doors on map: even locked and unpickable ones!

|-
!align=left|tdm_close_doors
|Closes all doors on map

|-
!align=left|tdm_show_loot
|Shows loot items through walls for a short time.

|-
!align=left|tdm_show_keys
|Shows keys through walls for a short time.

|-
!align=left|g_dragentity 1
|Aim at entity and hold attack control then pull back.

|-
!align=left|pm_noclipspeed N
|Changes the speed of player noclip movement.

|-
!align=left|g_fov N
|N=angle of field of view, eg, '''<code>g_fov 30</code>''' = zoom in to restrict field of view to 30 degrees. Default = 90.

|-
!align=left|g_showEntityInfo 1
|Show info about near entities (as box with classname).

|-
!align=left|com_showfps 1
|Show fps to test performance.

|-
!align=left|com_numQuickSaves N
|How many quicksaves to retain. Reducing the number won't delete any that you already have.

|-
!align=left|g_frametime 1
|Timing info for each frame, see [[Profiling#g_frametime|Profiling]].

|-
!align=left|r_showPrimitives 1
|Show info about number of [[drawcalls]] and tris/shadow tris rendered.

|-
!align=left|con_noprint 0
|Prints console messages to the screen as an overlay.

|-
!align=left|r_showskel 1
|Shows skeleton in-game with joint names.

|-
!align=left|g_showCollisionModels 1
|Shows collision models. Use '''g_maxShowDistance N''' to increase the distance where they are shown to.

|-
!align=left|r_showtris N
|(1) Shows triangles being rendered directly. (2) Shows overdrawn tri's. (3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals N
|(1) Shows all portals in scene (red=closed, green=open). If your portals don't show up they are most likely not sealing. Yellow indicates a portal that is effectively closed but which connects to a visleaf visible through another portal.
(2) Also prints area numbers, mainly where player's eye is right now.

|-
!align=left|r_showlightcount 1
|Using colours, shows the number of lights hitting a surface, black = 0, red = 1, blue = 2... etc.

|-
!align=left|seta tdm_showsprop 1
|Shows the volume of sounds heard by AI.

|-
!align=left|tdm_ai_showbark 1
|Gives the def name (not the soundshader) of barks used by AI.

|-
!align=left|tdm_ai_showalert 1
|Shows the AI's current alert total and alert state.

|-
!align=left|tdm_ai_showdest 1
|Shows the AI's current path destination.

|-
!align=left|bind "f1" "_impulse27"
|Pressing F1 shows the AAS regions.

|-
!align=left|timescale 2
|Double speed, good for testing pathing, 1 = normal speed, 2 = double, 0.5 = half speed. To have an effect, the "Uncapped FPS" setting must be Off.

|-
!align=left|g_timeModifier 2
|Same as timescale 2 but somewhat different

|-
!align=left|g_stopTime 1
|Stops gameplay time, but player can move normally.

|-
!align=left|teleport "entity name"
|teleports the player to the named entity

|-
!align=left|teleportArea N
|teleports the player into the area with number N

|-
!align=left|getviewpos
|get player's position and orientation [[Reporting_Problem#Coordinates|coordinates]]

|-
!align=left|setviewpos X Y Z [P Y R]
|teleports the player to the coordinates and optionally sets camera orientation.

|}

== Spawning entities ==

Spawns entity in front of the player. Look up if entity gets spawned under the floor.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|spawn atdm:weapon_blackjack
|Spawns blackjack.

|-
!align=left|spawn atdm:weapon_shortsword
|Spawns a sword.

|-
!align=left|spawn atdm:ammo_broadhead
|Spawns one arrow.

|-
!align=left|spawn atdm:ammo_broadhead inv_ammo_amount 50
|Spawns 50 arrows (one entity with 50 ammo). Similar technique can be used for other ammo types.

|-
!align=left|spawn atdm:ammo_firearrow
|

|-
!align=left|spawn atdm:ammo_gasarrow
|

|-
!align=left|spawn atdm:ammo_mossarrow
|

|-
!align=left|spawn atdm:ammo_noisemaker
|

|-
!align=left|spawn atdm:ammo_ropearrow
|

|-
!align=left|spawn atdm:ammo_waterarrow
|

|}

With the TDM console you can press tab after typing something to autocomplete. For example <tt>spawn atdm:<tab></tt> will cycle through the various spawnables. You can also add additional spawnargs using the following syntax: <tt>spawn classname [key value] [key value] ...</tt>.

== Diagnostic information ==

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|listEntities
|lists all current entities followed by a count.

|-
!align=left|listEntities GLOB
|lists all alive entities whose names match given glob/wildcard (e.g. use asterisks like <tt>*func_static*</tt> to search for substring).

|-
!align=left|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!align=left|listCvars GLOB
|lists all cvars matching the given glob/wildcard (no argument = lists everything).

|-
!align=left|listCmds GLOB
|lists all console commands matching the given glob/wildcard (no argument = lists everything).

|-
!align=left|condump [unwrap] ''filename.txt''
|Writes the text content of the console to text file ''filename.txt'' (you can use any file name). If optional keyword ''unwrap'' is used, full lines from the console will be stitched together with the following line. Useful when exporting long file paths from the console, that have been broken up by its width limit. ''TDM 2.03+''

|}

==See Also==

[[Cvars in The Dark Mod]]

{{editing}}

[[Category:CVARS]]

Console Useful Controls

2024-01-29T19:01:45Z

Stgatilov: listCvars and listCmds are important: they allow finding other cvars/cmds =)

==Introduction==

This is a list of common console commands and cvars that are of use to Dark Mod mappers and developers for testing etc. It is in order of key words and meaning. The console can be called by hitting "{{key|CTRL}}+{{key|ALT}}+{{key|~}}" ("{{key|CTRL}}+{{key|ALT}}+{{key|Key left of number 1}}" in general, e.g. "{{key|CTRL}}+{{key|ALT}}+{{key|^}}" on a German keyboard).

This will open the console to cover the upper 50% of the screen. To cover more (80%), also hold down the {{key|SHIFT}} key.

==Notes==

* Where a cvar or command is followed by a 1 (parameter) it can be taken that it is enabled by 1 and disabled by 0 unless otherwise stated. '''N''' indicates a range of values.
* The current value of a cvar can be shown by entering its name without a value.
* Parameters can be toggled between values by preceding the control with 'toggle' and following it with eg, 1 0. Example : toggle r_showtris 3 0
* Controls can be bound to keys to be used in-game, including the toggle command, eg, <tt>bind "v" "toggle r_showportals 1 0"</tt>
* Many controls can be included in the file '''Doomconfig.cfg''' in the darkmod folder so they are automatically effective.
* Some controls are disabled on exit from a map; others are permanent until manually changed.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|noclip
|Player flies through everything.

|-
!align=left|notarget
|AI will not know the player is there.

|-
!align=left|invisible
|AI will not see the player, but can still hear him.

|-
!align=left|inaudible
|AI will not hear the player, but can still see him.

|-
!align=left|god
|Player cannot be harmed.

|-
!align=left|killmonsters
|Removes all AI from a map.

|-
!align=left|tdm_open_doors
|Opens all doors on map: even locked and unpickable ones!

|-
!align=left|tdm_close_doors
|Closes all doors on map

|-
!align=left|tdm_show_loot
|Shows loot items through walls for a short time.

|-
!align=left|tdm_show_keys
|Shows keys through walls for a short time.

|-
!align=left|g_dragentity 1
|Aim at entity and hold attack control then pull back.

|-
!align=left|pm_noclipspeed N
|Changes the speed of player noclip movement.

|-
!align=left|g_fov N
|N=angle of field of view, eg, '''<code>g_fov 30</code>''' = zoom in to restrict field of view to 30 degrees. Default = 90.

|-
!align=left|g_showEntityInfo 1
|Show info about near entities (as box with classname).

|-
!align=left|com_showfps 1
|Show fps to test performance.

|-
!align=left|com_numQuickSaves N
|How many quicksaves to retain. Reducing the number won't delete any that you already have.

|-
!align=left|g_frametime 1
|Timing info for each frame, see [[Profiling#g_frametime|Profiling]].

|-
!align=left|r_showPrimitives 1
|Show info about number of [[drawcalls]] and tris/shadow tris rendered.

|-
!align=left|con_noprint 0
|Prints console messages to the screen as an overlay.

|-
!align=left|r_showskel 1
|Shows skeleton in-game with joint names.

|-
!align=left|g_showCollisionModels 1
|Shows collision models. Use '''g_maxShowDistance N''' to increase the distance where they are shown to.

|-
!align=left|r_showtris N
|(1) Shows triangles being rendered directly. (2) Shows overdrawn tri's. (3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals N
|(1) Shows all portals in scene (red=closed, green=open). If your portals don't show up they are most likely not sealing. Yellow indicates a portal that is effectively closed but which connects to a visleaf visible through another portal.
(2) Also prints area numbers, mainly where player's eye is right now.

|-
!align=left|r_showlightcount 1
|Using colours, shows the number of lights hitting a surface, black = 0, red = 1, blue = 2... etc.

|-
!align=left|seta tdm_showsprop 1
|Shows the volume of sounds heard by AI.

|-
!align=left|tdm_ai_showbark 1
|Gives the def name (not the soundshader) of barks used by AI.

|-
!align=left|tdm_ai_showalert 1
|Shows the AI's current alert total and alert state.

|-
!align=left|tdm_ai_showdest 1
|Shows the AI's current path destination.

|-
!align=left|bind "f1" "_impulse27"
|Pressing F1 shows the AAS regions.

|-
!align=left|timescale 2
|Double speed, good for testing pathing, 1 = normal speed, 2 = double, 0.5 = half speed. To have an effect, the "Uncapped FPS" setting must be Off.

|-
!align=left|g_timeModifier 2
|Same as timescale 2 but somewhat different

|-
!align=left|g_stopTime 1
|Stops gameplay time, but player can move normally.

|-
!align=left|teleport "entity name"
|teleports the player to the named entity

|-
!align=left|teleportArea N
|teleports the player into the area with number N

|-
!align=left|getviewpos
|get player's position and orientation [[Reporting_Problem#Coordinates|coordinates]]

|-
!align=left|setviewpos X Y Z [P Y R]
|teleports the player to the coordinates and optionally sets camera orientation.

|}

== Spawning entities ==

Spawns entity in front of the player. Look up if entity gets spawned under the floor.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|spawn atdm:weapon_blackjack
|Spawns blackjack.

|-
!align=left|spawn atdm:weapon_shortsword
|Spawns a sword.

|-
!align=left|spawn atdm:ammo_broadhead
|Spawns one arrow.

|-
!align=left|spawn atdm:ammo_broadhead inv_ammo_amount 50
|Spawns 50 arrows (one entity with 50 ammo). Similar technique can be used for other ammo types.

|-
!align=left|spawn atdm:ammo_firearrow
|

|-
!align=left|spawn atdm:ammo_gasarrow
|

|-
!align=left|spawn atdm:ammo_mossarrow
|

|-
!align=left|spawn atdm:ammo_noisemaker
|

|-
!align=left|spawn atdm:ammo_ropearrow
|

|-
!align=left|spawn atdm:ammo_waterarrow
|

|}

With the TDM console you can press tab after typing something to autocomplete. For example <tt>spawn atdm:<tab></tt> will cycle through the various spawnables. You can also add additional spawnargs using the following syntax: <tt>spawn classname [key value] [key value] ...</tt>.

== Diagnostic information ==

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|listCvars GLOB
|lists all cvars matching the given glob/wildcard (no argument = lists everything).

|-
!align=left|listCmds GLOB
|lists all console commands matching the given glob/wildcard (no argument = lists everything).

|-
!align=left|listEntities
|lists all current entities followed by a count.

|-
!align=left|listEntities GLOB
|lists all alive entities whose names match given glob/wildcard (e.g. use asterisks like <tt>*func_static*</tt> to search for substring).

|-
!align=left|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!align=left|condump [unwrap] ''filename.txt''
|Writes the text content of the console to text file ''filename.txt'' (you can use any file name). If optional keyword ''unwrap'' is used, full lines from the console will be stitched together with the following line. Useful when exporting long file paths from the console, that have been broken up by its width limit. ''TDM 2.03+''

|}

==See Also==

[[Cvars in The Dark Mod]]

{{editing}}

[[Category:CVARS]]

Console Useful Controls

2024-01-29T18:53:29Z

Stgatilov: listEntities accepts glob filter for entity name

==Introduction==

This is a list of common console commands and cvars that are of use to Dark Mod mappers and developers for testing etc. It is in order of key words and meaning. The console can be called by hitting "{{key|CTRL}}+{{key|ALT}}+{{key|~}}" ("{{key|CTRL}}+{{key|ALT}}+{{key|Key left of number 1}}" in general, e.g. "{{key|CTRL}}+{{key|ALT}}+{{key|^}}" on a German keyboard).

This will open the console to cover the upper 50% of the screen. To cover more (80%), also hold down the {{key|SHIFT}} key.

==Notes==

* Where a cvar or command is followed by a 1 (parameter) it can be taken that it is enabled by 1 and disabled by 0 unless otherwise stated. '''N''' indicates a range of values.
* The current value of a cvar can be shown by entering its name without a value.
* Parameters can be toggled between values by preceding the control with 'toggle' and following it with eg, 1 0. Example : toggle r_showtris 3 0
* Controls can be bound to keys to be used in-game, including the toggle command, eg, <tt>bind "v" "toggle r_showportals 1 0"</tt>
* Many controls can be included in the file '''Doomconfig.cfg''' in the darkmod folder so they are automatically effective.
* Some controls are disabled on exit from a map; others are permanent until manually changed.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|noclip
|Player flies through everything.

|-
!align=left|notarget
|AI will not know the player is there.

|-
!align=left|invisible
|AI will not see the player, but can still hear him.

|-
!align=left|inaudible
|AI will not hear the player, but can still see him.

|-
!align=left|god
|Player cannot be harmed.

|-
!align=left|killmonsters
|Removes all AI from a map.

|-
!align=left|tdm_open_doors
|Opens all doors on map: even locked and unpickable ones!

|-
!align=left|tdm_close_doors
|Closes all doors on map

|-
!align=left|tdm_show_loot
|Shows loot items through walls for a short time.

|-
!align=left|tdm_show_keys
|Shows keys through walls for a short time.

|-
!align=left|g_dragentity 1
|Aim at entity and hold attack control then pull back.

|-
!align=left|pm_noclipspeed N
|Changes the speed of player noclip movement.

|-
!align=left|g_fov N
|N=angle of field of view, eg, '''<code>g_fov 30</code>''' = zoom in to restrict field of view to 30 degrees. Default = 90.

|-
!align=left|g_showEntityInfo 1
|Show info about near entities (as box with classname).

|-
!align=left|com_showfps 1
|Show fps to test performance.

|-
!align=left|com_numQuickSaves N
|How many quicksaves to retain. Reducing the number won't delete any that you already have.

|-
!align=left|g_frametime 1
|Timing info for each frame, see [[Profiling#g_frametime|Profiling]].

|-
!align=left|r_showPrimitives 1
|Show info about number of [[drawcalls]] and tris/shadow tris rendered.

|-
!align=left|con_noprint 0
|Prints console messages to the screen as an overlay.

|-
!align=left|r_showskel 1
|Shows skeleton in-game with joint names.

|-
!align=left|g_showCollisionModels 1
|Shows collision models. Use '''g_maxShowDistance N''' to increase the distance where they are shown to.

|-
!align=left|r_showtris N
|(1) Shows triangles being rendered directly. (2) Shows overdrawn tri's. (3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals N
|(1) Shows all portals in scene (red=closed, green=open). If your portals don't show up they are most likely not sealing. Yellow indicates a portal that is effectively closed but which connects to a visleaf visible through another portal.
(2) Also prints area numbers, mainly where player's eye is right now.

|-
!align=left|r_showlightcount 1
|Using colours, shows the number of lights hitting a surface, black = 0, red = 1, blue = 2... etc.

|-
!align=left|seta tdm_showsprop 1
|Shows the volume of sounds heard by AI.

|-
!align=left|tdm_ai_showbark 1
|Gives the def name (not the soundshader) of barks used by AI.

|-
!align=left|tdm_ai_showalert 1
|Shows the AI's current alert total and alert state.

|-
!align=left|tdm_ai_showdest 1
|Shows the AI's current path destination.

|-
!align=left|bind "f1" "_impulse27"
|Pressing F1 shows the AAS regions.

|-
!align=left|timescale 2
|Double speed, good for testing pathing, 1 = normal speed, 2 = double, 0.5 = half speed. To have an effect, the "Uncapped FPS" setting must be Off.

|-
!align=left|g_timeModifier 2
|Same as timescale 2 but somewhat different

|-
!align=left|g_stopTime 1
|Stops gameplay time, but player can move normally.

|-
!align=left|teleport "entity name"
|teleports the player to the named entity

|-
!align=left|teleportArea N
|teleports the player into the area with number N

|-
!align=left|getviewpos
|get player's position and orientation [[Reporting_Problem#Coordinates|coordinates]]

|-
!align=left|setviewpos X Y Z [P Y R]
|teleports the player to the coordinates and optionally sets camera orientation.

|}

== Spawning entities ==

Spawns entity in front of the player. Look up if entity gets spawned under the floor.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|spawn atdm:weapon_blackjack
|Spawns blackjack.

|-
!align=left|spawn atdm:weapon_shortsword
|Spawns a sword.

|-
!align=left|spawn atdm:ammo_broadhead
|Spawns one arrow.

|-
!align=left|spawn atdm:ammo_broadhead inv_ammo_amount 50
|Spawns 50 arrows (one entity with 50 ammo). Similar technique can be used for other ammo types.

|-
!align=left|spawn atdm:ammo_firearrow
|

|-
!align=left|spawn atdm:ammo_gasarrow
|

|-
!align=left|spawn atdm:ammo_mossarrow
|

|-
!align=left|spawn atdm:ammo_noisemaker
|

|-
!align=left|spawn atdm:ammo_ropearrow
|

|-
!align=left|spawn atdm:ammo_waterarrow
|

|}

With the TDM console you can press tab after typing something to autocomplete. For example <tt>spawn atdm:<tab></tt> will cycle through the various spawnables. You can also add additional spawnargs using the following syntax: <tt>spawn classname [key value] [key value] ...</tt>.

== Diagnostic information ==

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|listEntities
|lists all current entities followed by a count.

|-
!align=left|listEntities GLOB
|lists all alive entities whose names match given glob/wildcard (e.g. use asterisks like <tt>*func_static*</tt> to search for substring).

|-
!align=left|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!align=left|condump [unwrap] ''filename.txt''
|Writes the text content of the console to text file ''filename.txt'' (you can use any file name). If optional keyword ''unwrap'' is used, full lines from the console will be stitched together with the following line. Useful when exporting long file paths from the console, that have been broken up by its width limit. ''TDM 2.03+''

|}

==See Also==

[[Cvars in The Dark Mod]]

{{editing}}

[[Category:CVARS]]

Console Useful Controls

2024-01-29T17:43:34Z

Stgatilov: Added tdm_open/close_doors, r_showPortals 2, teleportArea, g_stopTime + minor fixes.

==Introduction==

This is a list of common console commands and cvars that are of use to Dark Mod mappers and developers for testing etc. It is in order of key words and meaning. The console can be called by hitting "{{key|CTRL}}+{{key|ALT}}+{{key|~}}" ("{{key|CTRL}}+{{key|ALT}}+{{key|Key left of number 1}}" in general, e.g. "{{key|CTRL}}+{{key|ALT}}+{{key|^}}" on a German keyboard).

This will open the console to cover the upper 50% of the screen. To cover more (80%), also hold down the {{key|SHIFT}} key.

==Notes==

* Where a cvar or command is followed by a 1 (parameter) it can be taken that it is enabled by 1 and disabled by 0 unless otherwise stated. '''N''' indicates a range of values.
* The current value of a cvar can be shown by entering its name without a value.
* Parameters can be toggled between values by preceding the control with 'toggle' and following it with eg, 1 0. Example : toggle r_showtris 3 0
* Controls can be bound to keys to be used in-game, including the toggle command, eg, <tt>bind "v" "toggle r_showportals 1 0"</tt>
* Many controls can be included in the file '''Doomconfig.cfg''' in the darkmod folder so they are automatically effective.
* Some controls are disabled on exit from a map; others are permanent until manually changed.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|noclip
|Player flies through everything.

|-
!align=left|notarget
|AI will not know the player is there.

|-
!align=left|invisible
|AI will not see the player, but can still hear him.

|-
!align=left|inaudible
|AI will not hear the player, but can still see him.

|-
!align=left|god
|Player cannot be harmed.

|-
!align=left|killmonsters
|Removes all AI from a map.

|-
!align=left|tdm_open_doors
|Opens all doors on map: even locked and unpickable ones!

|-
!align=left|tdm_close_doors
|Closes all doors on map

|-
!align=left|tdm_show_loot
|Shows loot items through walls for a short time.

|-
!align=left|tdm_show_keys
|Shows keys through walls for a short time.

|-
!align=left|g_dragentity 1
|Aim at entity and hold attack control then pull back.

|-
!align=left|pm_noclipspeed N
|Changes the speed of player noclip movement.

|-
!align=left|g_fov N
|N=angle of field of view, eg, '''<code>g_fov 30</code>''' = zoom in to restrict field of view to 30 degrees. Default = 90.

|-
!align=left|g_showEntityInfo 1
|Show info about near entities (as box with classname).

|-
!align=left|com_showfps 1
|Show fps to test performance.

|-
!align=left|com_numQuickSaves N
|How many quicksaves to retain. Reducing the number won't delete any that you already have.

|-
!align=left|g_frametime 1
|Timing info for each frame, see [[Profiling#g_frametime|Profiling]].

|-
!align=left|r_showPrimitives 1
|Show info about number of [[drawcalls]] and tris/shadow tris rendered.

|-
!align=left|con_noprint 0
|Prints console messages to the screen as an overlay.

|-
!align=left|r_showskel 1
|Shows skeleton in-game with joint names.

|-
!align=left|g_showCollisionModels 1
|Shows collision models. Use '''g_maxShowDistance N''' to increase the distance where they are shown to.

|-
!align=left|r_showtris N
|(1) Shows triangles being rendered directly. (2) Shows overdrawn tri's. (3) Shows all tri's in scene, direct and indirect.

|-
!align=left|r_showportals N
|(1) Shows all portals in scene (red=closed, green=open). If your portals don't show up they are most likely not sealing. Yellow indicates a portal that is effectively closed but which connects to a visleaf visible through another portal.
(2) Also prints area numbers, mainly where player's eye is right now.

|-
!align=left|r_showlightcount 1
|Using colours, shows the number of lights hitting a surface, black = 0, red = 1, blue = 2... etc.

|-
!align=left|seta tdm_showsprop 1
|Shows the volume of sounds heard by AI.

|-
!align=left|tdm_ai_showbark 1
|Gives the def name (not the soundshader) of barks used by AI.

|-
!align=left|tdm_ai_showalert 1
|Shows the AI's current alert total and alert state.

|-
!align=left|tdm_ai_showdest 1
|Shows the AI's current path destination.

|-
!align=left|bind "f1" "_impulse27"
|Pressing F1 shows the AAS regions.

|-
!align=left|timescale 2
|Double speed, good for testing pathing, 1 = normal speed, 2 = double, 0.5 = half speed. To have an effect, the "Uncapped FPS" setting must be Off.

|-
!align=left|g_timeModifier 2
|Same as timescale 2 but somewhat different

|-
!align=left|g_stopTime 1
|Stops gameplay time, but player can move normally.

|-
!align=left|teleport "entity name"
|teleports the player to the named entity

|-
!align=left|teleportArea N
|teleports the player into the area with number N

|-
!align=left|getviewpos
|get player's position and orientation [[Reporting_Problem#Coordinates|coordinates]]

|-
!align=left|setviewpos X Y Z [P Y R]
|teleports the player to the coordinates and optionally sets camera orientation.

|}

== Spawning entities ==

Spawns entity in front of the player. Look up if entity gets spawned under the floor.

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|spawn atdm:weapon_blackjack
|Spawns blackjack.

|-
!align=left|spawn atdm:weapon_shortsword
|Spawns a sword.

|-
!align=left|spawn atdm:ammo_broadhead
|Spawns one arrow.

|-
!align=left|spawn atdm:ammo_broadhead inv_ammo_amount 50
|Spawns 50 arrows (one entity with 50 ammo). Similar technique can be used for other ammo types.

|-
!align=left|spawn atdm:ammo_firearrow
|

|-
!align=left|spawn atdm:ammo_gasarrow
|

|-
!align=left|spawn atdm:ammo_mossarrow
|

|-
!align=left|spawn atdm:ammo_noisemaker
|

|-
!align=left|spawn atdm:ammo_ropearrow
|

|-
!align=left|spawn atdm:ammo_waterarrow
|

|}

With the TDM console you can press tab after typing something to autocomplete. For example <tt>spawn atdm:<tab></tt> will cycle through the various spawnables. You can also add additional spawnargs using the following syntax: <tt>spawn classname [key value] [key value] ...</tt>.

== Diagnostic information ==

{|class="wikitable sortable" border=1 style="border-color: grey; border-collapse: collapse; font-size: 92%; margin-left: 1em" cellspacing=0 cellpadding=3

|-
!bgcolor=#ffdead|Command
!bgcolor=#ffdead|Description

|-
!align=left|listEntities
|lists all current entities followed by a count.

|-
!align=left|countEntities
|displays a count of entities by class. ''TDM 2.03+''

|-
!align=left|condump [unwrap] ''filename.txt''
|Writes the text content of the console to text file ''filename.txt'' (you can use any file name). If optional keyword ''unwrap'' is used, full lines from the console will be stitched together with the following line. Useful when exporting long file paths from the console, that have been broken up by its width limit. ''TDM 2.03+''

|}

==See Also==

[[Cvars in The Dark Mod]]

{{editing}}

[[Category:CVARS]]

Caulk

2024-01-05T21:22:24Z

Stgatilov: Reviewed the section about applying caulk for the sake of performance

== Introduction ==
"Caulk" is an old word, in verb form meaning "to make a ship or building watertight by filling the seams between planks with oakum or other material driven snug". A ship not properly caulked could leak, slow down, and sink. Reputedly, this inspired id co-founder John Carmack to chose the name "caulk" for a substance to seal internal and external leaks. The original purposes of caulk in Doom were likely to help avoid game slow-downs, and to close off any accidental tiny leaks by plastering the whole outside with it. From [https://forums.thedarkmod.com/index.php?/topic/18030-the-origins-of-caulk/&tab=comments#comment-388327 The Origins of Caulk]

In TDM, the noun "caulk" can be used in two senses:
# as a texture (found in textures/common/caulk), that appears pink/magenta in DR, but is not drawn in-game. Like other textures, it can be applied to the faces of brushes (worldspawns), func_statics, and so on.
# as a '''worldspawn brush''' with the caulk texture applied to one or typically all surfaces.

== Caulk considered dangerous ==

The very idea of caulk contradicts itself:
* (rendering) It is not rendered and does not cast shadows, thus it does '''not''' block neither view nor light.
* (area-portal graph) It is opaque and thus closes areas, meaning that it blocks both view and light.

It means that when you apply caulk, you cannot expect fully defined behavior in game.
The exact behavior depends on internal algorithms of the renderer, and may change between TDM versions due to engine improvements.

For example, caulk brushes inside doorway models are known to [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ break the new light portal flow optimizations] [https://bugs.thedarkmod.com/view.php?id=5172#c16126 #5172]. This issue is caused by the fact that stencil shadows are only generated from backfaces.

A related '''shadowcaulk material''' can fix this issue, because it casts shadows and thus blocks light rays in all regards.
But the contradiction in whether it blocks view or not still remains.
Perhaps it does not cause undefined behavior if the caulk geometry is fully surrounded by non-translucent geometry...

Another example: if occlusion culling happens in the future, it will most likely use all the world geometry as occluders, but most likely will '''not''' use all the models.
So if you cover a piece of the wall with caulk because it is invisible under a model, the objects behind this caulky hole will not be removed from rendering.

== Main Use of Caulk - for Separating Vis Leafs ==
It is the second meaning in which caulk is actually most useful: '''for defining and sealing, in conjunction with visportals, individual ''vis leaf'' areas of your map'''. This often takes the form of thin caulk-brush sheets sandwiched between non-brush opaque interior walls. Creating vis leafs is important to avoid unnecessary, performance-sucking rendering, and to provide more-plausible sound propagation. For more about this, see [[Visportals]] and [[Sound Propagation: Part 1]].

Other transparent "no draw" textures on brushes do not have the sealing property that caulk has.

== Another Important Use - Caulk Sky ==
[[Image:Caulk sky with portal sky cube.png|200px|thumb|right|Figure 1a. Looking up at a caulk sky with portal sky cube in DR.]] While most any opaque worldspawn brush can be used to seal against the void (as discussed in [[Performance: Essential Must-Knows]] and other places), to specifically create a sky, the external, void-facing brushes have two choices for texture:
* portal_sky (found in textures/smf/portal_sky)
* caulk
[[Image:Caulk sky in-game.jpg|200px|thumb|right|Figure 1b. Looking up at the same sky in-game.]]For a caulk sky, besides the caulk brushes themselves, you must have at least one surface anywhere in the rendered area with the portal_sky texture. For example, in Figure 1 (from a 2013 example by Obsttorte), this is done using an out-of-the-way portal_sky-textured cube brush. The engine will never render anything on the caulk brush surfaces themselves; they are merely views into the void, and the engine uses the portal_sky texture sample to "fill in" those views. Figure 1b shows the same "pit" scene, but in-game, at a different angle.

There are two main reasons traditionally why caulk sky was useful in TDM.

=== Non-Clipping of Objects that Extend Into the Void ===
Consider a map object that pierces an external brush of your map. Assume that (in order to compile without leak) its origin is within the rendered volume, either naturally or by adjustment. If the external brush has portal_sky on its interior, the map object (prior to TDM 2.05) will be clipped there. Sometimes, that's not what you want.

While caulk does not render, it does cut into other textures, but only if they are worldspawn. If you've converted them into func_statics, they will be rendered completely and not be cut off at the caulk surface. To ensure this happens, the func_static must reaching into the rendered area a bit. In Figure 1, the roof eaves at the pit lips are part of larger roof wedges that the player can see when jumping up. They are func_statics that extend into the void, but with origins in the pit's vis leaf. (If the game had multiple vis leafs from which to view the func_statics, they would appear unclipped from all.)

To summarize, caulk is transparent, and in-effect shows the portal_sky through it, as well as any func_statics that pierce it into your vis leaf. That means you can cut a func_static house in half with a caulk brush, and still see both sides of it. Using portal_sky, this was not possible until recently. However, since TDM 2.05, the default behavior of portal_sky regarding clipping is now similar to caulk.

For more, see [https://forums.thedarkmod.com/index.php?/topic/10003-so-what-are-you-working-on-right-now/page/178/&tab=comments#comment-311195 this forum post] and [http://bugs.thedarkmod.com/view.php?id=4635 this bug tracker entry about portal sky modes].

=== Atmospheric Fog ===
Dealing with fog effects is often tricky, particularly at the boundary of fog volume and sky. Portal_sky versus caulk sky can differ. Some starting points:
* A ''Fog Light'' with spawnarg "noFogBoundary" lets fog paint on solid surfaces, while leaving empty space and caulk sky free of fog effects.
* For more, see [[Light_Properties#Fog_Light | Fog Light]] and [https://forums.thedarkmod.com/index.php?/topic/15802-simulating-atmospheric-perspective Simulating Atmospheric Perspective].

== Other, Secondary Uses of Caulk as a Texture ==
=== As a DR Mapper Convenience ===
[[Image:caulk_image3.png|200px|thumb|right|Figure 2. Benefits of caulking as a mapping tool.]] Some mappers like to caulk the exterior (void-facing) surfaces of their maps. While unnecessary for game play (since the engine ignores those surfaces automatically), it benefits editing. By using the DR Caulk filter, the mapper can easily switch off the exterior surfaces and see inside the map to get a better vantage point. Image 2 shows the view:
* (''top'') if you don't caulk the exterior (and just leave it as a stone texture). It is difficult to get a good overhead view of the work. Unless you set up caulking (or one of the alternative methods), you have to either select and hide the exterior brushes or fly inside the map.
* (''middle'') if you do caulk the exterior, when the caulk filter is not active.
* (''bottom'') with the caulk filter activated, for a superior overhead view into the work.

Alternative non-caulk methods to do this include:
* using DR Layers. Move all the exterior brushes into their own Layer, and hide that layer.
* with any brush used as a Portal Sky, keeping that texture on all faces, and adding a custom DR "Portal Sky" filter

=== To Avoid Cost of Drawing Unseeable Polygons ===
Caulk can be used to skip drawing of: [[Image:caulk_image.png|200px|thumb|right|Figure 3. Caulk applied to a func_static window.]]
* back-surface polygons (tris) of a ''prop'' object, such as a door or window as in Figure 3. There, surfaces touching the wall are caulked, so are not drawn in game, saving tris. But GPU immediately drops all backfacing triangles anyway, so you won't notice any difference. Testing (detailed further below) shows that such caulking is not worth the effort.
* worldspawn brush surfaces entirely covered by detail work like patches.[[Image:caulk_image2.png|200px|thumb|right|Figure 4. Caulk applied to a unseeable worldspawn brush surface.]] See Figure 4. The player can never see the caulked surface because it's hidden by the func_static vault. However, stencil shadows can might get broken in this case (see [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ thread]), and there is no noticeable performance difference anyway.

=== Avoiding Z-Fighting ===
As just seen with the vault in Figure 4, caulking helps in certain circumstances. The caulked worldspawn surface does not "sparkle" or z-fight through the highest point of the vault, where the vault patch and the worldspawn brush are at equal height.

== Caulking of Hidden Surfaces to Improve Performance? - Discussion, Testing, and Analysis ==
=== Introduction ===
Every now and then, caulking arises in debates: is it useful and beneficial to performance to spend a lot of time object-caulking? And if so, how much caulk is required to get a solid impact on fps rate?

As Figure 3 indicated, to save a few polygons (tris), one can apply caulk on surfaces the player can never see in any circumstances, like wall-facing surfaces of prop windows and doors. This reduces the number of tris, and thus could potentially improve performance in some cases. But what does testing reveal?

=== Caulking That Cannot Affect Performance ===
There is no ''performance'' advantage to using caulk on any of these surfaces:
* worldspawn surfaces on the outside of the map in contact with the void
* worldspawn surfaces that are flush against another surface, for instance the bottom of a brush aligned with the floor.

Dmap compiler removes these surfaces automatically, so caulk texture is not needed.

=== Testing and Estimating the Effect of Caulking on Performance ===
Tests performed in 2010 by Sotha gave the following results.

Caulking a medium complex scene with tens of windows and other objects (Knighton Manor start) did NOT have any effect on fps counts. Caulking did save roughly 1000 tris, but this is not sufficient to cause any fps improvement. Also it was noticed that memory usage decreased : 1000 saved tris saved 0.6MB of memory. This is about the size of one 1K x 1K diffuse texture, so the difference is absolutely negligible.

Testing indicated that on a rather high-end computer (for 2010) an increase of 23000 tris, 75 draws and 2500 shdw reduced the fps count by two (stgatilov: relative to how many? was that additional geometry invisible?).
If a window consists of 5 brushes and the wall facing surfaces are caulked, this saves 5 surfaces and thus 10 tris per window. This would mean that 2300 windows should be caulked to get an improvement of 2fps. Basically this shows that caulking does not have much impact on modern hardware. However, on an older piece of hardware the amount of caulking needed for performance effect is lower, but even in this case it should be remembered that 1000 tris is roughly 20% of a single AI character.

=== Conclusion ===
Applying caulk on brushes for the purpose of optimization is simply not worth it.
And given that it can cause problems with TDM updates, better not do it.

{{editing}}
[[Category:Mapping Tutorials]]

Caulk

2024-01-05T17:17:52Z

Stgatilov: Added "caulk considered dangerous" section

== Introduction ==
"Caulk" is an old word, in verb form meaning "to make a ship or building watertight by filling the seams between planks with oakum or other material driven snug". A ship not properly caulked could leak, slow down, and sink. Reputedly, this inspired id co-founder John Carmack to chose the name "caulk" for a substance to seal internal and external leaks. The original purposes of caulk in Doom were likely to help avoid game slow-downs, and to close off any accidental tiny leaks by plastering the whole outside with it. From [https://forums.thedarkmod.com/index.php?/topic/18030-the-origins-of-caulk/&tab=comments#comment-388327 The Origins of Caulk]

In TDM, the noun "caulk" can be used in two senses:
# as a texture (found in textures/common/caulk), that appears pink/magenta in DR, but is not drawn in-game. Like other textures, it can be applied to the faces of brushes (worldspawns), func_statics, and so on.
# as a '''worldspawn brush''' with the caulk texture applied to one or typically all surfaces.

== Caulk considered dangerous ==

The very idea of caulk contradicts itself:
* (rendering) It is not rendered and does not cast shadows, thus it does '''not''' block neither view nor light.
* (area-portal graph) It is opaque and thus closes areas, meaning that it blocks both view and light.

It means that when you apply caulk, you cannot expect fully defined behavior in game.
The exact behavior depends on internal algorithms of the renderer, and may change between TDM versions due to engine improvements.

For example, caulk brushes inside doorway models are known to [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ break the new light portal flow optimizations] [https://bugs.thedarkmod.com/view.php?id=5172#c16126 #5172].
One workaround is to disable the optimizations... which means you lose much more performance than you tried to gain by applying caulk!

A related '''shadowcaulk material''' can also fix this issue, because it casts shadows and thus blocks light rays in all regards.
But the contradiction in blocking view still remains.

Another example: if occlusion culling happens in the future, it will most likely use all the world geometry as occluders, but most likely will '''not''' use all the models.
So if you cover a piece of the wall with caulk because it is invisible under a model, the objects behind caulky hole will not be removed from rendering.

== Main Use of Caulk - for Separating Vis Leafs ==
It is the second meaning in which caulk is actually most useful: '''for defining and sealing, in conjunction with visportals, individual ''vis leaf'' areas of your map'''. This often takes the form of thin caulk-brush sheets sandwiched between non-brush opaque interior walls. Creating vis leafs is important to avoid unnecessary, performance-sucking rendering, and to provide more-plausible sound propagation. For more about this, see [[Visportals]] and [[Sound Propagation: Part 1]].

Other transparent "no draw" textures on brushes do not have the sealing property that caulk has.

== Another Important Use - Caulk Sky ==
[[Image:Caulk sky with portal sky cube.png|200px|thumb|right|Figure 1a. Looking up at a caulk sky with portal sky cube in DR.]] While most any opaque worldspawn brush can be used to seal against the void (as discussed in [[Performance: Essential Must-Knows]] and other places), to specifically create a sky, the external, void-facing brushes have two choices for texture:
* portal_sky (found in textures/smf/portal_sky)
* caulk
[[Image:Caulk sky in-game.jpg|200px|thumb|right|Figure 1b. Looking up at the same sky in-game.]]For a caulk sky, besides the caulk brushes themselves, you must have at least one surface anywhere in the rendered area with the portal_sky texture. For example, in Figure 1 (from a 2013 example by Obsttorte), this is done using an out-of-the-way portal_sky-textured cube brush. The engine will never render anything on the caulk brush surfaces themselves; they are merely views into the void, and the engine uses the portal_sky texture sample to "fill in" those views. Figure 1b shows the same "pit" scene, but in-game, at a different angle.

There are two main reasons traditionally why caulk sky was useful in TDM.

=== Non-Clipping of Objects that Extend Into the Void ===
Consider a map object that pierces an external brush of your map. Assume that (in order to compile without leak) its origin is within the rendered volume, either naturally or by adjustment. If the external brush has portal_sky on its interior, the map object (prior to TDM 2.05) will be clipped there. Sometimes, that's not what you want.

While caulk does not render, it does cut into other textures, but only if they are worldspawn. If you've converted them into func_statics, they will be rendered completely and not be cut off at the caulk surface. To ensure this happens, the func_static must reaching into the rendered area a bit. In Figure 1, the roof eaves at the pit lips are part of larger roof wedges that the player can see when jumping up. They are func_statics that extend into the void, but with origins in the pit's vis leaf. (If the game had multiple vis leafs from which to view the func_statics, they would appear unclipped from all.)

To summarize, caulk is transparent, and in-effect shows the portal_sky through it, as well as any func_statics that pierce it into your vis leaf. That means you can cut a func_static house in half with a caulk brush, and still see both sides of it. Using portal_sky, this was not possible until recently. However, since TDM 2.05, the default behavior of portal_sky regarding clipping is now similar to caulk.

For more, see [https://forums.thedarkmod.com/index.php?/topic/10003-so-what-are-you-working-on-right-now/page/178/&tab=comments#comment-311195 this forum post] and [http://bugs.thedarkmod.com/view.php?id=4635 this bug tracker entry about portal sky modes].

=== Atmospheric Fog ===
Dealing with fog effects is often tricky, particularly at the boundary of fog volume and sky. Portal_sky versus caulk sky can differ. Some starting points:
* A ''Fog Light'' with spawnarg "noFogBoundary" lets fog paint on solid surfaces, while leaving empty space and caulk sky free of fog effects.
* For more, see [[Light_Properties#Fog_Light | Fog Light]] and [https://forums.thedarkmod.com/index.php?/topic/15802-simulating-atmospheric-perspective Simulating Atmospheric Perspective].

== Other, Secondary Uses of Caulk as a Texture ==
=== As a DR Mapper Convenience ===
[[Image:caulk_image3.png|200px|thumb|right|Figure 2. Benefits of caulking as a mapping tool.]] Some mappers like to caulk the exterior (void-facing) surfaces of their maps. While unnecessary for game play (since the engine ignores those surfaces automatically), it benefits editing. By using the DR Caulk filter, the mapper can easily switch off the exterior surfaces and see inside the map to get a better vantage point. Image 2 shows the view:
* (''top'') if you don't caulk the exterior (and just leave it as a stone texture). It is difficult to get a good overhead view of the work. Unless you set up caulking (or one of the alternative methods), you have to either select and hide the exterior brushes or fly inside the map.
* (''middle'') if you do caulk the exterior, when the caulk filter is not active.
* (''bottom'') with the caulk filter activated, for a superior overhead view into the work.

Alternative non-caulk methods to do this include:
* using DR Layers. Move all the exterior brushes into their own Layer, and hide that layer.
* with any brush used as a Portal Sky, keeping that texture on all faces, and adding a custom DR "Portal Sky" filter

=== To Avoid Drawing Unseeable Polygons ===
Caulk can be used to skip drawing of: [[Image:caulk_image.png|200px|thumb|right|Figure 3. Caulk applied to a func_static window.]]
* back-surface polygons (tris) of a ''prop'' object, such as a door or window as in Figure 3. There, surfaces touching the wall are caulked, so are not drawn in game, saving tris. Testing (detailed further below) shows that such caulking is not worth the effort, unless you plan massive cloning of that prop object.
* worldspawn brush surfaces entirely covered by detail work like patches.[[Image:caulk_image2.png|200px|thumb|right|Figure 4. Caulk applied to a unseeable worldspawn brush surface.]] See Figure 4. The player can never see the caulked surface because it's hidden by the func_static vault. This not only saves tris (which is not really important), but also removes the "sparkling" of the other texture at the highest point of the vault.

=== Avoiding Z-Fighting ===
As just seen with the vault in Figure 4, caulking helps in certain circumstances. To reiterate, the caulked worldspawn surface does not "sparkle" or z-fight through the highest point of the vault, where the vault patch and the worldspawn brush are at equal height.

== Caulking of Hidden Surfaces to Improve Performance? - Discussion, Testing, and Analysis ==
=== Introduction ===
Every now and then, caulking arises in debates: is it useful and beneficial to performance to spend a lot of time object-caulking? And if so, how much caulk is required to get a solid impact on fps rate?

As Figure 3 indicated, to save a few polygons (tris), one can apply caulk on surfaces the player can never see in any circumstances, like wall-facing surfaces of prop windows and doors. This reduces the number of tris, and thus could potentially improve performance in some cases. But what does testing reveal?

=== Caulking That Cannot Affect Performance ===
There is no ''performance'' advantage to using caulk on any of these surfaces:
* worldspawn surfaces on the outside of the map in contact with the void
* worldspawn surfaces that are flush against another surface, for instance the bottom of a brush aligned with the floor.

The game engine removes these surfaces automatically, so caulk texture is not needed.

=== Testing and Estimating the Effect of Caulking on Performance ===
Tests performed in 2010 by Sotha gave the following results.

Caulking a medium complex scene with tens of windows and other objects (Knighton Manor start) did NOT have any effect on fps counts. Caulking did save roughly 1000 tris, but this is not sufficient to cause any fps improvement. The main benefit of caulking was the decrease of memory usage: 1000 saved tris saved 0.6MB of memory.

Testing indicated that on a rather high-end computer (for 2010) an increase of 23000 tris, 75 draws and 2500 shdw reduced the fps count by two. If a window consists of 5 brushes and the wall facing surfaces are caulked, this saves 5 surfaces and thus 10 tris per window. This would mean that 2300 windows should be caulked to get an improvement of 2fps. Basically this shows that caulking does not have much impact on modern hardware. However, on an older piece of hardware the amount of caulking needed for performance effect is lower, but even in this case it should be remembered that 1000 tris is roughly 20% of a single AI character.

=== How Should Caulk be Used? Perhaps Before Massive Cloning ===
Mappers may selectively integrate object-caulking in their ongoing work flow. Suppose the mapper builds a func_static window to be cloned and put everywhere. It is beneficial to use a few seconds to apply caulk on the source func_static and then get the caulking tris-saving effect on all the clones. This adds little work for the mapper, but, in a medium sized scene where the windows and other cloned (but caulked) objects are omnipresent, might easily save a few thousand tris.

=== Conclusion ===
Mappers should not generally take extra trouble to caulk their individual objects, since solid performance increases do not occur with the levels of tris so saved. However, thousands of tris can be saved by simple workflow consideration, when working with objects which are cloned in large numbers.

{{editing}}
[[Category:Mapping Tutorials]]

New light leaks in 2.12

2023-12-22T22:29:48Z

Stgatilov:

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
|
4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| (not yet)

|-
| cos3_sacricide
| -1283.53 -380.68 83.25 15.2 -38.6 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|}

New light leaks in 2.12

2023-12-22T22:28:44Z

Stgatilov: WS2 added

There is major change in TDM 2.12 regarding how shadows are generated due to issue [https://bugs.thedarkmod.com/view.php?id=5172 #5172].
As the result, some we might see some '''major light leaks''' in the old missions.

=== Description ===

As far as I know, the problem happens only with stencil shadows, because stencil shadows are cast from back faces only (shadow maps are generated by front faces too).
The shape of such light leaks does '''not''' depend on the camera position.
Usually the problem is caused by using caulk on brushes: light leaks through the caulk.

'''New behavior''' (default in TDM 2.12 and after):
* r_useLightPortalFlow = 2
* r_useLightPortalFlowCulling = 1

The shadows are computed differently for world areas and for models:
# Any worldspawn brush within light volume always casts shadow. Even if it is behind walls and closed portals.
# A model casts shadow only if light beams from the light origin might reach it through visportals. No shadows behind walls and closed portals!

As an exception, some models switch from p.2 to p.1 and cast shadows everywhere.
For instance, this happens in case of parallel lights, and when entities are explicitly marked with the workaround spawnarg "forceShadowBehindOpaque".

'''Old behavior''' (default in TDM 2.11 and before):
* r_useLightPortalFlow = 1
* r_useLightPortalFlowCulling = 0

The behavior here is different depending on the type of light:
* '''Static''' lights use the new TDM 2.12 behavior, so models don't cast shadows behind walls.
* '''Dynamic''' lights: everything within light volume casts shadows, regardless of whether it's area/brush or model.

The light is static if it has not moved since game start.
That's the case when engine uses precomputed shadow volumes for world geometry.

=== Validation ===

Before adding an issue here, please make sure to check the following steps:

* Start game afresh, install mission, setviewpos and verify that light leak indeed happens. Perhaps you need to open some doors nearby.
* Restart game afresh, set "r_useLightPortalFlow 1" and "r_useLightPortalFlowCulling 0", start mission. Check that light leak no longer happens.

The light leak can be caused by this issue only if both points are true.

=== List of issues ===

{| class="wikitable"
|-
! Mission name !! getviewpos coordinates !! Links to forums !! Applied fixes

|-
| ws1_north
| -1153.92 3523.22 -955.75 29.8 -145.6 0.0
-664.04 2894.9 -635.75 10.2 9.9 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/ 1]
[https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=488509 2]
| svn rev 241: global workaround

|-
| ws2_homeagain
| 4385 420 -410 -30 -110 0
4178.12 391.47 -94.56 -28.8 43.6 0.0
4347.92 -271.22 57.53 -0.8 18.4 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=490582 1]
| (not yet)

|-
| cos3_sacricide
| -1283.53 -380.68 83.25 15.2 -38.6 0.0
| [https://forums.thedarkmod.com/index.php?/topic/22241-new-shadow-leaks-in-212-dev-builds/&do=findComment&comment=489895 1]
| (not yet)

|}

VMWare: Virtual machine with Linux

2023-12-16T22:09:14Z

Stgatilov: Added r_gpuBufferNonpersistentUpdateMode node.

This guide is originally written for TDM 2.07.

== Intro ==

It is very convenient for a Windows-centric developer to have a Linux virtual machine in his arcenal.

You can read how to set up VirtualBox VM in the article [[VirtualBox: Virtual machine with Linux for TDM]].
This article is about setting up a VMware VM, which has some benefits over VirtualBox: better performance and OpenGL support.

== Install VMware ==

While Oracle's VirtualBox is open-source, the VMware product is proprietary in its full sense. As of year 2019, there is [https://www.vmware.com/products/workstation-player.html VMware Workstation Player], which is '''free for non-commercial use'''. You can download it on [https://my.vmware.com/en/web/vmware/free#desktop_end_user_computing/vmware_workstation_player this page] (choose Windows version).

Installation is trivial. Most likely, you do '''not''' need the "Enhanced Keyboard Driver".

== Create VM ==

Start VMware Workstation, click on "Create a New Virtual Machine".

Point "Installer disc image file" to the ISO image of the Linux distro which you want to install (by default it would be [https://www.ubuntu.com/download/desktop Ubuntu LTS]). Click Next.

Choose a name like "Ubuntu XX.YY x64", set user and password, click Next. Don't forget to set Location: a typical VM takes 5-10 GB. Leave Disk Capacity settings in defaults: do '''not''' use monolithic disk, because it would make some configuring much harder!

As long as you choose reasonable settings and ISO, you should be eligible for "Easy Install", which means that you'll get Ubuntu installed for you automatically, along with open-vm-tools. Make sure you have '''internet access''' through the whole process, otherwise your installation will be incomplete.

== Client Tools ==

In order to use shared directories and shared clipboard, you need to install some sort of client tools. Unfortunately, this topic is quite messy in VMware world. First of all, there are two such tools available: ''VMware Tools'' is distributed with VMware Player, and ''open-vm-tools'' is intended to be distributed by Linux package manager. Second, default installations of the tools are often buggy and don't work.

In my case, open-vm-tools 2:10.2.0-3~ubuntu0.16.04.1 was installed automatically by VMware Player 15.0.2 during Easy Install procedure and it did not work well. It mounted the shared folder properly when I added it, but after a full reboot the shared folder was absent. Installing the patches from [https://askubuntu.com/a/726906/918615 this answer] helped. Of course, you need to do "<tt>sudo apt-get install git</tt>" first.

In order to create shared folder, open "Virtual Machine Settings" (in "Player" -> "Manage").
Go to "Options" -> "Shared Folders", and set it to "Always enabled". Now "Add" your TDM root directory to make it accessible from within VM. Check that it is available at <tt>/mnt/hgfs/[name_of_share]</tt>. If it is not there, then I wish you good luck!

== Configure VM ==

When your VM is '''not''' running, right-click on VM and go to "Settings".

Choose "Memory", and increase the amount of Memory available to 4096 MB.

Choose "Processors", and increase "Number of processor cores" to make TDM build faster. I advise setting it to the number of physical cores you have (6 for me).

Choose "Display", increase "Graphics memory" to 2 GB.

Click OK to apply changes.

== Clean backup ==

I prefer having the clean VM backed up so that I could restart with a fresh and configured VM at any moment. VMware Player does not support cloning and snapshots, but you can find the directory with your VM data and simply copy the whole directory.

== Build and run TDM ==

Open terminal, change dir to the root source code directory in the shared folder, e.g.:

cd /mnt/hgfs/thedarkmod/darkmod_src

From here you can build TDM in the usual way, as described in the [[The Dark Mod - Compilation Guide#Linux]]. Of course, you have to install some packages before first build.

In order to run TDM, go to assets root directory, e.g.:

cd /mnt/hgfs/thedarkmod/darkmod

Run TDM from there:

./thedarkmod.x64

For TDM 2.07, you also have to do "<tt>sudo apt-get install libopenal1</tt>" beforehand.

Currently VMware seems to support OpenGL 3.0 in general and OpenGL 3.3 Core profile only.

== Mouse look ==

VMware breaks mouse cursor warping in the same way as VirtualBox does. Warping is critical for mouse-look in FPS games, including TDM. Without it, you won't be able even to navigate through menus.

There are two ways to fix it in case of VMware Player:

'''VMware-side solution'''. Make sure the VM is shutdown, open the <tt>.vmx</tt>-file of your VM and add the following magic lines to it:

usb.generic.allowHID = "TRUE"
mouse.vusb.useBasicMouse = "FALSE"
mouse.vusb.enable = "TRUE"

Strangely, this is already enough to fix the problem. If your mouse is crazy in TDM, press Ctrl+Alt and click back to VM, and mouse look should return to normal.

Also with these lines, you can passthrough your mouse and keyboard exclusively to VM. In order to do that, click "Player" -> "Removable Devices", find your mouse/keyboard there and click "Connect". Make sure that you have spare USB mouse or keyboard connected to computer so that at least some control is left on the host side.

'''TDM-side hack'''. Open game console and set "<tt>in_nowarp 1</tt>" there.
After that you have a limited mouse-look. You cannot really play with it, but it is enough for clicking through menu and a bit of in-game testing. Use "turn left/right" keys as additional workaround.

== The game runs very slow ==

I have to set cvar "<tt>r_gpuBufferNonpersistentUpdateMode 1</tt>" locally to get normal performance (supposedly since TDM 2.09).
With default value of this cvar, TDM rendering is very slow inside VM for some reason.
Note that this cvar is internal and does not affect normal installations that much.

[[Category: Coding]]