View source for Left 4 Dead 2/Scripting/Script Functions

{{LanguageBar}}
{{toc-right}}

{{sq}} This list contains engine-related Squirrel variables, functions, and constants available for {{l4d2}} [[L4D2_Vscripts| Left 4 Dead 2 VScripts]]. 
Some can be printed in-game with the {{Code|script_help}} command when the game is run in developer mode with the {{Code|-dev}} or {{Code|-allowdebug}} parameters. Others have been found from data mining, for example with {{Code|script g_ModeScript.DeepPrintTable(getroottable())}}, and from the [[L4D2_EMS|Expanded Mutation System documentation]].

For functions and parameters related to the{{Code|DirectorOptions}}table, see the [[L4D2 Director Scripts]] page.

== Instances ==
{| class="standard-table" 
! Name !! Type !! Description
|-
| <code>Convars</code> || <code>[[#Convars|Convars ↓]]</code>
| Provides an interface to read and change the values of console variables.
|-
| <code>Director</code> || <code>[[#CDirector|CDirector ↓]]</code>
| Provides a limited interface to the Director.
|-
| <code>Entities</code> || <code>[[#CEntities|CEntities ↓]]</code>
| Allows searching of currently-spawned entities.
|-
| <code>EntityOutputs</code> || <code>[[#CScriptEntityOutputs|CScriptEntityOutputs ↓]]</code>
| Allows reading and changing of entities' output data.
|-
| <code>NavMesh</code> || <code>[[#CNavMesh|CNavMesh ↓]]</code>
| An interface to the Navigation Mesh.
|-
| <code>NetProps</code> || <code>[[#CNetPropManager|CNetPropManager ↓]]</code>
| Allows reading and updating the network properties of an entity.
|-
| <code>ResponseCriteria</code> || <code>[[#CScriptResponseCriteria|CScriptResponseCriteria ↓]]</code>
| Allows reading the response criteria of an entity.
|}

== Script Scopes ==
{| class="standard-table" 
! Name !! Type !! Description
|-
| <code>DirectorScript</code> || table
| Script scope for [[L4D2_Director_Scripts|Director scripts]]. Contains the active [[L4D2_Director_Scripts#DirectorOptions|DirectorOptions]] table.
|-
| <code>g_ClearoutTable</code> || table (<code>null</code>)
| NONE
|-
| <code>g_MapScript</code> || table
| Script scope of map-specific vscripts, which also contains utilty functions.
|-
| <code>g_ModeScript</code> || table
| Script scope of mode-specific vscripts like mutations. This scope also has the {{Code|g_MapScript}} scope as its environment.
|-
| <code>g_RoundState</code> || table
| Scope of the start box used in the Holdout or Dash mutation.
|-
| <code>[[#Response Rules|g_rr ↓]]</code> || table
| An interface to the Response System.
|}

== Variables ==
{| class="standard-table" 
! Name !! Type !! Description
|-
| <code>Documentation</code> || table
| Contains the printed strings from the <code>script_help</code> command.
|-
| <code>GameEventCallbacks</code> || table
| Table of registered game event callbacks.
|-
| <code>print_indent</code> || integer
| Spaces to indent prints by except ones from {{Code|realPrint}}. Defaults to 0.
|-
| <code>_PublishedHelp</code> || table
| NONE
|-
| <code>ScriptEventCallbacks</code> || table
| Table of registered script event callbacks.
|-
|}

=== Script Debug ===
{| class = "standard-table"
! Name !! Type !! Value
|-
| <code>ScriptDebugDefaultWatchColor</code> || array
| [0, 192, 0]
|-
| <code>ScriptDebugDrawTextEnabled</code> || bool
| true
|-
| <code>ScriptDebugDrawWatchesEnabled</code> || bool
| true
|-
| <code>ScriptDebugInDebugDraw</code> || bool
| false
|-
| <code>ScriptDebugText</code> || array
| NONE
|-
| <code>ScriptDebugTextIndent</code> || integer
| 0
|-
| <code>ScriptDebugTextFilters</code> || table
| NONE
|-
| <code>ScriptDebugTraces</code> || table
| NONE
|-
| <code>ScriptDebugTraceAllOn</code> || bool
| false
|-
| <code>ScriptDebugWatches</code> || array
| NONE
|}

== Constants ==
A [https://en.wikipedia.org/wiki/Constant_(computer_programming) constant] is a variable whose value cannot be altered during program runtime, usually to avoid [https://en.wikipedia.org/wiki/Magic_number_(programming) magic numbers] by giving them self-documenting names.

{| class="standard-table"
! Instance !! Type !! Value
|-
| <code>_charsize_</code> || integer
| 1
|-
| <code>_floatsize_</code> || integer
| 4
|-
| <code>_intsize_</code> || integer
| 4
|-
| <code>_version_</code> || string
| "Squirrel 3.0.4 stable"
|-
| <code>_versionnumber_</code> || integer
| 304
|-
| <code>RAND_MAX</code> || integer
| 32767
|-
| <code>SPAWN_FLAGS</code> || table
|<syntaxhighlight lang=js>
SPAWN		= 1
NOSPAWN		= 2
TARGETSPAWN	= 4</syntaxhighlight>
|-
| <code>PI</code> || float
| 3.14159
|}

<!-- These line breaks were always here, and are to put the section at the bottom of the TOC table -->
<!-- 12 line breaks here, currently -->
<br><br><br><br><br><br><br><br><br><br><br><br>

== Classes ==
=== CBaseEntity ===
[[#toc|toc ↑]]
Extended by:
[[#CBaseAnimating|CBaseAnimating ↓]]
[[#CBaseTrigger|CBaseTrigger ↓]]
[[#CEnvEntityMaker|CEnvEntityMaker ↓]]
[[#CInfoItemPosition|CInfoItemPosition ↓]]
[[#CPointTemplate|CPointTemplate ↓]]
[[#CPointScriptTemplate|CPointScriptTemplate ↓]]
[[#CPointScriptUseTarget|CPointScriptUseTarget ↓]]

This is a script handle class for entities. All entities have a script handle using this class, sometimes as one of its subclasses.

An entity's own handle are accessed with:
* <code>[[#CEntities|Entities ↓]]</code> instance.
* [[Entity Scripts]] only - The <code>self</code> keyword.

==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>__KeyValueFromInt</code><br><code>__KeyValueFromString</code><br><code>__KeyValueFromVector</code><br><code>{{Strikethrough|__KeyValueFromFloat}}</code> || <code>bool __KeyValueFromInt(string ''key'', int ''value'')</code><br><code>bool __KeyValueFromString(string ''key'', string ''value'')</code><br><code>bool __KeyValueFromVector(string ''key'', Vector ''value'')</code>
| Sets an entity [[keyvalue]] from a specific data type. Returns true if successfully set, false if it the key does not exist.

This simply changes the value without executing any other code that may be needed for the entity to fully process the keyvalue, such as code for updating the entity's internal network state. This can create unexpected side effects on already-spawned entities such as visual changes being delayed for clients.
{{tip|Use [[#CNetPropManager|Netprops ↓]] and update the keyvalue's corresponding prop instead, as this correctly updates the networking state and results in an immediate update.}}
{{warning|__KeyValueFromFloat doesn't exist}}
|-
| <code>ApplyAbsVelocityImpulse</code> || <code>void ApplyAbsVelocityImpulse(Vector ''impulse'')</code>
| Apply a Velocity Impulse as a world space impulse vector.
|-
| <code>ApplyLocalAngularVelocityImpulse</code> || <code>void ApplyLocalAngularVelocityImpulse(Vector ''impulse'')</code>
| Apply an Angular Velocity Impulse in entity local space. The direction of the input vector is the rotation axis, and the length is the magnitude of the impulse.
|-
| <code>ConnectOutput</code> || <code>void ConnectOutput(string ''output'', string ''function'')</code>
| Adds an I/O connection that will call the named function when the specified output fires.
|-
| <code>DisconnectOutput</code> || <code>void DisconnectOutput(string ''output'', string ''function'')</code>
| Removes a connected script function from an I/O event.
|-
| <code>FirstMoveChild</code> || <code>handle FirstMoveChild()</code>
| Returns the first entity parented to this one. Needs to be used in combination with NextMovePeer to iterate over all children.
{{tip|Example usage: <source lang=js>for (local child = entity.FirstMoveChild(); child != null; child = child.NextMovePeer())</source>}}
|-
| <code>GetAngles</code> || <code>QAngle GetAngles()</code>
| Returns the orientation of the entity in the world.
|-
| <code>GetBaseVelocity</code> || <code>Vector GetBaseVelocity()</code>
| Returns any constant velocity currently being imparted onto the entity. This includes being pushed by effects like [[trigger_push]] and players standing on moving geometry like elevators. Should always returns a zero vector if the entity is not affected by any movement effects. <!-- Thanks! -->
|-
| <code>GetCenter</code> || <code>Vector GetCenter()</code>
| Get world space center of object - absolute coords.
|-
| <code>GetClassname</code> || <code>string GetClassname()</code>
| Returns the entity class. This includes<code>player</code>and<code>infected</code>.
|-
| <code>GetContext</code> || <code>''variable'' GetContext(string ''name'')</code>
| Looks up a response context and returns it if available. May return string, float, or null (if the context isn't found).<br>{{bug*|Always returns null for contexts with numeric value}}{{bug*|Can return value for expired contexts}} <!-- I hate this shitty function -->
|-
| <code>GetEntityHandle</code> || <code>''unknown'' GetEntityHandle()</code>
| Get a C++ [[CHandle|EHANDLE]] reference of the entity. This is an opaque type not directly usable by Squirrel, not a normal script handle. Only necessary for [[#CPointScriptUseTarget|CPointScriptUseTarget functions. ↓]]
|-
| <code>GetEntityIndex</code> || <code>int GetEntityIndex()</code>
| Returns the entity index. This is the same type of index used in most game events.
|-
| <code>GetForwardVector</code> || <code>Vector GetForwardVector()</code>
| Get the forward vector of the entity.
|-
| <code>GetHealth</code> || <code>int GetHealth()</code>
| Returns the current health of the entity (does not include survivor temporary health).
|-
| <code>GetLocalAngles</code> || <code>QAngle GetLocalAngles()</code>
| Returns the orientation of the entity relative to it's parent or attachment point.
|-
| <code>GetLocalAngularVelocity</code> || <code>QAngle GetLocalAngularVelocity()</code>
| Maybe local angvel
|-
| <code>GetLocalOrigin</code> || <code>Vector GetLocalOrigin()</code>
| Returns the origin of the entity relative to it's parent or attachment point.
|-
| <code>GetLocalVelocity</code> || <code>Vector GetLocalVelocity()</code>
| Get Entity relative velocity
|-
| <code>GetMaxHealth</code> || <code>int GetMaxHealth()</code>
| Returns the maximum health of the entity.
|-
| <code>GetModelName</code> || <code>string GetModelName()</code>
| Returns the file name of the model used by the entity (if applicable).
|-
| <code>GetMoveParent</code> || <code>handle GetMoveParent()</code>
| If in hierarchy, retrieves the entity's parent
|-
| <code>GetName</code> || <code>string GetName()</code>
| Returns the targetname of the entity.
|-
| <code>GetOrigin</code> || <code>Vector GetOrigin()</code>
| Returns the origin of the entity in the world.
|-
| <code>GetOwnerEntity</code> || <code>handle GetOwnerEntity()</code>
| Get the owner entity, if there is one.
|-
| <code>GetPreTemplateName</code> || <code>string GetPreTemplateName()</code>
| Get the entity name stripped of template unique decoration.
|-
| <code>GetRootMoveParent</code> || <code>handle GetRootMoveParent()</code>
| If in hierarchy, walks up the hierarchy to find the root parent.
|-
| <code>GetScriptId</code> || <code>string GetScriptId()</code>
| Returns the name of the entity's think function. {{tip|Retrieve the actual script identifier with {{Code|NetProps.GetPropString(ent, "m_iszScriptId")}}}}
|-
| <code>GetScriptScope</code> || <code>table GetScriptScope()</code>
| Retrieve the table storing the Entity Script associated with this entity, null otherwise.
|-
| <code>GetVelocity</code> || <code>Vector GetVelocity()</code>
| Returns a local velocity Vector.
|-
| <code>IsPlayer</code> || <code>bool IsPlayer()</code>
| Does this entity belong to the player class.
|-
| <code>IsValid</code> || <code>bool IsValid()</code>
| Whether the handle still belongs to an entity that's still valid, could become invalid in cases such as the entity, like a destroyed func_breakable.(?)
|-
| <code>Kill</code> || <code>void Kill()</code>
| Removes the entity.
|-
| <code>NextMovePeer</code> || <code>handle NextMovePeer()</code>
| Returns the next child of this entity's parent. Used to continue iteration from FirstMoveChild().
|-
| <code>OverrideFriction</code> || <code>void OverrideFriction(float ''duration'', float ''friction'')</code>
| Takes duration, value for a temporary override
|-
| <code>PrecacheModel</code> || <code>int PrecacheModel(string ''filename'')</code>
| Precache a model after the map has loaded and return index of the model.
|-
| <code>PrecacheScriptSound</code> || <code>void PrecacheScriptSound(string ''soundscript'')</code>
| Precache a sound file, used by the specified soundscript.
|-
| <code>SetAngles</code> || <code>void SetAngles(QAngle ''direction'')</code>
| Sets the orientation of the entity. 
|-
| <code>SetContext</code> || <code>void SetContext(string ''name'', string ''value'', float ''duration'')</code>
| Stores any key/value pair in this entity's dialog contexts. Value must be a string. Will last for duration (set -1 to mean 'forever').
|-
| <code>SetContextNum</code> || <code>void SetContextNum(string ''name'', float ''value'', float ''duration'')</code>
| Stores any key/value pair in this entity's dialog contexts. Value must be a number (int or float). Will last for duration (set -1 to mean 'forever').
|-
| <code>SetForwardVector</code> || <code>void SetForwardVector(Vector ''direction'')</code>
| Set the orientation of the entity to have this forward vector.
|-
| <code>SetFriction</code> || <code>void SetFriction(float ''friction'')</code>
| Set PLAYER friction, ignored for objects.
|-
| <code>SetGravity</code> || <code>void SetGravity(float ''gravity'')</code>
| Set PLAYER gravity, ignored for objects.
|-
| <code>SetHealth</code> || <code>void SetHealth(int ''health'')</code>
| Changes the health value of the entity. Does not check whether to kill players.
|-
| <code>SetLocalAngles</code> || <code>void SetLocalAngles(QAngle ''direction'')</code>
| Sets the entity orientation relative to it's parent or attachment point.
|-
| <code>SetLocalOrigin</code> || <code>void SetLocalOrigin(Vector ''position'')</code>
| Sets the entity position relative to it's parent or attachment point.
|-
| <code>SetMaxHealth</code> || <code>void SetMaxHealth(int ''health'')</code>
| Changes the maximum health value of the entity.
|-
| <code>SetModel</code> || <code>void SetModel(string ''modelName'')</code>
| Changes the model of the entity (if applicable).
|-
| <code>SetOrigin</code> || <code>void SetOrigin(Vector ''position'')</code>
| Sets the world entity position.
|-
| <code>SetVelocity</code> || <code>void SetVelocity(Vector ''velocity'')</code>
| Sets the entity velocity.
|-
| <code>TakeDamage</code> || <code>void TakeDamage(float ''damage'', int ''damageType'', CBaseEntity ''attacker'')</code>
| Damages the entity.
|-
| <code>TakeDamageEx</code> || <code>void TakeDamageEx(CBaseEntity ''inflictor'', CBaseEntity ''attacker'', CBaseEntity ''weapon'', Vector ''vecDamageForce'', Vector ''vecDamagePosition'', float ''damage'', int ''damageType'')</code>
| Damages the entity (extended).
|-
| <code>ValidateScriptScope</code> || <code>bool ValidateScriptScope()</code>
| Ensures an entity has a script scope, if it doesn't have one then one is created. Returns true if created successfully.
|}

==== Hooks ====
If one of these functions are declared in an Entity Script, the entity will run this function automatically in the appropriate situation. 

{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>Input[''InputName'']</code> || <code>bool Input[''InputName'']()</code>
| Called when the entity receives an I/O input that matches the function's name. The name that follows after <code>Input</code> must match the casing, i.e. {{Code|InputFireUser1}} will catch any "FireUser1" inputs but not "fireuser1" inputs from the <code>[[ent_fire]]</code> command.

Variables {{Code|activator}} and {{Code|caller}} are added to the scope when the function is called. The function also must return a boolean value which controls if the input is allowed to be processed, i.e. returning false cancels the input.
|-
| <code>OnEntText</code> || <code>string OnEntText()</code>
| If ent_text is used on an entity and this function exists, it will be called every tick. Returns a string that gets displayed as part of the ent_text overlay. This is a handy feature for displaying script data on objects when you ent_text the object, or running arbitrary code (such as turning on additional debugging visualizations) is using ent_text. NOTE: ent_text_allow_script 1 must be set in order for this feature to be active. 
|-
| <code>OnPostSpawn</code> || <code>void OnPostSpawn()</code>
| Called after the entity spawns, which is after scripts and players have loaded. This could be used to have an entity register itself with a master script, or adjusting the entity parameters in a programmatic way.
|-
| <code>Precache</code> || <code>void Precache()</code>
| Called after the script executes. Can be used to call precache functions for models and sounds on map load.
|}

=== CBaseAnimating ===
[[#toc|toc ↑]]
Extends [[#CBaseEntity|CBaseEntity ↑]]
Extended by:
[[#CBaseFlex|CBaseFlex ↓]]
[[#CTerrorWeapon|CTerrorWeapon ↓]]

Script handle class for animating entities such as props.

==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>FindBodygroupByName</code> || <code>int FindBodygroupByName(string ''name'')</code>
| Find a bodygroup ID by name. Returns -1 if the bodygroup does not exist.
|-
| <code>GetAttachmentAngles</code> || <code>QAngle GetAttachmentAngles(int ''ID'')</code>
| Get the attachment ID's angles as a QAngle.
|-
| <code>GetAttachmentBone</code> || <code>int GetAttachmentBone(int ''ID'')</code>
| Get the attachment ID's parent bone index.
|-
| <code>GetAttachmentOrigin</code> || <code>Vector GetAttachmentOrigin(int ''ID'')</code>
| Get the attachment ID's origin as a Vector.
|-
| <code>GetBodygroup</code> || <code>int GetBodygroup(int ''ID'')</code>
| Get the bodygroup value by bodygroup ID.
|-
| <code>GetBodygroupName</code> || <code>string GetBodygroupName(int ''ID'')</code>
| Get the bodygroup ID's name.
|-
| <code>GetBodygroupPartName</code> || <code>string GetBodygroupPartName(int ''group'', int ''part'')</code>
| Get name by group and part.
|-
| <code>GetBoneAngles</code> || <code>QAngle GetBoneAngles(int ''ID'')</code>
| Get the bone ID's angles as a QAngle.
|-
| <code>GetBoneOrigin</code> || <code>Vector GetBoneOrigin(int ''ID'')</code>
| Get the bone ID's origin Vector.
|-
| <code>GetModelScale</code> || <code>float GetModelScale()</code>
| Get the model scale.
|-
| <code>GetSequence</code> || <code>int GetSequence()</code>
| Get the currently playing sequence ID.
|-
| <code>GetSequenceActivityName</code> || <code>string GetSequenceActivityName(int ''ID'')</code>
| Get the activity name for a sequence by sequence ID.
|-
| <code>GetSequenceDuration</code> || <code>float GetSequenceDuration(int ''ID'')</code>
| Get a sequence duration in seconds by sequence ID.
|-
| <code>GetSequenceName</code> || <code>string GetSequenceName(int ''ID'')</code>
| Get a sequence name by sequence ID.
|-
| <code>IsSequenceFinished</code> || <code>bool IsSequenceFinished()</code>
| Returns true if the current sequence has finished playing.
|-
| <code>LookupActivity</code> || <code>int LookupActivity(string ''activity'')</code>
| Get the named activity index. Returns -1 if the activity does not exist.
|-
| <code>LookupAttachment</code> || <code>int LookupAttachment(string ''name'')</code>
| Get the named attachment index. Returns 0 if the attachment does not exist.
|-
| <code>LookupBone</code> || <code>int LookupBone(string ''bone'')</code>
| Get the named bone index. Returns -1 if the bone does not exist.
|-
| <code>LookupSequence</code> || <code>int LookupSequence(string ''name'')</code>
| Looks up a sequence by sequence name or activity name. Returns -1 if the sequence does not exist.
|-
| <code>ResetSequence</code> || <code>void ResetSequence(int ''ID'')</code>
| Reset a sequence by sequence ID. If the ID is different than the current sequence, switch to the new sequence.
|-
| <code>SetBodygroup</code> || <code>void SetBodygroup(int ''ID'', int ''value'')</code>
| Set the bodygroup by ID.
|-
| <code>SetModelScale</code> || <code>void SetModelScale(float ''scale'', float ''change_duration'')</code>
| Changes a model's scale over time. Set the change duration to 0.0 to change the scale instantly.
|-
| <code>SetPoseParameter</code> || <code>float SetPoseParameter(int ''ID'', float ''value'')</code>
| Sets a pose parameter value. Returns the effective value after clamping or looping.
|-
| <code>SetSequence</code> || <code>void SetSequence(int ''ID'')</code>
| Plays a sequence by sequence ID.
|}

=== CBaseFlex ===
[[#toc|toc ↑]]
Extends [[#CBaseAnimating|CBaseAnimating ↑]]

Animated characters who have vertex flex capability (e.g., facial expressions).

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>GetCurrentScene</code> || <code>handle GetCurrentScene()</code>
| Returns the instance of the oldest active scene entity (if any).
|-
| <code>GetSceneByIndex</code> || <code>handle GetSceneByIndex(int ''index'')</code>
| Returns the instance of the scene entity at the specified index.
|-
| <code>PlayScene</code> || <code>float PlayScene(string ''sceneFile'', float ''delay'')</code>
| Play the specified .vcd file, causing the related characters to speak and subtitles to play.
|}

=== CBaseCombatCharacter ===
[[#toc|toc ↑]]
Extends [[#CBaseFlex|CBaseFlex ↑]]

Combat character. Common and uncommon infected and witches belong to this.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>GetLastKnownArea</code> || <code>TerrorNavArea GetLastKnownArea()</code>
| Return the last nav area occupied - NULL if unknown.
|}

=== CTerrorPlayer ===
[[#toc|toc ↑]]
Extends [[#CBaseCombatCharacter|CBaseCombatCharacter ↑]]

Script handle class for player entities. Both survivors and special infected belong to this.

====  Methods ====

{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>DropItem</code> || <code>void DropItem(string ''classname'')</code>
| Make the player drop an item/weapon from their inventory, by classname.
|-
| <code>Extinguish</code> || <code>void Extinguish()</code>
| Extinguish a burning player.
|-
| <code>EyeAngles</code> || <code>QAngle EyeAngles()</code>
| Returns the direction the player is looking.
|-
| <code>EyePosition</code> || <code>Vector EyePosition()</code>
| Returns the players eye position in the world.
|-
| <code>GetActiveWeapon</code> || <code>handle GetActiveWeapon()</code>
| Get the player's active weapon entity.
|-
| <code>GetAliveDuration</code> || <code>float GetAliveDuration()</code>
| Returns the time the character has been alive (only valid when alive).
|-
| <code>GetButtonMask</code> || <code>int GetButtonMask()</code>
| Returns a bitfield of currently pressed buttons. Test against each value to see which button is pressed. Recognized buttons are:<br>1 - <code>IN_ATTACK</code><br>2 - <code>IN_JUMP</code><br>4 - <code>IN_DUCK</code><br>8 - <code>IN_FORWARD</code><br>16 - <code>IN_BACK</code><br>32 - <code>IN_USE</code><br>2048 - <code>IN_ATTACK2</code><br>8192 - <code>IN_RELOAD</code>
|-
| <code>GetHealthBuffer</code> || <code>float GetHealthBuffer()</code>
| Returns the current temporary health of a survivor.
|-
| <code>GetNetworkIDString</code> || <code>string GetNetworkIDString()</code>
| Get the player's network (i.e. Steam) ID.
|-
| <code>GetPlayerName</code> || <code>string GetPlayerName()</code>
| Get the players name.
|-
| <code>GetPlayerUserId</code> || <code>int GetPlayerUserId()</code>
| Get the players userID.
|-
| <code>GetSenseFlags</code> || <code>int GetSenseFlags()</code>
| Get the current bot sense flags. Test against each value to see which flag is set. Values:<br>1 - <code>BOT_CANT_SEE</code><br>2 - <code>BOT_CANT_HEAR</code><br> 4 - <code>BOT_CANT_FEEL</code>
|-
| <code>GetSpecialInfectedDominatingMe</code> || <code>CTerrorPlayer GetSpecialInfectedDominatingMe()</code>
| Get the Special Infected dominating this Survivor.
|-
| <code>GetSurvivorSlot</code> || <code>int GetSurvivorSlot()</code>
| Get the player's slot number.
|-
| <code>GetZombieType</code> || <code>int GetZombieType()</code>
| If an infected, find out what type. Recognized ZombieTypes are: Smoker = 1, Boomer = 2, Hunter = 3, Spitter = 4, Jockey = 5, Charger = 6, Witch = 7, Tank = 8, Survivor = 9 
|-
| <code>GiveAmmo</code> || <code>void GiveAmmo(int ''amount'')</code>
| Adds ammo for the player's primary weapon ammo pool.
|-
| <code>GiveItem</code> || <code>void GiveItem(string ''itemname'')</code>
| Give an item/weapon by name. Uses the same names as the {{Code|give}} console command(<code>health, katana, rifle_ak47</code>, etc.). {{bug*|Cannot give item to a player that is currently running a chainsaw (same applies to GiveItemWithSkin)}}
|-
| <code>GiveItemWithSkin</code> || <code>void GiveItemWithSkin(string ''classname'', int ''skin'')</code>
| Gives the player a skinned weapon.
|-
| <code>GiveUpgrade</code> || <code>void GiveUpgrade(int ''upgradeType'')</code>
| Give a primary weapon upgrade. Possible values:<br>0 - <code>UPGRADE_INCENDIARY_AMMO</code><br>1 - <code>UPGRADE_EXPLOSIVE_AMMO</code><br>2 - <code>UPGRADE_LASER_SIGHT</code>
|-
| <code>HasEverBeenInjured</code> || <code>bool HasEverBeenInjured(int ''team'')</code>
| Returns true if the character has ever been injured by a member of the given team.
|-
| <code>HitWithVomit</code> || <code>void HitWithVomit()</code>
| Cover the player with a boomer vomit attack.
|-
| <code>IsAdrenalineActive</code> || <code>bool IsAdrenalineActive()</code>
| Return true if adrenaline is active.
|-
| <code>IsDead</code> || <code>bool IsDead()</code>
| Returns true when a player is dead for more than 5 seconds. Note that taking over a dying bot immediately switches to the dead phase.
|-
| <code>IsDominatedBySpecialInfected</code> || <code>bool IsDominatedBySpecialInfected()</code>
| Return true if being dominated by a Special Infected (i.e. held by smoker, charger, jockey or hunter)
|-
| <code>IsDying</code> || <code>bool IsDying()</code>
| Returns true when a player has recently died for 5 seconds. Note that taking over a dying bot skips the dying phase.
|-
| <code>IsFiringWeapon</code> || <code>bool IsFiringWeapon()</code>
| Return true if player is firing a weapon.
|-
| <code>IsIncapacitated</code> || <code>bool IsIncapacitated()</code>
| Returns true if in incapacitated state.
|-
| <code>IsHangingFromLedge</code> || <code>bool IsHangingFromLedge()</code>
| Returns true if in ledge hang state.
|-
| <code>IsGettingUp</code> || <code>bool IsGettingUp()</code>
| Return true if player is currently getting up.
|-
| <code>IsGhost</code> || <code>bool IsGhost()</code>
| Returns true if in ghost infected state.
|-
| <code>IsImmobilized</code> || <code>bool IsImmobilized()</code>
| Return true if currently immobilized. {{tip|Is true when in getting up animation, punched by tank, flung by charger, caught by charger, smoker or hunter, hanging, incapacitated, dead, being healed, using kit, defibrillator or unpacking an upgrade pack, using timed button, pouring gas can, handing in cola or using minigun (not true when staggering or caught by jockey)}}
|-
| <code>IsInCombat</code> || <code>bool IsInCombat()</code>
| Return true if currently in combat.
|-
| <code>IsIT</code> || <code>bool IsIT()</code>
| Return true if currently IT from bile.
|-
| <code>IsOnFire</code> || <code>bool IsOnFire()</code>
| Returns true if a player is on fire, e.g. Standing in fireworks crate explosions.
|-
| <code>IsOnThirdStrike</code> || <code>bool IsOnThirdStrike()</code>
| Return true if on third-strike.
|-
| <code>IsStaggering</code> || <code>bool IsStaggering()</code>
| Return true if player is staggering.
|-
| <code>IsSuppressingFallingDamage</code> || <code>bool IsSuppressingFallingDamage()</code>
| Returns true if falling damage is currently suppressed, which is if the entity received the {{Code|IgnoreFallDamage}} or {{Code|IgnoreFallDamageWithoutReset}} input, provided that it is still active.
|-
| <code>IsSurvivor</code> || <code>bool IsSurvivor()</code>
| Returns true if entity is on the survivor or l4d1 survivor team (Otherwise, unknown, spectator or infected).
|-
| <code>RemoveUpgrade</code> || <code>void RemoveUpgrade(int ''upgradeType'')</code>
| Remove a primary weapon upgrade. Possible values:<br>0 - <code>UPGRADE_INCENDIARY_AMMO</code><br>1 - <code>UPGRADE_EXPLOSIVE_AMMO</code><br>2 - <code>UPGRADE_LASER_SIGHT</code>
|-
| <code>ReviveByDefib</code> || <code>void ReviveByDefib()</code>
| Revive a dead player by defib. 
|-
| <code>ReviveFromIncap</code> || <code>void ReviveFromIncap()</code>
| Revive an incapacitated player.
|-
| <code>SetFriction</code> || <code>void SetFriction(int ''friction'')</code>
| Set player friction.
|-
| <code>SetGravity</code> || <code>void SetGravity(int ''gravity'')</code>
| Set player gravity.
|-
| <code>SetHealthBuffer</code> || <code>void SetHealthBuffer(float ''health'')</code>
| Sets the temporary health of a survivor; No effect for infecteds. Does not incapacitate or kill when set to zero.
|-
| <code>SetReviveCount</code> || <code>void SetReviveCount(int ''count'')</code>
| Sets the number of times a survivor has been revived, and updates third-strike state (B&W) and heartbeat sound.
{{bug*|Doesn't update the <code>m_isGoingToDie</code> netprop, which controls the dying quotes.|only=l4d2}}
|-
| <code>SetSenseFlags</code> || <code>void SetSenseFlags(int ''flags'')</code>
| Set the set of bot sense flags. Combine values to set appropriate flags:<br>1 - <code>BOT_CANT_SEE</code><br>2 - <code>BOT_CANT_HEAR</code><br> 4 - <code>BOT_CANT_FEEL</code>
|-
| <code>SnapEyeAngles</code> || <code>void SnapEyeAngles(QAngle ''angles'')</code>
| Sets the view angles. Supports rolling the view.
|-
| <code>Stagger</code> || <code>void Stagger(Vector ''position'')</code>
| Stagger a player away from a position. Use Vector(0,0,0) to just stagger forward.
|-
| <code>SwitchToItem</code> || <code>bool SwitchToItem(string ''classname'')</code>
| Make the player switch to an item/weapon by classname. Returns true if the switch was performed.
|-
| <code>TryGetPathableLocationWithin</code> || <code>Vector TryGetPathableLocationWithin(float ''radius'')</code>
| Get a location on the nav the player can path to within the desired radius.
|-
| <code>UseAdrenaline</code> || <code>void UseAdrenaline(float ''duration'')</code>
| Causes Adrenaline's speed and visual effect, no change to health.
|}

=== CTerrorWeapon ===
[[#toc|toc ↑]]
Extends [[#CBaseAnimating|CBaseAnimating ↑]].

All weapon entities that are part of a player's inventory, holstered or not, belongs to this. All {{Code|Clip2}} related functions have no gameplay effects (unless weapon scripts are modded), but can be used for your own custom weapon ammunition needs. E.g. A Hunting Rifle with 3 Oxygen Tank throwables.
{{note|[[weapon_chainsaw]]'s fuel can be modified with the {{Code|Clip1}} related functions!}}
{{note|[[weapon_pistol]]'s {{Code|GetDefaultClip1}} is always treated as a single pistol, but {{Code|GetMaxClip1}} will account for dual pistols as well! }}

==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>Clip1</code> || <code>int Clip1()</code>
| Current amount of ammo in a weapon's clip.
|-
| <code>Clip2</code> || <code>int Clip2()</code>
| Current 'secondary clip' ammo count. Always -1 in default game.
|-
| <code>GetDefaultClip1</code> || <code>int GetDefaultClip1()</code>
| Clip count of a weapon when its newly picked up.
|-
| <code>GetDefaultClip2</code> || <code>int GetDefaultClip2()</code>
| Default 'secondary clip' ammo count. Always -1 in default game; Only a positive value if a custom weapon script has {{Code|clip2_size}} set.
|-
| <code>GetMaxClip1</code> || <code>int GetMaxClip1()</code>
| Max clip count a weapon can hold. Will always return the same value as the {{Code|GetDefaultClip1}} function.
|-
| <code>GetMaxClip2</code> || <code>int GetMaxClip2()</code>
| Max 'secondary clip' count. Always -1 in default game; Only a positive value if a custom weapon script has {{Code|clip2_size}} set. Will always return the same value as the {{Code|GetDefaultClip2}} function.
|-
| <code>GiveDefaultAmmo</code> || <code>void GiveDefaultAmmo()</code>
| Revert both weapons's clip to their default values.
|-
| <code>Reload</code> || <code>bool Reload()</code>
| Forces the weapon to reload if it is not full. Returns true if it could start a weapon reload.
|-
| <code>SetClip1</code> || <code>void SetClip1(int ''amount'')</code>
| Sets a weapon's clip count.
|-
| <code>SetClip2</code> || <code>void SetClip2(int ''amount'')</code>
| Sets a weapon's 'secondary clip' count; Works just fine but has no gameplay effect in default game.
|}

=== CBaseTrigger ===
[[#toc|toc ↑]]
Extends [[#CBaseEntity|CBaseEntity ↑]]

Entity class for [[:Category:CBaseTrigger|all entities inheriting CBaseTrigger]]

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function  !! Signature  !! Description 
|-
| <code>Disable</code> || <code>void Disable() </code>
| Disable the trigger. Identical to the {{Code|Disable}} input.
|-
| <code>Enable</code> || <code>void Enable() </code>
| Enable the trigger. Identical to the {{Code|Enable}} input.
|-
| <code>IsTouching</code> || <code>bool IsTouching(handle ''entity'') </code>
| Checks whether the passed entity is touching the trigger.
|}

=== AI_Response ===
[[#toc|toc ↑]]
''Opaque type representing a return value from the old response system.''

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>GetMatchScore</code> || 
| Relative score of this match's quality (based on number of criteria matched)).
|}

=== CDirector ===
[[#toc|toc ↑]]
[[#Instances|Instances ↑]] Game Instance: <code>Director</code>

Provides methods for reading information and forcing events in the AI Director. To influence the Director behavior, the {{Code|[[L4D2_Director_Scripts#DirectorOptions|DirectorOptions]]}} table is used instead.

==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>AreAllSurvivorsInBattlefield</code> || <code>bool AreAllSurvivorsInBattlefield()</code>
| Returns true if all Survivors are in the battlefield.
|-
| <code>AreAllSurvivorsInFinaleArea</code> || <code>bool AreAllSurvivorsInFinaleArea()</code>
| True when all survivors are within the finale area.
|-
| <code>AreTeamsFlipped</code> || <code>bool AreTeamsFlipped()</code>
| True when teams are flipped in Versus modes.
|-
| <code>ClearCachedBotQueries</code> || <code>void ClearCachedBotQueries()</code>
| Mark all cached bot query results as invalid.
|-
| <code>ForceNextStage</code> || <code>void ForceNextStage()</code>
| Push the ScriptedMode to next stage - i.e. request GNSS be called.
|-
| <code>GetAveragedSurvivorSpan</code> || <code>float GetAveragedSurvivorSpan()</code>
| Get the distance between the lead and trailing survivors, smoothed over time.
|-
| <code>GetAveragedSurvivorSpeed</code> || <code>float GetAveragedSurvivorSpeed()</code>
| Get the rate at which the lead survivor is moving along the flow, smoothed over time.
|-
| <code>GetClosestActivePipeBomb</code> || <code>CBaseEntity GetClosestActivePipeBomb(Vector ''origin'')</code>
| Returns the closest active pipe bomb from this origin.
|-
| <code>GetClosestCharacterWhoIsIT</code> || <code>CBaseCombatCharacter GetClosestCharacterWhoIsIT(CBaseCombatCharacter ''character'')</code>
| Returns the closest character who is IT to the passed character.
|-
| <code>GetClosestSurvivor</code> || <code>CTerrorPlayer GetClosestSurvivor(Vector ''origin'', bool bIncludeIncap, bool bIncludeOnRescueVehicle)</code>
| Returns the closest Survivor from the passed origin, if incapped Survivors are included in search, or on rescue vehicle.
|-
| <code>GetCommonInfectedCount</code> || <code>int GetCommonInfectedCount()</code>
| Returns number for infected currently spawned.
|-
| <code>GetFurthestSurvivorFlow</code> || <code>float GetFurthestSurvivorFlow()</code>
| Get the maximum distance along the flow that the survivors have reached.
|-
| <code>GetGameMode</code> || <code>string GetGameMode()</code>
| Get the current game mode. If called in a mutation, it returns the current mutation, not the base mode. Will '''only''' look for the specific game mode/mutation.
|-
| <code>GetGameModeBase</code> || <code>string GetGameModeBase()</code>
| Get the current base game mode. Does not return the current mutation. Example, if looking for survival, it will also count for all game modes using survival as base. Such as Mutation 15 (Survival Versus)
|-
| <code>GetHighestFlowSurvivor</code> || <code>CTerrorPlayer GetHighestFlowSurvivor()</code>
| Returns the Survivor with the highest flow.
|-
| <code>GetHoldoutCooldownEndTime</code> || <code>float GetHoldoutCooldownEndTime()</code>
| Get the end time of the cooldown timer.
|-
| <code>GetLowestFlowSurvivor</code> || <code>CTerrorPlayer GetLowestFlowSurvivor()</code>
| Returns the Survivor with the lowest flow.
|-
| <code>GetMapName</code> || <code>string GetMapName()</code>
| Get the current map name.
|-
| <code>GetMapNumber</code> || <code>int GetMapNumber()</code>
| Return the current map number.
|-
| <code>GetMissionWipes</code> || <code>int GetMissionWipes()</code>
| Returns the current number of mission wipes.
|-
| <code>GetPendingMobCount</code> || <code>int GetPendingMobCount()</code>
| Returns the number of infected waiting to spawn.
|-
| <code>GetRandomSurvivor</code> || <code>CTerrorPlayer GetRandomSurvivor()</code>
| Returns a random alive Survivor.
|-
| <code>GetSurvivorSet</code> || <code>int GetSurvivorSet()</code>
| Get the current survivor set. L4D1 Survivors = 1, L4D2 Survivors = 2. {{bug*|Calling this inside mapspawn_addon or response_testbed_addon will give survivor set value of previous loaded map}}
|-
| <code>GetTimeSinceSpecialZombieKilled</code> || <code>float GetTimeSinceSpecialZombieKilled(int ''zombieType'')</code>
| Returns the time since the passed zombie type was killed.
|-
| <code>GetTotalElapsedMissionTime</code> || <code>float GetTotalElapsedMissionTime()</code>
| Returns the total elapsed mission time.
|-
| <code>HasAnySurvivorLeftSafeArea</code> || <code>bool HasAnySurvivorLeftSafeArea()</code>
| True when one or more survivors have left the starting safe area.
|-
| <code>IsAnySurvivorBypassingTank</code> || <code>bool IsAnySurvivorBypassingTank()</code>
| True when one or more survivors are bypassing the Tank.
|-
| <code>IsAnySurvivorInCombat</code> || <code>bool IsAnySurvivorInCombat()</code>
| Returns true if any survivor recently dealt or took damage.
|-
| <code>IsAnySurvivorInExitCheckpoint</code> || <code>bool IsAnySurvivorInExitCheckpoint()</code>
| True when one or more survivors are in the exit checkpoint.
|-
| <code>IsAnySurvivorInStartArea</code> || <code>bool IsAnySurvivorInStartArea()</code>
| True when one or more survivors are in the starting safe area.
|-
| <code>IsFinale</code> || <code>bool IsFinale()</code>
| True when the finale has started.
|-
| <code>IsFinaleEscapeInProgress</code> || <code>bool IsFinaleEscapeInProgress()</code>
| True when the finale escape is in progress.
|-
| <code>IsFinaleVehicleReady</code> || <code>bool IsFinaleVehicleReady()</code>
| True when the finale vehicle is ready.
|-
| <code>IsFinaleWon</code> || <code>bool IsFinaleWon()</code>
| Returns true if the finale has been won.
|-
| <code>IsFirstMapInScenario</code> || <code>bool IsFirstMapInScenario()</code>
| True if the first map in a scenario.
|-
| <code>IsL4D1Campaign</code> || <code>bool IsL4D1Campaign()</code>
| Return true if the current campaign is originally from L4D1.
|-
| <code>IsLocationFoggedToSurvivors</code> || <code>bool IsLocationFoggedToSurvivors(Vector ''origin'')</code>
| Returns true if the passed location is fogged to Survivors.
|-
| <code>IsPlayingIntro</code> || <code>bool IsPlayingIntro()</code>
| True if the intro is currently playing.
|-
| <code>IsPlayingOnConsole</code> || <code>bool IsPlayingOnConsole()</code>
| Return true if game is running on a console (such as Xbox 360).
|-
| <code>IsSessionStartMap</code> || <code>bool IsSessionStartMap()</code>
| True if the map is the start of the session.
|-
| <code>IsSinglePlayerGame</code> || <code>bool IsSinglePlayerGame()</code>
| Return true if game is in single player.
|-
| <code>IsValid</code> || <code>bool IsValid()</code>
| Whether<code>Director</code>belongs to a valid entity. Seems futile to use.
|-
| <code>IsTankInPlay</code> || <code>bool IsTankInPlay()</code>
| Returns true if any tanks are aggro on survivors.
|-
| <code>L4D1SurvivorGiveItem</code> || <code>void L4D1SurvivorGiveItem()</code>
| Let the L4D1 survivors know that now is a good time to give the players an item.
|-
| <code>PlayMegaMobWarningSounds</code> || <code>void PlayMegaMobWarningSounds()</code>
| Plays a horde scream sound and asks survivors to speak ''incoming horde'' lines.
|-
| <code>RegisterForbiddenTarget</code> || <code>void RegisterForbiddenTarget(CBaseEntity ''entity'')</code>
| Registers a target entity as forbidden.
|-
| <code>ResetMobTimer</code> || <code>void ResetMobTimer()</code>
| Trigger a mob as soon as possible when in {{Code|BUILD_UP}}.
|-
| <code>ResetSpecialTimers</code> || <code>void ResetSpecialTimers()</code>
| Reset all special timers (by type and by slot) so that hopefully mobs will spawn asap.
|-
| <code>SetHoldoutCooldownEndTime</code> || <code>void SetHoldoutCooldownEndTime(float ''time'')</code>
| 
|-
| <code>UnregisterForbiddenTarget</code> || <code>void UnregisterForbiddenTarget(CBaseEntity ''entity'')</code>
| Unregisters a target entity as forbidden.
|-
| <code>UserDefinedEvent1</code><br><code>UserDefinedEvent2</code><br><code>UserDefinedEvent3</code><br><code>UserDefinedEvent4</code> || <code>void UserDefinedEvent1()</code><br><code>void UserDefinedEvent2()</code><br><code>void UserDefinedEvent3()</code><br><code>void UserDefinedEvent4()</code>
| When called, these trigger the appropriate output of the {{Code|[[info_director]]}} entity.
| 
|-
| <code>WarpAllSurvivorsToBattlefield</code> || <code>void WarpAllSurvivorsToBattlefield()</code>
| Warp all Survivors to the battlefield.
|-
| <code>WarpAllSurvivorsToCheckpoint</code> || <code>void WarpAllSurvivorsToCheckpoint()</code>
| Warp all Survivors to the exit checkpoint.
|-
| <code>WarpAllSurvivorsToFinale</code> || <code>void WarpAllSurvivorsToFinale()</code>
| Warp all Survivors to the finale radio.
|}

=== CEntities ===
[[#toc|toc ↑]]
[[#Instances|Instances ↑]] Game Instance: <code>Entities</code>

An interface to find and iterate over the script handles for the entities in play. To iterate over a set of entities, pass null to the ''previous'' parameter in the appropriate method to start an iteration. A reference to a previously-found entity can be used instead to continue a search.

The following are two equivalent examples and iterate over all weapons on the map:

{| width=100%
|- style="vertical-align:top;"
|
<source lang=js>
local ent = null;
while ( ent = Entities.FindByClassname(ent, "weapon_*") )
{
  // ...
}
</source>
|
<source lang=js>
for (local ent; ent = Entities.FindByClassname(ent, "weapon_*"); )
{
  // ...
}
</source>
|}

{{Note |
* The variable name <code>ent</code> is arbitrary.
* Indeed, we mean "{{=}}" and not "{{=}}{{=}}" in the loop conditions! The loops end if <code>ent</code> becomes <code>null</code>, which happens when no matching entities have an [[entity index]] higher to the one in ''previous'' parameter.
* Semicolons are optional, except in the header of the <code>for</code> statement.
* The string parameters of the <code>FindBy...</code> functions support the wildcard star <code>*</code>. In the above example, <code>FindByClassname</code> only returns either a handle of an entity whose classname begins with "<code>weapon_</code>" or it returns <code>null</code>.
}}


==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>FindByClassname</code> || <code>handle FindByClassname(handle ''previous'', string ''class'')</code>
| Find entities by class name. 
|-
| <code>FindByClassnameNearest</code> || <code>handle FindByClassnameNearest(string ''class'', Vector ''origin'', float ''radius'')</code>
| Find the entity with the given class name nearest to the specified point.
|-
| <code>FindByClassnameWithin</code> || <code>handle FindByClassnameWithin(handle ''previous'', string ''class'', Vector ''origin'', float ''radius'')</code>
| Find entities by class name within a radius, while within a set radius. 
|-
| <code>FindByModel</code> || <code>handle FindByModel(handle ''previous'', string ''filename'')</code>
| Find entities by a model path name. 
|-
| <code>FindByName</code> || <code>handle FindByName(handle ''previous'', string ''name'')</code>
| Find entities by targetname. Special ones including {{Code|!bill}} will work. 
|-
| <code>FindByNameNearest</code> || <code>handle FindByNameNearest(string ''name'', Vector ''origin'', float ''radius'')</code>
| Find entities by targetname nearest to a point, while within a set radius. Special ones including {{Code|!bill}} will work. 
|-
| <code>FindByNameWithin</code> || <code>handle FindByNameWithin(handle ''previous'', string ''name'', Vector ''origin'', float ''radius'')</code>
| Find entities by targetname within a radius. Special ones including {{Code|!bill}} will work.
|-
| <code>FindByTarget</code> || <code>handle FindByTarget(handle ''previous'', string ''targetname'')</code>
| Find entities by its target.
|-
| <code>FindInSphere</code> || <code>handle FindInSphere(handle ''previous'', Vector ''origin'', float ''radius'')</code>
| Returns entities within a set radius.
|-
| <code>First</code> || <code>handle First()</code>
| The first entity that spawned (Always <code>worldspawn</code>). Can be used to begin an iteration for a list of entities.
|-
| <code>Next</code> || <code>handle Next(handle ''previous'')</code>
| At the given reference of a previously-found entity, returns the next one after it in the list.
|-
| <code>IsValid</code> || <code>bool IsValid()</code>
| Whether the handle for <code>Entities</code> is a valid handle.
|}
<!--
==== Code Samples ====

Example:
<source lang=js>

</source>
-->

=== CEnvEntityMaker ===
[[#toc|toc ↑]]
Extends [[#CBaseEntity|CBaseEntity ↑]]

Script handle class for [[env_entity_maker]]. 

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>SpawnEntity</code> || <code>void SpawnEntity()</code>
| Create an entity at the location of the maker.
|-
| <code>SpawnEntityAtEntityOrigin</code> || <code>void SpawnEntityAtEntityOrigin(CBaseEntity ''entity'')</code>
| Create an entity at the location of a specified entity instance.
|-
| <code>SpawnEntityAtLocation</code> || <code>void SpawnEntityAtLocation(Vector ''origin'', QAngle ''orientation'')</code>
| Create an entity at a specified location and orientation.
|-
| <code>SpawnEntityAtNamedEntityOrigin</code> || <code>void SpawnEntityAtNamedEntityOrigin(string ''name'')</code>
| Create an entity at the location of a named entity.
|}


=== CInfoItemPosition ===
[[#toc|toc ↑]]
Extends [[#CBaseEntity|CBaseEntity ↑]]

Script handle class for [[info_item_position]].

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>GetGroup</code> || 
| Get the group number for this item position
|-
| <code>GetRarity</code> || 
| Get the rarity for this item position.
|-
| <code>GetReplaceParm</code> || 
| Get a replacement parameter by index.
|-
| <code>SetGroup</code> || 
| Set the group number for this item position.
|-
| <code>SetRarity</code> || 
| Set the rarity for this item position.
|}

=== CNavMesh ===
[[#toc|toc ↑]]
[[#Instances|Instances ↑]] Game Instance: <code>NavMesh</code>

An interface to the Navigation Mesh.

==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>FindLadderAlongRay</code> || <code>CNavLadder FindLadderAlongRay(Vector ''startpos'', Vector ''endpos'', TerrorNavArea ''ignoreArea'')</code>
| Get nav ladder from ray.
|-
| <code>FindNavAreaAlongRay</code> || <code>TerrorNavArea FindNavAreaAlongRay(Vector ''startpos'', Vector ''endpos'', TerrorNavArea ''ignoreArea'')</code>
| Get nav area from ray.
|-
| <code>GetAllAreas</code> || <code>void GetAllAreas(table)</code>
| Fills a passed in table of all nav areas.
|-
| <code>GetAllLadders</code> || <code>void GetAllLadders(table)</code>
| Fills a passed in table of all nav ladders.
|-
| <code>GetAreasWithAttributes</code> || <code>void GetAreasWithAttributes(int ''bits'', table)</code>
| Fills a passed in table of all nav areas that have the specified attributes.
|-
| <code>GetLadderByID</code> || <code>CNavLadder GetLadderByID(int ''id'')</code>
| Get nav ladder by ID.
|-
| <code>GetLadderCount</code> || <code>int GetLadderCount()</code>
| Return total number of nav ladders.
|-
| <code>GetNavArea</code> || <code>TerrorNavArea GetNavArea(Vector ''origin'', float ''flBeneath'')</code>
| Given a position in the world, return the nav area that is closest and at the same height, or beneath it.
|-
| <code>GetNavAreaByID</code> || <code>TerrorNavArea GetNavAreaByID(int ''id'')</code>
| Get nav area by ID.
|-
| <code>GetNavAreaCount</code> || <code>int GetNavAreaCount()</code>
| Return total number of nav areas.
|-
| <code>GetNavAreasFromBuildPath</code> || <code>bool GetNavAreasFromBuildPath(TerrorNavArea ''startArea'', TerrorNavArea ''endArea'', Vector ''goalPos'', float ''flMaxPathLength'', int ''teamID'', bool ''ignoreNavBlockers'', table)</code>
| Fills table with areas from a path. Returns whether a path was found. If 'endArea' is NULL, will compute a path as close as possible to 'goalPos'.
|-
| <code>GetNavAreasInRadius</code> || <code>void GetNavAreasInRadius(Vector ''origin'', float ''radius'', table)</code>
| Fills a passed in table of nav areas within radius.
|-
| <code>GetNavAreasOverlappingEntityExtent</code> || <code>void GetNavAreasOverlappingEntityExtent(CBaseEntity ''entity'', table)</code>
| Fills passed in table with areas overlapping entity's extent.
|-
| <code>GetNearestNavArea</code> || <code>TerrorNavArea GetNearestNavArea(Vector ''origin'', float ''maxDist'', bool ''checkLOS'', bool ''checkGround'')</code>
| Given a position in the world, return the nav area that is closest and at the same height, or beneath it.
|-
| <code>GetObstructingEntities</code> || <code>void GetObstructingEntities(table)</code>
| Fills a passed in table of all obstructing entities.
|-
| <code>IsValid</code> || <code>bool IsValid()</code>
| Whether the handle belongs to a valid entity. Redundant as navigation meshes are not entity related.
|-
| <code>NavAreaBuildPath</code> || <code>bool NavAreaBuildPath(TerrorNavArea ''startArea'', TerrorNavArea ''endArea'', Vector ''goalPos'', float ''flMaxPathLength'', int ''teamID'', bool ''ignoreNavBlockers'')</code>
| Returns true if a path exists. If 'endArea' is NULL, will compute a path as close as possible to 'goalPos'.
|-
| <code>NavAreaTravelDistance</code> || <code>float NavAreaTravelDistance(TerrorNavArea ''startArea'', TerrorNavArea ''endArea'', float ''flMaxPathLength'')</code>
| Compute distance between two areas. Return -1 if can't reach 'endArea' from 'startArea'.
|-
| <code>RegisterAvoidanceObstacle</code> || <code>void RegisterAvoidanceObstacle(CBaseEntity ''entity'')</code>
| Registers an entity as an avoidance obstacle.
|-
| <code>UnblockRescueVehicleNav</code> || <code>void UnblockRescueVehicleNav()</code>
| Unblock the rescue vehicle nav areas so bots can path through them.
|-
| <code>UnregisterAvoidanceObstacle</code> || <code>void UnregisterAvoidanceObstacle(CBaseEntity ''entity'')</code>
| Unregisters an entity as an avoidance obstacle.
|}

=== TerrorNavArea ===
[[#toc|toc ↑]]
This is a script handle class for nav areas. Nav areas may also have [[List_of_L4D_Series_Nav_Mesh_Attributes|attributes]] applied on them.

==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>AddIncomingConnection</code> || <code>void AddIncomingConnection(TerrorNavArea ''area'', int ''dir'')</code>
| Add areas that connect TO this area by a ONE-WAY link.
|-
| <code>ComputeDirection</code> || <code>int ComputeDirection(Vector ''point'')</code>
| Return direction from this area to the given point.
|-
| <code>ConnectTo</code> || <code>void ConnectTo(TerrorNavArea ''area'', int ''dir'')</code>
| Connect this area to given area in given direction. If you set direction to -1, it will be automatically applied.
|-
| <code>ConnectToLadder</code> || <code>void ConnectToLadder(CNavLadder ''ladder'')</code>
| Connect this area to given ladder.
|-
| <code>Contains</code> || <code>bool Contains(TerrorNavArea ''area'')</code>
| Return true if other area is on or above this area, but no others.
|-
| <code>ContainsOrigin</code> || <code>bool ContainsOrigin(Vector ''point'')</code>
| Return true if given point is on or above this area, but no others.
|-
| <code>DebugDrawFilled</code> || <code>void DebugDrawFilled(int ''r'', int ''g'', int ''b'', int ''a'', float ''duration'', bool ''noDepthTest'')</code>
| Draw area as a filled rectangle of the given color.
|-
| <code>Disconnect</code> || <code>void Disconnect(TerrorNavArea ''area'')</code>
| Disconnect this area from given area.
|-
| <code>DisconnectLadder</code> || <code>void DisconnectLadder(CNavLadder ''ladder'')</code>
| Disconnect this area from given ladder.
|-
| <code>FindRandomSpot</code> || <code>Vector FindRandomSpot()</code>
| Get random origin within extent of area.
|-
| <code>GetAdjacentArea</code> || <code>TerrorNavArea GetAdjacentArea(int ''dir'', int ''nAreas'')</code>
| Return the n'th adjacent area in the given direction.
|-
| <code>GetAdjacentAreas</code> || <code>void GetAdjacentAreas(int ''dir'', table)</code>
| Fills a passed in table with all adjacent areas in the given direction.
|-
| <code>GetAdjacentCount</code> || <code>int GetAdjacentCount(int ''dir'')</code>
| Get the number of adjacent areas in the given direction.
|-
| <code>GetAttributes</code> || <code>int GetAttributes()</code>
| Get area attribute bits.
|-
| <code>GetAvoidanceObstacleHeight</code> || <code>float GetAvoidanceObstacleHeight()</code>
| Returns the maximum height of the obstruction above the ground.
|-
| <code>GetCenter</code> || <code>Vector GetCenter()</code>
| Get center origin of area.
|-
| <code>GetCorner</code> || <code>Vector GetCorner(int ''corner'')</code>
| Get corner origin of area.
|-
| <code>GetDistanceSquaredToPoint</code> || <code>float GetDistanceSquaredToPoint(Vector ''pos'')</code>
| Return shortest distance between point and this area.
|-
| <code>GetDoor</code> || <code>CBaseEntity GetDoor()</code>
| Returns the door entity above the area.
|-
| <code>GetElevator</code> || <code>CBaseEntity GetElevator()</code>
| Returns the elevator if in an elevator's path.
|-
| <code>GetElevatorAreas</code> || <code>void GetElevatorAreas(table)</code>
| Fills a passed in table with a collection of areas reachable via elevator from this area.
|-
| <code>GetID</code> || <code>int GetID()</code>
| Get area ID.
|-
| <code>GetIncomingConnections</code> || <code>void GetIncomingConnections(int ''dir'', table)</code>
| Fills a passed in table with areas connected TO this area by a ONE-WAY link (ie: we have no connection back to them).
|-
| <code>GetLadders</code> || <code>void GetLadders(int ''dir'', table)</code>
| Fills a passed in table of ladders in direction.
|-
| <code>GetParent</code> || <code>TerrorNavArea GetParent()</code>
| Returns the area just prior to this one in the search path.
|-
| <code>GetParentHow</code> || <code>int GetParentHow()</code>
| Returns how we get from parent to us.
|-
| <code>GetPlaceName</code> || <code>string GetPlaceName()</code>
| Get place name, null if no name.
|-
| <code>GetPlayerCount</code> || <code>int GetPlayerCount(int ''team'')</code>
| Return number of players of given team currently within this area (team of zero means any/all).
|-
| <code>GetRandomAdjacentArea</code> || <code>TerrorNavArea GetRandomAdjacentArea(int ''dir'')</code>
| Return a random adjacent area in the given direction.
|-
| <code>GetSizeX</code> || <code>float GetSizeX()</code>
| Return the area size along the X axis.
|-
| <code>GetSizeY</code> || <code>float GetSizeY()</code>
| Return the area size along the Y axis.
|-
| <code>GetSpawnAttributes</code> || <code>int GetSpawnAttributes()</code>
| Get spawn attribute bits.
|-
| <code>GetTimeSinceCleared</code> || <code>float GetTimeSinceCleared()</code>
| Returns the time since the area was cleared.
|-
| <code>GetZ</code> || <code>float GetZ(Vector ''pos'')</code>
| Returns the height of the area at the specified point.
|-
| <code>HasAttributes</code> || <code>bool HasAttributes(int ''bits'')</code>
| Has area attribute bits.
|-
| <code>HasAvoidanceObstacle</code> || <code>bool HasAvoidanceObstacle(float ''maxHeight'')</code>
| Returns true if there's a large, immobile object obstructing this area.
|-
| <code>HasSpawnAttributes</code> || <code>bool HasSpawnAttributes(int ''bits'')</code>
| Has spawn attribute bits.
|-
| <code>IsBlocked</code> || <code>bool IsBlocked(int ''team'', bool ''affectsFlow'')</code>
| Return true if team is blocked in this area.
|-
| <code>IsBottleneck</code> || <code>bool IsBottleneck()</code>
| Returns true if area is a bottleneck.
|-
| <code>IsCleared</code> || <code>bool IsCleared(CTerrorPlayer ''player'')</code>
| Returns true if this area has been cleared for the player.
|-
| <code>IsCompletelyVisibleToTeam</code> || <code>bool IsCompletelyVisibleToTeam(int ''team'')</code>
| Return true if given area is completely visible from somewhere in this area by someone on the team.
|-
| <code>IsConnected</code> || <code>bool IsConnected(TerrorNavArea ''area'', int ''dir'')</code>
| Return true if this area is connected to other area in given direction. (If you set direction to -1 or 4, it will automatically check all directions for a connection)
|-
| <code>IsConnectedLadder</code> || <code>bool IsConnectedLadder(CNavLadder ''ladder'', int ''dir'')</code>
| Return true if this area is connected to ladder in given direction.
|-
| <code>IsCoplanar</code> || <code>bool IsCoplanar(TerrorNavArea ''area'')</code>
| Return true if this area and given area are approximately co-planar.
|-
| <code>IsDamaging</code> || <code>bool IsDamaging()</code>
| Return true if continuous damage (ie: fire) is in this area.
|-
| <code>IsDegenerate</code> || <code>bool IsDegenerate()</code>
| Return true if this area is badly formed.
|-
| <code>IsEdge</code> || <code>bool IsEdge(int ''dir'')</code>
| Return true if there are no bi-directional links on the given side.
|-
| <code>IsFlat</code> || <code>bool IsFlat()</code>
| Return true if this area is approximately flat.
|-
| <code>IsOverlapping</code> || <code>bool IsOverlapping(TerrorNavArea ''area'')</code>
| Return true if 'area' overlaps our 2D extents.
|-
| <code>IsOverlappingOrigin</code> || <code>bool IsOverlappingOrigin(Vector ''pos'', float ''tolerance'')</code>
| Return true if 'pos' is within 2D extents of area.
|-
| <code>IsPotentiallyVisibleToTeam</code> || <code>bool IsPotentiallyVisibleToTeam(int ''team'')</code>
| Return true if any portion of this area is visible to anyone on the given team.
|-
| <code>IsRoughlySquare</code> || <code>bool IsRoughlySquare()</code>
| Return true if this area is approximately square.
|-
| <code>IsSpawningAllowed</code> || <code>bool IsSpawningAllowed()</code>
| Returns true if spawning is allowed in this area.
|-
| <code>IsUnderwater</code> || <code>bool IsUnderwater()</code>
| Return true if area is underwater.
|-
| <code>IsValid</code> || <code>bool IsValid()</code>
| Whether the handle belongs to a valid area.
|-
| <code>IsValidForWanderingPopulation</code> || <code>bool IsValidForWanderingPopulation()</code>
| Returns true if area is valid for wandering population.
|-
| <code>IsVisible</code> || <code>bool IsVisible(Vector ''point'')</code>
| Return true if area is visible from the given point.
|-
| <code>MarkAreaCleared</code> || <code>void MarkAreaCleared(CTerrorPlayer ''player'')</code>
| Mark this area as cleared for the player.
|-
| <code>MarkAreaNotCleared</code> || <code>void MarkAreaNotCleared()</code>
| Mark this area as not cleared.
|-
| <code>MarkAsBlocked</code> || <code>void MarkAsBlocked(int ''team'')</code>
| Mark this area as blocked for team.
|-
| <code>MarkAsDamaging</code> || <code>void MarkAsDamaging(float ''duration'')</code>
| Mark this area is damaging for the next 'duration' seconds.
|-
| <code>MarkObstacleToAvoid</code> || <code>void MarkObstacleToAvoid(float ''height'')</code>
| Marks the obstructed status of the nav area.
|-
| <code>RemoveAttributes</code> || <code>void RemoveAttributes(int ''bits'')</code>
| Removes area attribute bits.
|-
| <code>RemoveOrthogonalConnections</code> || <code>void RemoveOrthogonalConnections(int ''dir'')</code>
| Removes all connections in directions to left and right of specified direction.
|-
| <code>RemoveSpawnAttributes</code> || <code>void RemoveSpawnAttributes(int ''bits'')</code>
| Remove spawn attribute bits.
|-
| <code>SetAttributes</code> || <code>void SetAttributes(int ''bits'')</code>
| Set area attribute bits.
|-
| <code>SetPlaceName</code> || <code>void SetPlaceName(string ''name'')</code>
| Set place name. If you pass null, the place name will be set to nothing.
|-
| <code>SetSpawnAttributes</code> || <code>void SetSpawnAttributes(int ''bits'')</code>
| Set spawn attribute bits.
|-
| <code>UnblockArea</code> || <code>void UnblockArea()</code>
| Unblocks this area.
|}

=== CNavLadder ===
[[#toc|toc ↑]]
This is a script handle class for nav ladders.

==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>ConnectTo</code> || <code>void ConnectTo(TerrorNavArea ''area'')</code>
| Connect this ladder to given area.
|-
| <code>Disconnect</code> || <code>void Disconnect(TerrorNavArea ''area'')</code>
| Disconnect this ladder from given area.
|-
| <code>GetBottomArea</code> || <code>TerrorNavArea GetBottomArea()</code>
| Area of the bottom of the ladder.
|-
| <code>GetBottomOrigin</code> || <code>Vector GetBottomOrigin()</code>
| World coords of the bottom of the ladder.
|-
| <code>GetDir</code> || <code>int GetDir()</code>
| Return the way the ladder faces (ie: surface normal of climbable side).
|-
| <code>GetID</code> || <code>int GetID()</code>
| Get ladder ID.
|-
| <code>GetLadderEntity</code> || <code>CBaseEntity GetLadderEntity()</code>
| Returns the ladder entity.
|-
| <code>GetLength</code> || <code>float GetLength()</code>
| Return the length of the ladder.
|-
| <code>GetPosAtHeight</code> || <code>Vector GetPosAtHeight(float ''height'')</code>
| Return x,y coordinate of the ladder at a given height.
|-
| <code>GetTopArea</code> || <code>TerrorNavArea GetTopArea()</code>
| Area of the top of the ladder.
|-
| <code>GetTopOrigin</code> || <code>Vector GetTopOrigin()</code>
| World coords of the top of the ladder.
|-
| <code>GetWidth</code> || <code>float GetWidth()</code>
| Return the width of the ladder.
|-
| <code>IsConnected</code> || <code>bool IsConnected(TerrorNavArea ''area'', int ''dir'')</code>
| Return true if given ladder is connected in given direction.
|-
| <code>IsInUse</code> || <code>bool IsInUse(CBaseEntity ''ignore'')</code>
| Return true if someone is on this ladder (other than 'ignore').
|-
| <code>IsUsableByTeam</code> || <code>bool IsUsableByTeam(int ''teamID'')</code>
| Returns true if ladder is usable for team.
|-
| <code>IsValid</code> || <code>bool IsValid()</code>
| Whether the handle belongs to a valid ladder.
|}

=== CNetPropManager ===
[[#toc|toc ↑]]

[[#Instances|Instances ↑]] Game Instance: <code>NetProps</code>

Allows reading and updating the [[Networking_Entities#Network_Variables|network properties]] of an entity. 

If the entity has multiple netprops with the same name, the data table name can be prepended with a dot to specify which one to use. i.e. {{Code|m_itTimer.m_timestamp}}.

{{warning|Each netprop has a set size in bits, exceeding the size may desync the clients from the server causing unpredictable behavior.}}

==== Methods ====
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>GetPropArraySize</code> || <code>int GetPropArraySize(CBaseEntity ''entity'', string ''propertyName'')</code>
| Returns the size of an netprop array, or -1.
|-
| <code>GetPropEntity</code> || <code>CBaseEntity GetPropEntity(CBaseEntity ''entity'', string ''propertyName'')</code>
| Reads an EHANDLE-valued netprop (21 bit integer). Returns the script handle of the entity.
|-
| <code>GetPropEntityArray</code> || <code>CBaseEntity GetPropEntityArray(CBaseEntity ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads an EHANDLE-valued netprop (21 bit integer) from an array. Returns the script handle of the entity.
|-
| <code>GetPropFloat</code> || <code>float GetPropFloat(CBaseEntity ''entity'', string ''propertyName'')</code>
| Reads a float-valued netprop.
|-
| <code>GetPropFloatArray</code> || <code>float GetPropFloatArray(CBaseEntity ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads a float-valued netprop from an array.
|-
| <code>GetPropInt</code> || <code>int GetPropInt(CBaseEntity ''entity'', string ''propertyName'')</code>
| Reads an integer-valued netprop.
|-
| <code>GetPropIntArray</code> || <code>int GetPropIntArray(CBaseEntity ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads an integer-valued netprop from an array.
|-
| <code>GetPropString</code> || <code>string GetPropString(CBaseEntity ''entity'', string ''propertyName'')</code>
| Reads an string-valued netprop.
|-
| <code>GetPropStringArray</code> || <code>string GetPropStringArray(CBaseEntity ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads an string-valued netprop from an array.
|-
| <code>GetPropType</code> || <code>string GetPropType(CBaseEntity ''entity'', string ''propertyName'')</code>
| Returns the name of the netprop type as a string.
|-
| <code>GetPropVector</code> || <code>Vector GetPropVector(CBaseEntity ''entity'', string ''propertyName'')</code>
| Reads a 3D vector-valued netprop. {{todo | Does it work for other dimensions too?}}
|-
| <code>GetPropVectorArray</code> || <code>Vector GetPropVectorArray(CBaseEntity ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads a 3D vector-valued netprop from an array. 
|-
| <code>HasProp</code> || <code>bool HasProp(CBaseEntity ''entity'', string ''propertyName'')</code>
| Checks if a netprop exists.
|-
| <code>SetPropEntity</code> || <code>void SetPropEntity(CBaseEntity ''entity'', string ''propertyName'', CBaseEntity ''value'')</code>
| Sets an EHANDLE-valued netprop (21 bit integer) to reference the specified entity.
|-
| <code>SetPropEntityArray</code> || <code>void SetPropEntityArray(CBaseEntity ''entity'', string ''propertyName'', CBaseEntity ''value'', int ''arrayElement'')</code>
| Sets an EHANDLE-valued netprop (21 bit integer) from an array to reference the specified entity.
|-
| <code>SetPropFloat</code> || <code>void SetPropFloat(CBaseEntity ''entity'', string ''propertyName'', float ''value'')</code>
| Sets a netprop to the specified float.
|-
| <code>SetPropFloatArray</code> || <code>void SetPropFloatArray(CBaseEntity ''entity'', string ''propertyName'', float ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified float.
|-
| <code>SetPropInt</code> || <code>void SetPropInt(CBaseEntity ''entity'', string ''propertyName'', int ''value'')</code>
| Sets a netprop to the specified integer.
|-
| <code>SetPropIntArray</code> || <code>void SetPropIntArray(CBaseEntity ''entity'', string ''propertyName'', int ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified integer.
|-
| <code>SetPropString</code> || <code>void SetPropString(CBaseEntity ''entity'', string ''propertyName'', string ''value'')</code>
| Sets a netprop to the specified string.
|-
| <code>SetPropStringArray</code> || <code>void SetPropStringArray(CBaseEntity ''entity'', string ''propertyName'', string ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified string.
|-
| <code>SetPropVector</code> || <code>void SetPropVector(CBaseEntity ''entity'', string ''propertyName'', Vector ''value'')</code>
| Sets a netprop to the specified vector.
|-
| <code>SetPropVectorArray</code> || <code>void SetPropVectorArray(CBaseEntity ''entity'', string ''propertyName'', Vector ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified vector.
|}

=== CScriptEntityOutputs ===
[[#toc|toc ↑]]
[[#Instances|Instances ↑]] Game Instance: <code>EntityOutputs</code>

Allows reading and changing of entities' output data.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>AddOutput</code> || <code>void AddOutput(CBaseEntity ''entity'', string ''outputName'', string ''targetName'', string ''inputName'', string ''parameter'', float ''delay'', int ''timesToFire'')</code>
| Adds a new output to the entity.
|-
| <code>GetNumElements</code> || <code>int GetNumElements(CBaseEntity ''entity'', string ''outputName'')</code>
| Returns the number of array elements.
|-
| <code>GetOutputTable</code> || <code>void GetOutputTable(CBaseEntity ''entity'', string ''outputName'', table, int ''arrayElement'')</code>
| Fills the passed table with output information.
|-
| <code>HasAction</code> || <code>bool HasAction(CBaseEntity ''entity'', string ''outputName'')</code>
| Returns true if an action exists for the output.
|-
| <code>HasOutput</code> || <code>bool HasOutput(CBaseEntity ''entity'', string ''outputName'')</code>
| Returns true if the output exists.
|-
| <code>RemoveOutput</code> || <code>void RemoveOutput(CBaseEntity ''entity'', string ''outputName'', string ''targetName'', string ''inputName'', string ''parameter'')</code>
| Removes an output from the entity.
|}

=== CScriptResponseCriteria ===
[[#toc|toc ↑]]

[[#Instances|Instances ↑]] Game Instance: <code>ResponseCriteria</code>

Allows reading the response rules of an entity. 

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>GetTable</code> || <code>void GetTable(CBaseEntity ''entity'', table)</code>
| Fills the passed table with all criteria.
|-
| <code>GetValue</code> || <code>string GetValue(CBaseEntity ''entity'', string ''criteriaName'')</code>
| Returns a string.
|-
| <code>HasCriterion</code> || <code>bool HasCriterion(CBaseEntity ''entity'', string ''criteriaName'')</code>
| Returns true if the criterion exists.
|}

=== Convars ===
[[#toc|toc ↑]]
[[#Instances|Instances ↑]] Game Instance: <code>Convars</code>

An interface to manipulate the [[List of L4D2 Cvars|convars]] on the server.
<!--
The class for this isn't directly available but is <code>CScriptConvarAccessor</code>. Not that it's important.
-->

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>GetClientConvarValue</code> || <code>string GetClientConvarValue(string ''name'', int ''entindex'')</code>
| Returns the convar value for the entindex as a string. Only works on client convars with the FCVAR_USERINFO flag. Convars without FCVAR_USERINFO or non-existent ones return empty string 
|-
| <code>GetStr</code> || <code>string GetStr(string ''name'')</code>
| Returns the convar as a string. Returns null if no such convar. 
|-
| <code>GetFloat</code> || <code>float GetFloat(string ''name'')</code>
| Returns the convar as a float. Returns null if no such convar.
|-
| <code>SetValue</code> || <code>void SetValue(string ''name'', ''value'')</code>
| Sets the value of the convar. Supported types are bool, int, float, string. 
|}

=== CPointTemplate ===
[[#toc|toc ↑]]
Extends [[#CBaseEntity|CBaseEntity ↑]]

Script handle class for [[point_template]].

==== Hooks ====

;<code>table PreSpawnInstance(string ''entityClass'', string ''entityName'')</code>
:If this is defined, it will be called right before the entity is created, and any KeyValues returned will be assigned to the entity.

:This could be used to dynamically assign target names, colors, even models. Unfortunately, models don't work like one would think. Yes, it is possible to change that gas tank into a football model, will even keep the weapon_gascan class, but it won't behave like one.

<source lang="lua">function PreSpawnInstance( entityClass, entityName )
{
	return 
	{ 
   		rendercolor = "0 255 0"
   		targetname = "mySpawnedEntity"
	}
}
</source>

;<code>void PostSpawn(table ''entities'')</code>
:Called after the entities are spawned. A table with the handles of the spawned entities indexed by name is passed to the function. Could use this to connect outputs or do whatever needs to be done after the entity was created. 

<source lang="lua">function PostSpawn( entities )
{
	foreach( name, handle in entities )
	{
		printl( name + ": " + handle )
	}
}
</source>

=== CPointScriptTemplate ===
[[#toc|toc ↑]]
Extends [[#CBaseEntity|CBaseEntity ↑]]

Script handle class for [[point_script_template]].

==== Methods ====

{| class=standard-table style="width: 100%;"
! Function  !! Signature !! Description
|-
| <code>AddTemplate</code> || <code>void AddTemplate(string, handle)</code>
|Add an entity to the template spawner.
|-
| <code>SetGroupSpawnTables</code> || <code>void SetGroupSpawnTables(handle, handle)</code>
|Cache the group spawn tables.
|}


=== CPointScriptUseTarget ===
[[#toc|toc ↑]]
Extends [[#CBaseEntity|CBaseEntity ↑]]

Script handle class for the [[point_script_use_target]] entity.

==== Methods ====

{| class=standard-table style="width: 100%;"
! Function  !! Signature !! Description
|-
| <code>CanShowBuildPanel</code> || <code>void CanShowBuildPanel(bool ''showPanel'')</code>
|Sets if the UI panel for the button is shown.
|-
| <code>GetUseModelName</code> || <code>string GetUseModelName()</code>
|Get the entity name of the prop bound to this button.
|-
| <code>SetProgressBarText</code> || <code>void SetProgressBarText(string ''text'')</code>
|Sets the use text for the button UI.
|-
| <code>SetProgressBarSubText</code> || <code>void SetProgressBarText(string ''text'')</code>
|Sets the subtext below the progress bar for the button UI.
|-
| <code>SetProgressBarFinishTime</code> || <code>void SetProgressBarFinishTime(float ''time'')</code>
|Sets the total time the button takes to use. If '0', no progress bar will be displayed.
|-
| <code>SetProgressBarCurrentProgress</code> || <code>void SetProgressBarCurrentProgress(float ''time'')</code>
|Sets the current use progress. It can be used to save the use progress when the user releases the use key.
|-
| <code>StopUse</code> || <code>void StopUse()</code>
|Stop the current use action.
|-
|}


==== Members ====
These variables are only available in the Entity Script after the entity has spawned. They're a custom C++ class, [[CHandle|CHandles]] which also is sometimes referred as EHANDLEs (Entity Handles). These can't be used or modified like the usual script handles, and really is only meant for verifications with comparing the output of the<code>[[#CBaseEntity|CBaseEntity ↑]]::GetEntityHandle()</code>method.

{| class="standard-table" style="width: 100%;"
! Instance !! Type !! Description
|-
| <code>UseModelEntity</code> || <code><nowiki>[C++] CHandle<CBaseEntity></nowiki></code>
| The Use Model prop associated with this entity.
|-
| <code>PlayerUsingMe</code> || <code><nowiki>[C++] CHandle<CBaseEntity></nowiki></code>
| The current using player. {{todo|Recheck on this old info: Is it not 0 / null if not being used?}}.
|}

==== Hooks ====
These VScript methods are called on the script set in the '''Entity Scripts''' keyvalue for the [[point_script_use_target]].
{| class=standard-table
! Function  !! Signature !! Description
|-
| <code>OnUseFinished</code> || <code>void OnUseFinished()</code>
| Called when the player has used this button for at least 'FinishTime' seconds.
|-
| <code>OnUseStart</code> || <code>bool OnUseStart()</code>
|Called when the player begins to use this button. Return false to disable the third-person use animation.<br>{{bug*|This breaks <code>point_script_use_target</code> when declared. Use {{Code|ConnectOutput()}} and hook a function to the {{Code|OnUseStarted}} output instead.
|-
| <code>OnUseStop</code> || <code>void OnUseStop(float ''timeUsed'')</code>
|Called when the player stops using this button. Passes the time this button has been used (time between StartUse and now).
|-
| <code>Precache</code> || <code>void Precache()</code>
|Called by the game engine when the entity first spawns, immediately after this script is run.
|-
|}

=== Decider ===
[[#toc|toc ↑]]
''An isolated instance of a rulescript database.''

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>constructor</code> || 
| 
|-
| <code>AddRule</code> || <code>bool AddRule(handle ''CRule'')</code>
| Add a CRule object (defined in rulescript_base.nut) 
|-
| <code>FindAllMatches</code> || <code>handle FindAllMatches(handle ''query'', float ''leeway'')</code>
| Returns an array of all matching responses. If leeway is nonzero, all results scoring within 'leeway' of the best score return.
|-
| <code>FindBestMatch</code> || <code>handle FindBestMatch(handle ''query'')</code>
| Query the database and return the best result found. If multiple of equal score found, an arbitrary one returns. 
|-
| <code>IsValid</code> || <code>bool IsValid()</code>
| Whether the object belongs to a valid entity(?).
|}


=== regexp ===
[[#toc|toc ↑]]
The built-in [http://squirrel-lang.org/doc/sqstdlib3.html#d0e2591 Squirrel class] for regular expressions.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>constructor</code> || <code>regexp()</code>
| 
|-
| <code>capture</code> || <code> [table] capture(''str'', [''start''])</code>
| Returns an array of tables containing two indexes ("begin" and "end") of the first match of the regular expression in the string str. An array entry is created for each captured sub expressions. If no match occurs returns null. The search starts from the index start of the string, if start is omitted the search starts from the beginning of the string. 
|-
| <code>match</code> || <code> bool match(''str'')</code>
| Returns a true if the regular expression matches the string str, otherwise returns false. 
|-
| <code>search</code> || <code>table search(''str'', [''start''])</code>
| Returns a table containing two indexes ("begin" and "end") of the first match of the regular expression in the string ''str'', otherwise if no match occurs returns null. The search starts from the index start of the string, if start is omitted the search starts from the beginning of the string. 
|-
| <code>subexpcount</code> || 
| 
|}


=== CCallChainer ===
[[#toc|toc ↑]]
'''CCallChainer''' objects collect all functions with a matching prefix in a given scope, then inserts it all into the {{Code|chains}} table with the prefix removed. All collected unprefixed functions can then be called in a chain using the class's {{Code|Call()}} method, given the method's ''event'' argument matches the functions' name.

Whenever a '''CCallChainer''' object is created, a function named {{Code|Dispatch}} followed by its given prefix will also be created, which the class binds the environment of its {{Code|Call()}} method to.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>constructor</code> || <code>CCallChainer(string ''functionPrefix'', table ''scope'' = null)</code>
| Creates a CCallChainer object that'll collect functions that have a matching prefix in the given scope.
|-
| <code>PostScriptExecute</code> || <code>void PostScriptExecute()</code>
| Search for all non-native functions with matching prefixes, then push them into the {{Code|chains}} table.
|-
| <code>Call</code> || <code>bool Call(string ''event'', any ...)</code>
| Find an unprefixed function name in the {{Code|chains}} table and call it with the given arguments.
|}

==== Members ====
{| class="standard-table" style="width: 100%;"
! Instance !! Type !! Description
|-
| <code>chains</code> || <code>table</code>
| Contains names of unprefixed functions, each with an array of functions to call.
|-
| <code>prefix</code> || <code>string</code>
| Prefix that functions should have to be added into the {{Code|chains}} table. Set by the constructor.
|-
| <code>scope</code> || <code>table</code>
| If set, seek functions in this scope instead. Set by the constructor.
|}


=== CSimpleCallChainer ===
[[#toc|toc ↑]]
Intended to be simpler to use than [[#CCallChainer|CCallChainer ↑]], the class '''CSimpleCallChainer''' holds only a single chain of functions inside an array instead of multiple inside a table. As such, its {{Code|Call()}} method does not need a function's name.

This class is also used internally by these [[#CBaseEntity|CBaseEntity ↑]] hooks: {{Code|Precache()}} and {{Code|OnPostSpawn()}}.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>constructor</code> || <code>CSimpleCallChainer(string ''functionPrefix'', table ''scope'' = null, exactMatch = false)</code>
| Creates a CSimpleCallChainer object that'll collect functions that have a matching prefix in the given scope, unless it seek for an exact name match.
|-
| <code>PostScriptExecute</code> || <code>void PostScriptExecute()</code>
| Begin searching for all non-native functions with matching prefixes, then push them into the {{Code|chain}} array.
|-
| <code>Call</code> || <code>bool Call(any ...)</code>
| Call all functions inside the {{Code|chain}} array with the given arguments.
|}

==== Members ====
{| class="standard-table" style="width: 100%;"
! Instance !! Type !! Description
|-
| <code>chain</code> || <code>array</code>
| All functions to be called by the {{Code|Call()}} method.
|-
| <code>exactMatch</code> || <code>bool</code>
| If set, names of non-native functions and {{Code|prefix}} must be an exact match.  Set by the constructor.
|-
| <code>prefix</code> || <code>string</code>
| Prefix that functions should have to be added into the {{Code|chain}} array. Set by the constructor.
|-
| <code>scope</code> || <code>table</code>
| If set, seek functions in this scope instead. Set by the constructor.
|}


=== LateBinder ===
[[#toc|toc ↑]]

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>Begin</code> || 
| 
|-
| <code>End</code> || 
| 
|-
| <code>EstablishDelegation</code> || 
| 
|-
| <code>HookRootMetamethod</code> || 
| 
|-
| <code>UnhookRootMetamethod</code> || 
| 
|-
| <code>RemoveDelegation</code> || 
| 
|-
| <code>Resolve</code> || 
| 
|}


==== Members ====
{| class="standard-table" style="width: 100%;"
! Instance !! Type !! Description
|-
| <code>m_bindNamesStack</code> || <code>array</code>
| 
|-
| <code>m_fixupSet</code> || <code>array</code>
| 
|-
| <code>m_log</code> || <code>bool</code>
| 
|-
| <code>m_logIndent</code> || <code>int</code>
| 
|-
| <code>m_targetTable</code> || <code>table?(null)</code>
| 
|-
|}

== Data Types ==
[[#toc|toc ↑]]

=== Vector ===
[[#toc|toc ↑]]
Squirrel equivalent of the C++ [[Vector]] class. It is a three-dimensional vector with overloaded arithmetic operations for both Vectors and scalar values. 

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>constructor</code> || <code>Vector(float ''x'' = 0, float ''y'' = 0, float ''z'' = 0)</code>
| Creates a new vector with the specified Cartesian coordiantes.
|-
| <code>Cross</code> || <code>float Cross(Vector ''factor'')</code>
| The vector product of two vectors. Returns a vector orthogonal to the input vectors.
|-
| <code>Dot</code> || <code>float Dot(Vector ''factor'')</code>
| The scalar product of two vectors. 
|-
| <code>Length</code> || <code>float Length()</code>
| Magnitude of the vector.
|-
| <code>LengthSqr</code> || <code>float LengthSqr()</code>
| The magnitude of the vector squared. Faster than the above method.
|-
| <code>Length2D</code> || <code>float Length2D()</code>
| Returns the magnitude of the vector on the x-y plane. Meant to be used when working with the client's HUD.
|-
| <code>Length2DSqr</code> || <code>float Length2DSqr()</code>
| Returns the square of the magnitude of the vector on the x-y plane. Faster than the above method.
|-
| <code>Norm</code> || <code>float Norm()</code>
| Seems to also return the vector length.
|-
| <code>Scale</code> || <code>Vector Scale(float ''factor'')</code>
| Scales the vector magnitude.
|-
| <code>ToKVString</code> || <code>string ToKVString()</code>
| Returns a string without separations commas. {{note|Not required for the {{code|SpawnEntityWithTable}} function, as it understands the Vector data type.}}
|-
| <code>tostring</code> || <code>string tostring()</code>
| Returns a human readable string.
|}

==== Members ====
{| class="standard-table" style="width: 100%;"
! Instance !! Type !! Description
|-
| <code>x</code> || <code>float</code>
| Cartesian X axis.
|-
| <code>y</code> || <code>float</code>
| Cartesian Y axis.
|-
| <code>z</code> || <code>float</code>
| Cartesian Z axis.
|}

==== Operations ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Operation !! Return Type !! Description
|-
| <code>Vector + Vector</code> || <code>Vector</code>
| Returns the sum of both classes's members (XYZ).
|-
| <code>Vector - Vector</code> || <code>Vector</code>
| Returns the subtraction of both classes's members (XYZ).
|-
| <code>Vector * int</code> || rowspan="2"| <code>Vector</code>
|rowspan="2"| Returns the multiplication of a Vector against a scalar.
|-
| <code>Vector * float</code>
|}

=== QAngle ===
[[#toc|toc ↑]]
Squirrel equivalent of the C++ [[QAngle]] class. Represents a three-dimensional orientation as Euler angles.

Has overloaded arithmetic operations with both QAngles and scalar values.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>constructor</code> || <code>QAngle(float ''pitch'' = 0, float ''yaw'' = 0, float ''roll'' = 0)</code>
| Creates a new QAngle.
|-
| <code>Forward	</code> || <code>Vector Forward()</code>
| Returns the Forward Vector of the angles. 
|-
| <code>Left</code> || <code>Vector Left()</code>
| Returns the left Vector of the angles. {{bug*|Returns right Vector instead}}
|-
| <code>Pitch</code> || <code>float Pitch()</code>
| Returns the pitch angle in degrees.
|-
| <code>Roll</code> || <code>float Roll()</code>
| Returns the roll angle in degrees.
|-
| <code>ToKVString</code> || <code>string ToKVString()</code>
| Returns a string with the values separated by one space. {{tip|Use this with the {{Code|angles}} key when using the {{Code|SpawnEntityWithTable}} function.}}
|-
| <code>ToQuat</code> || <code>Quaternion ToQuat()</code>
| Returns a quaternion representaion of the orientation.
|-
| <code>Up</code> || <code>Vector Up()</code>
| Returns the Up Vector of the angles.
|-
| <code>Yaw</code> || <code>float Yaw()</code>
| Returns the yaw angle in degrees.
|}

==== Members ====
{| class="standard-table" style="width: 100%;"
! Instance !! Type !! Description
|-
| <code>x</code> || <code>float</code>
| Pitch in degrees.
|-
| <code>y</code> || <code>float</code>
| Yaw in degrees.
|-
| <code>z</code> || <code>float</code>
| Roll in degrees.
|}

==== Operations ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Operation !! Return Type !! Description
|-
| <code>QAngle + QAngle</code> || <code>QAngle</code>
| Sum of both classes's members (XYZ). 
|-
| <code>QAngle - QAngle</code> || <code>QAngle</code>
| Subtraction of both classes's members (XYZ).
|-
| <code>QAngle * int</code> || rowspan="2"| <code>QAngle</code>
|rowspan="2"| QAngle multiplied by a number.
|-
| <code>QAngle * float</code>
|}

=== Vector2D, Vector4D ===
[[#toc|toc ↑]]
Two and four-dimensional equivalents of the Vector data type. Has the same overloaded operators. 

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>constructor</code> || <code>Vector2D(float ''x'' = 0, float ''y'' = 0)</code>
| Creates a new 2D vector with the specified Cartesian coordinates.
|-
| <code>constructor</code> || <code>Vector4D(float ''x'' = 0, float ''y'' = 0, float ''z'' = 0, float ''w'' = 0)</code>
| Creates a new 4D vector with the given coordinate numbers.
|-
| <code>Dot</code> || <code>float Dot(Vector''X''D ''factor'')</code>
| The scalar product of two vectors.
|-
| <code>Length</code> || <code>float Length()</code>
| Magnitude of the vector.
|-
| <code>LengthSqr</code> || <code>float LengthSqr()</code>
| The magnitude of the vector squared. Faster than the above method.
|-
| <code>Norm</code> || <code>float Norm()</code>
| Seems to also return the vector length.
|-
| <code>ToKVString</code> || <code>string ToKVString()</code>
| Returns a string without separations commas.
|}

==== Members ====
{| class="standard-table" style="width: 100%;"
! Instance !! Type !! Description
|-
| <code>x</code> || <code>float</code>
| Cartesian X axis.
|-
| <code>y</code> || <code>float</code>
| Cartesian Y axis.
|-
| <code>z</code> || <code>float</code>
| Cartesian Z axis. Vector4D only.
|-
| <code>w</code> || <code>float</code>
| Component for possibly creating homogeneous coordinates? Vector4D only.
|}

==== Operations ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Operation !! Return Type !! Description
|-
| <code>Vector2D + Vector2D</code><br><code>Vector4D + Vector4D</code> || <code>Vector2D</code><br><code>Vector4D</code>
| Returns the sum of both classes's members (XYZ).
|-
| <code>Vector2D - Vector2D</code><br><code>Vector4D - Vector4D</code> || <code>Vector2D</code><br><code>Vector4D</code>
| Returns the subtraction of both classes's members (XYZ).
|-
| <code>Vector2D * int</code><br><code>Vector4D * int</code> || rowspan="2"| <code>Vector2D</code><br><code>Vector4D</code>
|rowspan="2"| Returns the multiplication of the given Vector variant against a scalar.
|-
| <code>Vector2D * float</code><br><code>Vector4D * float</code>
|}

=== Quaternion ===
[[#toc|toc ↑]]
A [http://en.wikipedia.org/wiki/Quaternion Quaternion] represents rotations in three-dimensional space.

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>constructor</code> || <code>Quaternion()</code>
| Creates a new identity quaternion.
|-
| <code>constructor</code> || <code>Quaternion(float ''x'' = 0,float ''y'' = 0,float ''z'' = 0,float ''w'' = 0)</code>
| Creates a new quaternion of the form: <code>''w'' + ''x'''''i''' + ''y'''''j''' + ''z'''''k'''</code>.
|-
| <code>Dot</code> || <code>float Dot(Quaternion ''factor'')</code>
| The 4D scalar product of two quaternions. represents the angle between the quaternions in the range [1, 0].
|-
| <code>Invert</code> || <code>Quaternion Invert()</code>
| Returns a quaternion with the complimentary rotation.
|-
| <code>Norm</code> || <code>Quaternion Norm()</code>
| Normalizes the 4D vector length. {{todo|What effect does this have in quaternions?}}
|-
| <code>SetPitchYawRoll</code> || <code>void SetPitchYawRoll(float ''pitch'', float ''yaw'', float ''roll'')</code>
| Recomputes the quaternion from the supplied Euler angles.
|-
| <code>ToKVString</code> || <code>string ToKVString()</code>
| Returns a string with the values separated by one space.
|-
| <code>ToQAngle</code> || <code>QAngle ToQAngle()</code>
| Returns the angles resulting from the rotation.
|}


==== Members ====
{| class="standard-table" style="width: 100%;"
! Instance !! Type !! Description
|-
| <code>x</code> || <code>float</code>
| Vector component along the '''i''' axis.
|-
| <code>y</code> || <code>float</code>
| Vector component along the '''j''' axis.
|-
| <code>z</code> || <code>float</code>
| Vector component along the '''k''' axis.
|-
| <code>w</code> || <code>float</code>
| Scalar part.
|}

==== Operations ====
{| class="standard-table" style="width:100%"
! Operation !! Return Type !! Description
|-
| <code>Quaternion + Quaternion</code> || <code>Quaternion</code>
| Sum of the two Quaternions.
|-
| <code>Quaternion - Quaternion</code> || <code>Quaternion</code>
| Subtraction of the two Quaternions.
|-
| <code>Quaternion * int</code> || rowspan="2"| <code>Quaternion</code>
|rowspan="2"| Quaternion multiplied by a number.
|-
| <code>Quaternion * float</code>
|}

== Scripted Mode ==
[[#toc|toc ↑]]
Enabling Scripted Mode makes a large amount of features like cm_ director options and various hooks available. Scripted Mode is enabled if a script (<''current_mode_name''>.nut) is present.
{{warning|Only one addon is able to actively use these functions so using scripted mode features outside of mutations is conflict prone and discouraged}}

Scripted Mode data are stored under the {{Code|g_ModeScript}} scope.

=== sm_utilities.nut ===
[[#toc|toc ↑]]
sm_utilities contains many wrapper functions for manipulating different features. Only a few of them are listed here, see the [[L4D2_EMS/Appendix:_Functions|EMS tutorial]] for more examples. These functions are inside g_MapScript scope.

{| class="standard-table" style="width: 100%;"
! Function !! Signature !! Description
|-
| <code>CheckOrSetMapCallback</code> || <code>void CheckOrSetMapCallback(''cb_name'', ''cb_default'')</code>
| Pass a callback and default @ for it, if it doesnt exist in current table, place it there.
|-
| <code>DeepPrintTable</code> || <code>void DeepPrintTable(handle ''table'', string ''prefix'' = "")</code>
| Print out a table (and subtables) to the console. This works with classes as well (not instances).
|-
| <code>DuplicateTable</code> || <code>table DuplicateTable(table ''source'')</code>
| This returns a deep copy of the passed in table.
|-
| <code>InjectTable</code> || <code>void InjectTable(table ''override'', table ''base'')</code>
| Inject the override data into the base table - i.e. add any new ones, overwrite dupes.
|-
| <code>SpawnStartBox</code> || <code>handle SpawnStartBox(''centerobjname'', ''useFloating'', ''width'', ''depth'', ''barriermodel'', ''min_gap'')</code>
| Auto-create a startbox that will give you a callback when the first player exits it.
|-
| <code>TeleportPlayersToStartPoints</code> || <code>void TeleportPlayersToStartPoints(string ''spawnpointName'')</code>
| Teleport players to start entities named by the argument - must have 4 spawnpoints.
|-
| <code>Ticker_AddToHud</code> || <code>void Ticker_AddToHud(table ''hudTable'', string ''strInit'', bool ''blink'')</code>
| Adds ticker data to a passed in HUDTable.
|-
| <code>Ticker_NewStr</code> || <code>void Ticker_NewStr(string ''newStr'', float ''newTimeout'')</code>
| Sets the current Ticker string, w/an optional timeout value.
|-
| <code>TimeToDisplayString</code> || <code>string TimeToDisplayString(float ''disp_time'')</code>
| Convert a # of seconds to a displayable time string form m:ss
|-
|}


=== Hooks ===
[[#toc|toc ↑]]
Scripted mode provides hook functions, used by simply adding a function with the same name and arguments to the script, and are called back by the C++ code at the appropriate moments.
{{todo|Everything to know about OnGamePlayStart and OnActivate.}}

==== OnShutdown ====
<code>void OnShutdown()</code>: Called as the mutation is shutdown, happens for multiple scenarios, such as map change or a mission being lost. To retrieve the reason, use such a code:

<source lang="JavaScript">
function OnShutdown()
{
	local reason = SessionState.ShutdownReason
	local nextmap = SessionState.NextMap

	printl("Mutation shut down under reason " + reason.tostring() + ", next map is " + nextmap)
}
</source>

==== OnActivate ====
<code>void OnActivate()</code>: Called after OnGameplayStart. Unknown anything else about it, comes likely from EMS and pulled via console command "script g_ModeScript.DeepPrintTable(getroottable())"

==== OnGameplayStart ====
<code>void OnGameplayStart()</code>: Called whenever the gameplay starts.

==== AllowBash ====
<code>int AllowBash(handle ''basher'', handle ''bashee'')</code>: called whenever melee bash is used. Returns these values:

*ALLOW_BASH_ALL - normal melee behavior
*ALLOW_BASH_NONE - do nothing at all
*ALLOW_BASH_PUSHONLY - applies physics push but deals no damage (including prevention of insta-kill ambush behavior) 

==== AllowTakeDamage ====
<code>bool AllowTakeDamage(table ''damageTable'')</code>: Adding a function with this name in the script causes C++ to call it on all damage events. The damageTable is actually defined in scriptedmode.nut and filled in as appropriate before each call.

<source lang="JavaScript">
ScriptedDamageInfo <-
{
	Attacker = null				// hscript of the entity that attacked
	Victim = null				// hscript of the entity that was hit
	Inflictor = null			// hscript of the entity that was the inflictor
	DamageDone = 0				// copyback variable for how much damage done
	DamageType = -1				// copyback variable for what type of damage
	Location = Vector(0,0,0)	// where
	Weapon = null				// by what - often Null (say if attacker was a common)
}
</source> 

Returning "false" causes the damage will be stopped and nothing will be done to the target (though animation/bloodstains/decals will probably still happen, sorry about that). The only fields read back by the C++ is DamageDone, so it can be used to change the damage value before it is applied, and DamageType, so it can be used to change the type of damage. The Type field is a bitfield, of which several key #def's are exported to script (DMG_HEADSHOT, DMG_BULLET, DMG_BUCKSHOT, DMG_MELEE, DMG_STUMBLE, DMG_BLAST, DMG_BLAST_SURFACE, DMG_BURN ).
Some situations will trigger this event still and deal zero damage while reporting a normal damage value:
1. Falling from a slope that gives immunity to fall damage ( Dark Carnival First Chapter )

2. A tank rock hits you after a smoker grabbed you.

==== BotQuery ====
<code>bool BotQuery(int ''queryflag'', handle ''entity'', bool ''defaultvalue'')</code>: Hook to control survivor bot behavior. Only one known flag is supported.
* <code>BOT_QUERY_NOTARGET</code> - Fired when a bot wants to bash a prop. Returning {{Code|false}} disallows the bashing.

==== CanPickupObject ====
<code>bool CanPickupObject(handle ''object'')</code>: Hook function for deciding whether a given prop should be pickupable (HL2 style). Returning <code>true</code> makes the players able to pick up the object. Only functional for server side props. If this is defined it must return true in order the PickupObject() function to work.

==== InterceptChat ====
<code>void InterceptChat(string ''message'', CTerrorPlayer ''speaker'')</code>: If you put a function with this name in your script, C++ will call it on all chat messages. Passing in the (annotated) chat string and the handle of the speaker. If the function returns false, it will prevent other players from seeing the chat message except for the player who entered it.

==== SetupModeHUD ====
{{todo}}

==== UserConsoleCommand ====
<code>void UserConsoleCommand(handle ''playerScript'', arg)</code>: when a user does a <code>scripted_user_func argument</code> at console (or bound to a key) this function is called (if it exists). The playerscript is which players console it came from. You can pass strings or whatever, of course. So could do a switch statement off {{Code|arg}} to give players special controls, etc.

==== OnGameEvent_''x'' ====
<code>void OnGameEvent_''x''(table ''params'')</code>: A callback that is called when the game event ''x'' is fired. See {{Code|resource\gameevents.res}}, {{Code|resource\serverevents.res}} and {{Code|resource\modevents.res}} for valid events. The callback functions can be registered independently from Scripted Mode, using: <code>__CollectGameEventCallbacks(this)</code>
'''See [[L4D2_EMS/Appendix:_Game_Events|EMS Appendix - Game Events]] for more information.'''

== Global Functions ==
=== Printing and Drawing ===
[[#toc|toc ↑]]
Functions for printing out messages or drawing elements in the world, mostly for debugging reasons.
{{warning|Any function with the <code>Debug</code> prefix requires the cvar <code>developer</code> be enabled and the game unpaused.<br>They also do not appear in multiplayer, only on a local server.}}

{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>__DumpScope</code> || <code>void __DumpScope(int ''indentation'', table ''scope'')</code>
| Dumps a scope's contents and expands all tables and arrays; this is what the <code>ent_script_dump</code> command uses.
{{tip|You can use this to print tables/arrays.}}
{{Expand|title=Example|
Using this code:
<source lang=js>
local testTable =
{
	integer = 20,
	string = "hello",
	array = [1, 2, 3]
};

printl("{");
__DumpScope(1, testTable);
printl("}");
</source>

Will print the following in console:
<source lang=js>
{
   string = "hello"
   array(ARRAY)
   [
      0 = 1
      1 = 2
      2 = 3
   ]
   integer = 20
}
</source>
}}
|-
| <code>[[/ClientPrint|ClientPrint]]</code> || <code>void ClientPrint(CTerrorPlayer ''player'', int ''destination'', string ''message'')</code>
| Print a client message. If you pass null instead of a valid player, the message will be sent to all clients.
|-
| <code>DebugDrawBox</code> || <code>void DebugDrawBox(Vector ''origin'', vector ''min'', vector ''max'', int ''r'', int ''g'', int ''b'', int ''alpha'', float ''duration'')</code>
| Draw a debug overlay box.
|-
| <code>DebugDrawBoxAngles</code> || <code>void DebugDrawBoxAngles(Vector ''origin'', Vector ''min'', Vector ''max'', QAngle ''direction'', Vector ''rgb'', int ''alpha'', float ''duration'')</code>
| Draw a debug oriented box (cent, min, max, angles(p,y,r), vRgb, a, duration).
|-
| <code>DebugDrawBoxDirection</code> || <code>void DebugDrawBoxDirection(Vector ''center'', Vector ''min'', Vector ''max'', Vector ''forward'', Vector ''rgb'', float ''alpha'', float ''duration'')</code>
| Draw a debug forward box.
|-
| <code>DebugDrawCircle</code> || <code>void DebugDrawCircle(Vector ''center'', Vector ''rgb'', float ''alpha'', float ''radius'', bool ''ztest'', float ''duration'')</code>
| Draw a debug circle.
|-
| <code>DebugDrawClear</code> || <code>void DebugDrawClear()</code>
| Try to clear all the debug overlay info.
|-
| <code>DebugDrawLine</code> || <code>void DebugDrawLine(Vector ''start'', Vector ''end'', int ''red'', int ''green'', int ''blue', bool ''zTest'', float ''time'')</code>
| Draw a debug overlay line.
|-
| <code>DebugDrawLine_vCol</code> || <code>void DebugDrawLine_vCol(Vector ''start'', vector ''end'', vector ''rgb'', bool ''ztest'', float ''duration'')</code>
| Draw a debug line using color vec.
|-
| <code>DebugDrawScreenTextLine</code> || <code>void DebugDrawScreenTextLine(float ''x'', float ''y'', int ''lineOffset'', string ''text'', int ''r'', int ''g'', int ''b'', int ''a'', float ''duration'')</code>
| Draw text with a line offset.
|-
| <code>DebugDrawText</code> || <code>void DebugDrawText(Vector ''origin'', string ''text'', bool ''useViewCheck'', float ''duration'')</code>
| Draw text on the screen, starting on the position of ''origin''.
|-
| <code>DumpObject</code> || <code>void DumpObject(handle ''object'')</code>
| Dumps information about a class or instance.
|-
| <code>HUDManageTimers</code> || <code>void HUDManageTimers(int ''timerID'', int ''command'', float ''value'')</code>
| Manages the HUD timers. Valid command enumerations are: TIMER_DISABLE, TIMER_COUNTUP, TIMER_COUNTDOWN, TIMER_STOP, TIMER_SET
|-
| <code>HUDPlace</code> || <code>void HUDPlace(int ''slot'', float ''x'', float ''y'', float ''width'', float ''height'')</code>
| Sets the position of a HUD element. See [[L4D2_EMS/Appendix:_HUD]]
|-
| <code>HUDReadTimer</code> || <code>float HUDReadTimer(int ''timerID'')</code>
| Returns the value of a HUD timer. See [[L4D2_EMS/Appendix:_HUD]]
|-
| <code>HUDSetLayout</code> || <code>void HUDSetLayout(table ''HUDTable'')</code>
| Applies a HUD to the screen. See [[L4D2_EMS/Appendix:_HUD]] {{important|Scriptedmode feature, usable properly in mutations only}}
|-
| <code>Msg</code> || <code>void Msg(string ''message'')</code>
| Prints message to console without any line feed after.
|-
| <code>print</code> || <code>void print(string ''message'')</code>
| Prints message to console without any line feed after. Identical to {{Code|Msg()}}.
|-
| <code>printl</code> || <code>void printl(string ''message'')</code>
| Prints message to console with a line feed after.
|-
| <code>realPrint</code> || <code>void realPrint(string ''message'')</code>
| Identical to print. print seems to be a wrapper for this.
|-
| <code>ShowMessage</code> || <code>void ShowMessage(string ''message'')</code>
| Print a HUD message on all clients. {{bug*|Non-functional.|only=l4d2}}
|-
| <code>Say</code> || <code>void Say(CTerrorPlayer ''player'', string ''message'', bool ''teamOnly'') </code>
| Calling this will have the specified player send the message to chat, either to teamOnly (true) or to everyone. 
|-
| <code>SendToConsole</code> || <code>void SendToConsole(string ''command'')</code>
| Send a string to the console as a command.
|-
| <code>SendToServerConsole</code> || <code>void SendToServerConsole(string ''command'')</code>
| Send a string to the server console as a command.
|-
|}

=== Hooks ===
[[#toc|toc ↑]]
==== DebugTick ====

<code>void DebugTick()</code>: Called every tick, if a function with this name is in your script. {{note|The Mutation/Mode name needs to be prefixed with "'''debug_'''" in order for this function to be called.}}

==== Update ====

<code>void Update()</code>: Called every second, including the first, if a function with this name is in your script when it runs for the first time. Gives easy control over the flow of a game.
{{todo|In which scopes does the hook work?}}

=== Entity Manipulation ===
[[#toc|toc ↑]]
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>[[/AddThinkToEnt|AddThinkToEnt]]</code> || <code>void AddThinkToEnt(handle ''entity'', string ''FuncName'')</code>
| Sets a function in the entity's script to rerun by itself constantly.
|-
| <code>[[/CommandABot|CommandABot]]</code> || <code>bool CommandABot(table ''commandTable'')</code>
| Issues commands to bots based on a table configuration. 
|-
| <code>ConnectOutputs</code> || <code>void ConnectOutputs(table)</code>
| sets output functions for entity by table {{todo}}  
|-
| <code>DoEntFire</code> || <code>void DoEntFire(string ''target'', string ''action'', string ''value'', float ''delay'', handle ''activator'', handle ''caller'')</code>
| Adds entity I/O event to the event queue to be processed at appropriate time based on specified delay. The ''caller'' and ''activator'' argument takes a ''CBaseEntity'' script handle, and entities assigned can receive inputs with ''target'' set to ''!self'', or ''!activator'' / ''!caller''.
|-
| <code>EntFire</code> || <code>void EntFire(string ''target'', string ''action'', string ''value = null'', float ''delay = 0'', handle ''activator = null'')</code>
| Wrapper for {{code|DoEntFire()}}. If called from an entity's script scope it sets caller to self. {{bug*|Using value 0 mistakenly converts it to empty string. Use "0" as value to prevent that}}
|-
| <code>DropFire</code> || <code>void DropFire(Vector ''location'')</code>
| Drop a fire pool from the specified Vector location.
|-
| <code>DropSpit</code> || <code>void DropSpit(Vector ''location'')</code>
| Drop a spit pool from the specified Vector location.
|-
| <code>EmitAmbientSoundOn</code> || <code>void EmitAmbientSoundOn(string ''soundName'', float ''volume'', int ''soundlevel'', int ''pitch'', handle ''entity'')</code>
| Play named sound on an entity that has similar configurations to [[ambient_generic]].
|-
| <code>EmitSoundOnClient</code> || <code>void EmitSoundOnClient(string ''soundScript'', handle ''player'')</code>
| Play named sound only on the client for the specified player.
|-
| <code>EmitSoundOn</code> || <code>void EmitSoundOn(string ''soundScript'', handle ''entity'')</code>
| Play named sound on an entity.
|-
| <code>EntIndexToHScript</code> || <code>CBaseEntity EntIndexToHScript(int ''entIndex'')</code>
| Returns the script handle for the given entity index.
|-
| <code>FindRescueAreaTrigger</code> || <code>CBaseTrigger FindRescueAreaTrigger()</code>
| Returns the trigger entity for the rescue area.
|-
| <code>GetListenServerHost</code> || <code>handle GetListenServerHost()</code>
| Get the host player on a listen server.
|-
| <code>GetFriction</code> || <code>float GetFriction(CTerrorPlayer ''player'')</code>
| Returns the Friction on a player entity, meaningless if not a player.
|-
| <code>[[/GetInvTable| GetInvTable]]</code> || <code>void GetInvTable(CTerrorPLayer ''player'',table ''invTable'')</code>
| Fills ''invTable'' with the specified player's inventory.
|-
| <code>GetPhysVelocity</code> || <code>Vector GetPhysVelocity(handle ''entity'')</code>
| Returns the velocity of the entity.
|-
| <code>GetPhysAngularVelocity</code> || <code>Vector GetPhysAngularVelocity(handle ''entity'')</code>
| Returns the Angular velocity of the entity.
|-
| <code>GetPlayerFromCharacter</code> || <code>handle GetPlayerFromCharacter(int ''characterType'')</code>
| Given a character type, return the entity, or null.
|-
| <code>GetPlayerFromUserID</code> || <code>handle GetPlayerFromUserID(int ''ID'')</code>
| Given a user id, return the entity, or null.
|-
| <code>IsPlayerABot</code> || <code>bool IsPlayerABot(handle ''player'')</code>
| Is this player/entity a bot.
|-
| <code>PickupObject</code> || <code>void PickupObject(handle ''player'', handle ''entity'')</code>
| Object from world is put into the "Held" slot of the player. Warning: it will smoothly interpolate from where it is to the players hand - which is a bit goofy if it is on other side of level. 
|-
| <code>PlayerInstanceFromIndex</code> || <code>CTerrorPlayer PlayerInstanceFromIndex(int ''index'')</code>
| Get a script handle of a player using the player index.
|-
| <code>PrecacheEntityFromTable</code> || <code>bool PrecacheEntityFromTable(table ''keyvalues'')</code>
| Precache an entity from [[KeyValues]] in a table.
|-
| <code>RotateOrientation</code> || <code>QAngle RotateOrientation(QAngle, QAngle)</code>
| Rotate a QAngle by another QAngle.
|-
| <code>RotatePosition</code> || <code>Vector RotatePosition(Vector ''origin'', QAngle ''rotation'', Vector ''input'')</code>
| Rotate the input Vector around an origin.
|-
| <code>SetFakeClientConVarValue</code> || <code>void SetFakeClientConVarValue(handle ''bot'', string ''cvar'', string ''value'')</code>
| Sets a USERINFO client ConVar for a fakeclient.
|-
| <code>SpawnEntityFromTable</code> || <code>handle SpawnEntityFromTable(string ''classname'', table ''keyvalues'')</code>
| Native function for entity spawning. See [[L4D2_EMS/Appendix:_Spawning]].
|-
| <code>SpawnEntityGroupFromTable</code> || <code>bool SpawnEntityGroupFromTable(table ''entityGroup'')</code>
| Native function for entity group spawning. See [[L4D2_EMS/Appendix:_Spawning]].
|-
| <code>StopAmbientSoundOn</code> || <code>void StopAmbientSoundOn(string ''soundName'', handle ''entity'')</code>
| Stop named sound on an entity that has similar configurations to [[ambient_generic]].
|-
| <code>StopSoundOn</code> || <code>void StopSoundOn(string ''soundScript'', handle ''entity'')</code>
| Stop named sound on an entity.
|-
| <code>[[/ZSpawn| ZSpawn]]</code> || <code>bool ZSpawn(table ''spawnTable'')</code>
| Spawn an infected of liking, with a choice.
|}

=== Response Rules ===
[[#toc|toc ↑]]
<small>[[#Script_Scopes|Script Scopes ↑]]</small>

The<code>g_rr</code>table is used to create and/or override responses and their rules, allowing custom concepts to be dynamically made without altering existing talker files.<br>
{{todo|Test these functions and document them further.}}

{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>[[/rr_ProcessRules| rr_ProcessRules]]</code> || <code>void rr_ProcessRules(handle ''rulesArray'')</code>
| Processes and adds the given ''rulesArray'' table to the talker system. This is an incomplete implementation of custom talker concepts for VScript, but it is mostly functional.
|-
| <code>rr_PlaySoundFile</code> || <code>unknown rr_PlaySoundFile(CTerrorPlayer ''speaker'', unknown ''query'', unknown ''soundfile'', unknown ''context'', unknown ''contextToWorld'', unknown ''volume'', unknown ''func'')</code>
| 
|-
| <code>rrDebugPrint</code> || <code>void rrDebugPrint(string ''message'')</code>
| Print function that works similarly to {{Code|printl()}} but prepends ''RR_TESTBED: '' to the start of the message.
|-
| <code>rr_ProcessResponse</code> || <code>unknown rr_ProcessResponse(unknown ''resp'')</code>
| 
|-
| <code>PrintTable</code> || <code>void PrintTable(handle ''table'')</code>
| Print a table without searching through subtables to the console. Works with classes as well (not instances).
|-
| <code>rr_ProcessCriterion</code> || <code>unknown rr_ProcessCriterion(unknown ''crit'')</code>
| 
|-
| <code>rr_EmitSound</code> || <code>unknown rr_EmitSound(CTerrorPlayer ''speaker'', unknown ''query'', unknown ''soundName'', unknown ''context'', unknown ''contextToWorld'', unknown ''func'')</code>
| 
|-
| <code>rr_CharacterSpeak</code> || <code>unknown rr_CharacterSpeak(CTerrorPlayer ''speaker'', unknown ''query'')</code>
| 
|-
| <code>rr_ApplyContext</code> || <code>unknown rr_ApplyContext(CTerrorPlayer ''speaker'', unknown ''query'', unknown ''contextData'', unknown ''contextToWorld'', unknown ''func'')</code>
| 
|-
| <code>rrPrintTable</code> || <code>void rrPrintTable(handle ''table'', ''prefix'' = "\t")</code>
| Prints a table (non-recursive)
|-
|}

=== Other ===
[[#toc|toc ↑]]
{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>AddToScriptHelp</code> || 
| 
|-
| <code>Assert</code> || <code>void Assert(bool ''value'', string ''msg'' = null)</code>
| Test value and if not true, throws an exception string "Assertion failed".
If ''msg'' parameter is set, then an exception string will be "Assertion failed: your message".
|-
| <code>CheckForSpecialStage</code> || <code>void CheckForSpecialStage(''level'', ''stage_list'', ''stage_info'')</code>
| Helper for picking a random special stage based on stage_info table.
|-
| <code>ClearGameEventCallbacks</code> || <code>void ClearGameEventCallbacks()</code>
| Empties the tables of game event callback functions.
|-
| <code>ClearSavedTables</code> || <code>void ClearSavedTables()</code>
| Removes any tables saved with {{Code|SaveTable()}}.
|-
| <code>developer</code> || <code>int developer()</code>
| The current level of the <code>developer</code> console variable.
|-
| <code>Document</code> || <code>void Document(unknown ''symbolOrTable'', unknown ''itemIfSymbol'' = null, string ''descriptionIfSymbol'' = null)</code>
| 
|-
| <code>DoIncludeScript</code> || <code>bool DoIncludeScript(string ''file'', handle/table ''scope'')</code>
| Execute a script. and put all its content for the argument passed to the {{Code|scope}} parameter. (internal)
|-
| <code>IncludeScript</code> || <code>bool IncludeScript(string ''file'', handle ''scope'' = null)</code>
| Wrapper for DoIncludeScript.
|-
| <code>DoUniqueString</code> || <code>string DoUniqueString(string/null ''input'')</code>
| Generate a string guaranteed to be unique across the life of the script VM. This function requires a string or a null value as an input, otherwise throws an error.
You should use {{Code|UniqueString}} function instead, as it is converting any input value to a string before calling this function, making generation process practically errorless.
|-
| <code>Ent</code> || <code>handle Ent(string/int ''idxorname'')</code>
| Wrapper function. If a string is provided, it'll find the entity by name using the string. But if an integer is provided, it'll be converted to a Script Handle before verifying the entity exists.
|-
| <code>FileToString</code> || <code>string FileToString(string ''path'')</code>
| Reads the file located in left4dead2/ems/''path'' and returns its contents as a string. ''path'' supports folders and special names "." and "..", which indicate "current folder" and "parent folder" respectfully.
If file does not exist, a null value will be returned.

If file is longer than 16384 bytes, it will return a null value and print an error "File ems/''path'' (from ''path'') is len [actual file length here] too long for a ScriptFileRead".

Warning: if ''path'' contains folders, these folders will be created, if missing. Check carefully what you are reading, since there is no way to remove files/folders using VScript.
|-
| <code>FireGameEvent</code> || <code>string FireGameEvent(string ''event'', table ''params'')</code>
| Fire a game event to a listening callback function in script. Parameters are passed in a squirrel table.
|-
| <code>FireScriptEvent</code> || <code>void FireScriptEvent(event, params)</code>
| Wrapper for {{Code|__RunEventCallbacks()}}
|-
| <code>ForceScavengeStart</code> || <code>void ForceScavengeStart()</code>
| Starts the scavenge round, even if the setup timer hasn't elapsed.
|-
| <code>ForceSurvivalStart</code> || <code>void ForceSurvivalStart()</code>
| Starts the survival round, even if the survivors haven't activated the radio.
|-
| <code>ForceVersusStart</code> || <code>void ForceVersusStart()</code>
| Starts the versus round, even if the survivors haven't left the safe room.
|-
| <code>GetCharacterDisplayName</code> || <code>string GetCharacterDisplayName(CTerrorPlayer ''player'')</code>
| Return {{Code|null}} if not a survivor, else the survivor's chosen character's name. This does not work with team 4 survivors.
|-
| <code>GetCurrentFlowDistanceForPlayer</code> || <code>float GetCurrentFlowDistanceForPlayer(CTerrorPlayer ''player'')</code>
| Returns the navigation flow distance from the start to the specified player.
|-
| <code>GetCurrentFlowPercentForPlayer</code> || <code>float GetCurrentFlowPercentForPlayer(CTerrorPlayer ''player'')</code>
| Returns how far in the navigation flow from the start to the end the player is.
|-
| <code>GetFlowDistanceForPosition</code> || <code>float GetFlowDistanceForPosition(Vector ''position'')</code>
| Returns the navigation flow distance from the start to the specified point.
|-
| <code>GetFlowPercentForPosition</code> || <code>float GetFlowPercentForPosition(Vector ''position'', bool ''unknown'')</code>
| Returns how far in the navigation flow from the start to the end the position is.
|-
| <code>GetMaxFlowDistance</code> || <code>float GetMaxFlowDistance()</code>
| Returns the navigation flow distance from the start to the end of the level.
|-
| <code>GetAverageSurvivorFlowDistance</code> || <code>float GetAverageSurvivorFlowDistance()</code>
| Returns the navigation flow distance from the start to the survivors position averaged.
|-
| <code>GetDifficulty</code> || <code>int GetDifficulty()</code>
| Returns the current difficulty as a numeric value. Easy = 0, Normal = 1, Advanced = 2, Expert = 3.
|-
| <code>GetDifficultyString</code> || <code>string GetDifficultyString()</code>
| Returns the current difficulty as a string. Difficulty names are in z_difficulty cvar style: Easy, Normal, Hard, Impossible.
|-
| <code>GetFrameCount</code> || <code>void GetFrameCount()</code>
| Returns the engine's current frame count.
|-
| <code>GetFunctionSignature</code> || 
| 
|-
| <code>GetInfectedStats</code> || <code>void GetInfectedStats(table ''statTable'') </code>
| Fills statTable with some infected counts/etc... Right now the list is Witches, Tanks, Specials, Commons, though we may add more as requested going forward.
|-
| <code>GetModelIndex</code> || <code>int GetModelIndex(string ''filename'')</code>
| Returns index of model by name.
|-
| <code>GetScavengeItemsGoal</code> || <code>int GetScavengeItemsGoal()</code>
| Returns number of Scavenge items needed.
|-
| <code>GetScavengeItemsRemaining</code> || <code>int GetScavengeItemsRemaining()</code>
| Returns number of Scavenge items remaining.
|-
| <code>GetSoundDuration</code> || <code>float GetSoundDuration(string ''soundname'', string ''actormodel'')</code>
| Returns float duration of the sound. Takes soundname and optional actormodelname.
|-
| <code>HasConfigurableDifficultySetting</code> || <code>bool HasConfigurableDifficultySetting()</code>
| Returns true if the mode has more than a single difficulty.
|-
| <code>HasPlayerControlledZombies</code> || <code>bool HasPlayerControlledZombies()</code>
| Returns true if the current mode supports player controlled zombies.
|-
| <code>IsMissionFinalMap</code> || <code>bool IsMissionFinalMap()</code>
| True if the current map is the final map of the campaign. Independent of {{ent|trigger_finale}} existence.
|-
| <code>IsDedicatedServer</code> || <code>bool IsDedicatedServer()</code>
| Returns true if this is a dedicated server.
|-
| <code>IsModelPrecached</code> || <code>bool IsModelPrecached(string ''modelname'')</code>
| Checks if the modelname is precached.
|-
| <code>IsSoundPrecached</code> || <code>bool IsSoundPrecached(string ''soundname'')</code>
| Checks if the soundname is precached.
|-
| <code>IsWeakref</code> || <code>bool IsWeakref(table, key)</code>
| Returns true/false based on whether table[key] is a weak reference
|-
| <code>LocalTime</code> || <code>void LocalTime(table)</code>
| Fills out a table with the local time (second, minute, hour, day, month, year, dayofweek, dayofyear, daylightsavings).
|-
| <code>MakeNamespace</code> || 
| 
|-
| <code>PrecacheModel</code> || <code>int PrecacheModel(string ''filename'')</code>
| Precache a model and return index of the model.
|-
| <code>PrecacheSound</code> || <code>void PrecacheSound(string ''soundName'')</code>
| Precache a sound.
|-
| <code>QueueSpeak</code> || <code>void QueueSpeak(handle ''entity'', string ''concept'', float ''delay'', string ''criteria'')</code>
| Queue a speech concept.
|-
| <code>RandomFloat</code> || <code>float RandomFloat(float ''min'', float ''max'')</code>
| Generate a random floating-point number within a range, inclusive.
|-
| <code>RandomInt</code> || <code>int RandomInt(int ''min'', int ''max'')</code>
| Generate a random integer within a range, inclusive.
|-
| <code>ReapplyInfectedFlags</code> || <code>ReapplyInfectedFlags(int ''flags'', handle ''infected'')</code>
| Apply Infected Flags from {{Code|DirectorOptions}}. Applies to all common (spawned and unspawned) unless a handle to a specific infected is specified. 
|-
| <code>RegisterFunctionDocumentation</code> || <code>void RegisterFunctionDocumentation(unknown ''func'', string ''name'', string ''signature'', string ''description'')</code>
| 
|-
| <code>RegisterScriptGameEventListener</code> || <code>void RegisterScriptGameEventListener(string ''eventName'')</code>
| Register as a listener for a game event from script. It's what {{Code|__CollectGameEventCallbacks()}} uses to register event callbacks to the C++ code.
|-
| <code>ReloadMOTD</code> || <code>void ReloadMOTD()</code>
| Reloads the MotD file.
|-
| <code>RestoreTable</code> || <code>void RestoreTable(string ''identifier'', table)</code>
|Restores table data and '''deletes it'''. See [[L4D2_EMS/Appendix:_Table_Save_Restore]].
|-
| <code>RetrieveNativeSignature</code> || <code>unknown RetrieveNativeSignature(string ''nativeFunction'')</code>
| 
|-
| <code>rr_AddDecisionRule</code> || <code>bool rr_AddDecisionRule(RRule ''rule'')</code>
| Add a rule to the decision database. Takes a RRule object from rulescript_base.nut.
|-
| <code>rr_CommitAIResponse</code> || <code>bool rr_CommitAIResponse(handle ''entity'', table ''airesponse'')</code>
| Supposed to commit the result of QueryBestResponse back to the given entity to play. Takes a table needing the keys ''response'' with a ResponseSingle object (defined in response_testbed.nut) and ''orig_query'' with an unknown content.
|-
| <code>rr_GetResponseTargets</code> || <code>table rr_GetResponseTargets()</code>
| Retrieve a table of all available expresser targets, in the form { name : handle, name: handle }.
|-
| <code>rr_QueryBestResponse</code> || <code>unknown rr_QueryBestResponse(handle ''entity'', table ''query'')</code>
| Tests ''query'' against entity's response system and returns the best response found (or null if none found). Returns a pointer with a null type, that is apparently not usable anywhere. Possibly supposed to return a AI_Response object.
|-
| <code>RushVictim</code> || <code>void RushVictim(handle ''hVictim'', float ''range'')</code>
| Make all common zombies in range rush the victim. (If hVictim isn't set, a random survivor will be chosen.)
|-
| <code>SaveTable</code> || <code>void SaveTable(string ''identifier'', table)</code>
| See [[L4D2_EMS/Appendix:_Table_Save_Restore]].
|-
| <code>ScreenFade</code> || <code>void ScreenFade(handle ''player'', int ''red'', int ''green'', int ''blue'', int ''alpha'', float ''fadeTime'', float ''fadeHold'', int ''flags'')</code>
| Start a screenfade with the following parameters.
|-
| <code>ScreenShake</code> || <code>void ScreenShake(Vector ''vecCenter'', float ''flAmplitude'', float ''flFrequency'', float ''flDuration'', float ''flRadius'', int ''eCommand'', bool ''bAirShake'')</code>
| Start a screenshake with the following parameters.
|-
| <code>SetScavengeItemsGoal</code> || <code>void SetScavengeItemsGoal(int ''count'')</code>
| Set the number of Scavenge items needed.
|-
| <code>SetScavengeItemsRemaining</code> || <code>void SetScavengeItemsRemaining(int ''count'')</code>
| Set the number of Scavenge items remaining.
|-
| <code>StageInfo_Execute</code> || <code>void StageInfo_Execute(''stageInfo'', ''stageDefaults'')</code>
| Execute a stage table, i.e. move parameters to DirectorOptions, do callbacks and so on.
|-
| <code>StartAssault</code> || <code>void StartAssault()</code>
| Tells all existing nextbots to swap into assault mode and not hide/dither/loiter.
|-
| <code>StringToFile</code> || <code>void StringToFile(string ''path'', string ''string'')</code>
| Stores the ''string'' into the file located at left4dead2/ems/''path''. ''Path'' can contain folders -- in that case folders will be automatically created. Also ''path'' supports special names "." and "..", which indicate "current folder" and "parent folder" respectfully.

Things to consider:
* You can save much more than you can read with FileToString() -- you are limited only by script execution time. Check carefully what are you writing!
* Due to a bug, string is saved with zero byte at the end. Such file is still read back properly by FileToString(), but that means you can save only 16383 bytes of useful information if you plan to read the file back.
* There is no way to remove files using VScript.
|-
| <code>Time</code> || <code>float Time()</code>
| Get the current server time.
|-
| <code>[[/TraceLine| TraceLine]]</code> || <code>bool TraceLine(table ''traceTable'')</code>
| Uses a configuration table to do a raytrace, puts return information into the table for return usage.
|-
| <code>UniqueString</code> || <code>string UniqueString(string ''input''="")</code>
| Generate a string guaranteed to be unique across the life of the script VM, with an optional root string. Input will be converted to a string by calling {{Code|tostring()}} member function of that input, before passing it to {{Code|DoUniqueString}} function. Useful for adding data to tables when not sure what keys are already in use in that table. Throws error on null value.
|-
| <code>VSquirrel_OnCreateScope</code> || <code>table VSquirrel_OnCreateScope(value, table ''scope'')</code>
| Creates a new scope with the name of value in the submitted table (includes unique params).
|-
| <code>VSquirrel_OnReleaseScope</code> || <code>void VSquirrel_OnReleaseScope(table ''createdScope'')</code>
| Removes a scope created via VSquirrel_OnCreateScope.
|-
| <code>__CollectGameEventCallbacks</code> || <code>void __CollectGameEventCallbacks(scope)</code>
| Wrapper that registers callbacks for both [[#OnGameEvent_x|OnGameEvent_''x'' ↑]] and {{Code|OnScriptEvent_}} functions. Done using the {{Code|__CollectEventCallbacks}} function.
|-
| <code>__CollectEventCallbacks</code> || <code>void __CollectEventCallbacks(scope, prefix, globalTableName, regFunc)</code>
| Overloaded function, used by the above one like this: {{Code|__CollectEventCallbacks(scope, "OnGameEvent_", "GameEventCallbacks", ::RegisterScriptGameEventListener)}}
|-
| <code>__ExecutePreSpawn</code> || 
| 
|-
| <code>__FinishSpawn</code> || 
| 
|-
| <code>__ReplaceClosures</code> || <code>void __ReplaceClosures(script, scope)</code>
| 
|-
| <code>__RunEventCallbacks</code> || <code>void __RunEventCallbacks(event, params, prefix, globalTableName, bWarnIfMissing)</code>
| Call all functions in the callback array for the given game event.
|-
| <code>__RunGameEventCallbacks</code> || <code>void __RunGameEventCallbacks(event, params </code>
| Wrapper for {{Code|__RunEventCallbacks()}}
|}

=== Squirrel Standard Library ===
[[#toc|toc ↑]]

{{sq}} List of functions that come from Squirrel's [https://web.archive.org/web/20230608131548if_/http://www.squirrel-lang.org/doc/squirrel3.pdf#%5B%7B%22num%22%3A392%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C115%2C490.402%2Cnull%5D built-in functions] and [https://web.archive.org/web/20131204090523if_/http://squirrel-lang.org:80/doc/sqstdlib3.pdf standard library]. Not all functions from the linked documentations are present in VScript, such as the {{Code|blob}} library.

{| class = "standard-table" style = "width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>array</code> || <code>array(int ''size'', any ''fill'' = null)</code>
| Create and returns array of a specified size where each element is set to {{Code|''fill''}}.
|-
| <code>assert</code> || <code>assert(bool ''exp'')</code>
| Throws an exception if exp is evaluated to false.
|-
| <code>callee</code> || <code>function callee()</code>
| Returns the currently running closure.
|-
| <code>collectgarbage</code> || <code>int collectgarbage()</code>
| Runs the garbage collector and returns the number of reference cycles found(and deleted) This function only works on garbage collector builds. 
|-
| <code>compilestring</code> || <code>function compilestring(string ''string'', string ''buffername'' = null)</code>
| Compiles a string containing a squirrel script into a function and returns it.
|-
| <code>enabledebuginfo</code> || <code>void enabledebuginfo(any ''enable'')</code>
| Enable/disable the debug line information generation at compile time. enable != null enables . enable == null disables. 
|-
| <code>error</code> || <code>void error(string ''x'')</code>
| Prints x in the standard error output.
|-
| <code>getconsttable</code> || <code>table getconsttable()</code>
| Returns the const table of the VM. 
|-
| <code>getroottable</code> || <code>table getroottable()</code>
| Returns the root table of the VM. 
|-
| <code>getstackinfos</code> || <code>table getstackinfos(int ''stacklevel'')</code>
| Returns the stack frame informations at the given stack level (0 is the current function 1 is the caller and so on). If the stack level doesn't exist the function returns null. {{Expand|title=Example|<source>{
	func="DoStuff",	//function name
	
	src="test.nut",	//source file
	
	line=10,		//line number
	
	locals = {		//a table containing the local variables
	
		a=10,
		
		testy="I'm a string"
	}
}</source>}}
|-
| <code>newthread</code> || <code>coroutine newthread(function ''threadfunc'')</code>
| Creates a new cooperative thread object(coroutine) and returns it 
|-
| <code>print</code> || <code>void print(string ''message'')</code>
| Prints message to console without any line feed after.
|-
| <code>resurrectunreachable</code> || <code>array resurrectunreachable()</code>
| Runs the garbage collector and returns an array containing all unreachable object found. If no unreachable object is found, null is returned instead. This function is meant to help debugging reference cycles. This function only works on garbage collector builds. 
|-
| <code>setconsttable</code> || <code>table setconsttable(table ''consttable'')</code>
| Sets the const table of the VM which also returns the previous const table.  
|-
| <code>seterrorhandler</code> || <code>void seterrorhandler(function ''func'')</code>
| Sets the runtime error handler .
|-
| <code>setroottable</code> || <code>table setroottable(table ''roottable'')</code>
| Sets the root table of the VM which also returns the previous root table. 
|-
| <code>suspend</code> || <code>void suspend(any ''ret'')</code>
| Suspends the coroutine that called this function.
|-
| <code>type</code> || <code>string type(any ''obj'')</code>
| Return the 'raw' type of an object without invoking the metatmethod '_typeof'. 
|}

==== Math ====
The built-in [https://web.archive.org/web/20131204090523if_/http://squirrel-lang.org:80/doc/sqstdlib3.pdf#%5B%7B%22num%22%3A111%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C115%2C725%2Cnull%5D Squirrel math library].

{| class="standard-table" style="width: 100%;"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>abs</code> || <code> int abs(float ''x'')</code>
| Returns the absolute value of <code>x</code> as an integer.
|-
| <code>acos</code> || <code> float acos(float ''x'')</code>
| Returns the arccosine of <code>x</code>.
|-
| <code>asin</code> || <code> float asin(float ''x'')</code>
| Returns the arcsine of <code>x</code>.
|-
| <code>atan</code> || <code> float atan(float ''x'')</code>
| Returns the arctangent of <code>x</code>.
|-
| <code>atan2</code> || <code> float atan2(float ''x'', float ''y'')</code>
| Returns the arctangent of <code>x/y</code>.
|-
| <code>ceil</code> || <code> float ceil(float ''x'')</code>
| Returns a float value representing the smallest integer that is greater than or equal to <code>x</code>.
|-
| <code>cos</code> || <code> float cos(float ''x'')</code>
| Returns the cosine of <code>x</code>.
|-
| <code>exp</code> || <code> float exp(float ''x'')</code>
| Returns the exponential value (<code>e^x</code>) of the float parameter <code>x</code>.
|-
| <code>fabs</code> || <code> float fabs(float ''x'')</code>
| Returns the absolute value of <code>x</code> as a float.
|-
| <code>floor</code> || <code> float floor(float ''x'')</code>
| Returns a float value representing the largest integer that is less than or equal to <code>x</code>.
|-
| <code>log</code> || <code> float log(float ''x'')</code>
| Returns the natural logarithm of <code>x</code>.
|-
| <code>log10</code> || <code> float log10(float ''x'')</code>
| Returns the logarithm base-10 of <code>x</code>.
|-
| <code>pow</code> || <code> float pow(float ''x'', float ''y'')</code>
| Returns <code>x</code> raised to the power of <code>y</code>.
|-
| <code>rand</code> || <code> int rand()</code>
| Returns a pseudorandom integer in the range 0 to <code>RAND_MAX</code>.
|-
| <code>sin</code> || <code> float sin(float ''x'')</code>
| Returns the sine of <code>x</code>.
|-
| <code>sqrt</code> || <code> float sqrt(float ''x'')</code>
| Returns the square root of <code>x</code>.
|-
| <code>srand</code> || <code> void srand(float ''seed'')</code>
| Sets the starting point for generating a series of pseudorandom integers.
|-
| <code>tan</code> || <code> float tan(float ''x'')</code>
| Returns the tangent of <code>x</code>.
|}

==== Strings ====
The built-in [https://web.archive.org/web/20131204090523if_/http://squirrel-lang.org:80/doc/sqstdlib3.pdf#%5B%7B%22num%22%3A119%2C%22gen%22%3A0%7D%2C%7B%22name%22%3A%22XYZ%22%7D%2C115%2C725%2Cnull%5D Squirrel string library].

{| class="standard-table" style="width:100%"
! Function !! Signature !! Description
|-
| <code>format</code> || <code>string format(string ''format'', args...)</code>
| Returns a [[w:printf format string|formatted string]]. Same rules as the standard C functions (except * is not supported).
|-
| <code>lstrip</code> || <code>string lstrip(string ''str'')</code>
| Removes whitespace characters at the beginning of the given string.
|-
| <code>rstrip</code> || <code>string rstrip(string ''str'')</code>
| Removes whitespace characters at the end of the given string.
|-
| <code>split</code> || <code>array split(string ''str'', string ''separator'')</code>
| Returns an array of strings split at each point where a separator character occurs in str. The separator is not returned as part of any array element. the parameter separators is a string that specifies the characters as to be used for the splitting.
|-
| <code>strip</code> || <code>string strip(string ''str'')</code>
| Removes whitespace characters at both the beginning and end of the given string.
|}

=== Script Debug ===
[[#toc|toc ↑]]
Functions for interacting with the debugger. Some of them are documented [[L4D2_EMS/Appendix:_Debugging|here]].

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function !! Signature !! Description
|-
| <code>BeginScriptDebug</code> || <code>void BeginScriptDebug()</code>
| 
|-
| <code>EndScriptDebug</code> || <code>void EndScriptDebug()</code>
| 
|-
| <code>ScriptDebugAddTextFilter</code> || <code>void ScriptDebugAddTextFilter()</code>
| 
|-
| <code>ScriptDebugAddTrace</code> || <code>void ScriptDebugAddTrace()</code>
| 
|-
| <code>ScriptDebugAddWatch</code> || <code>void ScriptDebugAddWatch()</code>
| 
|-
| <code>ScriptDebugAddWatches</code> || <code>void ScriptDebugAddWatches()</code>
| 
|-
| <code>ScriptDebugAddWatchPattern</code> || <code>void ScriptDebugAddWatchPattern()</code>
| 
|-
| <code>ScriptDebugClearTraces</code> || <code>void ScriptDebugClearTraces()</code>
| 
|-
| <code>ScriptDebugClearWatches</code> || <code>void ScriptDebugClearWatches()</code>
| 
|-
| <code>ScriptDebugDefaultWatchColor</code> || <code>void ScriptDebugDefaultWatchColor()</code>
| 
|-
| <code>ScriptDebugDraw</code> || <code>void ScriptDebugDraw()</code>
| 
|-
| <code>ScriptDebugDrawWatches</code> || <code>void ScriptDebugDrawWatches()</code>
| 
|-
| <code>ScriptDebugDumpKeys</code> || <code>void ScriptDebugDumpKeys()</code>
| 
|-
| <code>ScriptDebugHook</code> || <code>void ScriptDebugHook()</code>
| 
|-
| <code>ScriptDebugIterateKeys</code> || <code>void ScriptDebugIterateKeys()</code>
| 
|-
| <code>ScriptDebugIterateKeysRecursive</code> || <code>void ScriptDebugIterateKeysRecursive()</code>
| 
|-
| <code>ScriptDebugRemoveTextFilter</code> || <code>void ScriptDebugRemoveTextFilter()</code>
| 
|-
| <code>ScriptDebugRemoveTrace</code> || <code>void ScriptDebugRemoveTrace()</code>
| 
|-
| <code>ScriptDebugRemoveWatch</code> || <code>void ScriptDebugRemoveWatch()</code>
| 
|-
| <code>ScriptDebugRemoveWatches</code> || <code>void ScriptDebugRemoveWatches()</code>
| 
|-
| <code>ScriptDebugRemoveWatchPattern</code> || <code>void ScriptDebugRemoveWatchPattern()</code>
| 
|-
| <code>ScriptDebugText</code> || <code>void ScriptDebugText()</code>
| 
|-
| <code>ScriptDebugTextDraw</code> || <code>void ScriptDebugTextDraw()</code>
| 
|-
| <code>ScriptDebugTextPrint</code> || <code>void ScriptDebugTextPrint()</code>
| 
|-
| <code>ScriptDebugTextTrace</code> || <code>void ScriptDebugTextTrace()</code>
| 
|-
| <code>ScriptDebugTraceAll</code> || <code>void ScriptDebugTraceAll()</code>
| 
|-
| <code>ScriptDebugWatches</code> || <code>void ScriptDebugWatches()</code>
| 
|-
| <code>__VScriptServerDebugHook</code> || <code>__VScriptServerDebugHook()</code>
| 
|}

== See also ==
[[#toc|toc ↑]]
* [[VScript]]
* [[VScript Fundamentals]]
* {{sq}} [[Squirrel]]
* {{l4d2}} [[L4D2 Vscript Examples|L4D2 VScripts Examples]]
* {{l4d2}} [[L4D2 Vscript Helpers|L4D2 VScript Helpers]]
* {{csgo}} [[List of CS:GO Script Functions]]
* {{tf2}} [[Team_Fortress_2/Scripting/Script_Functions|List of TF2 Script Functions]]
* {{portal2}} [[List of Portal 2 Script Functions]]
* {{asrd}} [[List of Reactive Drop Script Functions|List of AS:RD Script Functions]]
* [[List of Script Libraries]]

<!--
Move some of these to [[L4D2 VScripts]], [[L4D2 VScript Examples]] and [[Mutation Gametype (L4D2)]]. First one especially as it's supposed to be the hub for everything L4D2 VScripting.
For some of these pages, it might be better to make use of Github and its file viewer?

* {{l4d2}} [[L4D2_Vscript_Helpers|L4D2 VScript Helpers]]

=== [[L4D2 EMS|EMS]] === <-- This page can't be edited :/
*[[L4D2_Decrypted_mutations|Decrypted Mutation VScripts]]
*[[Mutation Gametype (L4D2)]]
*[[L4D2 Gamemodes File]]
-->
[[Category:Left 4 Dead 2]]
[[Category:Scripting]]