NAVIGATION
ARTICLE
DOOM 3 script events: system events (called via 'sys.')
| Name | Description |
|---|---|
| terminate | Terminates a thread. |
| pause | Pauses the current thread. |
| wait | Suspends execution of the current thread for the given number of seconds. |
| waitFrame | Suspends execution for one game frame. |
| waitFor | Waits for the given entity to complete it's move. |
| waitForThread | Waits for the given thread to terminate. |
| Prints the given string to the console. | |
| println | Prints the given line to the console. |
| say | Multiplayer - Print this line on the network |
| assert | Breaks if the condition is zero. (Only works in debug builds.) |
| trigger | Triggers the given entity. |
| setcvar | Sets a cvar. |
| getcvar | Returns the string for a cvar. |
| random | Returns a random value X where 0 <= X < range. |
| getTime | Returns the current game time in seconds. |
| killthread | Kills all threads with the specified name |
| threadname | Sets the name of the current thread. |
| getEntity | Returns a reference to the entity with the specified name. |
| spawn | Creates an entity of the specified classname and returns a reference to the entity. |
| respawn | Respawn |
| copySpawnArgs | copies the spawn args from an entity |
| setSpawnArg | Sets a key/value pair to be used when a new entity is spawned. |
| SpawnString | Returns the string for the given spawn argument. |
| SpawnFloat | Returns the floating point value for the given spawn argument. |
| SpawnVector | Returns the vector for the given spawn argument. |
| clearPersistantArgs | clears data that persists between maps |
| setPersistantArg | Sets a key/value pair that persists between maps |
| getPersistantString | Returns the string for the given persistant arg |
| getPersistantFloat | Returns the floating point value for the given persistant arg |
| getPersistantVector | Returns the vector for the given persistant arg |
| angToForward | Returns a forward vector for the given Euler angles. |
| angToRight | Returns a right vector for the given Euler angles. |
| angToUp | Returns an up vector for the given Euler angles. |
| sin | Returns the sine of the given angle in degrees. |
| cos | Returns the cosine of the given angle in degrees. |
| sqrt | Returns the square root of the given number. |
| vecNormalize | Returns the normalized version of the given vector. |
| vecLength | Returns the length of the given vector. |
| DotProduct | Returns the dot product of the two vectors. |
| CrossProduct | Returns the cross product of the two vectors. |
| VecToAngles | Returns Euler angles for the given direction. |
| onSignal | Sets a script callback function for when the given signal is raised on the given entity. |
| clearSignalThread | Clears the script callback function set for when the given signal is raised on the given entity. |
| setCamera | Turns over view control to the given camera entity. |
| firstPerson | Returns view control to the player entity. |
| trace | 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 |
| tracePoint | Returns the fraction of movement completed before the trace hits solid geometry when moving from 'start' to 'end'. The 'passEntity' is considered non-solid |
| getTraceFraction | Returns the fraction of movement completed during the last call to trace or tracePoint. |
| getTraceEndPos | Returns the position the trace stopped due to a collision with solid geometry during the last call to trace or tracePoint |
| getTraceNormal | Returns the normal of the hit plane during the last call to trace or tracePoint |
| getTraceEntity | Returns a reference to the entity which was hit during the last call to trace or tracePoint |
| 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 |
| getTraceBody | Returns the number of the body part of the entity which was hit during the last call to trace or tracePoint |
| fadeIn | Fades towards the given color over the given time in seconds. |
| fadeOut | Fades from the given color over the given time in seconds. |
| fadeTo | Fades to the given color up to the given alpha over the given time in seconds. |
| music | Starts playing background music. |
| error | Issues an error. |
| warning | Issues a warning. |
| strLength | Returns the number of characters in the string |
| strLeft | Returns a string composed of the first num characters |
| strRight | Returns a string composed of the last num characters |
| strSkip | Returns the string following the first num characters |
| strMid | Returns a string composed of the characters from start to start + num |
| strToFloat | Returns the numeric value of a string |
| radiusDamage | 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 |
| isClient | networking - checks for client |
| isMultiplayer | checks if it's a multiplayer game |
| getFrameTime | returns the length of time between game frames. this is not related to renderer frame rate. |
| getTicsPerSecond | returns the number of game frames per second. this is not related to renderer frame rate. |
| cacheSoundShader | ensure the specified sound shader is loaded by the system. prevents cache hits when playing sound shaders. |
| debugLine | line drawing for debug visualization. lifetime of 0 == 1 frame. |
| debugArrow | |
| debugCircle | |
| debugBounds | |
| drawText | text drawing for debugging. align can be 0-left, 1-center, 2-right. lifetime of 0 == 1 frame. |
| influenceActive | checks if an influence is active |
Last changed Sep 21, 2026
