View source for Team Fortress 2/Scripting/Script Functions

{{LanguageBar}}
{{TF2 topicon|docs}}
{{toc-right}}
{{sq}} This list contains the engine-related Squirrel classes, functions and variables available for [[VScript]] in {{tf2|4|}}

The official documentation can be printed in the console by setting <code>developer</code> to non-zero, loading a map, and executing <code>script_help</code>. However, this documentation does not list everything, requiring them to be found by other means instead.

{{tip|[https://discord.com/invite/tf2maps TF2Maps.net Discord] has a dedicated VScript channel, which is a useful place to ask for help from other people.}}
{{tip|Tutorial on setting up Visual Studio Code (VSCode), including auto-completing of VScript functions, can be [[Setting_Up_VScript_in_Visual_Studio_Code|found here]].}}

== Instances ==
{| class = "standard-table"
! Name
! Class
! Description
|-
|<code>Convars</code>
|<code>[[#Convars|Convars ↓]]</code>
|Provides an interface to read and change the values of console variables.
|-
|<code>Entities</code>
|<code>[[#CEntities|CEntities ↓]]</code>
|Provides access to currently spawned entities.
|-
|<code>EntityOutputs</code>
|<code>[[#CScriptEntityOutputs|CScriptEntityOutputs ↓]]</code>
|Allows manipulation of entity output data
|-
|<code>NavMesh</code>
|<code>[[#CNavMesh|CNavMesh ↓]]</code>
|Provides access to the maps NavMesh and NavAreas.
|-
|<code>NetProps</code>
|<code>[[#CNetPropManager|CNetPropManager ↓]]</code>
|Allows reading and updating the network properties of an entity.
|-
|<code>PlayerVoiceListener</code>
|<code>[[#CPlayerVoiceListener|CPlayerVoiceListener ↓]]</code>
|Tracks if any player is using voice and for how long.
|}

== Variables ==
{| class = "standard-table"
! Name
! Type
! Value / Description
|-
|<code>__FILE__</code>
|string
| File name of the currently executing script
|-
|<code>__LINE__</code>
|integer
| Line number of the currently executing code
|-
|<code>[[Team_Fortress_2/Scripting/Script_Functions/Constants|Constants]]</code>
|table
| Enumerations for various function arguments or netprops.
|-
|<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
| 0. Spaces to indent prints by, except ones from <code>realPrint</code>.
|-
|<code>_PublishedHelp</code>
|table
| NONE
|-
|<code>ScriptEventCallbacks</code>
|table
| Table of registered script event callbacks.
|-
|<code>ScriptHookCallbacks</code>
|table
| Table of registered script hook 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 made to rid any instances of [https://en.wikipedia.org/wiki/Magic_number_(programming) magic numbers] by giving them self-documenting names.

{| class = "standard-table"
! Name
! Type
! Value
|-
|<code>_charsize_</code>
|integer
| 1
|-
|<code>_floatsize_</code>
|integer
| 4
|-
|<code>_intsize_</code>
|integer
|32-bit: 4
64-bit: 8
|-
|<code>_version_</code>
|string
| "Squirrel 3.2 stable"
|-
|<code>_versionnumber_</code>
|integer
| 320
|-
|<code>RAND_MAX</code>
|integer
|Windows: 32768
Linux: 2147483647
|-
|<code>PI</code>
|float
| 3.14159
|}

=== Enums ===
:''See [[Team_Fortress_2/Scripting/Script_Functions/Constants|this page]] for all enums under the <code>Constants</code> table.''

There are also [https://en.wikipedia.org/wiki/Enumerated_type enums] kept within the <code>Constants</code> table, all with their own constants. For an example of accessing an enum's constant, the <code>HIDEHUD_CROSSHAIR</code> constant of the enum <code>HideHUD</code> is accessed by doing ''<code>Constants.HideHUD.HIDEHUD_CROSSHAIR</code>''.

== Classes ==
=== CBaseEntity ===
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.
* <code>EntIndexToHScript</code> function.
* [[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
|-
| {{obs}} <code>__KeyValueFromFloat (&rarr; KeyValueFromFloat)</code>
| <code>bool __KeyValueFromFloat(string ''key'', float ''value'')</code>
| Behaves the same as <code>KeyValueFromFloat</code>, use that instead.
|-
| {{obs}} <code>__KeyValueFromInt (&rarr; KeyValueFromInt)</code>
| <code>bool __KeyValueFromInt(string ''key'', int ''value'')</code>
| Behaves the same as <code>KeyValueFromInt</code>, use that instead.
|-
| {{obs}} <code>__KeyValueFromString (&rarr; KeyValueFromString)</code>
| <code>bool __KeyValueFromString(string ''key'', string ''value'')</code>
| Behaves the same as <code>KeyValueFromString</code>, use that instead.
|-
| {{obs}} <code>__KeyValueFromVector (&rarr; KeyValueFromVector)</code>
| <code>bool __KeyValueFromVector(string ''key'', Vector ''value'')</code>
| Behaves the same as <code>KeyValueFromVector</code>, use that instead.
|-
| <code>AcceptInput</code>
| <code>bool AcceptInput(string ''input'', string ''param'', handle ''activator'', handle ''caller'')</code>
| Generate a synchronous I/O event. Unlike <code>EntFireByHandle</code>, this is processed immediately. Returns false if ''input'' is a null/empty string, or if the input wasn't handled.
|-
| <code>AddEFlags</code>
| <code>void AddEFlags(int ''flags'')</code>
| Adds the supplied ''flags'' to the '''Entity Flags''' in the entity. ''(m_iEFlags datamap)''
See [[Team_Fortress_2/Scripting/Script_Functions/Constants#FEntityEFlags|Constants.FEntityEFlags]].
{{note|Adding <code>EFL_KILLME</code> will make the entity unkillable, even on round resets, until the flag is removed.}}
|-
| <code>AddFlag</code>
| <code>void AddFlag(int ''flags'')</code>
| Adds the supplied ''flags'' to another separate player-related entity flags system in the entity. ''(m_fFlags datamap)''
See [[Team_Fortress_2/Scripting/Script_Functions/Constants#FPlayer|Constants.FPlayer]].
|-
| <code>AddSolidFlags</code>
| <code>void AddSolidFlags(int ''flags'')</code>
| Adds the supplied ''flags'' to the ''Solid Flags'' in the entity. ''(m_Collision.m_usSolidFlags datamap)''
See [[Team_Fortress_2/Scripting/Script_Functions/Constants#FSolid|Constants.FSolid]].
|-
| <code>ApplyAbsVelocityImpulse</code>
| <code>void ApplyAbsVelocityImpulse(Vector ''impulse'')</code>
| Apply a Velocity Impulse as a world space impulse vector. Works for most physics-based objects including dropped weapons and even dropped Sandviches.
|-
| <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>BecomeRagdollOnClient</code>
| <code>bool BecomeRagdollOnClient(Vector ''impulse'')</code>
| Acts like the <code>BecomeRagdoll</code> input, with the required ''impulse'' value applied as a force on the ragdoll. Does NOT spawn a <code>[[prop_ragdoll]]</code> or any other entity.
{{warning|These are a special group of ragdolls that never disappear by default. To limit them or force them to disappear, use the [[game_ragdoll_manager]] entity.}}
|-
| <code>ClearFlags</code>
| <code>void ClearFlags()</code>
| Sets the player-related entity flags to 0 on an entity, clearing them.
|-
| <code>ClearSolidFlags</code>
| <code>void ClearSolidFlags()</code>
| Sets ''Solid Flags'' to 0 on an entity, clearing them.
|-
| <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.
{{note|If you are trying to access <code>activator</code> and <code>caller</code> in the called function and it doesn't exist, this means the entity has no script scope. Use <code>ValidateScriptScope</code> to fix this.}}
|-
| <code>Destroy</code>
| <code>void Destroy()</code>
| Removes the entity. Simply calls [[UTIL_Remove]].
|-
| <code>DisableDraw</code>
| <code>void DisableDraw()</code>
| Disable drawing and transmitting the entity to clients. ''(adds EF_NODRAW)''
|-
| <code>DisconnectOutput</code>
| <code>void DisconnectOutput(string ''output'', string ''function'')</code>
| Removes a connected script function from an I/O event.
|-
| <code>DispatchSpawn</code>
| <code>void DispatchSpawn()</code>
| Alternative dispatch spawn, same as the one in CEntities, for convenience.
{{note|Calling this on players will cause them to respawn.}}
|-
| <code>EmitSound</code>
| <code>void EmitSound(string ''soundname'')</code>
| Plays a sound from this entity. The sound must be precached first for it to play (using <code>PrecacheSound</code> or <code>PrecacheScriptSound</code>).
{{warning|Looping sounds will not stop on the entity when it's destroyed and will persist forever! To workaround this, run <code>StopSound</code> in the <code>OnDestroy</code> callback.}}
|-
| <code>EnableDraw</code>
| <code>void EnableDraw()</code>
| Enable drawing and transmitting the entity to clients. ''(removes EF_NODRAW)''
|-
| <code>entindex</code>
| <code>int entindex()</code>
| Returns the entity index.
|-
| <code>EyeAngles</code>
| <code>QAngle EyeAngles()</code>
| Returns the entity's eye angles. Acts like <code>GetAbsAngles</code> if the entity does not support it.
|-
| <code>EyePosition</code>
| <code>Vector EyePosition()</code>
| Get vector to eye position - absolute coords. Acts like <code>GetOrigin</code> if the entity does not support it.
|-
| <code>FirstMoveChild</code>
| <code>handle FirstMoveChild()</code>
| Returns the most-recent entity parented to this one.
{{tip|Example usage: <source lang=js>for (local child = entity.FirstMoveChild(); child != null; child = child.NextMovePeer())</source>}}
|-
| <code>GetAbsAngles</code>
| <code>QAngle GetAbsAngles()</code>
| Get the entity's pitch, yaw, and roll as '''QAngles'''.
|-
| <code>GetAbsVelocity</code>
| <code>Vector GetAbsVelocity()</code>
| Returns the current absolute velocity of the entity.
|-
| {{obs}} <code>GetAngles (&rarr; GetAbsAngles)</code>
| <code>Vector GetAngles()</code>
| Get the entity's pitch, yaw, and roll as a '''Vector'''.
|-
| <code>GetAngularVelocity</code>
| <code>Vector GetAngularVelocity()</code>
| Get the local angular velocity - returns a '''Vector''' of pitch, yaw, and roll.
|-
| <code>GetBaseVelocity</code>
| <code>Vector GetBaseVelocity()</code>
| Returns any constant velocity currently being imparted onto the entity. This includes being pushed by effects like {{ent|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. 
|-
| <code>GetBoundingMaxs</code>
| <code>Vector GetBoundingMaxs()</code>
| Get a vector containing max bounds, centered on object
|-
| <code>GetBoundingMaxsOriented</code>
| <code>Vector GetBoundingMaxsOriented()</code>
| Get a vector containing max bounds, centered on object, taking the object's orientation into account
{{bug|This does not transform the bounds correctly and in some cases the bounding box will not cover the whole entity. As a workaround, use the non-oriented bounds and perform an AABB transformation using a matrix constructed from the entity's origin and angles.}}
|-
| <code>GetBoundingMins</code>
| <code>Vector GetBoundingMins()</code>
| Get a vector containing min bounds, centered on object
|-
| <code>GetBoundingMinsOriented</code>
| <code>Vector GetBoundingMinsOriented()</code>
| Get a vector containing min bounds, centered on object, taking the object's orientation into account
{{bug|This does not transform the bounds correctly and in some cases the bounding box will not cover the whole entity. As a workaround, use the non-oriented bounds and perform an AABB transformation using a matrix constructed from the entity's origin and angles.}}
|-
| <code>GetCenter</code>
| <code>Vector GetCenter()</code>
| Gets center point of the entity in world coordinates.
|-
| <code>GetClassname</code>
| <code>string GetClassname()</code>
| 
|-
| <code>GetCollisionGroup</code>
| <code>int GetCollisionGroup()</code>
| Gets the current collision group of the entity. 
|-
| <code>GetEFlags</code>
| <code>int GetEFlags()</code>
|
|-
| <code>GetFlags</code>
| <code>int GetFlags()</code>
| Get the entity's flags.
See [[Team_Fortress_2/Scripting/Script_Functions/Constants#FPlayer|Constants.FPlayer]].
{{tip|Example usage: <source lang=js>if (entity.GetFlags() & Constants.FPlayer.FL_ONGROUND) 
{
	printl("Entity is on the ground!");
}</source>}}
|-
| <code>GetEntityHandle</code>
| <code>ehandle GetEntityHandle()</code>
| Get the entity as an EHANDLE
|-
| <code>GetEntityIndex</code>
| <code>int GetEntityIndex()</code>
| 
|-
| <code>GetForwardVector</code>
| <code>Vector GetForwardVector()</code>
| Get the forward vector of the entity
|-
| <code>GetFriction</code>
| <code>float GetFriction()</code>
| Get PLAYER friction, ignored for objects
|-
| <code>GetGravity</code>
| <code>float GetGravity()</code>
|
|-
| <code>GetHealth</code>
| <code>int GetHealth()</code>
| 
|-
|style=white-space:nowrap| {{obs}} <code>GetLeftVector (&rarr; GetRightVector)</code>
| <code>Vector GetLeftVector()</code>
| Get the ''right'' vector of the entity. This is purely for compatibility.
|-
| <code>GetLocalAngles</code>
| <code>QAngle GetLocalAngles()</code>
| 
|-
| <code>GetLocalOrigin</code>
| <code>Vector GetLocalOrigin()</code>
| 
|-
| <code>GetLocalVelocity</code>
| <code>Vector GetLocalVelocity()</code>
| Get Entity relative velocity
|-
| <code>GetMaxHealth</code>
| <code>int GetMaxHealth()</code>
| 
|-
| <code>GetModelKeyValues</code>
| <code>handle GetModelKeyValues()</code>
| Get a KeyValue class instance on this entity's model
|-
| <code>GetModelName</code>
| <code>string GetModelName()</code>
| Returns the name of the model
|-
| <code>GetMoveParent</code>
| <code>handle GetMoveParent()</code>
| If in hierarchy, retrieves the entity's parent
|-
| <code>GetMoveType</code>
| <code>int GetMoveType()</code>
|
|-
| <code>GetName</code>
| <code>string GetName()</code>
| 
|-
| <code>GetOrigin</code>
| <code>Vector GetOrigin()</code>
| This is <code>GetAbsOrigin</code> with a funny script name for some reason. Not changing it for legacy compat though.
|-
| <code>GetOwner</code>
| <code>handle GetOwner()</code>
| Gets this entity's owner
|-
| <code>GetPhysAngularVelocity</code>
| <code>Vector GetPhysAngularVelocity()</code>
|
|-
| <code>GetPhysVelocity</code>
| <code>Vector GetPhysVelocity()</code>
|
|-
| <code>GetPreTemplateName</code>
| <code>string GetPreTemplateName()</code>
| Get the entity name stripped of template unique decoration
|-
| <code>GetRightVector</code>
| <code>Vector GetRightVector()</code>
| Get the right vector of the entity
|-
| <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>
| Retrieve the unique identifier used to refer to the entity within the scripting system.
|-
| <code>GetScriptScope</code>
| <code>handle GetScriptScope()</code>
| Retrieve the script-side data associated with an entity
|-
| <code>GetScriptThinkFunc</code>
| <code>string GetScriptThinkFunc()</code>
| Retrieve the name of the current script think func
|-
| <code>GetSolid</code>
| <code>int GetSolid()</code>
|
|-
| <code>GetSoundDuration</code>
| <code>float GetSoundDuration(string ''soundname'', string ''actormodelname'')</code>
| Returns float duration of the sound. Actor model name is optional and can be left null.
{{todo|Actor model name is likely a leftover from {{hl2|2}}}}
{{warning|Does not work on dedicated servers as they do not have audio libraries built-in to load sounds.}}
|-
| <code>GetTeam</code>
| <code>int GetTeam()</code>
| 
|-
| <code>GetUpVector</code>
| <code>Vector GetUpVector()</code>
| Get the up vector of the entity
|-
| {{obs}} <code>GetVelocity (&rarr; GetAbsVelocity)</code>
| <code>Vector GetVelocity()</code>
| 
|-
| <code>GetWaterLevel</code>
| <code>int GetWaterLevel()</code>
| This function tells you how much of the entity is underwater. It returns a value of 0 if not underwater, 1 if the feet are (touching water brush), 2 if the waist is (center of the hull of the entity), and 3 if the head is (eyes position).
{{note|Some entities might not return 1 despite touching water. In some cases you might get 0 and 3 only, or sometimes 0, 2 and 3.}}
|-
| <code>GetWaterType</code>
| <code>int GetWaterType()</code>
| It returns the type of water the entity is currently submerged in. 32 for water and 16 for slime.
|-
| <code>IsAlive</code>
| <code>bool IsAlive()</code>
| Am I alive?
|-
| <code>IsEFlagSet</code>
| <code>bool IsEFlagSet(int ''eflag'')</code>
|
|-
| <code>IsPlayer</code>
| <code>bool IsPlayer()</code>
| Checks whether the entity is a player or not.
|-
| <code>IsSolid</code>
| <code>bool IsSolid()</code>
| 
|-
| <code>IsSolidFlagSet</code>
| <code>bool IsSolidFlagSet(int ''solidflag'')</code>
|
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| Checks whether the entity still exists. Useful when storing entity handles and needing to check if the entity was not deleted.
{{note|This function is never necessary to call on handles returned from built-in script functions, as they are guaranteed to be valid or <code>null</code>.}}
|-
| <code>KeyValueFromFloat</code>
| <code>bool KeyValueFromFloat(string ''key'', float ''value'')</code>
| Executes KeyValue with a float
{{warning|Does not update the internal network state of the entity, which can result in any desired visual changes being delayed for clients if used after spawning. [[#CNetPropManager|Netprops ↓]] can be used instead which correctly updates the networking state and results in an immediate update. An exception is the <code>origin</code> keyvalue, which does update network state immediately.}}
|-
| <code>KeyValueFromInt</code>
| <code>bool KeyValueFromInt(string ''key'', int ''value'')</code>
| Executes KeyValue with an int
{{warning|See above.}}
|-
| <code>KeyValueFromString</code>
| <code>bool KeyValueFromString(string ''key'', string ''value'')</code>
| Executes KeyValue with a string
{{warning|See above.}}
|-
| <code>KeyValueFromVector</code>
| <code>bool KeyValueFromVector(string ''key'', Vector ''value'')</code>
| Executes KeyValue with a vector
{{warning|See above.}}
|-
| <code>Kill</code>
| <code>void Kill()</code>
| Removes the entity. Equivalent of firing the <code>Kill</code> I/O input, but instantaneous.
{{warning|This clears the owner entity (<code>m_hOwnerEntity</code> netprop) before removing, this may cause unexpected problems with entities that rely on cleaning up data related to their owner, such as Medigun healing targets. In those cases, use <code>Destroy</code> instead.}}
|-
| <code>LocalEyeAngles</code>
| <code>handle LocalEyeAngles()</code>
| Returns the entity's local eye angles
|-
| <code>NextMovePeer</code>
| <code>handle NextMovePeer()</code>
| Returns the next entity parented ''with'' the entity. Intended for iteration use with <code>FirstMoveChild()</code>.
|-
| <code>PrecacheModel</code>
| <code>void PrecacheModel(string ''modelname'')</code>
| Precache a model (<code>.mdl</code>) or sprite (<code>.vmt</code>). The extension must be specified.
{{note|This has no return, unlike the global <code>PrecacheModel</code> function. Use the latter if you need the model index.}}
{{note|Does not precache gibs. See <code>PrecacheEntityFromTable</code> instead.}}
|-
| <code>PrecacheScriptSound</code>
| <code>void PrecacheScriptSound(string ''soundscript'')</code>
| Precache a sound script. Same as <code>PrecacheSoundScript</code>.
|-
| <code>PrecacheSoundScript</code>
| <code>void PrecacheSoundScript(string ''soundscript'')</code>
| Precache a sound script. Same as <code>PrecacheScriptSound</code>.
|-
| <code>RemoveEFlags</code>
| <code>void RemoveEFlags(int ''eflags'')</code>
| 
|-
| <code>RemoveFlag</code>
| <code>void RemoveFlag(int ''flags'')</code>
| 
|-
| <code>RemoveSolidFlags</code>
| <code>void RemoveSolidFlags(int ''solidflags'')</code>
|
|-
| <code>SetAbsAngles</code>
| <code>void SetAbsAngles(QAngle ''angles'')</code>
| Set entity pitch, yaw, roll as QAngles. Does not work on players, use <code>SnapEyeAngles</code> instead.
|-
| <code>SetAbsVelocity</code>
| <code>void SetAbsVelocity(Vector ''velocity'')</code>
| Sets the current absolute velocity of the entity. Does nothing on [[VPhysics]] objects (such as <code>prop_physics</code>). For those, use <code>SetPhysVelocity</code> instead.
|-
| <code>SetAbsOrigin</code>
| <code>void SetAbsOrigin(Vector ''origin'')</code>
| Sets the absolute origin of the entity.
{{note|On some entities, this won't interpolate positions and therefore moving entities might look jittery. In those cases, use <code>KeyValueFromVector("origin", pos)</code> instead.}}
|-
| {{obs}} <code>SetAngles (&rarr; SetAbsAngles)</code>
| <code>void SetAngles(float ''pitch'', float ''yaw'', float ''roll'')</code>
| Set entity angles.
|-
| <code>SetAngularVelocity</code>
| <code>void SetAngularVelocity(float ''pitch'', float ''yaw'', float ''roll'')</code>
| Set the local angular velocity.
|-
| <code>SetCollisionGroup</code>
| <code>void SetCollisionGroup(int ''collision_group'')</code>
| Set the current collision group of the entity.
See [[Team_Fortress_2/Scripting/Script_Functions/Constants#ECollisionGroup|Constants.ECollisionGroup]]
|-
| <code>SetDrawEnabled</code>
| <code>void SetDrawEnabled(bool ''toggle'')</code>
| Enables drawing if you pass true, disables drawing if you pass false.
|-
| <code>SetEFlags</code>
| <code>void SetEFlags(int ''eflags'')</code>
|
|-
| <code>SetForwardVector</code>
| <code>void SetForwardVector(Vector ''forward'')</code>
| Set the orientation of the entity to have this forward vector
|-
| <code>SetFriction</code>
| <code>void SetFriction(float ''friction'')</code>
|
|-
| <code>SetGravity</code>
| <code>void SetGravity(float ''gravity'')</code>
| Sets a multiplier for gravity. 1 is default gravity.
{{note|0 gravity will not work. Instead, set it to something like <code>0.000001</code> as a workaround}}
|-
| <code>SetHealth</code>
| <code>void SetHealth(int ''health'')</code>
| 
|-
| <code>SetLocalAngles</code>
| <code>void SetLocalAngles(QAngle ''angles'')</code>
| 
|-
| <code>SetLocalOrigin</code>
| <code>void SetLocalOrigin(Vector ''origin'')</code>
| 
|-
| <code>SetMaxHealth</code>
| <code>void SetMaxHealth(int ''health'')</code>
| Sets the maximum health this entity can have. Does not update the current health, so <code>SetHealth</code> should be used afterwards.
{{note|Does nothing on players. Add the <code>max health additive bonus</code> attribute via <code>AddCustomAttribute</code> instead.}}
|-
| <code>SetModel</code>
| <code>void SetModel(string ''model_name'')</code>
| Set a model for this entity.
{{note|Does nothing on players. Use <code>SetCustomModel</code> in that case.}}
{{warning|Make sure the model was already precached before using this function or otherwise the game will crash! Alternatively, <code>SetModelSimple</code> will precache the entity for you.}}
|-
| <code>SetMoveType</code>
| <code>void SetMoveType([[Team_Fortress_2/Scripting/Script_Functions/Constants#EMoveType|EMoveType]] ''movetype'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#EMoveCollide|EMoveCollide]] ''movecollide'')</code>
|
|-
| {{obs}} <code>SetOrigin (&rarr; SetAbsOrigin)</code>
| <code>void SetOrigin(Vector''origin'')</code>
| 
|-
| <code>SetOwner</code>
| <code>void SetOwner(handle ''entity'')</code>
| Sets this entity's owner
|-
| <code>SetPhysAngularVelocity</code>
| <code>void SetPhysAngularVelocity(Vector ''angular_velocity'')</code>
|
|-
| <code>SetPhysVelocity</code>
| <code>void SetPhysVelocity(Vector ''velocity'')</code>
| 
|-
| <code>SetSize</code>
| <code>void SetSize(Vector ''mins'', Vector ''maxs'')</code>
| Sets the bounding box's scale for this entity.
{{warning|If any component of mins/maxs is backwards (i.e. mins.x > maxs.x), the engine will exit with a fatal error.}}
|-
| <code>SetSolid</code>
| <code>void SetSolid(int ''solid'')</code>
| 
|-
| <code>SetSolidFlags</code>
| <code>void SetSolidFlags(int ''solid_flags'')</code>
|
|-
| <code>SetTeam</code>
| <code>void SetTeam(int ''team'')</code>
| Sets entity team.
{{note|Use <code>ForceChangeTeam</code> on players instead.}}
|-
| {{obs}} <code>SetVelocity (&rarr; SetAbsVelocity)</code>
| <code>void SetVelocity(Vector ''velocity'')</code>
| 
|-
| <code>SetWaterLevel</code>
| <code>void SetWaterLevel(int ''water_level'')</code>
| This sets how much of the entity is underwater. Setting it to 0 means it is not underwater, 1 if the feet are (touching water brush), 2 if the waist is (center of the hull of the entity), and 3 if the head is (eyes position).
|-
| <code>SetWaterType</code>
| <code>void SetWaterType(int ''water_type'')</code>
| Set the type of water the entity is currently submerged in. Generic values to use are 32 for water and 16 for slime.
|-
| <code>StopSound</code>
| <code>void StopSound(string ''sound_name'')</code>
| Stops a sound on this entity.
|-
| <code>TakeDamage</code>
| <code>void TakeDamage(float ''flDamage'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#FDmgType|Constants.FDmgType]] ''nDamageType'', handle ''hAttacker'')</code>
| Deals damage to the entity.
|-
| <code>TakeDamageEx</code>
| <code>void TakeDamageEx(handle ''hInflictor'', handle ''hAttacker'', handle ''hWeapon'', Vector ''vecDamageForce'', Vector ''vecDamagePosition'', float ''flDamage'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#FDmgType|Constants.FDmgType]] ''nDamageType'')</code>
| Extended version of <code>TakeDamage</code>. 
{{note|If ''vecDamageForce'' is Vector(0, 0, 0), the game will automatically calculate it from ''vecDamagePosition'' and ''flDamage''. However, specifying a custom damage force requires a really, really big value to have visible effect (in the hundreds of thousands).}}
|-
| <code>TakeDamageCustom</code>
| <code>void TakeDamageCustom(handle ''hInflictor'', handle ''hAttacker'', handle ''hWeapon'', Vector ''vecDamageForce'', Vector ''vecDamagePosition'', float ''flDamage'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#FDmgType|Constants.FDmgType]] ''nDamageType'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#ETFDmgCustom|Constants.ETFDmgCustom]] ''nCustomDamageType'')</code>
| Extended version of <code>TakeDamageEx</code> that can apply a custom damage type.
|-
| <code>Teleport</code>
| <code>void Teleport(bool ''use_origin'', Vector ''origin'', bool ''use_angles'', QAngle ''angles'', bool ''use_velocity'', Vector ''velocity'')</code>
| Teleports this entity. For this function, set the bools to false if you want that entity's property unchanged. (do not use null arguments!)
|-
| <code>TerminateScriptScope</code>
| <code>void TerminateScriptScope()</code>
| Clear the current script scope for this entity
|-
| <code>ToggleFlag</code>
| <code>void ToggleFlag(int ''flags'')</code>
|
|-
| <code>ValidateScriptScope</code>
| <code>bool ValidateScriptScope()</code>
| Create a script scope for an entity if it doesn't already exist. The return value is always returns true, unless the script VM is disabled in launch options.
{{tip|On players, this only needs to be called once. Script scopes remain permanent on players until their entity is removed, i.e. disconnected. The best place to call this is in the <code>player_spawn</code> event when <code>params.team</code> equals 0 (unassigned). The event is always fired once for team unassigned when the player entity spawns. Similarly, for engineer buildings, this function can also be called once. The <code>player_builtobject</code> is fired when an engineer building is created (or re-placed after moving, but this shouldn't matter).}}
|}

==== Hooks ====
Hooks are functions that are called by the game code at appropriate moments. For example, when an entity takes damage, the OnTakeDamage hook would be executed.

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>Input<''name''></code>
| <code>bool Input<''name''>()</code>
| Called right before an entity receives a valid input from the I/O system that matches the function's name. The name of the function needs to be<code>Input</code>followed by the name of the input. E.g. for the FireUser1 input, it would be<code>InputFireUser1</code>. When the function is called, Script Handles of the activator and caller entities are accessible to the function under the variables<code>activator</code>and<code>caller</code>. The function needs to return a boolean value; Returning<code>true</code>processes the input, while<code>false</code>cancels it.
{{bug|There is an inconsistency with the naming scheme of the inputs. Certain inputs are required in PascalCase format, others in lowercase format. For example, <code>ForceDrop</code> input on [[item_teamflag]] must be specified in lowercase, i.e. <code>Inputforcedrop</code>, but another input such as <code>Kill</code> input must be in PascalCase, i.e. <code>InputKill</code>. However, this inconsistency also varies between different entity classes as well. The cause of this is string caching in the game (I/O is case-insensitive so it normally doesn't matter, but Squirrel is case-sensitive).}}
{{tip|It is best to define both variants of these function and have one be a wrapper for the other, i.e. <code>Inputfireuser1 <- InputFireUser1</code>.}}
{{tip|This hook is fired ''before'' the game processes the input internally. If a hook is required that runs ''after'' the game processes it, there is two options:
* Asynchronous: Use a EntFire with a 0 delay to run code at the end of the frame. This is not instantly executed which may cause issues if multiple inputs get processed at once.
* Synchronous: Using a quirk, it's possible to synchronously detect when the input has been processed. The game wipes the <code>activator</code> and <code>caller</code> variables from the root table after processing an input. A [https://developer.electricimp.com/resources/metamethods metamethod] that overrides the slot deletion operator can be used to detect this. The following example demonstrates a system to conveniently define pre- and post- input hooks using a <code>SetInputHook</code> function:
{{ExpandBox|<source lang=js>
// Implementation

::_PostInputScope <- null
::_PostInputFunc  <- null

::SetInputHook <- function(entity, input, pre_func, post_func)
{
        entity.ValidateScriptScope()
	local scope = entity.GetScriptScope()
	if (post_func)
	{
		local wrapper_func = function() 
		{ 
			_PostInputScope = scope
			_PostInputFunc  = post_func
			if (pre_func)
				return pre_func.call(scope)
			return true
		}
		
		scope["Input" + input]           <- wrapper_func
		scope["Input" + input.tolower()] <- wrapper_func // workaround for case bug
	}
	else if (pre_func)
	{
		scope["Input" + input]           <- pre_func
		scope["Input" + input.tolower()] <- pre_func // workaround for case bug
	}
}

getroottable().setdelegate(
{
	_delslot = function(k)
	{
		if (_PostInputScope && k == "activator" && "activator" in this)
		{
			_PostInputFunc.call(_PostInputScope)
			_PostInputFunc = null
		}
		
		rawdelete(k)
	}
})

// Example that hooks the RunScriptCode input on worldspawn

function PreInputRunScriptCode()
{
	printl("INPUT PRE: RunScriptCode")
	printl("\tself: " + self)
	printl("\tactivator: " + activator)
	return true
}

function PostInputRunScriptCode()
{
	printl("INPUT POST: RunScriptCode")
	printl("\tself: " + self)
	printl("\tactivator: " + activator)
}

local world = Entities.FindByClassname(null, "worldspawn")
SetInputHook(world, "RunScriptCode", PreInputRunScriptCode, PostInputRunScriptCode)

EntFire("worldspawn", "RunScriptCode", "printl(`RunScriptCode executed`)", 0, GetListenServerHost())
</source>}}
|}
}}
|-
| <code>OnGameEvent_<''name''></code>
| <code>void OnGameEvent_<''name''>(table ''params'')</code>
| Called each time a game event with the specified name occurs. The name of the function needs to be <code>OnGameEvent_</code> followed by the name of the game event. E.g. for the player_spawn input, it would be <code>OnGameEvent_player_spawn</code>.

When the function is called, a table is passed to the function with keys that vary depending on the event. For example, the player_spawn event passes a table with the keys <code>userid, team, class</code>, while the deadringer_cheat_death event passes a table with the keys <code>spy, attacker</code>.

A call to <code>__CollectGameEventCallbacks</code> is required to register this hook. See the [[Team_Fortress_2/Scripting/VScript_Examples#Listening_for_Events|examples page]].

See [[Team_Fortress_2/Scripting/Game_Events|this page for a list of game events]] as well as the table passed on each event.
|-
| <code>Precache</code>
| <code>void Precache()</code>
| Entity function that is called after the script executes, but before the entity is initialized. Can be used to call precache functions for models and sounds on map load.
{{tip|This can also be used to modify keyvalues on the entity, and it will use the new values when initializing.}}
|-
| <code>ConnectOutputs</code>
| <code>void ConnectOutputs(handle ''scope'')</code>
| Global function called after an entity with an script assigned spawns (i.e. <code>vscripts</code> keyvalue is not blank). Unlike <code>OnPostSpawn</code>, this is called immediately and therefore on map respawn, some entities may not exist during this point.
{{note|This is a ''global'' hook and therefore will only work in global scope, unlike <code>Precache</code> and <code>OnPostSpawn</code>.}}
|-
| <code>OnPostSpawn</code>
| <code>void OnPostSpawn()</code>
| Entity function called after the entity is spawned and initialized, at the ''end'' of the frame. When map entities are respawned, this effectively runs after all scripts, players etc have been 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>OnScriptHook_OnTakeDamage</code>
| <code>void OnScriptHook_OnTakeDamage(handle ''params'')</code>
| Called each time an entity takes damage. The script can modify the table entries not prefixed with ''const'', and these will be sent back to the game code. 

A call to <code>__CollectGameEventCallbacks</code> is required to register this hook. Internally, this hook is processed the same as a game event, but with the <code>OnScriptHook</code> prefix instead of <code>OnGameEvent</code>. Therefore, see the [[Team_Fortress_2/Scripting/VScript_Examples#Listening_for_Events|example page for an explanation of how to register the hook]].
Example: 
{{ExpandBox|<source lang=js>
local EventsID = UniqueString()
getroottable()[EventsID] <-
{
    OnScriptHook_OnTakeDamage = function(params)
    {
		printl("OnScriptHook_OnTakeDamage")
		if (params.const_entity.IsPlayer())
		{
			printl(params)
			params.damage = 0
		}
    }

    // Cleanup events on round restart
    OnGameEvent_scorestats_accumulated_update = function(_) { delete getroottable()[EventsID] }
}
local EventsTable = getroottable()[EventsID]
foreach (name, callback in EventsTable) EventsTable[name] = callback.bindenv(this)
__CollectGameEventCallbacks(EventsTable)
</source>}}
{{note|The [[worldspawn|world]] entity (brushes, static props etc) will not trigger this function by default as it normally can't 'receive' damage. However, the world can be made to 'allow' damage using the following code: <code>NetProps.SetPropInt(Entities.FindByClassname(null, "worldspawn"), "m_takedamage", 1)</code>. This does not appear to have any adverse side effects, and allows detecting when the world has been hit.}}
{{note|If called where the damage source is a player's hitscan weapon, player positions or angles fetched within the [[lag compensation]] "cone" of the attacker will be using lag compensated positions rather than their real positions.}}
{{note|Drowning damage does not trigger this hook. As a workaround, it can be detected in <code>player_hurt</code> event or disabled by setting <code>m_PainFinished</code> netprop to a very high value.}}
{{warning|This is called before any actual damage processing is done. Certain entries might not be calculated or have different values compared to what ''will'' be calculated.}}
{{tip|Listen for the <code>player_hurt</code> or <code>npc_hurt</code> (nextbots) [[TF2_VScript_Examples#Listening_for_Events|event]] to effectively have an OnTakeDamage callback ''after'' final damage calculations are done.}}
{{tip|<code>DMG_ACID</code> is set in <code>damage_type</code> for critical damage, and <code>DMG_SLOWBURN</code> for falloff. These flags can be toggled to add/remove crits or falloff respectively.}}
{{tip|The hitbox that got hit can be retrieved using the <code>m_LastHitGroup</code> netprop on [[player]] entities or [[generic_actor]]. The number corresponds to [[Team_Fortress_2/Scripting/Script_Functions/Constants#EHitGroup|Constants.EHitGroup]]}}
The table contains the following keys:
{| class="standard-table" style="width:100%"
! Name
! Type
! Description
|-
| <code>const_entity</code>
| <code>handle</code>
| The entity which took damage
|-
| <code>inflictor</code>
| <code>handle</code>
| The entity which dealt the damage, can be null
|-
| <code>weapon</code>
| <code>handle</code>
| The weapon which dealt the damage, can be null
|-
| <code>attacker</code>
| <code>handle</code>
| The owner of the damage, can be null
|-
| <code>damage</code>
| <code>float</code>
| Damage amount
|-
| <code>max_damage</code>
| <code>float</code>
| Damage cap
|-
| <code>damage_bonus</code>
| <code>float</code>
| Additional damage (e.g. from crits)
{{warning|Always 0 because this hook is run before this is calculated.}}
|-
| <code>damage_bonus_provider</code>
| <code>handle</code>
| Owner of the damage bonus
{{warning|Always 0 because this hook is run before this is calculated.}}
|-
| <code>const_base_damage</code>
| <code>float</code>
| Base damage
|-
| <code>damage_force</code>
| <code>Vector</code>
| Damage force
|-
| <code>damage_for_force_calc</code>
| <code>float</code>
| {{bug|This value does not seem to do anything.}}
|-
| <code>damage_position</code>
| <code>Vector</code>
| World position of where the damage came from. E.g. end position of a bullet or a rocket
|-
| <code>reported_position</code>
| <code>Vector</code>
| World position of where the damage supposedly came from
|-
| <code>damage_type</code>
| <code>int</code>
| Combination of damage types. See [[Team_Fortress_2/Scripting/Script_Functions/Constants#FDmgType|Constants.FDmgType]]
|-
| <code>damage_custom</code>
| <code>int</code>
| {{bug|Because of a code oversight, this value is read-only. Use <code>damage_stats</code> instead which can be read and written.}}
|-
| <code>damage_stats</code>
| <code>int</code>
| Special damage type. See [[Team_Fortress_2/Scripting/Script_Functions/Constants#ETFDmgCustom|Constants.ETFDmgCustom]]. Unlike <code>damage_type</code>, only one custom damage type can be set.
|-
| <code>force_friendly_fire</code>
| <code>bool</code>
| If true, force the damage to friendlyfire, regardless of this entity's and attacker's team
{{note|Hitscan/melee will not run OnTakeDamage unless the <code>mp_friendlyfire</code> convar is set to 1.}}
|-
| <code>ammo_type</code>
| <code>int</code>
| Unused
|-
| <code>player_penetration_count</code>
| <code>int</code>
| How many players the damage has penetrated so far
|-
| <code>damaged_other_players</code>
| <code>int</code>
| How many players other than the attacker has the damage been applied to. Used for rocket jump damage reduction
|-
| <code>crit_type</code>
| <code>int</code>
| Type of crit damage. 0 - None, 1 - Mini, 2 - Full
{{warning|Always 0 because this hook is run before this is set. Instead, check <code>DMG_ACID</code> in <code>damage_type</code>, which is set when the shot will be critical.}}
|-
| <code>early_out</code>
| <code>bool</code>
| If set to true by the script, the game's damage routine will not run and it will simply return the currently set damage.
|-
|}
|}

==== Callbacks ====
===== OnDestroy =====
It is possible to setup an asynchronous hook which is fired when the entity is deleted, as shown below. It is processed at the end of the frame after the entity's own destroy callback, but before the entity is about to be removed from memory. The caveats are that it is not possible to rescue an entity nor its children in this callback, and the targetname of the entity is cleared (this can be workarounded by storing the name in the script scope if needed). A useful application of this hook is to stop looping sounds on an entity so they don't persist.
{{ExpandBox|<source lang=js>
// Implementation
function SetDestroyCallback(entity, callback)
{
	entity.ValidateScriptScope()
	local scope = entity.GetScriptScope()
	scope.setdelegate({}.setdelegate({
			parent   = scope.getdelegate()
			id       = entity.GetScriptId()
			index    = entity.entindex()
			callback = callback
			_get = function(k)
			{
				return parent[k]
			}
			_delslot = function(k)
			{
				if (k == id)
				{
					entity = EntIndexToHScript(index)
					local scope = entity.GetScriptScope()
					scope.self <- entity
					callback.pcall(scope)
				}
				delete parent[k]
			}
		})
	)
}

// Example
local entity = SpawnEntityFromTable("prop_dynamic", 
{
	model = "models/player/heavy.mdl"
	origin = Vector(1, 2, 3)
})

SetDestroyCallback(entity, function()
{
	printf("Entity %s at %s was destroyed\n", self.GetClassname(), self.GetOrigin().ToKVString())
})
</source>}}

{{note|All handles to the entity are destroyed when inside the callback. You must access the entity by using <code>self</code> only.}}

Alternatively: if entities need to be rescued from a deletion on a round restart, for example a player parented to a vehicle, the <code>scorestats_accumulated_update</code> event can be used. This event is fired on round restart right before all entities are removed. Add the <code>EFL_KILLME</code> eflag to the entities to rescue, then remove it after entities have spawned.

=== CBaseAnimating ===
Extends [[#CBaseEntity|CBaseEntity ↑]]

Script handle class for animatable entities, such as props.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>DispatchAnimEvents</code>
| <code>void DispatchAnimEvents(handle ''entity'')</code>
| Dispatch animation events to a CBaseAnimating entity.
|-
| <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 an attachment's angles as a QAngle, by ID.
|-
| <code>GetAttachmentBone</code>
| <code>int GetAttachmentBone(int ''ID'')</code>
| Get an attachment's parent bone index by ID.
|-
| <code>GetAttachmentOrigin</code>
| <code>Vector GetAttachmentOrigin(int ''ID'')</code>
| Get an attachment's origin as a Vector, by ID.
|-
| <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's name by ID.
|-
| <code>GetBodygroupPartName</code>
| <code>string GetBodygroupPartName(int ''group'', int ''part'')</code>
| Get the bodygroup's name by group and part.
|-
| <code>GetBoneAngles</code>
| <code>QAngle GetBoneAngles(int ''ID'')</code>
| Get the bone's angles as a QAngle, by ID.
{{warning|For performance, bone transforms are cached by the game. The cache is updated once per frame. Setting new sequences, cycles etc may cause this to access stale bone data. If this is a problem, then call <code>SetModelSimple</code> first, which will update the bone cache.}}
|-
| <code>GetBoneOrigin</code>
| <code>Vector GetBoneOrigin(int ''ID'')</code>
| Get the bone's origin Vector by ID.
{{warning|See above.}}
|-
| <code>GetCycle</code>
| <code>float GetCycle()</code>
| Gets the model's current animation cycle rate.
|-
| <code>GetModelScale</code>
| <code>float GetModelScale()</code>
| Get the model's scale.
|-
| <code>GetPlaybackRate</code>
| <code>float GetPlaybackRate()</code>
| Get the current animation's playback rate.
|-
| <code>GetSequence</code>
| <code>int GetSequence()</code>
| Get the current-playing sequence's 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. Returns "Not Found!" if ID is -1, "Unknown" if the sequence doesn't exist or "No model!" if no model is assigned.
|-
| <code>GetSkin</code>
| <code>int GetSkin()</code>
| Gets the current skin index.
|-
| <code>IsSequenceFinished</code>
| <code>bool IsSequenceFinished()</code>
| Ask whether the main sequence is done 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>LookupPoseParameter</code>
| <code>int LookupPoseParameter(string ''name'')</code>
| Gets the pose parameter's index. Returns -1 if the pose parameter does not exist.
|-
| <code>LookupSequence</code>
| <code>int LookupSequence(string ''name'')</code>
| Looks up a sequence by names of sequences or activities. 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>SetCycle</code>
| <code>void SetCycle(float ''cycle'')</code>
| Sets the model's current animation cycle from 0 to 1.
{{note|This only works if the entity has <code>m_bClientSideAnimation</code> set to false. Some entities such as [[prop_dynamic]] have this true by default and therefore SetCycle will visually not do anything until that netprop is turned off.}}
|-
| <code>SetModelSimple</code>
| <code>void SetModelSimple(string ''model_name'')</code>
| Set a model for this entity. Matches easier behaviour of the SetModel input, automatically precaches, maintains sequence/cycle if possible. Also clears the bone cache.
{{note|Does nothing on players. Use <code>SetCustomModel</code> in that case.}}
|-
| <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>SetPlaybackRate</code>
| <code>void SetPlaybackRate(float ''rate'')</code>
| Set the current animation's playback rate.
|-
| <code>SetPoseParameter</code>
| <code>float SetPoseParameter(int ''ID'', float ''value'')</code>
| Sets a pose parameter value. Returns the effective value after clamping or looping.
{{note|Does nothing on players. Pose parameters aren't networked on players.}}
{{bug|[[prop_dynamic]] will have visual glitches with server-sided pose parameters. Use [[point_posecontroller]], or another entity like [[base_boss]] or [[funCBaseFlex]].}}
|-
| <code>SetSequence</code>
| <code>void SetSequence(int ''ID'')</code>
| Plays a sequence by sequence ID.
{{warning|This can cause animation stutters when transitioning between sequences, or sequences to not be set at all on some entities (such as [[obj_sentrygun]]). Using <code>ResetSequence</code> instead will prevent this. Only tested on [[base_boss]].}}
{{note|Does nothing on players. Players use a different animation system.}}
|-
| <code>SetSkin</code>
| <code>void SetSkin(int ''index'')</code>
| Sets the model's skin.
|-
| <code>StopAnimation</code>
| <code>void StopAnimation()</code>
| Stop the current animation (same as SetPlaybackRate 0.0)
|-
| <code>StudioFrameAdvance</code>
| <code>void StudioFrameAdvance()</code>
| Advance animation frame to some time in the future with an automatically calculated interval
|-
| <code>StudioFrameAdvanceManual</code>
| <code>void StudioFrameAdvanceManual(float ''dt'')</code>
| Advance animation frame to some time in the future with a manual interval
|}

=== CBaseCombatWeapon ===
Extends [[#CBaseAnimating|CBaseAnimating ↑]]

Script handle class for any weapon entities that can be part of a player's inventory.<br>
Team Fortress 2's weapons leave <code>Clip2</code> unused, so those functions can be ignored
==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>CanBeSelected</code>
| <code>bool CanBeSelected()</code>
| Can this weapon be selected
|-
| <code>Clip1</code>
| <code>int Clip1()</code>
| Current ammo in clip1
|-
| <code>Clip2</code>
| <code>int Clip2()</code>
| Current ammo in clip2
|-
| <code>GetDefaultClip1</code>
| <code>int GetDefaultClip1()</code>
| Default size of clip1
|-
| <code>GetDefaultClip2</code>
| <code>int GetDefaultClip2()</code>
| Default size of clip2
|-
| <code>GetMaxClip1</code>
| <code>int GetMaxClip1()</code>
| Max size of clip1
|-
| <code>GetMaxClip2</code>
| <code>int GetMaxClip2()</code>
| Max size of clip2
|-
| <code>GetName</code>
| <code>string GetName()</code>
| Gets the weapon's internal name (not the targetname!)
{{warning|This conflicts with CBaseEntity's <code>GetName</code> function. To get the targetname of the weapon, call it like this instead <code>CBaseEntity.GetName.call(weapon)</code>}}
|-
| <code>GetPosition</code>
| <code>int GetPosition()</code>
| Gets the weapon's current position
|-
| <code>GetPrimaryAmmoCount</code>
| <code>int GetPrimaryAmmoCount()</code>
| Current primary ammo count if no clip is used or to give a player if they pick up this weapon legacy style (not TF)
|-
| <code>GetPrimaryAmmoType</code>
| <code>int GetPrimaryAmmoType()</code>
| Returns the primary ammo type
|-
| <code>GetPrintName</code>
| <code>string GetPrintName()</code>
| Gets the weapon's print name
|-
| <code>GetSecondaryAmmoCount</code>
| <code>int GetSecondaryAmmoCount()</code>
| Current secondary ammo count if no clip is used or to give a player if they pick up this weapon legacy style (not TF)
|-
| <code>GetSecondaryAmmoType</code>
| <code>int GetSecondaryAmmoType()</code>
| Returns the secondary ammo type
|-
| <code>GetSlot</code>
| <code>int GetSlot()</code>
| Gets the weapon's current slot
| 
|-
| <code>GetSubType</code>
| <code>int GetSubType()</code>
| Get the weapon subtype
|-
| <code>GetWeaponFlags</code>
| <code>int GetWeaponFlags()</code>
| Get the weapon flags
|-
| <code>GetWeight</code>
| <code>int GetWeight()</code>
| Get the weapon weighting/importance
|-
| <code>HasAnyAmmo</code>
| <code>bool HasAnyAmmo()</code>
| Do we have any ammo?
|-
| <code>HasPrimaryAmmo</code>
| <code>bool HasPrimaryAmmo()</code>
| Do we have any primary ammo?
|-
| <code>HasSecondaryAmmo</code>
| <code>bool HasSecondaryAmmo()</code>
| Do we have any secondary ammo?
|-
| <code>IsAllowedToSwitch</code>
| <code>bool IsAllowedToSwitch()</code>
| Are we allowed to switch to this weapon?
|-
| <code>IsMeleeWeapon</code>
| <code>bool IsMeleeWeapon()</code>
| Returns whether this is a melee weapon
{{note|<code>tf_weapon_buff_item</code> (entity for Soldier's banner items), are considered melee in the code.}}
|-
| <code>PrimaryAttack</code>
| <code>void PrimaryAttack()</code>
| Force a primary attack
{{tip|This allows arbitrarily firing weapons that do not actually belong to any player. This can be useful for creating entities that might not fully work on their own, for example rockets. Most weapons will work as long as the <code>m_hOwner</code> netprop on the weapon is set to an existing player. Weapons spawned manually might also need <code>SetClip(-1)</code>, and <code>m_flNextPrimaryAttack</code> (or <code>m_flSecondaryPrimaryAttack</code>) set to 0 before calling this function to always allow firing without delays.}}
{{warning|Hitscan and melee weapons require [[lag compensation]] information to be present, or the game will crash! Calling this from a player's think function or OnTakeDamage hook (whose source is a player's hitscan weapon) is sufficient. Alternatively, lag compensation can be temporarily disabled which allows calling this function from anywhere, with the side effect of poor hit registration for high latency players. This can be achieved by setting the <code>m_bLagCompensation</code> [[#CNetPropManager|netprop ↓]] on the player to to false, calling this function, and reverting it back to true.}}
{{warning|This will play the weapon's fire sound to everyone except the owner. If the sound is desired, the sound can be played to the owner exclusively via <code>EmitSoundEx</code>. If the sound is not desired, it can be stopped by calling <code>StopSound</code> after this function.}}
|-
| <code>SecondaryAttack</code>
| <code>void SecondaryAttack()</code>
| Force a secondary attack
{{warning|See above.}}
|-
| <code>SetClip1</code>
| <code>void SetClip1(int ''amount'')</code>
| Set current ammo in clip1.
|-
| <code>SetClip2</code>
| <code>void SetClip2(int ''amount'')</code>
| Set current ammo in clip2.
|-
| <code>SetCustomViewModel</code>
| <code>void SetCustomViewModel(string ''model_name'')</code>
| Sets a custom view model for this weapon by model name.
|-
| <code>SetCustomViewModelModelIndex</code>
| <code>void SetCustomViewModelModelIndex(int ''model_index'')</code>
| Sets a custom view model for this weapon by modelindex.
|-
| <code>SetSubType</code>
| <code>void SetSubType(int ''subtype'')</code>
| Set the weapon subtype
|-
| <code>UsesClipsForAmmo1</code>
| <code>bool UsesClipsForAmmo1()</code>
| Do we use clips for ammo 1?
|-
| <code>UsesClipsForAmmo2</code>
| <code>bool UsesClipsForAmmo2()</code>
| Do we use clips for ammo 2?
|-
| <code>UsesPrimaryAmmo</code>
| <code>bool UsesPrimaryAmmo()</code>
| Do we use primary ammo?
|-
| <code>UsesSecondaryAmmo</code>
| <code>bool UsesSecondaryAmmo()</code>
| Do we use secondary ammo?
|-
| <code>VisibleInWeaponSelection</code>
| <code>bool VisibleInWeaponSelection()</code>
| Is this weapon visible in weapon selection
|}

=== CBaseFlex ===
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>PlayScene</code>
| <code>float PlayScene(string ''scene_file'', float ''delay'')</code>
| Play the specified .vcd file, causing the related characters to speak and subtitles to play. 
{{tip|Open <code>tf2_misc_dir.vpk</code> and browse the files in <code>scripts/talker/...</code> to find .vcd files. Alternatively, use the <code>rr_debugresponses 1</code> command with <code>developer 1</code> to find .vcds from in-game voicelines.}}
|}

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

Combat entities with similar movement capabilities to a player.
==== Methods ====
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>GetLastKnownArea</code>
| <code>handle GetLastKnownArea()</code>
| Return the last nav area occupied, NULL if unknown.

See [[#CTFNavArea|CTFNavArea ↓]].
|}

=== CBasePlayer ===
Extends [[#CBaseCombatCharacter|CBaseCombatCharacter ↑]]

Script handle class for player entities.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>GetForceLocalDraw</code>
| <code>bool GetForceLocalDraw()</code>
| Whether the player is being forced by SetForceLocalDraw to be drawn.
|-
| <code>GetPlayerMaxs</code>
| <code>Vector GetPlayerMaxs()</code>
| Get a vector containing max bounds of the player in local space. The player's model scale will affect the result.
|-
| <code>GetPlayerMins</code>
| <code>Vector GetPlayerMins()</code>
| Get a vector containing min bounds of the player in local space. The player's model scale will affect the result.
|-
| <code>GetScriptOverlayMaterial</code>
| <code>string GetScriptOverlayMaterial()</code>
| Gets the current overlay material set by SetScriptOverlayMaterial.
|-
| <code>IsNoclipping</code>
| <code>bool IsNoclipping()</code>
| Returns true if the player is in noclip mode.
|-
| <code>SetForceLocalDraw</code>
| <code>void SetForceLocalDraw(bool ''forceDraw'')</code>
| Forces the player to be drawn as if they were in thirdperson.
|-
| <code>SetScriptOverlayMaterial</code>
| <code>void SetScriptOverlayMaterial(string ''material'')</code>
|  Sets the overlay material that can't be overriden by other overlays. E.g. Jarate.
|-
| <code>SnapEyeAngles</code>
| <code>void SnapEyeAngles(QAngle ''angles'')</code>
| Snap the player's eye angles to this.
{{note|Do not use this if you are setting the angles temporarily and reverting it in the same frame (for example if firing projectiles at a specific angle). This will cause camera jitter in multiplayer. Instead, modify the <code>pl.v_angle</code> netprop and then revert that (which is what the game reads for eye angles internally). Example:
{{ExpandBox|<source lang=js>
    local eye_angles = player.LocalEyeAngles()
    NetProps.SetPropVector(player, "pl.v_angle", angles + Vector())
	
    NetProps.SetPropEntity(flaregun, "m_hOwner", player)
    NetProps.SetPropFloat(flaregun, "m_flNextPrimaryAttack", 0)
    flaregun.PrimaryAttack()
    
    NetProps.SetPropVector(player, "pl.v_angle", eye_angles + Vector())
</source>}}}}
|-
| <code>ViewPunch</code>
| <code>void ViewPunch(QAngle ''angleOffset'')</code>
| Ow! Punches the player's view.
|-
| <code>ViewPunchReset</code>
| <code>void ViewPunchReset(float ''tolerance'')</code>
| Reset's the player's view punch if the offset stays below the given tolerance.
|}

=== CBaseMultiplayerPlayer ===
Extends [[#CBasePlayer|CBasePlayer ↑]]

Script handle sub-class for player entities in multiplayer games. No additional methods.

<!-- No methods, so we do a line-break on our own to avoid having the bottom section seem "merged" on a quick glance. -->
<br>

=== CEconEntity ===
Extends [[#CBaseAnimating|CBaseAnimating ↑]]

Script handle class for economic exquisite equippables, meaning hats and weapons.

==== Methods ====
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>AddAttribute</code>
| <code>void AddAttribute(string ''name'', float ''value'', float ''duration'')</code>
| Add an attribute to the entity. Set duration to -1 for the attribute to be applied forever.
|-
| <code>GetAttribute</code>
| <code>float GetAttribute(string ''name'', float ''default_value'')</code>
| Get an attribute float from the entity. If the attribute does not exist, returns <code>default_value</code>.
|-
| <code>RemoveAttribute</code>
| <code>void RemoveAttribute(string ''name'')</code>
| Remove an attribute from the entity.
{{note|Static attributes (i.e. attributes that exist by default on the item) cannot be removed. However, you can override their value with <code>AddAttribute</code> to effectively modify or disable them.}}
|-
| <code>ReapplyProvision</code>
| <code>void ReapplyProvision()</code>
| Relinks attributes to provisioners, e.g. calling this on a weapon will add it's attributes to the player.
|}

=== CTFPlayer ===
Extends [[#CBaseMultiplayerPlayer|CBaseMultiplayerPlayer ↑]]

Script handle class for [[player]] entities of Team Fortress 2.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>AddCond</code>
| <code>void AddCond(ETFCond ''cond'')</code>
| 
|-
| <code>AddCondEx</code>
| <code>void AddCondEx(ETFCond ''cond'', float ''duration'', handle ''provider'')</code>
| 
|-
| <code>AddCurrency</code>
| <code>void AddCurrency(int ''amount'')</code>
| Kaching! Give the player some cash for game modes with upgrades, ie. MvM. The new value is bounded between 0-30000.
{{note|Using <code>RemoveCurrency</code>/<code>SetCurrency</code> instead or setting the <code>m_nCurrency</code> netprop directly will bypass the bounds checking.}}
|-
| <code>AddCustomAttribute</code>
| <code>void AddCustomAttribute(string ''name'', float ''value'', float ''duration'')</code>
| Add a custom attribute to the player. Set duration to -1 for the attribute to be applied forever.
{{note|This does not work when applied in the <code>player_spawn</code> event, because custom attributes are cleared immediately after the event. As a workaround, it can be applied with a delay. See the [[Team_Fortress_2/Scripting/VScript_Examples#Adding_attributes_to_player_on_spawn|example]] code.}}
|-
| <code>AddHudHideFlags</code>
| <code>void AddHudHideFlags(int ''flags'')</code>
| Hides a hud element based on [[Team_Fortress_2/Scripting/Script_Functions/Constants#FHideHUD|Constants.FHideHUD]]
|-
| <code>ApplyPunchImpulseX</code>
| <code>bool ApplyPunchImpulseX(float ''impulse'')</code>
| Apply a view punch along the pitch angle. Used to flinch players when hit. If the player is a fully charged scoped-in sniper and the weapon has the <code>aiming_no_flinch</code> attribute, the punch will not apply. Returns true if the punch was applied.
|-
| <code>BleedPlayer</code>
| <code>void BleedPlayer(float ''duration'')</code>
| Make a player bleed for a set duration of time.
|-
| <code>BleedPlayerEx</code>
| <code>void BleedPlayerEx(float ''duration'', int ''damage'', bool ''endless'', int ''nCustomDamageType'')</code>
| Make a player bleed for a set duration of time, or forever, with specific damage per tick and damage_custom index.
|-
| <code>CancelTaunt</code>
| <code>void CancelTaunt()</code>
| Cancels any taunt in progress
|-
| <code>CanAirDash</code>
| <code>bool CanAirDash()</code>
| Can the player air dash/double jump?
|-
| <code>CanBeDebuffed</code>
| <code>bool CanBeDebuffed()</code>
| 
|-
| <code>CanBreatheUnderwater</code>
| <code>bool CanBreatheUnderwater()</code>
| 
|-
| <code>CanDuck</code>
| <code>bool CanDuck()</code>
| Can the player duck?
|-
| <code>CanGetWet</code>
| <code>bool CanGetWet()</code>
| Can the player get wet by jarate/milk?
|-
| <code>CanJump</code>
| <code>bool CanJump()</code>
| Can the player jump? Returns false if the player is taunting or if the <code>no_jump</code> attribute is present and non-zero. There is other conditions that prevent jumping but this function by itself doesn't check those.
|-
| <code>ClearCustomModelRotation</code>
| <code>void ClearCustomModelRotation()</code>
|
|-
| <code>ClearSpells</code>
| <code>void ClearSpells()</code>
|
|-
| <code>ClearTauntAttack</code>
| <code>void ClearTauntAttack()</code>
| Stops active taunt from damaging or cancels Rock-Paper-Scissors result
|-
| <code>CanPlayerMove</code>
| <code>bool CanPlayerMove()</code>
| Can the player move?
|-
| <code>DoTauntAttack</code>
| <code>void DoTauntAttack()</code>
| Performs taunts attacks if available. Player must be already taunting and taunt must have a valid attack assigned (<code>taunt attack name</code> attribute)
|-
| <code>DropFlag</code>
| <code>void DropFlag(bool ''silent'')</code>
| Force player to drop the flag.
|-
| <code>DropRune</code>
| <code>void DropRune(bool ''apply_force'', int ''team'')</code>
| Force player to drop the rune.
{{tip|This can be abused to spawn arbitrary Mannpower powerups. See [[Team_Fortress_2/Scripting/VScript_Examples#Creating_Mannpower_powerups|the example]].}}
|-
| <code>EndLongTaunt</code>
| <code>void EndLongTaunt()</code>
| Stops a looping taunt (obeys minimum time rules and plays outro animation if available)
|-
| <code>EquipWearableViewModel</code>
| <code>void EquipWearableViewModel(handle ''entity'')</code>
| Equips a wearable on the viewmodel. Intended to be used with [[tf_wearable_vm]] entities.
|-
| <code>ExtinguishPlayerBurning</code>
| <code>void ExtinguishPlayerBurning()</code>
|
|-
| <code>FiringTalk</code>
| <code>void FiringTalk()</code>
| Makes eg. a heavy go AAAAAAAAAAaAaa like they are firing their minigun.
{{note|This only works in a few situations as it requires certain gameplay conditions to be true. An example of when this will work: when the player is invulnerable.}}
{{bug|Unfortunately does not work for Heavy's minigun due to the above quirk.}}
|-
| <code>ForceChangeTeam</code>
| <code>void ForceChangeTeam(int ''team'', bool ''full_team_switch'')</code>
| Force player to change their team. Setting the bool to true will not remove nemesis relationships or reset the player's class, as well as not slaying the player.
 {{note|This will not work if a player is in a duel. Setting the <code>m_bIsCoaching</code> [[#CNetPropManager|netprop ↓]] to true on the player and reverting it afterwards is a workaround.}}
|-
| <code>ForceRegenerateAndRespawn</code>
| <code>void ForceRegenerateAndRespawn()</code>
| Force regenerates and respawns the player
|-
| <code>ForceRespawn</code>
| <code>void ForceRespawn()</code>
| Force respawns the player
|-
| <code>GetActiveWeapon</code>
| <code>handle GetActiveWeapon()</code>
| Get the player's current weapon
|-
| <code>GetBackstabs</code>
| <code>int GetBackstabs()</code>
| 
|-
| <code>GetBonusPoints</code>
| <code>int GetBonusPoints()</code>
|
|-
| <code>GetBotType</code>
| <code>int GetBotType()</code>
|
|-
| <code>GetBuildingsDestroyed</code>
| <code>int GetBuildingsDestroyed()</code>
| 
|-
| <code>GetCaptures</code>
| <code>int GetCaptures()</code>
| 
|-
| <code>GetClassEyeHeight</code>
| <code>Vector GetClassEyeHeight()</code>
| Gets the eye height of the player
|-
| <code>GetCondDuration</code>
| <code>float GetCondDuration(ETFCond ''cond'')</code>
| Returns duration of the condition. Returns 0 if the cond is not applied. Returns -1 if the cond is infinite.
|-
| <code>GetCustomAttribute</code>
| <code>float GetCustomAttribute(string ''name'', float ''default_value'')</code>
| Get an attribute float from the player. If the attribute does not exist, returns <code>default_value</code>.
|-
| <code>GetCurrency</code>
| <code>int GetCurrency()</code>
| Get player's cash for game modes with upgrades, ie. MvM
|-
| <code>GetCurrentTauntMoveSpeed</code>
| <code>float GetCurrentTauntMoveSpeed()</code>
| 
|-
| <code>GetDefenses</code>
| <code>int GetDefenses()</code>
| 
|-
| <code>GetDisguiseAmmoCount</code>
| <code>int GetDisguiseAmmoCount()</code>
| 
|-
| <code>GetDisguiseTarget</code>
| <code>handle GetDisguiseTarget()</code>
| 
|-
| <code>GetDisguiseTeam</code>
| <code>int GetDisguiseTeam()</code>
| 
|-
| <code>GetDominations</code>
| <code>int GetDominations()</code>
| 
|-
| <code>GetGrapplingHookTarget</code>
| <code>handle GetGrapplingHookTarget()</code>
| What entity is the player grappling?
|-
| <code>GetHeadshots</code>
| <code>int GetHeadshots()</code>
| 
|-
| <code>GetHealPoints</code>
| <code>int GetHealPoints()</code>
| 
|-
| <code>GetHealTarget</code>
| <code>handle GetHealTarget()</code>
| Who is the medic healing?
|-
| <code>GetHudHideFlags</code>
| <code>int GetHudHideFlags()</code>
| Gets current hidden hud elements
|-
| <code>GetInvulns</code>
| <code>int GetInvulns()</code>
| 
|-
| <code>GetKillAssists</code>
| <code>int GetKillAssists()</code>
| 
|-
| <code>GetLastWeapon</code>
| <code>handle GetLastWeapon()</code>
|
|-
| <code>GetNextChangeClassTime</code>
| <code>float GetNextChangeClassTime()</code>
| Get next change class time.
|-
| <code>GetNextChangeTeamTime</code>
| <code>float GetNextChangeTeamTime()</code>
| Get next change team time.
|-
| <code>GetNextRegenTime</code>
| <code>float GetNextRegenTime()</code>
| Get next health regen time.
|-
| <code>GetPlayerClass</code>
| <code>int GetPlayerClass()</code>
|
|-
| <code>GetRageMeter</code>
| <code>float GetRageMeter()</code>
| 
|-
| <code>GetResupplyPoints</code>
| <code>int GetResupplyPoints()</code>
| 
|-
| <code>GetRevenge</code>
| <code>int GetRevenge()</code>
| 
|-
| <code>GetScoutHypeMeter</code>
| <code>float GetScoutHypeMeter()</code>
| 
|-
| <code>GetSpyCloakMeter</code>
| <code>float GetSpyCloakMeter()</code>
| 
|-
| <code>GetTeleports</code>
| <code>int GetTeleports()</code>
| 
|-
| <code>GetTauntAttackTime</code>
| <code>float GetTauntAttackTime()</code>
| Timestamp until a taunt attack "lasts". 0 if unavailable
|-
| <code>GetTauntRemoveTime</code>
| <code>float GetTauntRemoveTime()</code>
| Timestamp until taunt is stopped
|-
| <code>GetVehicleReverseTime</code>
| <code>float GetVehicleReverseTime()</code>
| Timestamp when kart was reversed
|-
| <code>GetTimeSinceCalledForMedic</code>
| <code>float GetTimeSinceCalledForMedic()</code>
| When did the player last call medic
|-
| <code>GrantOrRemoveAllUpgrades</code>
| <code>void GrantOrRemoveAllUpgrades(bool ''remove'', bool ''refund'')</code>
|
|-
| <code>HasItem</code>
| <code>bool HasItem()</code>
| Currently holding an item? Eg. capture flag
{{tip|Fetch the <code>m_hItem</code> netprop to get the entity handle.}}
|-
| <code>HandleTauntCommand</code>
| <code>void HandleTauntCommand(int ''taunt_slot'')</code>
| Spoofs a taunt command from the player, as if they selected this taunt.
|-
| <code>IgnitePlayer</code>
| <code>void IgnitePlayer()</code>
| Supposed to set the player on fire, but... {{bug|Does nothing except play on-fire sound and voicelines. {{workaround|Create a [[trigger_ignite]] and EntFire <code>StartTouch</code> input on it.}}}}
|-
| <code>InAirDueToExplosion</code>
| <code>bool InAirDueToExplosion()</code>
| 
|-
| <code>InAirDueToKnockback</code>
| <code>bool InAirDueToKnockback()</code>
| 
|-
| <code>InCond</code>
| <code>bool InCond(ETFCond ''cond'')</code>
| 
|-
| <code>IsAirDashing</code>
| <code>bool IsAirDashing()</code>
| 
|-
| <code>IsAllowedToRemoveTaunt</code>
| <code>bool IsAllowedToRemoveTaunt()</code>
| Returns true if the taunt will be stopped
|-
| <code>IsAllowedToTaunt</code>
| <code>bool IsAllowedToTaunt()</code>
| 
|-
| <code>IsBotOfType</code>
| <code>bool IsBotOfType(int ''type'')</code>
| Returns true if the player matches this bot type. Only one type of bot exists which is reserved for AI bots (not [https://wiki.teamfortress.com/wiki/Bots#Puppet_bots puppet bots]): [[Team_Fortress_2/Scripting/Script_Functions/Constants#EBotType|TF_BOT_TYPE]]. 0 is used for real players or puppet bots. Use <code>IsFakeClient</code> to check for a puppet bot instead.
|-
| <code>IsCallingForMedic</code>
| <code>bool IsCallingForMedic()</code>
| Is this player calling for medic?
|-
| <code>IsCarryingRune</code>
| <code>bool IsCarryingRune()</code>
| 
|-
| <code>IsControlStunned</code>
| <code>bool IsControlStunned()</code>
| 
|-
| <code>IsCritBoosted</code>
| <code>bool IsCritBoosted()</code>
| 
|-
| <code>IsFakeClient</code>
| <code>bool IsFakeClient()</code>
| Returns true if the player is a puppet or AI bot. To check if the player is a AI bot (<code>CTFBot</code>) specifically, use <code>IsBotOfType</code> instead.
|-
| <code>IsFireproof</code>
| <code>bool IsFireproof()</code>
| 
|-
| <code>IsFullyInvisible</code>
| <code>bool IsFullyInvisible()</code>
| 
|-
| <code>IsHypeBuffed</code>
| <code>bool IsHypeBuffed()</code>
| 
|-
| <code>IsImmuneToPushback</code>
| <code>bool IsImmuneToPushback()</code>
| 
|-
| <code>IsInspecting</code>
| <code>bool IsInspecting()</code>
| 
|-
| <code>IsInvulnerable</code>
| <code>bool IsInvulnerable()</code>
| 
|-
| <code>IsJumping</code>
| <code>bool IsJumping()</code>
| 
|-
| <code>IsMiniBoss</code>
| <code>bool IsMiniBoss()</code>
| Is this player an MvM mini-boss?
|-
| <code>IsParachuteEquipped</code>
| <code>bool IsParachuteEquipped()</code>
| 
|-
| <code>IsPlacingSapper</code>
| <code>bool IsPlacingSapper()</code>
| Returns true if we placed a sapper in the last few moments
|-
| <code>IsRageDraining</code>
| <code>bool IsRageDraining()</code>
| 
|-
| <code>IsRegenerating</code>
| <code>bool IsRegenerating()</code>
| 
|-
| <code>IsSapping</code>
| <code>bool IsSapping()</code>
| Returns true if we are currently sapping
|-
| <code>IsSnared</code>
| <code>bool IsSnared()</code>
| 
|-
| <code>IsStealthed</code>
| <code>bool IsStealthed()</code>
| 
|-
| <code>IsTaunting</code>
| <code>bool IsTaunting()</code>
| 
|-
| <code>IsUsingActionSlot</code>
| <code>bool IsUsingActionSlot()</code>
| 
|-
| <code>IsViewingCYOAPDA</code>
| <code>bool IsViewingCYOAPDA()</code>
| 
|-
| <code>Regenerate</code>
| <code>void Regenerate(bool ''refill_health_ammo'')</code>
| Resupplies a player. If refill health/ammo is set, clears negative conds, gives back player health/ammo
|-
| <code>RemoveAllItems</code>
| <code>void RemoveAllItems(bool ''unused'')</code>
| {{bug|This does not actually remove all items. It only drops the passtime ball, intelligence, disables radius healing, and hides the Spy invis watch.}}
|-
| <code>RemoveAllObjects</code>
| <code>void RemoveAllObjects(bool ''explode'')</code>
| Remove all player objects. Eg. dispensers/sentries.
|-
| <code>RemoveCond</code>
| <code>void RemoveCond(ETFCond ''cond'')</code>
| Removes a condition. Does not remove a condition if the minimum duration has not passed. Does nothing if the condition isn't added (interally does <code>InCond</code> check).
|-
| <code>RemoveCondEx</code>
| <code>void RemoveCondEx(ETFCond ''cond'', bool ''ignoreDuration'')</code>
| Extended version of above function. Allows forcefully removing the condition even if minimum duration is not met.
|-
| <code>RemoveCurrency</code>
| <code>void RemoveCurrency(int ''amount'')</code>
| Take away money from a player for reasons such as ie. spending. Lower bounded to 0.
{{note|Unlike <code>AddCurrency</code>, negative values will go past the 30000 limit.}}
|-
| <code>RemoveCustomAttribute</code>
| <code>void RemoveCustomAttribute(string ''name'')</code>
| Remove a custom attribute to the player
|-
| <code>RemoveDisguise</code>
| <code>void RemoveDisguise()</code>
| Undisguise a spy.
|-
| <code>RemoveHudHideFlags</code>
| <code>void RemoveHudHideFlags(int ''flags'')</code>
| Unhides a hud element based on [[Team_Fortress_2/Scripting/Script_Functions/Constants#FHideHUD|Constants.FHideHUD]]
|-
| <code>RemoveInvisibility</code>
| <code>void RemoveInvisibility()</code>
| Un-invisible a spy.
|-
| <code>RemoveTeleportEffect</code>
| <code>void RemoveTeleportEffect()</code>
|
|-
| <code>ResetScores</code>
| <code>void ResetScores()</code>
| 
|-
| <code>RollRareSpell</code>
| <code>void RollRareSpell()</code>
|
|-
| <code>SetCondDuration</code>
| <code>void SetCondDuration(ETFCond ''cond'', float ''duration'')</code>
| 
|-
| <code>SetCurrency</code>
| <code>void SetCurrency(int ''amount'')</code>
| Set player's cash for game modes with upgrades, ie. MvM. Does not have any bounds checking.
|-
| <code>SetCurrentTauntMoveSpeed</code>
| <code>void SetCurrentTauntMoveSpeed(float ''speed'')</code>
| 
|-
| <code>SetCustomModel</code>
| <code>void SetCustomModel(string ''model_name'')</code>
| Sets a custom player model without animations (model will T-pose). To enable animations, use <code>SetCustomModelWithClassAnimations</code> instead.
|-
| <code>SetCustomModelOffset</code>
| <code>void SetCustomModelOffset(Vector ''offset'')</code>
| 
|-
| <code>SetCustomModelRotates</code>
| <code>void SetCustomModelRotates(bool ''toggle'')</code>
| 
|-
| <code>SetCustomModelRotation</code>
| <code>void SetCustomModelRotation(QAngle ''angles'')</code>
| 
|-
| <code>SetCustomModelVisibleToSelf</code>
| <code>void SetCustomModelVisibleToSelf(bool ''toggle'')</code>
| 
|-
| <code>SetCustomModelWithClassAnimations</code>
| <code>void SetCustomModelWithClassAnimations(string ''model_name'')</code>
| Sets a custom player model with full animations.
|-
| <code>SetDisguiseAmmoCount</code>
| <code>void SetDisguiseAmmoCount(int ''count'')</code>
| 
|-
| <code>SetForcedTauntCam</code>
| <code>void SetForcedTauntCam(int ''toggle'')</code>
| 
|-
| <code>SetGrapplingHookTarget</code>
| <code>void SetGrapplingHookTarget(handle ''entity'', bool ''bleed'')</code>
| Set the player's target grapple entity
|-
| <code>SetHudHideFlags</code>
| <code>void SetHudHideFlags(int ''flags'')</code>
| Force hud hide flags to a value based on [[Team_Fortress_2/Scripting/Script_Functions/Constants#FHideHUD|Constants.FHideHUD]]
|-
| <code>SetIsMiniBoss</code>
| <code>void SetIsMiniBoss(bool ''toggle'')</code>
| Make this player an MvM mini-boss.
|-
| <code>SetNextChangeClassTime</code>
| <code>void SetNextChangeClassTime(float ''time'')</code>
| Set next change class time.
|-
| <code>SetNextChangeTeamTime</code>
| <code>void SetNextChangeTeamTime(float ''time'')</code>
| Set next change team time.
|-
| <code>SetNextRegenTime</code>
| <code>void SetNextRegenTime(float ''time'')</code>
| Set next available resupply time.
|-
| <code>SetPlayerClass</code>
| <code>void SetPlayerClass(int ''class'')</code>
| Sets the player class. Updates the player's visuals and model.
{{note|Does not force the class to be changed and can be buggy for server-side scripts. This can be resolved by calling <code>NetProps.SetPropInt(player, "m_Shared.m_iDesiredPlayerClass", classIndex)</code> after <code>SetPlayerClass</code> and before <code>ForceRegenerateAndRespawn</code>. This resolves issues like the player respawning as their "desired" class instead or loadout showing the desired class rather than what they are.}}
{{note|Does not regenerate class properties, such as health or weapons. This can be done by calling <code>ForceRegenerateAndRespawn</code> afterwards.}}
{{warning|If the player is not respawned, the hitbox set will be used from the old class! Calling <code>SetCustomModel</code> with a blank parameter is sufficient to update it.}}
|-
| <code>SetRageMeter</code>
| <code>void SetRageMeter(float ''percent'')</code>
| Sets rage meter from 0 - 100.
|-
| <code>SetRPSResult</code>
| <code>void SetRPSResult(int ''result'')</code>
| Rig the result of Rock-Paper-Scissors (0 - rock, 1 - paper, 2 - scissors)
|-
| <code>SetScoutHypeMeter</code>
| <code>void SetScoutHypeMeter(float ''percent'')</code>
| Sets hype meter from 0 - 100.
|-
| <code>SetSpyCloakMeter</code>
| <code>void SetSpyCloakMeter(float)</code>
| Sets cloakmeter from 0 - 100.
|-
| <code>SetVehicleReverseTime</code>
| <code>void SetVehicleReverseTime(float ''time'')</code>
| Set the timestamp when kart was reversed
|-
| <code>SetUseBossHealthBar</code>
| <code>void SetUseBossHealthBar(bool ''toggle'')</code>
| 
|-
| <code>StopTaunt</code>
| <code>void StopTaunt(bool ''remove_prop'')</code>
| Stops current taunt. If ''remove_prop'' is true, the taunt prop will be immediately deleted instead of potentially delaying
|-
| <code>StunPlayer</code>
| <code>void StunPlayer(float ''duration'', float ''move_speed_reduction'', int ''flags'', handle ''attacker'')</code>
| Stuns the player for a specified duration. Move speed reduction is a fraction (0 = no reduction. 1 = total reduction, no movement). Flag combinations control the stun type and behavior, see the [[Team_Fortress_2/Scripting/Script_Functions/Constants#TF_STUN|constants page]].
|-
| <code>Taunt</code>
| <code>void Taunt(int ''taunt_index'', int ''taunt_concept'')</code>
| Performs a taunt if allowed. For taunt index, see [[Team_Fortress_2/Scripting/Script_Functions/Constants#FTaunts|Constants.FTaunts]]. For concepts, see [[Team_Fortress_2/Scripting/Script_Functions/Constants#MP_CONCEPT|MP_CONCEPT List]]. Concept is the "voiceline" index to use with the taunt. For <code>TAUNT_SHOW_ITEM</code> and <code>TAUNT_BASE_WEAPON</code> this is set automatically. <code>TAUNT_LONG</code> is not supported.
{{tip|TAUNT_MISC_ITEM with a concept of <code>MP_CONCEPT_TAUNT_LAUGH</code> will make the player laugh. Concept <code>MP_CONCEPT_TAUNT_REPLAY</code> will play the replay taunt.}}
|-
| <code>TryToPickupBuilding</code>
| <code>bool TryToPickupBuilding()</code>
| Make the player attempt to pick up a building in front of them
|-
| <code>UpdateSkin</code>
| <code>void UpdateSkin(int ''skin'')</code>
|
|-
| <code>WasInCond</code>
| <code>bool WasInCond(ETFCond ''cond'')</code>
| 
|-
| <code>Weapon_CanUse</code>
| <code>bool Weapon_CanUse(handle ''weapon'')</code>
| 
|-
| <code>Weapon_Drop</code>
| <code>void Weapon_Drop(handle ''weapon'')</code>
| Does nothing!
|-
| <code>Weapon_DropEx</code>
| <code>void Weapon_DropEx(handle ''weapon'', Vector ''target'', Vector ''velocity'')</code>
| Does nothing!
|-
| <code>Weapon_Equip</code>
| <code>void Weapon_Equip(handle ''weapon'')</code>
| Equips a weapon in the player. This places it inside the <code>m_hMyWeapons</code> array.
|-
| <code>Weapon_SetLast</code>
| <code>void Weapon_SetLast(handle ''weapon'')</code>
| 
|-
| <code>Weapon_ShootPosition</code>
| <code>Vector Weapon_ShootPosition()</code>
| 
|-
| <code>Weapon_Switch</code>
| <code>void Weapon_Switch(handle ''weapon'')</code>
| Attempts a switch to the given weapon, if present in the player's inventory (<code>m_hMyWeapons</code> array).
{{note|Most of the time a weapon switch will succeed, except in these circumstances. Workarounds are provided in each case to allow a forced switch.
* Revved with a minigun
* Just fired with a sniper rifle
* Blowing the horn of a banner item
* Holding Half-Zatoichi and under 50 health
* Backstab stun from a Razorback
-> Set <code>m_hActiveWeapon</code> on the player to null.

* Player has <code>TF_COND_CANNOT_SWITCH_FROM_MELEE</code> condition (from eating Buffalo Steak Sandvich) and is holding a melee
-> Remove <code>TF_COND_CANNOT_SWITCH_FROM_MELEE</code> condition.

* Using the Thermal Thruster:
<source lang=js>
// assuming "weapon" is the thermal thruster
NetProps.SetPropEntity(player, "m_hActiveWeapon", null)	
if (player.InCond(Constants.ETFCond.TF_COND_ROCKETPACK))
{
    // needed to stop air sound
    SendGlobalGameEvent("rocketpack_landed", { userid = GetPlayerUserID(player) })
    player.RemoveCond(Constants.ETFCond.TF_COND_ROCKETPACK)
}

</source>
}}
|}

=== CTFBot ===
Extends [[#CTFPlayer|CTFPlayer ↑]] and [[#NextBotCombatCharacter|NextBotCombatCharacter ↓]]

Script handle class for bot-controlled players aka [[tf_bot]]. Beep boop.

{{note|[https://wiki.teamfortress.com/wiki/Bots#Puppet_bots Puppet bots] do ''not'' inherit from this class.}}

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>AddBotAttribute</code>
| <code>void AddBotAttribute(int ''attribute'')</code>
| Sets attribute flags on this TFBot
|-
| <code>AddBotTag</code>
| <code>void AddBotTag(string ''tag'')</code>
| Adds a bot tag
|-
| <code>AddWeaponRestriction</code>
| <code>void AddWeaponRestriction(int ''flags'')</code>
| Adds weapon restriction flags
|-
| <code>ClearAllBotAttributes</code>
| <code>void ClearAllBotAttributes()</code>
| Clears all attribute flags on this TFBot
|-
| <code>ClearAllBotTags</code>
| <code>void ClearAllBotTags()</code>
| Clears bot tags
|-
| <code>ClearAllWeaponRestrictions</code>
| <code>void ClearAllWeaponRestrictions()</code>
| Removes all weapon restriction flags
|-
| <code>ClearAttentionFocus</code>
| <code>void ClearAttentionFocus()</code>
| Clear current focus
|-
| <code>ClearBehaviorFlag</code>
| <code>void ClearBehaviorFlag(int ''flags'')</code>
| Clear the given behavior flag(s) for this bot
{{bug|Does not work}}
|-
| <code>DelayedThreatNotice</code>
| <code>void DelayedThreatNotice(handle ''threat'', float ''delay'')</code>
| Notice the threat after a delay in seconds
|-
| <code>DisbandCurrentSquad</code>
| <code>void DisbandCurrentSquad()</code>
| Forces the current squad to be entirely disbanded by everyone
|-
| <code>FindVantagePoint</code>
| <code>handle FindVantagePoint(float ''max_distance'')</code>
| Get the nav area of the closest vantage point (within distance)
|-
| <code>GenerateAndWearItem</code>
| <code>void GenerateAndWearItem(string ''item_name'')</code>
| Give me an item!
|-
| <code>GetActionPoint</code>
| <code>handle GetActionPoint()</code>
| Get the given action point for this bot
|-
| <code>GetAllBotTags</code>
| <code>void GetAllBotTags(handle ''table'')</code>
| Get all bot tags. The key is the index, and the value is the tag
|-
| <code>GetHomeArea</code>
| <code>handle GetHomeArea()</code>
| Sets the home nav area of the bot
|-
| <code>GetDifficulty</code>
| <code>[[Team_Fortress_2/Scripting/Script_Functions/Constants#ETFBotDifficultyType|ETFBotDifficultyType]] GetDifficulty()</code>
| Returns the bot's difficulty level
|-
| <code>GetMaxVisionRangeOverride</code>
| <code>float GetMaxVisionRangeOverride()</code>
| Gets the max vision range override for the bot {{warning|MaxVisionRange overrides, as well as certain other bot modifiers, can persist after a bot has been moved to spectator and assigned a new class/loadout in MvM! Identifying MvM bots by the MaxVisionRange override set in a popfile may not be reliable.}} 
|-
| <code>GetMission</code>
| <code>int GetMission()</code>
| Get this bot's current mission
{{bug|Does not work}}
|-
| <code>GetMissionTarget</code>
| <code>handle GetMissionTarget()</code>
| Get this bot's current mission target
|-
| <code>GetNearestKnownSappableTarget</code>
| <code>handle GetNearestKnownSappableTarget()</code>
| Gets the nearest known sappable target
|-
| <code>GetPrevMission</code>
| <code>int GetPrevMission()</code>
| Get this bot's previous mission
{{bug|Does not work}}
|-
| <code>GetSpawnArea</code>
| <code>handle GetSpawnArea()</code>
| Return the nav area of where we spawned
|-
| <code>GetSquadFormationError</code>
| <code>float GetSquadFormationError()</code>
| Gets our formation error coefficient.
|-
| <code>HasBotAttribute</code>
| <code>bool HasBotAttribute(int ''attribute'')</code>
| Checks if this TFBot has the given attributes
|-
| <code>HasBotTag</code>
| <code>bool HasBotTag(string ''tag'')</code>
| Checks if this TFBot has the given bot tag
|-
| <code>HasMission</code>
| <code>bool HasMission(int ''mission'')</code>
| Return true if the given mission is this bot's current mission
{{bug|Does not work}}
|-
| <code>HasWeaponRestriction</code>
| <code>bool HasWeaponRestriction(int ''flags'')</code>
| Checks if this TFBot has the given weapon restriction flags
|-
| <code>IsAmmoFull</code>
| <code>bool IsAmmoFull()</code>
| 
|-
| <code>IsAmmoLow</code>
| <code>bool IsAmmoLow()</code>
| 
|-
| <code>IsAttentionFocused</code>
| <code>bool IsAttentionFocused()</code>
| Is our attention focused right now?
|-
| <code>IsAttentionFocusedOn</code>
| <code>bool IsAttentionFocusedOn(handle ''entity'')</code>
| Is our attention focused on this entity
|-
| <code>IsBehaviorFlagSet</code>
| <code>bool IsBehaviorFlagSet(int ''flags'')</code>
| Return true if the given behavior flag(s) are set for this bot
{{bug|Does not work}}
|-
| <code>IsDifficulty</code>
| <code>bool IsDifficulty(int ''difficulty'')</code>
| Returns true/false if the bot's difficulty level matches.
|-
| <code>IsInASquad</code>
| <code>bool IsInASquad()</code>
| Checks if we are in a squad
|-
| <code>IsOnAnyMission</code>
| <code>bool IsOnAnyMission()</code>
| Return true if this bot has a current mission
|-
| <code>IsWeaponRestricted</code>
| <code>bool IsWeaponRestricted(handle ''weapon'')</code>
| Checks if the given weapon is restricted for use on the bot
|-
| <code>LeaveSquad</code>
| <code>void LeaveSquad()</code>
| Makes us leave the current squad (if any)
|-
| <code>PressAltFireButton</code>
| <code>void PressAltFireButton(float ''duration'')</code>
| 
|-
| <code>PressFireButton</code>
| <code>void PressFireButton(float ''duration'')</code>
| 
|-
| <code>PressSpecialFireButton</code>
| <code>void PressSpecialFireButton(float ''duration'')</code>
|-
| <code>RemoveBotAttribute</code>
| <code>void RemoveBotAttribute(int ''attribute'')</code>
| Removes attribute flags on this TFBot
|-
| <code>RemoveBotTag</code>
| <code>void RemoveBotTag(string ''tag'')</code>
| Removes a bot tag
|-
| <code>RemoveWeaponRestriction</code>
| <code>void RemoveWeaponRestriction(int ''flags'')</code>
| Removes weapon restriction flags
|-
| <code>SetActionPoint</code>
| <code>void SetActionPoint(handle ''entity'')</code>
| Set the given action point for this bot
|-
| <code>SetAttentionFocus</code>
| <code>void SetAttentionFocus(handle ''entity'')</code>
| Sets our current attention focus to this entity
|-
| <code>SetAutoJump</code>
| <code>void SetAutoJump(float ''minTime'', float ''maxTime'')</code>
| Sets if the bot should automatically jump, and how often.
|-
| <code>SetBehaviorFlag</code>
| <code>void SetBehaviorFlag(int ''flags'')</code>
| Set the given behavior flag(s) for this bot
{{bug|Does not work}}
|-
| <code>SetDifficulty</code>
| <code>void SetDifficulty(int ''difficulty'')</code>
| Sets the bots difficulty level
|-
| <code>SetHomeArea</code>
| <code>void SetHomeArea(handle ''area'')</code>
| Set the home nav area of the bot, may be null.
|-
| <code>SetMaxVisionRangeOverride</code>
| <code>void SetMaxVisionRangeOverride(float ''range'')</code>
| Sets max vision range override for the bot
|-
| <code>SetMission</code>
| <code>void SetMission(int ''mission'', bool ''reset_behavior'')</code>
| Set this bot's current mission to the given mission
{{bug|Does not work}}
|-
| <code>SetMissionTarget</code>
| <code>void SetMissionTarget(handle ''entity'')</code>
| Set this bot's mission target to the given entity
|-
| <code>SetPrevMission</code>
| <code>void SetPrevMission(int ''mission'')</code>
| Set this bot's previous mission to the given mission
{{bug|Does not work}}
|-
| <code>SetScaleOverride</code>
| <code>void SetScaleOverride(float ''scale'')</code>
| Sets the scale override for the bot
|-
| <code>SetShouldQuickBuild</code>
| <code>void SetShouldQuickBuild(bool ''toggle'')</code>
| Sets if the bot should build instantly
|-
| <code>SetSquadFormationError</code>
| <code>void SetSquadFormationError(float ''coefficient'')</code>
| Sets our formation error coefficient.
|-
| <code>ShouldAutoJump</code>
| <code>bool ShouldAutoJump()</code>
| Returns if the bot should automatically jump
|-
| <code>ShouldQuickBuild</code>
| <code>bool ShouldQuickBuild()</code>
| Returns if the bot should build instantly
|-
| <code>UpdateDelayedThreatNotices</code>
| <code>void UpdateDelayedThreatNotices()</code>
|}

=== CTFBaseBoss ===
Extends [[#NextBotCombatCharacter|NextBotCombatCharacter ↓]]

Base class intended for custom NPCs. Officially this is only used as part of [[tank_boss|MvM tank]].

==== Methods ====
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>SetResolvePlayerCollisions</code>
| <code>void SetResolvePlayerCollisions(bool ''toggle'')</code>
| Sets whether the entity should push away players intersecting its bounding box. On by default.
|}
{{note|There's more methods in input form. See [[base_boss]] page.}}

=== Convars ===
Game Instance: <code>Convars</code>

An interface to manipulate the [[ConVar|convars]] on the server.

{{note|Protected convars (e.g. <code>rcon_password</code>) cannot be accessed.}}
<!--
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%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>GetBool</code>
| <code>bool GetBool(string ''name'')</code>
| Returns the convar as a bool. May return null if no such convar.
|-
| <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. 
{{tip|The list of available client convars can be printed in console using the <code>findflags USERINFO</code> command.}}
{{note|Notable client convars available:
* cl_autoreload : Whether the client wants autoreload after each shot
* cl_autorezoom : Whether the client wants auto scope-in after firing a sniper rifle
* cl_flipviewmodels : Whether the client has flipped viewmodels
* cl_language : The client's language setting
* cl_spec_mode : Currently observer mode, corresponds to the [[Team_Fortress_2/Scripting/Script_Functions/Constants#ESpectatorMode|constants]].
* fov_desired : The client's FOV
* hud_classautokill : If the client wants to suicide after choosing a new class
* hud_combattext : Whether damage numbers are enabled
* name : The client's name
* closecaption : Whether the client has [[closed caption]]s enabled.
}}

|-
| <code>GetInt</code>
| <code>int GetInt(string ''name'')</code>
| Returns the convar as an int. May return null if no such convar.
|-
| <code>GetStr</code>
| <code>string GetStr(string ''name'')</code>
| Returns the convar as a string. May return null if no such convar. Returns <code>hunter2</code> if a protected convar is accessed.
|-
| <code>GetFloat</code>
| <code>float GetFloat(string ''name'')</code>
| Returns the convar as a float. May return null if no such convar.
|-
| <code>IsConVarOnAllowList</code>
| <code>bool IsConVarOnAllowList(string ''name'')</code>
| Checks if the convar is allowed to be used and is in cfg/vscript_convar_allowlist.txt. Please be nice with this and use it for *compatibility* if you need check support and NOT to force server owners to allow hostname to be set... or else this will simply lie and return true in future. ;-) You have been warned!
|-
| <code>SetValue</code>
| <code>void SetValue(string ''name'', any ''value'')</code>
| Sets the value of the convar. The convar must be in cfg/vscript_convar_allowlist.txt to be set. Convars marked as cheat-only can be set even if ''sv_cheats'' is off. Convars marked as dev-only (i.e. not visible in console) can also be set. Supported types are bool, int, float, string. The original value of the convar is saved and is reset on map change, in other words convar changes will not persist across maps.
{{warning|For changes intended to persist for the whole map, set these at the start of each round instead of only once. Otherwise, custom server configs may load after the initial script and not use the correct settings.}}
|}

=== CEntities ===
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, "tf_weapon_*") )
{
  // ...
}
</source>
|
<source lang=js>
for (local ent; ent = Entities.FindByName(ent, "tf_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>tf_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>CreateByClassname</code>
| <code>handle CreateByClassname(string ''classname'')</code>
| Creates an entity by classname.
{{tip|Example usage: <source lang=js>local prop = Entities.CreateByClassname("prop_dynamic")</source>}}
|-
| <code>DispatchSpawn</code>
| <code>void DispatchSpawn(handle ''entity'')</code>
| Dispatches spawn of an entity! Use this on entities created via <code>CreateByClassname</code> to actually spawn them into the world.
{{note|Calling this on players will cause them to respawn.}}
|-
| <code>FindByClassname</code>
| <code>handle FindByClassname(handle ''previous'', string ''classname'')</code>
| Find entities by the string of their <code>classname</code> keyvalue. Pass 'null' value to start an iteration, or reference to a previously found entity to continue a search
{{note|The classname keyvalue of an entity can be manipulated and does not necessarily reflect its code class. There might be entities that have a different classname than the one they are created with. For example you can spawn a "prop_dynamic" then change its classname to "my_prop", and it will retain the functionality of its code class while also not showing up when searching for "prop_dynamic".}}
|-
| <code>FindByClassnameNearest</code>
| <code>handle FindByClassnameNearest(string ''classname'', Vector ''center'', float ''radius'')</code>
| Find entities by classname nearest to a point within a radius.
|-
| <code>FindByClassnameWithin</code>
| <code>handle FindByClassnameWithin(handle ''previous'', string ''classname'', Vector ''center'', float ''radius'')</code>
| Find entities by classname within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>FindByModel</code>
| <code>handle FindByModel(handle ''previous'', string ''modelname'')</code>
| Find entities by the string of their <code>model</code> keyvalue. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>FindByName</code>
| <code>handle FindByName(handle ''previous'', string ''targetname'')</code>
| Find entities by the string of their {{ent|targetname}} keyvalue. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>FindByNameNearest</code>
| <code>handle FindByNameNearest(string ''targetname'', Vector ''center'', float ''radius'')</code>
| Find entities by targetname nearest to a point within a radius.
|-
| <code>FindByNameWithin</code>
| <code>handle FindByNameWithin(handle ''previous'', string ''targetname'', Vector ''center'', float ''radius'')</code>
| Find entities by targetname within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>FindByTarget</code>
| <code>handle FindByTarget(handle ''previous'', string ''target'')</code>
| Find entities by the string of their <code>target</code> keyvalue.{{confirm}} Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>FindInSphere</code>
| <code>handle FindInSphere(handle ''previous'', Vector ''center'', float ''radius'')</code>
| Find entities within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
|-
| <code>First</code>
| <code>handle First()</code>
| Begin an iteration over the list of entities. The first entity is always [[worldspawn]].
|-
| <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.
|}

=== CTFNavArea ===

Script handle class for areas part of the [[Nav Mesh|navigation mesh]].

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>AddIncomingConnection</code>
| <code>void AddIncomingConnection(handle ''area'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''dir'')</code>
| Add areas that connect TO this area by a ONE-WAY link
|-
| <code>ClearAttributeTF</code>
| <code>void ClearAttributeTF(int ''bits'')</code>
| Clear TF-specific area attribute bits.
|-
| <code>ComputeClosestPointInPortal</code>
| <code>Vector ComputeClosestPointInPortal(handle ''to'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''dir'', Vector ''closePos'')</code>
| Compute closest point within the "portal" between to an area's direction from the given position.
|-
| <code>ComputeDirection</code>
| <code>int ComputeDirection(Vector ''point'')</code>
| Return direction from this area to the given point.
|-
| <code>ConnectTo</code>
| <code>void ConnectTo(handle ''area'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''dir'')</code>
| Connect this area to given area in given direction.
|-
| <code>Contains</code>
| <code>bool Contains(handle ''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'', float ''margin'')</code>
| Draw area as a filled rectangle of the given color.
|-
| <code>Disconnect</code>
| <code>void Disconnect(handle ''area'')</code>
| Disconnect this area from given area.
|-
| <code>FindRandomSpot</code>
| <code>Vector FindRandomSpot()</code>
| Get random origin within extent of area.
|-
| <code>GetAdjacentArea</code>
| <code>handle GetAdjacentArea([[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''dir'', int ''n'')</code>
| Return the n'th adjacent area in the given direction
{{note|'Adjacent area' really means ''outgoing'' connection. Adjacent areas don't necessarily have to physically be touching, there can be a height discrepancy (e.g. at a drop ledge)}}
|-
| <code>GetAdjacentAreas</code>
| <code>void GetAdjacentAreas([[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''dir'', handle ''table'')</code>
| Fills a passed in table with all adjacent areas in the given direction.
|-
| <code>GetAdjacentCount</code>
| <code>int GetAdjacentCount([[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''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([[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''dir'')</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>handle GetDoor()</code>
| Returns the door entity above the area.
|-
| <code>GetElevator</code>
| <code>handle GetElevator()</code>
| Returns the elevator if in an elevator's path.
|-
| <code>GetElevatorAreas</code>
| <code>void GetElevatorAreas(handle ''table'')</code>
| Fills 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([[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''dir'', handle ''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>GetParent</code>
| <code>handle 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 if it exists, null otherwise.
|-
| <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>handle GetRandomAdjacentArea([[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''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>GetTravelDistanceToBombTarget</code>
| <code>float GetTravelDistanceToBombTarget()</code>
| Gets the travel distance to the MvM bomb target.
|-
| <code>GetZ</code>
| <code>float GetZ(Vector ''pos'')</code>
| Return Z of area at (x,y) of 'pos'
|-
| <code>HasAttributeTF</code>
| <code>bool HasAttributeTF(int ''bits'')</code>
| Has TF-specific area attribute bits of the given ones.
|-
| <code>HasAttributes</code>
| <code>bool HasAttributes(int ''bits'')</code>
| Has area attribute bits of the given ones?.
|-
| <code>HasAvoidanceObstacle</code>
| <code>bool HasAvoidanceObstacle(float ''maxheight'')</code>
| Returns true if there's a large, immobile object obstructing this area
|-
| <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. (tiny narrow areas with only one path)
|-
| <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(handle ''area'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''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>IsCoplanar</code>
| <code>bool IsCoplanar(handle ''area'')</code>
| Return true if this area and given. area are approximately co-planar
|-
| <code>IsDamaging</code>
| <code>bool IsDamaging()</code>
| Return true if this area is marked to have continuous damage.
|-
| <code>IsDegenerate</code>
| <code>bool IsDegenerate()</code>
| Return true if this area is badly formed.
|-
| <code>IsEdge</code>
| <code>bool IsEdge([[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''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(handle ''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>IsReachableByTeam</code>
| <code>bool IsReachableByTeam(int ''team'')</code>
| Is this area reachable by the given team?
|-
| <code>IsRoughlySquare</code>
| <code>bool IsRoughlySquare()</code>
| Return true if this area is approximately square.
|-
| <code>IsTFMarked</code>
| <code>bool IsTFMarked()</code>
| Is this nav area marked with the current marking scope?
|-
| <code>IsUnderwater</code>
| <code>bool IsUnderwater()</code>
| Return true if area is underwater.
|-
| <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 eyepoint.
|-
| <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([[Team_Fortress_2/Scripting/Script_Functions/Constants#ENavDirType|ENavDirType]] ''dir'')</code>
| Removes all connections in directions to left and right of specified direction.
|-
| <code>SetAttributeTF</code>
| <code>void SetAttributeTF(int ''bits'')</code>
| Set TF-specific area attributes.
|-
| <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>TFMark</code>
| <code>void TFMark()</code>
| Mark this nav area with the current marking scope.
|-
| <code>UnblockArea</code>
| <code>void UnblockArea()</code>
| Unblocks this area.
|}

=== CNavMesh ===
Game Instance: <code>NavMesh</code>

An interface to collect nav areas from, especially for pathfinding needs.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>FindNavAreaAlongRay</code>
| <code>handle FindNavAreaAlongRay(Vector ''startpos'', Vector ''endpos'', handle ''ignoreAreaID'')</code>
| get nav area from ray
|-
| <code>GetAllAreas</code>
| <code>void GetAllAreas(handle ''table'')</code>
| fills a passed in table of all nav areas
|-
| <code>GetAreasWithAttributes</code>
| <code>void GetAreasWithAttributes(int ''bits'', handle ''table'')</code>
| fills a passed in table of all nav areas that have the specified attributes
|-
| <code>GetNavArea</code>
| <code>handle GetNavArea(Vector ''origin'', float ''flBeneath'')</code>
| given a position in the world, return the nav area that is closest to or below that height.
|-
| <code>GetNavAreaByID</code>
| <code>handle GetNavAreaByID(int ''areaID'')</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(handle ''startArea'', handle ''endArea'', Vector ''goalPos'', float ''flMaxPathLength'', int ''teamID'', bool ''ignoreNavBlockers'', handle ''table'')</code>
| Fills the 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'', handle ''table'')</code>
| fills a passed in table of nav areas within radius
|-
| <code>GetNavAreasOverlappingEntityExtent</code>
| <code>void GetNavAreasOverlappingEntityExtent(handle ''entity'', handle ''table'')</code>
| fills passed in table with areas overlapping entity's extent
|-
| <code>GetNearestNavArea</code>
| <code>handle GetNearestNavArea(Vector ''origin'', float ''maxDist'', bool ''checkLOS'', bool ''checkGround'')</code>
| given a position in the world, return the nav area that is closest to or below that height.
|-
| <code>GetObstructingEntities</code>
| <code>void GetObstructingEntities(handle ''table'')</code>
| fills a passed in table of all obstructing entities
|-
| <code>NavAreaBuildPath</code>
| <code>bool NavAreaBuildPath(handle ''startArea'', handle ''endArea'', Vector ''goalPos'', float ''flMaxPathLength'', int ''teamID'', bool ''ignoreNavBlockers'')</code>
| returns true if a path exists
|-
| <code>NavAreaTravelDistance</code>
| <code>float NavAreaTravelDistance(handle ''startArea'', handle ''endArea'', float ''flMaxPathLength'')</code>
| compute distance between two areas. Return -1 if can't reach 'endArea' from 'startArea'
|-
| <code>RegisterAvoidanceObstacle</code>
| <code>void RegisterAvoidanceObstacle(handle ''entity'')</code>
| registers avoidance obstacle
|-
| <code>UnregisterAvoidanceObstacle</code>
| <code>void UnregisterAvoidanceObstacle(handle ''entity'')</code>
| unregisters avoidance obstacle
|}

=== CNetPropManager ===
Game Instance: <code>NetProps</code>

Allows reading and updating the [[Networking_Entities#Network_Variables|network properties]] and data-maps of an entity. A brief explanation: all entities in the game have 2 types of internal properties: networked and saved (called "data" by the game). Networked properties are transmitted to the client, while data properties are a leftover from singleplayer games, which are properties that get saved to a save file (that can be re-loaded later). Some properties may exist in both lists, or one list but not the other and vice versa, so it's best to check both lists. Entities follow an inheritance tree, and they inherit the properties of their parent(s). For organization/optimization purposes, properties also tend to be nested inside "tables".

Netprops nested in a table can be accessed using dot notation similar to a [[Squirrel]] table. Example: to access the netprop <code>m_bJumping</code> on a player, you would specify <code>m_Shared.m_bJumping</code>.

{{note|Sometimes the table structure is figured out automatically and doesn't need to be specified explicitly. The easiest way to check is to use <code>HasProp</code> to see if its correct. For example, <code>LocalWeaponData</code> and <code>LocalActiveWeaponData</code> don't need to be specified. But on the contrary, <code>m_Collision</code>, <code>m_Shared</code> and <code>m_AttributeManager</code> (+ <code>m_Item</code>) must be explicitly specified.}}
	
{{tip|Resources for finding netprops and datamaps of entities:
* Interactive viewer of netprops: https://jackz.me/netprops/tf2
* Formatted list of netprops and datamaps: https://sigwiki.potato.tf/index.php/Entity_Properties
* Raw list of netprops and datamaps: https://www.invalidvertex.com/tf2dump.php
* Better raw list of datamaps that includes type information: https://cdn.discordapp.com/attachments/1039243316920844428/1095872595049599056/dump_datamaps.txt
}}

{{warning|Each netprop has a set size in bits, exceeding the size may desync the clients from the server causing unpredictable behavior.}}
{{note|Netprops containing the substring <code>EntityQuality</code> or <code>AccountID</code> are banned and cannot be set nor fetched, to prevent spoofing economy items as legitimate.}}
{{tip|Run the code below to fold netprop functions for easier and more efficient usage. E.g. <code>NetProps.GetPropInt</code> would simply become <code>GetPropInt</code>.
<source lang=js>
foreach (k, v in ::NetProps.getclass())
    if (k != "IsValid")
        getroottable()[k] <- ::NetProps[k].bindenv(::NetProps)
</source>
}}

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>GetPropArraySize</code>
| <code>int GetPropArraySize(handle ''entity'', string ''propertyName'')</code>
| Returns the size of an netprop array, or -1.
|-
| <code>GetPropEntity</code>
| <code>handle GetPropEntity(handle ''entity'', string ''propertyName'')</code>
| Reads an EHANDLE-valued netprop (21 bit integer). Returns the script handle of the entity.
|-
| <code>GetPropEntityArray</code>
| <code>handle GetPropEntityArray(handle ''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>GetPropBool</code>
| <code>bool GetPropBool(handle ''entity'', string ''propertyName'')</code>
| Reads a boolean-valued netprop.
|-
| <code>GetPropBoolArray</code>
| <code>bool GetPropBoolArray(handle ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads a boolean-valued netprop from an array.
|-
| <code>GetPropFloat</code>
| <code>float GetPropFloat(handle ''entity'', string ''propertyName'')</code>
| Reads a float-valued netprop.
|-
| <code>GetPropFloatArray</code>
| <code>float GetPropFloatArray(handle ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads a float-valued netprop from an array.
|-
| <code>GetPropInfo</code>
| <code>bool GetPropInfo(handle ''entity'', string ''propertyName'', int ''arrayElement'', handle ''table'')</code>
| Fills in a passed table with property info for the provided entity.
|-
| <code>GetPropInt</code>
| <code>int GetPropInt(handle ''entity'', string ''propertyName'')</code>
| Reads an integer-valued netprop.
|-
| <code>GetPropIntArray</code>
| <code>int GetPropIntArray(handle ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads an integer-valued netprop from an array.
|-
| <code>GetPropString</code>
| <code>string GetPropString(handle ''entity'', string ''propertyName'')</code>
| Reads an string-valued netprop.
|-
| <code>GetPropStringArray</code>
| <code>string GetPropStringArray(handle ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads an string-valued netprop from an array.
|-
| <code>GetPropType</code>
| <code>string GetPropType(handle ''entity'', string ''propertyName'')</code>
| Returns the name of the netprop type as a string.
|-
| <code>GetPropVector</code>
| <code>Vector GetPropVector(handle ''entity'', string ''propertyName'')</code>
| Reads a 3D vector-valued netprop.
|-
| <code>GetPropVectorArray</code>
| <code>Vector GetPropVectorArray(handle ''entity'', string ''propertyName'', int ''arrayElement'')</code>
| Reads a 3D vector-valued netprop from an array. 
|-
| <code>GetTable</code>
| <code>void GetTable(handle ''entity'', int ''iPropType'', handle ''table'')</code>
| Fills in a passed table with all props of a specified type for the provided entity (set iPropType to 0 for SendTable or 1 for DataMap)
|-
| <code>HasProp</code>
| <code>bool HasProp(handle ''entity'', string ''propertyName'')</code>
| Checks if a netprop exists.
|-
| <code>SetPropBool</code>
| <code>void SetPropBool(handle ''entity'', string ''propertyName'', bool ''value'')</code>
| Sets a netprop to the specified boolean.
|-
| <code>SetPropBoolArray</code>
| <code>void SetPropBoolArray(handle ''entity'', string ''propertyName'', bool ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified boolean.
|-
| <code>SetPropEntity</code>
| <code>void SetPropEntity(handle ''entity'', string ''propertyName'', handle ''value'')</code>
| Sets an EHANDLE-valued netprop (21 bit integer) to reference the specified entity.
|-
| <code>SetPropEntityArray</code>
| <code>void SetPropEntityArray(handle ''entity'', string ''propertyName'', handle ''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(handle ''entity'', string ''propertyName'', float ''value'')</code>
| Sets a netprop to the specified float.
|-
| <code>SetPropFloatArray</code>
| <code>void SetPropFloatArray(handle ''entity'', string ''propertyName'', float ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified float.
|-
| <code>SetPropInt</code>
| <code>void SetPropInt(handle ''entity'', string ''propertyName'', int ''value'')</code>
| Sets a netprop to the specified integer.
{{warning|Do not override <code>m_iTeamNum</code> netprops on players or Engineer buildings permanently. Use <code>ForceChangeTeam</code> or <code>SetTeam</code> or respectively. Not doing so will result in unpredictable server crashes later on. Overriding m_iTeamNum temporarily and then reverting it in the same frame is safe however.}}
|-
| <code>SetPropIntArray</code>
| <code>void SetPropIntArray(handle ''entity'', string ''propertyName'', int ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified integer.
|-
| <code>SetPropString</code>
| <code>void SetPropString(handle ''entity'', string ''propertyName'', string ''value'')</code>
| Sets a netprop to the specified string.
|-
| <code>SetPropStringArray</code>
| <code>void SetPropStringArray(handle ''entity'', string ''propertyName'', string ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified string.
|-
| <code>SetPropVector</code>
| <code>void SetPropVector(handle ''entity'', string ''propertyName'', Vector ''value'')</code>
| Sets a netprop to the specified vector.
|-
| <code>SetPropVectorArray</code>
| <code>void SetPropVectorArray(handle ''entity'', string ''propertyName'', Vector ''value'', int ''arrayElement'')</code>
| Sets a netprop from an array to the specified vector.
|}

=== CScriptEntityOutputs ===
Game Instance: <code>EntityOutputs</code>

Allows reading and manipulation of entity output data.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>AddOutput</code>
| <code>void AddOutput(handle ''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(handle ntity ''entity'', string ''outputName'')</code>
| Returns the number of array elements.
|-
| <code>GetOutputTable</code>
| <code>void GetOutputTable(handle ''entity'', string ''outputName'', table, int ''arrayElement'')</code>
| Fills the passed table with output information.
|-
| <code>HasAction</code>
| <code>bool HasAction(handle ''entity'', string ''outputName'')</code>
| Returns true if an action exists for the output.
|-
| <code>HasOutput</code>
| <code>bool HasOutput(handle ''entity'', string ''outputName'')</code>
| Returns true if the output exists.
|-
| <code>RemoveOutput</code>
| <code>void RemoveOutput(handle ''entity'', string ''outputName'', string ''targetName'', string ''inputName'', string ''parameter'')</code>
| Removes an output from the entity.
{{note|The order of the internal output data may change after this is performed, which can be problematic if iterating outputs. As a workaround, all the outputs can be stored in an array of tables first and then removed while iterating the array.}}
|}


=== CScriptKeyValues ===
Script handle representation of a model's [[$keyvalues]] block.
All sub-keys are instances of the same class.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>constructor</code>
|-
| <code>FindKey</code>
| <code>CScriptKeyValues FindKey(string ''key'')</code>
| Find a sub key by the key name.
|-
| <code>GetFirstSubKey</code>
| <code>CScriptKeyValues GetFirstSubKey()</code>
| Return the first sub key object.
|-
| <code>GetKeyBool</code>
| <code>bool GetKeyBool(string ''key'')</code>
| Return the key value as a bool.
|-
| <code>GetKeyFloat</code>
| <code>float GetKeyFloat(string ''key'')</code>
| Return the key value as a float.
|-
| <code>GetKeyInt</code>
| <code>int GetKeyInt(string ''key'')</code>
| Return the key value as an integer.
|-
| <code>GetKeyString</code>
| <code>string GetKeyString(string ''key'')</code>
| Return the key value as a string.
|-
| <code>GetNextKey</code>
| <code>CScriptKeyValues GetNextKey()</code>
| Return the next neighbor key object to the one the method is called on.
|-
| <code>IsKeyEmpty</code>
| <code>bool IsKeyEmpty(string ''key'')</code>
| Returns true if the named key has no value.
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| Whether the handle belongs to a valid key.
|-
| <code>ReleaseKeyValues</code>
| <code>void ReleaseKeyValues()</code>
| Releases the contents of the instance.
|}


=== CPlayerVoiceListener ===
Game Instance: <code>PlayerVoiceListener</code>

Tracks if any player is using voice and for how long.

==== Methods ====
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>GetPlayerSpeechDuration</code>
| <code>float GetPlayerSpeechDuration(int ''playerIndex'')</code>
| Returns the number of seconds the player has been continuously speaking.
|-
| <code>IsPlayerSpeaking</code>
| <code>bool IsPlayerSpeaking(int ''playerIndex'')</code>
| Returns whether the player specified is speaking.
|}

=== CEnvEntityMaker ===
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(handle ''entity'')</code>
| Create an entity at the location of a specified entity instance.
|-
| <code>SpawnEntityAtLocation</code>
| <code>void SpawnEntityAtLocation(Vector ''origin'', Vector ''orientation'')</code>
| Create an entity at a specified location and orientation, orientation is Euler angle in degrees (pitch, yaw, roll).
|-
| <code>SpawnEntityAtNamedEntityOrigin</code>
| <code>void SpawnEntityAtNamedEntityOrigin(string ''targetname'')</code>
| Create an entity at the location of a named entity. If multiple entities have the same name, only the one with the lowest entity index will be targeted.
|-
|}

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

Script handle class for {{ent|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.
{{ExpandBox|<source lang=cpp>
function PreSpawnInstance( entityClass, entityName )
{
	local keyvalues =
	{ 
   		rendercolor = "0 255 0",
   		targetname = "mySpawnedEntity"
	}

	return keyvalues
}
</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.
{{note|PostSpawn() will not be called unless the PreSpawnInstance() function is also defined in the script.}}
{{ExpandBox|<source lang=cpp>
function PostSpawn( entities )
{
	foreach( targetname, handle in entities )
	{
		printl( targetname + ": " + handle )
	}
}
</source>}}

===== Example =====
Spawned entities can be accessed synchronously in script by using an entity maker. The following generalised example creates a global <code>SpawnMyEntity()</code> function which spawns and returns the templated entity. It can be modified to support multiple templated entities.
{{ExpandBox|<source lang=cpp>
m_hSpawnedEntity <- null
m_KeyValues <- null

m_hSpawner <- Entities.CreateByClassname( "env_entity_maker" )
m_hSpawner.__KeyValueFromString( "EntityTemplate", self.GetName() )

function PreSpawnInstance( classname, targetname )
{
	return m_KeyValues
}

function PostSpawn( entities )
{
	foreach ( targetname, entity in entities )
	{
		m_hSpawnedEntity = entity
		break
	}
}

::SpawnMyEntity <- function( keyvalues = null )
{
	m_KeyValues = keyvalues
	m_hSpawner.SpawnEntity()
	return m_hSpawnedEntity
}.bindenv(this)
</source>}}

Spawn templated entities from any script.
{{ExpandBox|<source lang=cpp>
local ent = SpawnMyEntity( {
	rendercolor = Vector( RandomInt(0, 255), RandomInt(0, 255), RandomInt(0, 255) )
} )

printl( ent )
</source>}}

=== CFuncTrackTrain ===
Extends [[#CBaseEntity|CBaseEntity ↑]]

Script handle class for {{ent|func_tracktrain}}.

==== Methods ====
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>GetFuturePosition</code>
| <code>Vector GetFuturePosition(float ''x'', float ''speed'')</code>
| Get a position on the track X seconds in the future.
|-
|}


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

Script handle class for {{ent|point_script_template}}.

==== Methods ====
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>AddTemplate</code>
| <code>void AddTemplate(string ''classname'', table ''keyvalues'')</code>
| Add an entity with the given keyvalues to the template spawner, similar to <code>SpawnEntityFromTable</code>. The number of templates allowed is unlimited.
|-
| <code>SetGroupSpawnTables</code>
| <code>void SetGroupSpawnTables(table ''group'', table ''spawn'')</code>
| Unused. This only stores a reference to the two tables which is removed when the {{ent|point_script_template}} is deleted.
|}

{{note|To spawn every added template, fire the <code>ForceSpawn</code> input onto the {{ent|point_script_template}} with <code>AcceptInput</code>.}}

==== Hooks ====
<code>PreSpawnInstance</code> hook from {{ent|point_template}} is not available.

;<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. 
{{bug|As the <code>PreSpawnInstance</code> hook is not implemented, this callback is never fired. This can be fixed however by defining an entity table named <code>__EntityMakerResult</code> in the entity's scope.}}
{{tip|Due to tables requiring unique keys, templated entities that have no targetname or have conflicting ones will not be present in the table. A workaround is to intercept the <code>__EntityMakerResult</code> table and add every entity to an array instead, as shown in the following example: {{ExpandBox|<source lang=js>
local template = SpawnEntityFromTable("point_script_template", {})
template.SetGroupSpawnTables({})

local scope = template.GetScriptScope()
scope.Entities <- []
scope.__EntityMakerResult <- {entities = scope.Entities}.setdelegate({_newslot = function(_, value) {entities.append(value)}})
scope.PostSpawn <- function(named_entities)
{
	__DumpScope(0, Entities)
}

template.AddTemplate("prop_dynamic",
{
	model = "models/player/heavy.mdl",
	origin = Vector(247, -281, -123)
})

template.AddTemplate("prop_dynamic",
{
	model = "models/player/spy.mdl",
	origin = Vector(247, -381, -123)
})

template.AcceptInput("ForceSpawn", "", null, null)
</source>}}}}



=== CSceneEntity ===
Extends [[#CBaseEntity|CBaseEntity ↑]]

Script handle class for {{ent|scripted_scene}}, which make use of [[VCD]] data.

==== Methods ====
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>AddBroadcastTeamTarget</code>
| <code>void AddBroadcastTeamTarget(int ''index'')</code>
| Adds a team (by index) to the broadcast list.
|-
| <code>EstimateLength</code>
| <code>float EstimateLength()</code>
| Returns length of this scene in seconds.
|-
| <code>FindNamedEntity</code>
| <code>handle FindNamedEntity(string ''reference'')</code>
| Given an entity reference, such as !target, get actual entity from scene object
|-
| <code>IsPaused</code>
| <code>bool IsPaused()</code>
| If this scene is currently paused.
|-
| <code>IsPlayingBack</code>
| <code>bool IsPlayingBack()</code>
| If this scene is currently playing.
|-
| <code>LoadSceneFromString</code>
| <code>bool LoadSceneFromString(string ''sceneName'', string ''scene'')</code>
| Given a dummy scene name and a vcd string, load the scene.
|-
| <code>RemoveBroadcastTeamTarget</code>
| <code>void RemoveBroadcastTeamTarget(int ''index'')</code>
| Removes a team (by index) from the broadcast list.
|}


=== CCallChainer ===
'''CCallChainer''' objects collect all functions with a matching prefix in a given scope, then inserts it all into the <code>chains</code> table with the prefix removed. All collected unprefixed functions can then be called in a chain using the class's <code>Call()</code> method, given the method's ''event'' argument matches the functions' name.

Whenever a '''CCallChainer''' object is created, a function named <code>Dispatch</code> followed by its given prefix will also be created, which  the class binds the environment of its <code>Call()</code> 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</code> table.
|-
| <code>Call</code>
| <code>bool Call(string ''event'', any ...)</code>
| Find an unprefixed function name in the <code>chains</code> 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</code> table. Set by the constructor.
|-
| <code>scope</code>
| <code>table</code>
| If set, seek functions in this scope instead. Set by the constructor.
|}

=== CSimpleCallChainer ===
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()</code> method does not need a function's name.

This class is also used internally by these [[#CBaseEntity|CBaseEntity ↑]] hooks: <code>Precache()</code> and <code>OnPostSpawn()</code>.

==== 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</code> array.
|-
| <code>Call</code>
| <code>bool Call(any ...)</code>
| Call all functions inside the <code>chain</code> 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()</code> method.
|-
| <code>exactMatch</code>
| <code>bool</code>
| If set, names of non-native functions and <code>prefix</code> 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</code> array. Set by the constructor.
|-
| <code>scope</code>
| <code>table</code>
| If set, seek functions in this scope instead. Set by the constructor.
|}

=== NextBotCombatCharacter ===
Extends [[#CBaseCombatCharacter|CBaseCombatCharacter ↑]]

Script handle class for non-playable combat characters operating under the [[NextBot]] system.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>ClearImmobileStatus</code>
| <code>void ClearImmobileStatus()</code>
| Clear immobile status
|-
| <code>FlagForUpdate</code>
| <code>void FlagForUpdate(bool ''toggle'')</code>
| Flag this bot for update
|-
| <code>GetBodyInterface</code>
| <code>INextBotComponent GetBodyInterface()</code>
| Get this bot's body interface{{note|Not actually exposed, no functions exist}}
|-
| <code>GetBotId</code>
| <code>int GetBotId()</code>
| Get this bot's id
|-
| <code>GetImmobileDuration</code>
| <code>float GetImmobileDuration()</code>
| How long have we been immobile
|-
| <code>GetImmobileSpeedThreshold</code>
| <code>float GetImmobileSpeedThreshold()</code>
| Return units/second below which this actor is considered immobile
|-
| <code>GetIntentionInterface</code>
| <code>INextBotComponent GetIntentionInterface()</code>
| Get this bot's intention interface{{note|Not actually exposed, no functions exist}}
|-
| <code>GetLocomotionInterface</code>
| <code>ILocomotion GetLocomotionInterface()</code>
| Get this bot's locomotion interface
|-
| <code>GetTickLastUpdate</code>
| <code>int GetTickLastUpdate()</code>
| Get last update tick
|-
| <code>GetVisionInterface</code>
| <code>INextBotComponent GetVisionInterface()</code>
| Get this bot's vision interface{{note|Not actually exposed, no functions exist}}
|-
| <code>IsEnemy</code>
| <code>bool IsEnemy(handle ''entity'')</code>
| Return true if given entity is our enemy
|-
| <code>IsFlaggedForUpdate</code>
| <code>bool IsFlaggedForUpdate()</code>
| Is this bot flagged for update
|-
| <code>IsFriend</code>
| <code>bool IsFriend(handle ''entity'')</code>
| Return true if given entity is our friend
|-
| <code>IsImmobile</code>
| <code>bool IsImmobile()</code>
| Return true if we haven't moved in awhile
|}

=== INextBotComponent ===
Base script handle class for any interfaces belonging to an individual [[#NextBotCombatCharacter|NextBotCombatCharacter ↑]] entity.

==== Methods ====
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>ComputeUpdateInterval</code>
| <code>bool ComputeUpdateInterval()</code>
| Recomputes the component update interval
|-
| <code>GetUpdateInterval</code>
| <code>float GetUpdateInterval()</code>
| Returns the component update interval
|-
| <code>Reset</code>
| <code>void Reset()</code>
| Resets the internal update state
|}

=== ILocomotion ===
Extends [[#INextBotComponent|INextBotComponent ↑]]

The interface for interacting with a specific NextBot's movement brain.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>Approach</code>
| <code>void Approach(Vector ''goal'', float ''goalWeight'')</code>
| The primary locomotive method. Goal determines the destination position to move towards. goalWeight determines the priority of this path, you can set this to 1.0 generally speaking.
{{tip|To make the entity move smoothly towards its destination make sure to put this under a think function.}}
|-
| <code>ClearStuckStatus</code>
| <code>void ClearStuckStatus(string ''reason'')</code>
| Reset stuck status to un-stuck. Reason message is shown when debugging nextbots.
|-
| <code>ClimbUpToLedge</code>
| <code>bool ClimbUpToLedge(Vector ''goalPos'', Vector ''goalForward'', handle ''obstacle'')</code>
| Initiate a jump to an adjacent high ledge, return false if climb can't start
|-
| <code>ComputeUpdateInterval</code>
| <code>bool ComputeUpdateInterval()</code>
| Returns false if no time has elapsed
|-
| <code>DriveTo</code>
| <code>void DriveTo(Vector ''pos'')</code>
| Move the bot to the precise given position immediately, updating internal state
|-
| <code>FaceTowards</code>
| <code>void FaceTowards(Vector ''target'')</code>
| Rotate body to face towards target
{{tip|To make the entity look smoothly towards a spot make sure to put this under a think function, as using the function only once makes the entity only look towards it a bit but not fully, rotating ever so slightly.}}
|-
| <code>FractionPotentialGap</code>
| <code>float FractionPotentialGap(Vector ''from'', Vector ''to'')</code>
| If the locomotor cannot jump over the gap, returns the fraction of the jumpable ray
|-
| <code>FractionPotentiallyTraversable</code>
| <code>float FractionPotentiallyTraversable(Vector ''from'', Vector ''to'', bool ''immediately'')</code>
| If the locomotor could not move along the line given, returns the fraction of the walkable ray. If ''immediately'' is true, breakables are considered non-traverseable
|-
| <code>GetDeathDropHeight</code>
| <code>float GetDeathDropHeight()</code>
| Distance at which we will die if we fall
|-
| <code>GetDesiredSpeed</code>
| <code>float GetDesiredSpeed()</code>
| Get desired speed for locomotor movement
|-
| <code>GetFeet</code>
| <code>Vector GetFeet()</code>
| Return position of feet - the driving point where the bot contacts the ground
|-
| <code>GetGround</code>
| <code>handle GetGround()</code>
| Return the current ground entity or NULL if not on the ground
|-
| <code>GetGroundMotionVector</code>
| <code>Vector GetGroundMotionVector()</code>
| Return unit vector in XY plane describing our direction of motion - even if we are currently not moving
|-
| <code>GetGroundNormal</code>
| <code>Vector GetGroundNormal()</code>
| Surface normal of the ground we are in contact with
|-
| <code>GetGroundSpeed</code>
| <code>float GetGroundSpeed()</code>
| Return current world space speed in XY plane
|-
| <code>GetMaxAcceleration</code>
| <code>float GetMaxAcceleration()</code>
| Return maximum acceleration of locomotor
|-
| <code>GetMaxDeceleration</code>
| <code>float GetMaxDeceleration()</code>
| Return maximum deceleration of locomotor
|-
| <code>GetMaxJumpHeight</code>
| <code>float GetMaxJumpHeight()</code>
| Return maximum height of a jump.
{{tip|If using a <code>base_boss</code> entity, as there is currently no available method to modify this value, you can fire the input <code>SetMaxJumpHeight</code> to change it.}}
|-
| <code>GetMotionVector</code>
| <code>Vector GetMotionVector()</code>
| Return unit vector describing our direction of motion - even if we are currently not moving
|-
| <code>GetRunSpeed</code>
| <code>float GetRunSpeed()</code>
| Get maximum running speed
|-
| <code>GetSpeed</code>
| <code>float GetSpeed()</code>
| Return current world space speed (magnitude of velocity)
|-
| <code>GetSpeedLimit</code>
| <code>float GetSpeedLimit()</code>
| Get maximum speed bot can reach, regardless of desired speed
|-
| <code>GetStepHeight</code>
| <code>float GetStepHeight()</code>
| If delta Z is lower than this, we can step up the surface (like a stair step), but if delta Z is greater than this, we have to jump to get up. 
{{tip|If using a <code>base_boss</code> entity, as there is currently no available method to modify this value, you can fire the input <code>SetStepHeight</code> to change it.}}
|-
| <code>GetStuckDuration</code>
| <code>float GetStuckDuration()</code>
| Return how long we've been stuck
|-
| <code>GetTraversableSlopeLimit</code>
| <code>float GetTraversableSlopeLimit()</code>
| Return Z component of unit normal of steepest traversable slope
|-
| <code>GetUpdateInterval</code>
| <code>float GetUpdateInterval()</code>
| Returns time between updates
|-
| <code>GetVelocity</code>
| <code>Vector GetVelocity()</code>
| Return current world space velocity
|-
| <code>GetWalkSpeed</code>
| <code>float GetWalkSpeed()</code>
| Get maximum walking speed
|-
| <code>HasPotentialGap</code>
| <code>float HasPotentialGap(Vector ''from'', Vector ''to'')</code>
| Checks if there is a possible gap that will need to be jumped over. Returns fraction of ray from 0 to 1.
|-
| <code>IsAbleToClimb</code>
| <code>bool IsAbleToClimb()</code>
| Return true if this bot can climb arbitrary geometry it encounters
|-
| <code>IsAbleToJumpAcrossGaps</code>
| <code>bool IsAbleToJumpAcrossGaps()</code>
| Return true if this bot can jump across gaps in its path
|-
| <code>IsAreaTraversable</code>
| <code>bool IsAreaTraversable(handle ''area'')</code>
| Return true if given area can be used for navigation
|-
| <code>IsAttemptingToMove</code>
| <code>bool IsAttemptingToMove()</code>
| Return true if we have tried to Approach() or DriveTo() very recently
|-
| <code>IsClimbingOrJumping</code>
| <code>bool IsClimbingOrJumping()</code>
| Is jumping in any form
|-
| <code>IsClimbingUpToLedge</code>
| <code>bool IsClimbingUpToLedge()</code>
| Is climbing up to a high ledge
|-
| <code>IsEntityTraversable</code>
| <code>bool IsEntityTraversable(handle ''entity'', bool ''immediately'')</code>
| Return true if the entity handle is traversable. If ''immediately'' is true, breakables are considered non-traverseable
|-
| <code>IsGap</code>
| <code>bool IsGap(Vector ''pos'', Vector ''forward'')</code>
| Return true if there is a gap at this position.
{{note|''forward'' is unused.}}
|-
| <code>IsJumpingAcrossGap</code>
| <code>bool IsJumpingAcrossGap()</code>
| Is jumping across a gap to the far side
|-
| <code>IsOnGround</code>
| <code>bool IsOnGround()</code>
| Return true if standing on something
|-
| <code>IsPotentiallyTraversable</code>
| <code>float IsPotentiallyTraversable(Vector ''from'', Vector ''to'', bool ''immediately'')</code>
| Checks if this locomotor could potentially move along the line given. Returns fraction of trace result (1 = clear). If ''immediately'' is true, breakables are considered non-traverseable
|-
| <code>IsRunning</code>
| <code>bool IsRunning()</code>
| Is running?
|-
| <code>IsScrambling</code>
| <code>bool IsScrambling()</code>
| Is in the middle of a complex action (climbing a ladder, climbing a ledge, jumping, etc) that shouldn't be interrupted
|-
| <code>IsStuck</code>
| <code>bool IsStuck()</code>
| Return true if bot is stuck. If the locomotor cannot make progress, it becomes stuck and can only leave this stuck state by successfully movingand becoming un-stuck.
|-
| <code>Jump</code>
| <code>void Jump()</code>
| Initiate a simple undirected jump in the air
|-
| <code>JumpAcrossGap</code>
| <code>void JumpAcrossGap(Vector ''goalPos'', Vector ''goalForward'')</code>
| Initiate a jump across an empty volume of space to far side
{{note|''goalForward'' is unused.}}
|-
| <code>OnLandOnGround</code>
| <code>void OnLandOnGround(handle ''ground'')</code>
| Manually run the OnLandOnGround callback. Typically invoked when bot lands on the ground after being in the air
|-
| <code>OnLeaveGround</code>
| <code>void OnLeaveGround(handle ''ground'')</code>
| Manually run the OnLeaveGround callback. Typically invoked when bot leaves ground for any reason
|-
| <code>Reset</code>
| <code>void Reset()</code>
| Resets motion, stuck state etc
|-
| <code>Run</code>
| <code>void Run()</code>
| Set desired movement speed to running
|-
| <code>SetDesiredSpeed</code>
| <code>void SetDesiredSpeed(float ''speed'')</code>
| Set desired speed for locomotor movement
|-
| <code>SetSpeedLimit</code>
| <code>void SetSpeedLimit(float ''limit'')</code>
| Set maximum speed bot can reach, regardless of desired speed
|-
| <code>Stop</code>
| <code>void Stop()</code>
| Set desired movement speed to stopped
|-
| <code>Walk</code>
| <code>void Walk()</code>
| Set desired movement speed to walking
|}

=== LateBinder ===

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! 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%"
|- style="position:sticky; z-index:10; top:0"
! 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>
| 
|-
|}

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

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! 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>
| <code>subexpcount()</code>
| 
|}

== Data Types ==

=== Vector ===
Squirrel equivalent of the C++ [[Vector]] class. A three-dimensional vector with overloaded arithmetic operations for both Vectors and scalar values.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! 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>Vector 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.
{{tip|This can be used to quickly check if the vector is equal to 0 0 0, by checking if the magnitude is 0.}}
|-
| <code>Length2D</code>
| <code>float Length2D()</code>
| Returns the magnitude of the vector on the x-y plane.
|-
| <code>Length2DSqr</code>
| <code>float Length2DSqr()</code>
| Returns the square of the magnitude of the vector on the x-y plane.
|-
| <code>Norm</code>
| <code>float Norm()</code>
| Normalizes the vector in place and returns it's 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.
|-
| <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>
|rowspan="2"| <code>Vector</code>
|rowspan="2"| Returns the sum of both classes's members (XYZ).
|-
| <code>QAngle + Vector</code>
|-
| <code>Vector - Vector</code>
|rowspan="2"| <code>Vector</code>
|rowspan="2"| Returns the subtraction of both classes's members (XYZ).
|-
| <code>QAngle - Vector</code>
|-
| <code>Vector * integer</code>
|rowspan="2"| <code>Vector</code>
|rowspan="2"| Returns the multiplication of a Vector against a scalar.
|-
| <code>Vector * float</code>
|}

=== QAngle ===
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%"
|- style="position:sticky; z-index:10; top:0"
! 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>
| {{note|Returns the ''right'' Vector of the angles.}}
|-
| <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.
|-
| <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>
|rowspan="2"| <code>QAngle</code>
|rowspan="2"| Sum of both classes's members (XYZ). 
|-
| <code>Vector + QAngle</code>
|-
| <code>QAngle - QAngle</code>
|rowspan="2"| <code>QAngle</code>
|rowspan="2"| Subtraction of both classes's members (XYZ).
|-
| <code>Vector - QAngle</code>
|-
| <code>QAngle * int</code>
|rowspan="2"| <code>QAngle</code>
|rowspan="2"| QAngle multiplied by a number.
|-
| <code>QAngle * float</code>
|}


=== Vector2D, Vector4D ===
Two and four-dimensional equivalents to Vector.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>constructor</code>
| <code>Vector''X''D(float ''x'', float ''y'', ...)</code>
| Creates a new vector with the specified Cartesian coordiantes.
|-
| <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.
|}


=== Quaternion ===
[http://en.wikipedia.org/wiki/Quaternion Quaternion] represents rotations in three-dimensional space.

==== Methods ====
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>constructor</code>
| <code>Quaternion()</code>
| Creates a new identity quaternion.
|-
| <code>constructor</code>
| <code>Quaternion(float ''x'',float ''y'',float ''z'',float ''w'')</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>float Norm()</code>
| Normalizes the quaternion. 
|-
| <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 ====
{{todo|Descriptions of the operations are lacking details.}}

{| 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 * integer</code>
|rowspan="2"| <code>Quaternion</code>
|rowspan="2"| Quaternion multiplied by a number.
|-
| <code>Quaternion * float</code>
|}

== Globals ==

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>AddThinkToEnt</code>
| <code>void AddThinkToEnt(handle ''entity'', string ''FuncName'')</code>
| Sets a function in the entity's script to rerun by itself constantly. Pass null as the function name to remove a think function. The default think interval is 0.1s, unless overridden by returning a different time interval in seconds in the think function. TF2 runs at 66 ticks per second, so the lowest possible interval is 0.015 seconds.
{{tip|Return -1 to think every tick. Do not return 0 or 0.015, this will give inconsistent intervals. {{confirm|This issue has only been observed on players}}}}
{{note|If trying to clear a think function while inside a think function, <code>AddThinkToEnt</code> will not work as the think function is restored on the entity after it's finished. <br><code>NetProps.SetPropString(self, "m_iszScriptThinkFunction", "")</code> must be used to remove the think function.
{{warning|This can apply to events if they are chained from a think function, for example killing a player with <code>TakeDamage</code> and then trying to clear the think function in <code>player_death</code> event. The think function will not be cleared unless the line above is also added.}}}}
{{note|Some entities are sensitive to when this think function executes within a frame. A notable example is modifying the [[tf_player_manager]] entity. The think function must be applied to the manager entity for netprop changes to work correctly, and not any other entity, otherwise modifying its properties will be inconsistent.}}
{{bug|The think function name stored in the entity is not reset if null is passed as the function name. However this is harmless, and it will only show a warning in console.}}
|-
| <code>AddToScriptHelp</code>
| <code>AddToScriptHelp()</code>
| 
|-
| <code>AllowThirdPersonCamera</code>
| <code>bool AllowThirdPersonCamera()</code>
| 
|-
| <code>ArePlayersInHell</code>
| <code>bool ArePlayersInHell()</code>
| 
|-
| <code>Assert</code>
| <code>void Assert(bool ''value'', string ''optional message'')</code>
| Test value and if not true, throws exception, optionally with message.
|-
| <code>ClearGameEventCallbacks</code>
| <code>void ClearGameEventCallbacks()</code>
| Empties the tables of game event callback functions.
{{deprecated|'''Do NOT use this!''' It removes all events, including those from other scripts, and is a common source of script conflicts. Instead, update your event code to use a namespace (define and contain your callback functions inside of a table), which will clean up automatically when this table is removed without interfering with other scripts. Refer to the [[Team_Fortress_2/Scripting/VScript_Examples#Listening_for_Events|examples page]] for guidance on how to set an automatic system for this.}}
|-
| <code>CreateProp</code>
| <code>handle CreateProp(string ''classname'', Vector ''origin'', string ''model_name'', int ''activity'')</code>
| Create a prop
|-
| <code>CreateSceneEntity</code>
| <code>handle CreateSceneEntity(string ''scene'')</code>
| Create a scene entity to play the specified scene.
|-
| <code>developer</code>
| <code>int developer()</code>
| The current level of the <code>developer</code> console variable.
|-
| <code>DispatchParticleEffect</code>
| <code>void DispatchParticleEffect(string ''name'', Vector ''origin'', Vector ''direction'')</code>
| Dispatches a one-off particle system. To pass angles into this, use the <code>.Forward()</code> method on a QAngle.
{{note|For more control over particles such as parenting them to entities, see the [[Team_Fortress_2/Scripting/VScript_Examples#Spawning_a_Particle|examples page]] for alternative methods.}}
{{warning|This does not precache custom particles. As a result, custom particles may show as a burst of red Xs instead on dedicated servers. To precache a particle, use the following function:
{{ExpandBox|<source lang=js>
function PrecacheParticle(name)
{
    PrecacheEntityFromTable({ classname = "info_particle_system", effect_name = name })
}
</source>}}
}}
|-
| <code>Document</code>
| <code>void Document(unknown ''symbolOrTable'', unknown ''itemIfSymbol'' = null, string ''descriptionIfSymbol'' = null)</code>
|-
| <code>DoEntFire</code>
| <code>void DoEntFire(string ''target'', string ''action'', string ''value'', float ''delay'', handle ''activator'', handle ''caller'')</code>
| Generate an entity I/O event. The ''caller'' and ''activator'' argument takes a ''CBaseEntity'' script handle, and entities assigned can receive inputs with ''target'' set to ''!self'', or ''!activator'' / ''!caller''. Negative delays are clamped to 0.
{{note|Does not work if the ''target'' string is <code>point_servercommand</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''</code>parameter. The file must have the <code>.nut</code> extension.
{{warning|Do not put uppercase letters in the path, doing so will cause Linux to fail loading the script from loose directories.}}
|-
| <code>IncludeScript</code>
| <code>bool IncludeScript(string ''file'', handle ''scope'' = null)</code>
| Wrapper for DoIncludeScript.
|-
| <code>EmitAmbientSoundOn</code>
| <code>void EmitAmbientSoundOn(string ''soundName'', float ''volume'', int ''soundlevel'', int ''pitch'', handle ''entity'')</code>
| Play named sound on an entity using configurations similar to [[ambient_generic]]. Soundlevel is in decibels, see [[Soundscripts#SoundLevel|this page]] for real world equivalents.
{{tip|Sounds may be hard to hear even at full volume. Naming custom sounds according to the [[soundmixer]] can be used to make them naturally louder.}}
{{tip|To convert radius in Hammer units to decibels (similar to [[ambient_generic]]), use the following formula:
<source lang=js>
local soundlevel = (40 + (20 * log10(radius / 36.0))).tointeger()
</source>
}}
|-
| <code>StopAmbientSoundOn</code>
| <code>void StopAmbientSoundOn(string ''soundName'', handle ''entity'')</code>
| Stop named sound on an entity using configurations similar to [[ambient_generic]].
|-
| <code>[[Team Fortress 2/Scripting/Script Functions/EmitSoundEx|EmitSoundEx]]</code>
| <code>void EmitSoundEx(handle ''table'')</code>
| Play a sound. Takes in a script table of params: <code>sound_name</code>, <code>channel</code>, <code>volume</code>, <code>sound_level</code>, <code>flags</code>, <code>pitch</code>, <code>special_dsp</code>, <code>origin</code>, <code>delay</code>, <code>sound_time</code>, <code>entity</code>, <code>speaker_entity</code>, <code>filter_type</code>, <code>filter_param</code>. All parameters are optional except ''sound_name''. See the [[Team Fortress 2/Scripting/Script Functions/EmitSoundEx|main page]] for more details.
|-
| <code>EmitSoundOn</code>
| <code>void EmitSoundOn(string ''soundScript'', handle ''entity'')</code>
| Play named sound on given entity. The sound must be precached first for it to play (using <code>PrecacheSound</code> or <code>PrecacheScriptSound</code>).
{{warning|Looping sounds will not stop on the entity when it's destroyed and will persist forever! To workaround this, run <code>StopSound</code> in the <code>OnDestroy</code> callback.}}
|-
| <code>StopSoundOn</code>
| <code>void StopSoundOn(string ''soundScript'', handle ''entity'')</code>
| Stop named sound on an entity.
|-
| <code>EmitSoundOnClient</code>
| <code>void EmitSoundOnClient(string ''soundScript'', handle ''player'')</code>
| Play named sound only on the client for the specified player. The sound must be precached first for it to play (<code>PrecacheScriptSound</code>).
{{note|This only supports soundscripts.}}
|-
| <code>EntFire</code>
| <code>void EntFire(string ''target'', string ''action'', string ''value = null'', float ''delay = 0'', handle ''activator = null'')</code>
| Wrapper for DoEntFire() that sets<code>''activator''</code> to null, but has no<code>''caller''</code>param. Negative delays are clamped to 0.
{{note|Does not work if the ''target'' string is <code>point_servercommand</code>.}}
|-
| <code>EntFireByHandle</code>
| <code>void EntFireByHandle(handle ''entity'', string ''action'', string ''value'', float ''delay'', handle ''activator'', handle ''caller'')</code>
| Generate an entity I/O event. First parameter is an entity instance. Negative delays are clamped to 0.
{{note|With a 0 delay, this will be processed at the end of the frame rather than instantly. If you need an instant, synchronous I/O event then use <code>AcceptInput</code> instead.}}
|-
| <code>EntIndexToHScript</code>
| <code>handle EntIndexToHScript(int ''entIndex'')</code>
| Turn an entity index integer to an HScript representing that entity's script instance.
|-
| <code>FileToString</code>
| <code>string FileToString(string ''file'')</code>
| Reads a string from file located in the game's ''scriptdata'' folder. Returns the string from the file, null if no file or file is greater than 16384 bytes.
{{note|Files packed inside the [[BSP]] cannot be read.}}
{{note|This opens files in text mode, therefore binary files will not be parsed correctly.}}
|-
| <code>FindCircularReference</code>
| <code>FindCircularReference()</code>
| 
|-
| <code>FindCircularReferences</code>
| <code>FindCircularReferences()</code>
| 
|-
| <code>FireGameEvent</code>
| <code>bool FireGameEvent(string ''name'', handle ''table'')</code>
| Fire a game event to a listening callback function in script. Parameters are passed in a squirrel table.
{{note|The name might be misleading. This does not fire an event that the game will pick up, the function that sends a real game event is named <code>SendGlobalGameEvent</code>.}}
|-
| <code>FireScriptHook</code>
| <code>bool FireScriptHook(string ''name'', handle ''table'')</code>
| Fire a script hook to a listening callback function in script. Parameters are passed in a squirrel table.
|-
| <code>FireScriptEvent</code>
| <code>void FireScriptEvent(string ''event'', table ''params'')</code>
| Wrapper for <code>__RunEventCallbacks()</code>
|-
| <code>ForceEnableUpgrades</code>
| <code>void ForceEnableUpgrades(int ''state'')</code>
| Whether to force on MvM-styled upgrades on/off. 0 -> default, 1 -> force off, 2 -> force on
|-
| <code>ForceEscortPushLogic</code>
| <code>void ForceEscortPushLogic(int ''state'')</code>
| Forces payload pushing logic. 0 -> default, 1 -> force off, 2 -> force on
|-
| <code>FlagsMayBeCapped</code>
| <code>bool FlagsMayBeCapped()</code>
| May a flag be captured?
|-
| <code>FrameTime</code>
| <code>float FrameTime()</code>
| Get the time spent on the server in the last frame. Usually this will be 0.015 (the default tickrate)
|-
| <code>GameModeUsesCurrency</code>
| <code>bool GameModeUsesCurrency()</code>
| Does the current gamemode have currency?
|-
| <code>GameModeUsesMiniBosses</code>
| <code>bool GameModeUsesMiniBosses()</code>
| Does the current gamemode have minibosses?
|-
| <code>GameModeUsesUpgrades</code>
| <code>bool GameModeUsesUpgrades()</code>
| Does the current gamemode have upgrades?
|-
| <code>GetClassLimit</code>
| <code>int GetClassLimit(int ''class'')</code>
| Get class limit for class. See [[Team_Fortress_2/Scripting/Script_Functions/Constants#ETFClass|Constants.ETFClass]].
|-
| <code>GetDeveloperLevel</code>
| <code>int GetDeveloperLevel()</code>
| Gets the level of 'developer'
|-
| <code>GetFrameCount</code>
| <code>int GetFrameCount()</code>
| Returns the engines current frame count. The counter does not reset between map changes. This is NOT the tick count.
{{tip|To get the current tick count, read the <code>m_nSimulationTick</code> netprop from any player or moving entity.}}
|-
| <code>GetFriction</code>
| <code>float GetFriction(handle ''player'')</code>
| Returns the Friction on a player entity, meaningless if not a player
|-
| <code>GetFunctionSignature</code>
| <code>string GetFunctionSignature(function ''func'', string ''prefix'')</code>
| 
|-
| <code>GetGravityMultiplier</code>
| <code>float GetGravityMultiplier()</code>
| 
|-
| <code>GetListenServerHost</code>
| <code>handle GetListenServerHost()</code>
| Get the local player on a listen server. Returns null on dedicated servers.
{{note|This depends on the player entity, and therefore this might return null on a listen server if the player doesn't exist yet during map load. Use <code>IsDedicatedServer</code> instead to check if the server is a listen or dedicated server, as it checks it in a different way.}}
{{tip|Alternatively, use <code>PlayerInstanceFromIndex(1)</code> to fetch the first player on the server. For convenience sake (e.g. for script compatibility), you can map this to that function using the following:
<source lang=js>
::GetListenServerHost <- @() PlayerInstanceFromIndex(1)
</source>}}
|-
| <code>GetMannVsMachineAlarmStatus</code>
| <code>bool GetMannVsMachineAlarmStatus()</code>
| 
|-
| <code>GetMapName</code>
| <code>string GetMapName()</code>
| Get the name of the map without extension, e.g. <code>ctf_2fort</code>. For workshop maps, this will be in the format <code>workshop/[name].ugc[id]</code>.
|-
| <code>GetModelIndex</code>
| <code>int GetModelIndex(string ''filename'')</code>
| Returns the index of the named model.
|-
| <code>GetOvertimeAllowedForCTF</code>
| <code>bool GetOvertimeAllowedForCTF()</code>
| 
|-
| <code>{{obs}} GetPhysAngularVelocity</code>
| <code>Vector GetPhysAngularVelocity(handle ''entity'')</code>
| Returns the Angular velocity of the entity.  Deprecated, use the <code>GetPhysAngularVelocity</code> method on the entity instead.
|-
| <code>{{obs}} GetPhysVelocity</code>
| <code>Vector GetPhysVelocity(handle ''entity'')</code>
| Returns the velocity of the entity. Deprecated, use the <code>GetPhysVelocity</code> method on the entity instead.
|-
| <code>GetPlayerFromUserID</code>
| <code>handle GetPlayerFromUserID(int ''userid'')</code>
| Given a user id, return the entity, or null.
{{note|The 'fake' [[SourceTV]] player will always be returned as null. If you need to actually retrieve the SourceTV player, use <code>EntIndexToHScript</code>.}}
{{tip|For the opposite, getting the user id from an entity, see the [[Team_Fortress_2/Scripting/VScript_Examples#Getting_the_userid_from_a_player_handle|examples page]].}}
|-
| <code>GetRoundState</code>
| <code>int GetRoundState()</code>
| Get current round state. See [[Team_Fortress_2/Scripting/Script_Functions/Constants#ERoundState|Constants.ERoundState]].
|-
| <code>GetSoundDuration</code>
| <code>float GetSoundDuration(string ''soundname'', string ''actormodelname'')</code>
| Returns float duration of the sound. Actor model name is optional and can be left null.
{{todo|Actor model name is likely a leftover from {{hl2|2}}}}
{{warning|Does not work on dedicated servers as they do not have audio libraries built-in to load sounds.}}
|-
| <code>GetStopWatchState</code>
| <code>int GetStopWatchState()</code>
| Get the current stopwatch state. See [[Team_Fortress_2/Scripting/Script_Functions/Constants#EStopwatchState|Constants.EStopwatchState]].
|-
| <code>GetWinningTeam</code>
| <code>int GetWinningTeam()</code>
| Who won!
|-
| <code>HaveStopWatchWinner</code>
| <code>bool HaveStopWatchWinner()</code>
| 
|-
| <code>InMatchStartCountdown</code>
| <code>bool InMatchStartCountdown()</code>
| Are we in the pre-match/setup state?
|-
| <code>InOvertime</code>
| <code>bool InOvertime()</code>
| Currently in overtime?
|-
| <code>IsAttackDefenseMode</code>
| <code>bool IsAttackDefenseMode()</code>
| 
|-
| <code>IsBirthday</code>
| <code>bool IsBirthday()</code>
| Are we in birthday mode?
|-
| <code>IsCompetitiveMode</code>
| <code>bool IsCompetitiveMode()</code>
| Playing competitive?
|-
| <code>IsDedicatedServer</code>
| <code>bool IsDedicatedServer()</code>
| Returns true if this server is a dedicated server.
|-
| <code>IsDefaultGameMode</code>
| <code>bool IsDefaultGameMode()</code>
| The absence of arena, mvm, tournament mode, etc
|-
| <code>IsHolidayActive</code>
| <code>bool IsHolidayActive(int ''holiday'')</code>
| Is the given holiday active? See [[Team_Fortress_2/Scripting/Script_Functions/Constants#EHoliday|Constants.EHoliday]].
|-
| <code>IsHolidayMap</code>
| <code>bool IsHolidayMap(int ''holiday'')</code>
| Playing a holiday map? See [[Team_Fortress_2/Scripting/Script_Functions/Constants#EHoliday|Constants.EHoliday]].
|-
| <code>IsInArenaMode</code>
| <code>bool IsInArenaMode()</code>
| Playing arena mode?
|-
| <code>IsInKothMode</code>
| <code>bool IsInKothMode()</code>
| Playing king of the hill mode?
|-
| <code>IsInMedievalMode</code>
| <code>bool IsInMedievalMode()</code>
| Playing medieval mode?
|-
| <code>IsInWaitingForPlayers</code>
| <code>bool IsInWaitingForPlayers()</code>
| Are we waiting for some stragglers?
|-
| <code>IsMannVsMachineMode</code>
| <code>bool IsMannVsMachineMode()</code>
| Playing MvM? Beep boop
|-
| <code>IsMannVsMachineRespecEnabled</code>
| <code>bool IsMannVsMachineRespecEnabled()</code>
| Are players allowed to refund their upgrades?
|-
| <code>IsMatchTypeCasual</code>
| <code>bool IsMatchTypeCasual()</code>
| Playing casual?
|-
| <code>IsMatchTypeCompetitive</code>
| <code>bool IsMatchTypeCompetitive()</code>
| Playing competitive?
|-
| <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>IsPasstimeMode</code>
| <code>bool IsPasstimeMode()</code>
| No ball games.
|-
| <code>IsPlayerABot</code>
| <code>bool IsPlayerABot(handle ''player'')</code>
| Is this player/entity a puppet or AI bot. To check if the player is a AI bot (<code>CTFBot</code>) specifically, use <code>IsBotOfType</code> instead.
|-
| <code>IsPowerupMode</code>
| <code>bool IsPowerupMode()</code>
| Playing powerup mode? Not compatible with MvM
|-
| <code>IsPVEModeActive</code>
| <code>bool IsPVEModeActive()</code>
| 
|-
| <code>IsQuickBuildTime</code>
| <code>bool IsQuickBuildTime()</code>
| If an engie places a building, will it immediately upgrade? Eg. MvM pre-round etc.
|-
| <code>IsTruceActive</code>
| <code>bool IsTruceActive()</code>
| 
|-
| <code>IsUsingGrapplingHook</code>
| <code>bool IsUsingGrapplingHook()</code>
| 
|-
| <code>IsUsingSpells</code>
| <code>bool IsUsingSpells()</code>
| 
|-
| <code>IsWeakref</code>
| <code>bool IsWeakref()</code>
| 
|-
| <code>LocalTime</code>
| <code>void LocalTime(table ''out'')</code>
| Fills out a table with the local time (second, minute, hour, day, month, year, dayofweek, dayofyear, daylightsavings). This mirrors the <code>tm</code> structure in C++, see the [https://cplusplus.com/reference/ctime/tm/ reference page] for more information.
|-
| <code>MakeNamespace</code>
| <code>MakeNamespace()</code>
| 
|-
| <code>MapHasMatchSummaryStage</code>
| <code>bool MapHasMatchSummaryStage()</code>
| 
|-
| <code>MatchmakingShouldUseStopwatchMode</code>
| <code>bool MatchmakingShouldUseStopwatchMode()</code>
| 
|-
| <code>MaxClients</code>
| <code>float MaxClients()</code>
| Get the current number of max clients set by the maxplayers command.
{{bug|The return value is mistakenly defined as a float. It is best to use <code>.tointeger()</code> after calling this.}}
|-
| <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.
{{note|Does nothing in {{tf2|2}} as the code is not implemented.}}
|-
| <code>PlayerInstanceFromIndex</code>
| <code>CBasePlayer PlayerInstanceFromIndex(int ''index'')</code>
| Get a script handle of a player using the player index. 
{{note|The 'fake' [[SourceTV]] player will always be returned as null. If you need to actually retrieve the SourceTV player, use <code>EntIndexToHScript</code>.}}
|-
| <code>PlayerReadyStatus_ArePlayersOnTeamReady</code>
| <code>bool PlayerReadyStatus_ArePlayersOnTeamReady(int ''team'')</code>
| 
|-
| <code>PlayerReadyStatus_HaveMinPlayersToEnable</code>
| <code>bool PlayerReadyStatus_HaveMinPlayersToEnable()</code>
| 
|-
| <code>PlayerReadyStatus_ResetState</code>
| <code>void PlayerReadyStatus_ResetState()</code>
| 
|-
| <code>PlayersAreOnMatchSummaryStage</code>
| <code>bool PlayersAreOnMatchSummaryStage()</code>
| 
|-
| <code>PointsMayBeCaptured</code>
| <code>bool PointsMayBeCaptured()</code>
| Are points able to be captured?
|-
| <code>PrecacheEntityFromTable</code>
| <code>bool PrecacheEntityFromTable(table ''keyvalues'')</code>
| Precache an entity from [[KeyValues]] in a table. Internally this function creates the entity, fire <code>DispatchSpawn</code> and removes it instantly. Returns false if the table has no ''classname'' key, if the value of ''classname'' is null or empty, or if the entity failed to be created.
{{tip|Can be used  to precache gibs for a model on any entity by using [[tf_generic_bomb]]. Example: <source>PrecacheEntityFromTable({ classname = "tf_generic_bomb", model = MODEL_NAME })</source>}}
|-
| <code>PrecacheModel</code>
| <code>int PrecacheModel(string ''filename'')</code>
| Precache a model (<code>.mdl</code>) or sprite (<code>.vmt</code>) and return model index. The extension must be specified. Returns -1 if null or empty filename is passed in. Missing models/sprites will still return a new index.
{{note|Does not precache gibs. See <code>PrecacheEntityFromTable</code> instead.}}
|-
| <code>PrecacheScriptSound</code>
| <code>bool PrecacheScriptSound(string ''soundName'')</code>
| Precache a soundscript. Returns false if soundscript is missing, or if a null or empty sound name is passed in.
|-
| <code>PrecacheSound</code>
| <code>bool PrecacheSound(string ''soundName'')</code>
| Precache a raw sound. Returns false if a null or empty sound name is passed in.
|-
| <code>PrintHelp</code>
| <code>void PrintHelp()</code>
| Equivalent to running <code>script_help</code> command.
|-
| <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>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()</code> uses to register event callbacks to the C++ code.
{{note|This cannot be used to register non-existent game events.}}
|-
| <code>RegisterScriptHookListener</code>
| <code>void RegisterScriptHookListener(string ''name'')</code>
| Register as a listener for a script hook from script.
|-
| <code>RetrieveNativeSignature</code>
| <code>string RetrieveNativeSignature(function ''func'')</code>
| 
|-
| <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.
{{bug|This is not calculated correctly and the rotation will always be relative to (0, 0, 0). As a workaround, subtract the origin from the input, call this function and then add the origin back which will perform the expected result.}}
|-
| <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 customisable screenfade. If no player is specified, the fade will apply to all players. For a list of flags, see [[Team_Fortress_2/Scripting/Script_Functions/Constants#FFADE|FFADE]] constants.
|-
| <code>ScreenShake</code>
| <code>void ScreenShake(Vector ''vecCenter'', float ''flAmplitude'', float ''flFrequency'', float ''flDuration'', float ''flRadius'', int ''eCommand'', bool ''bAirShake'')</code>
| Start a customisable screenshake. Set ''eCommand'' to 0 to start a shake, or 1 to stop an existing shake.
|-
| <code>ScriptHooksEnabled</code>
| <code>bool ScriptHooksEnabled()</code>
| Returns whether script hooks are currently enabled.
|-
| <code>SendGlobalGameEvent</code>
| <code>bool SendGlobalGameEvent(string ''event_name'', handle ''params'')</code>
| Sends a real game event to everything. Parameters are passed in a squirrel table.
{{warning|Certain events that are usually clientside only will not work when fired by this function, with an error complaining that "no listeners are registered for this event". However, defining an empty event listener will make it work.}}
{{warning|Events that upload statistics to Steam servers such as <code>player_escort_score</code> can take as long as 1 millisecond to execute! This can be prevented by temporarily giving the player the <code>FL_FAKECLIENT</code> flag and reverting it afterwards (however be careful not to revert it on actual bots!).
Example:
{{ExpandBox|<source lang=js>
local is_bot = player.IsFakeClient()
if (!is_bot) player.AddFlag(Constants.FPlayer.FL_FAKECLIENT)

SendGlobalGameEvent("player_escort_score", 
{
    player = player.entindex(),
    points = 1
})

if (!is_bot) player.RemoveFlag(Constants.FPlayer.FL_FAKECLIENT)
</source>
}}}}
|-
| <code>SendToConsole</code>
| <code>void SendToConsole(string ''command'')</code>
| Issues a command to the local client, as if they typed in the command in their console. Does nothing on dedicated servers.
|-
| <code>SendToServerConsole</code>
| <code>void SendToServerConsole(string ''command'')</code>
| Issues a command to the server, as if typed in the console.
{{note|This obeys the behavior of the <code>sv_allow_point_servercommand</code> convar. By default, this command will do nothing unless the server has this command to set to "always"}}
|-
| <code>SendToConsoleServer</code>
| <code>void SendToConsoleServer(string ''command'')</code>
| Copy of SendToServerConsole with another name for compat.
|-
| <code>SetFakeClientConVarValue</code>
| <code>void SetFakeClientConVarValue(handle ''bot'', string ''cvar'', string ''value'')</code>
| Sets a USERINFO client ConVar for a fakeclient.
{{tip|This can be used to change the name of a bot by using the <code>name</code> cvar.}}
|-
| <code>SetGravityMultiplier</code>
| <code>void SetGravityMultiplier(float ''multiplier'')</code>
| 
|-
| <code>SetMannVsMachineAlarmStatus</code>
| <code>void SetMannVsMachineAlarmStatus(bool ''status'')</code>
| 
|-
| <code>SetOvertimeAllowedForCTF</code>
| <code>void SetOvertimeAllowedForCTF(bool ''state'')</code>
| 
|-
| <code>SetPlayersInHell</code>
| <code>void SetPlayersInHell(bool ''state'')</code>
| 
|-
| <code>SetSkyboxTexture</code>
| <code>void SetSkyboxTexture(string ''texture'')</code>
| Sets the current skybox texture. The path is relative to "materials/skybox/". Only the main name of a skybox texture is needed, for example "sky_gravel_01".
|-
| <code>SetUsingSpells</code>
| <code>void SetUsingSpells(bool ''state'')</code>
| 
|-
| <code>SpawnEntityFromTable</code>
| <code>handle SpawnEntityFromTable(string ''name'', handle ''keyvalues'')</code>
| Spawn entity from KeyValues in table - 'name' is entity name, rest are KeyValues for spawn.
{{note|Multiple keys of the same name can be specified by appending the key with an incremental #x suffix.}}
{{note|<code>parentname</code> is not resolved and therefore will not work. Instead, fire <code>AcceptInput</code> after spawning (with <code>SetParent !activator</code> parameters), or use <code>SpawnEntityGroupFromTable</code>.}}
{{tip|If spawning multiple entities at once, use <code>SpawnEntityGroupFromTable</code> as it will be more efficient.}}
Example:
{{ExpandBox|<source lang=js>
SpawnEntityFromTable("logic_timer", {
    targetname = "cool"
    RefireTime = 60
    "OnTimer#1" : "entity,Trigger,,0,-1"
    "OnTimer#2" : "somethingelse,Disable,,0,-1"
})
</source>
}}
{{warning|If using commas inside the parameter field of a output key, it will not be parsed correctly as the comma will be treated as delimiter.
To fix this, an special delimiter also supported by the game can be used named 'ESC'. This cannot be typed on a keyboard normally, and must be copied from another source. The easiest way is to [https://pastebin.com/raw/TaJ7pnVC open this link], and copy + paste the character in a supporting editor such as Notepad++.<br>
Example (the character will not display correctly on this page):<br><code>"OnTrigger#5": "res,RunScriptCode,NetProps.SetPropString(self, `m_iszMvMPopfileName`, `test`),0,-1"</code><br>would instead be changed to<br>
<code>"OnTrigger#5": "res�RunScriptCode�NetProps.SetPropString(self, `m_iszMvMPopfileName`, `test`)�0�-1"</code>}}
{{note|If using a complex model, usually custom models, it might cause stutters to the server when spawning it. To work around this issue instead spawn it with <code>CreateByClassname</code> and set its netprops manually, and don't forget to make sure the model is precached properly too.}}
|-
| <code>SpawnEntityGroupFromTable</code>
| <code>bool SpawnEntityGroupFromTable(handle ''groups'')</code>
| Hierarchically spawn an entity group from a set of spawn tables. This computes a spawn order for entities so that parenting is resolved correctly.
The table for this must take the following format. <code>group</code> can be any name, as long as it's unique. Each group can only contain one entity. (The table is formatted like this as otherwise it wouldn't be possible to spawn multiple entities of the same classname). The function always returns true, even if entity spawning fails.
<source lang=js>
{
	<group> =
	{
		<classname> =
		{
			// key - values
		}
	},
	// ...
}
</source>
Example usage:
{{ExpandBox|<source lang=js>
SpawnEntityGroupFromTable(
{
	a =
	{
		info_particle_system =
		{
			origin = GetListenServerHost().GetOrigin(),
			parentname = "mytarget",
			effect_name = "soldierbuff_blue_soldier",
			start_active = true		
		}
	},
	b =
	{
		info_particle_system =
		{
			origin = GetListenServerHost().GetOrigin(),
			parentname = "mytarget",
			effect_name = "soldierbuff_red_soldier",
			start_active = true		
		}
	},
})
</source>
}}
{{Note|You will need to hijack an unused string netprop and set the bounding box data for brush entities there, then run a script on the entity to parse it. Example: {{ExpandBox|

Make a script file named "make_brush.nut" that contains the following:
<source lang=js>
function OnPostSpawn()
{
    local buf = split(NetProps.GetPropString(self, "m_iszResponseContext"), " ")
    self.SetSize(Vector(buf[0], buf[1], buf[2]), Vector(buf[3], buf[4], buf[5]))
    self.SetSolid(2)
}
</source>

Now you can set the min/max bounding box values for a brush ent directly in the ent key/values like so:
<source lang=js>
SpawnEntityGroupFromTable({
	[0] = {
		func_rotating =
		{
			message = "hl1/ambience/labdrone2.wav",
			responsecontext = "-1 -1 -1 1 1 1",
			vscripts = "make_brush",
			volume = 8,
			targetname = "crystal_spin",
			spawnflags = 65,
			solidbsp = 0,
			rendermode = 10,
			rendercolor = "255 255 255",
			renderamt = 255,
			maxspeed = 48,
			fanfriction = 20,
			angles = QAngle(),
			origin = Vector(),
		}
	},
	[1] = {
		trigger_multiple =
		{
			targetname = "trigger1",
			responsecontext = "-250 -250 -250 250 250 250",
			vscripts = "make_brush",
			parentname = "crystal_spin",
			spawnflags = 1,
			"OnStartTouchAll#1": "!activator�RunScriptCode�ClientPrint(self, 3, `I am in trigger1`)�0�-1",
		}
	},
	[2] = {
		prop_dynamic =
		{
			targetname = "crystal",
			solid = 6,
			renderfx = 15,
			rendercolor = "255 255 255",
			renderamt = 255,
			physdamagescale = 1.0,
			parentname = "crystal_spin",
			modelscale = 1.3,
			model = "models/props_moonbase/moon_gravel_crystal_blue.mdl",
			MinAnimTime = 5,
			MaxAnimTime = 10,
			fadescale = 1.0,
			fademindist = -1.0,
			origin = Vector(),
			angles = QAngle(45, 0, 0)
		}
	},
})
</source>
}}}}  
{{tip|If a list of entity handles created from this function is needed, there is two workarounds:
*1 - Assign a <code>vscripts</code> file that appends <code>this</code> to a global array.
*2 - Use a <code>point_script_template</code>, see the [[#CPointScriptTemplate|spawn hook example ↑]].}}
|-
| <code>StringToFile</code>
| <code>void StringToFile(string ''file'', string ''string'')</code>
| Stores a string as a file, located in the game's ''scriptdata'' folder.
{{warning|Since this writes to the disk, the performance will vary depending on the hardware (i.e. HDD or SSD). This function should only be called at checkpoints such as round restart or before level change, and not during gameplay to prevent hitches.}}
{{warning|This writes files in text mode, therefore binary files will not be written correctly. As another consequence, if writing multi-line strings directly, this may cause issues due to Window's encoding new lines as \r\n, but Mac/Linux encodes as \n. This can be fixed by setting EOL (end-of-line) encoding to ''Unix'' or ''CR'' in your text editor.}}
{{bug|A single NULL byte will always be appended to the end of the file}}
|-
| <code>Time</code>
| <code>float Time()</code>
| Get the current time since map load in seconds. The time resets on map change.
|-
| <code>TraceLine</code>
| <code>float TraceLine(Vector ''start'', Vector ''end'', handle ''ignore'')</code>
| Trace a ray. Return fraction along line that hits world or models. Optionally, ignore the specified entity.
{{tip|Specify the same start and end point to check whether a point is inside solid geometry/out of bounds.}}
|-
| <code>[[Team Fortress 2/Scripting/Script Functions/TraceLineEx|TraceLineEx]]</code>
| <code>bool TraceLineEx(table ''traceTable'')</code>
| Extended version of <code>TraceLine</code>. See the [[Team Fortress 2/Scripting/Script Functions/TraceLineEx|main page]] for more details.
|-
| <code>TraceLinePlayersIncluded</code>
| <code>float TraceLinePlayersIncluded(Vector, Vector, handle)</code>
| Different version of <code>TraceLine</code> that also hits players and NPCs.
|-
| <code>[[Team Fortress 2/Scripting/Script Functions/TraceHull|TraceHull]]</code>
| <code>bool TraceHull(table ''traceTable'')</code>
| Trace a [[Bounding_box|box (AABB)]]. See the [[Team Fortress 2/Scripting/Script Functions/TraceHull|main page]] for more details.
|-
| <code>UniqueString</code>
| <code>string UniqueString(string ''suffix'' = "")</code>
| Generate a string guaranteed to be unique across the life of the script VM, with an optional suffix. Useful for adding data to tables when not sure what keys are already in use in that table.
The format of the string is <code>_%x%llx_%s</code>, with arguments as follows: random number between 0 and 4095, an incrementing 64-bit counter, and ''suffix''.
|-
| <code>DoUniqueString</code>
| <code>string DoUniqueString(string ''suffix'')</code>
| Internal function called by <code>UniqueString</code>
|-
| <code>UsePlayerReadyStatusMode</code>
| <code>bool UsePlayerReadyStatusMode()</code>
| 
|-
| <code>VSquirrel_OnCreateScope</code>
| <code>table VSquirrel_OnCreateScope(any ''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>__CollectEventCallbacks</code>
| <code>void __CollectEventCallbacks(scope, prefix, globalTableName, regFunc)</code>
| Overloaded function. Its only used for this: <code>__CollectEventCallbacks(scope, "OnGameEvent_", "GameEventCallbacks", ::RegisterScriptGameEventListener)</code>
|-
| <code>__CollectGameEventCallbacks</code>
| <code>void __CollectGameEventCallbacks(table ''scope'')</code>
| Wrapper that registers callbacks for both [[#Hooks|OnGameEvent_''x'' ↑]] and <code>OnScriptEvent_</code> functions. Done using the <code>__CollectEventCallbacks</code> function.
|-
| <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()</code>
|-
| <code>__RunScriptHookCallbacks</code>
| <code>void __RunScriptHookCallbacks(event, param)</code>
|
|}

=== Printing and Drawing ===
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>ClientPrint</code>
| <code>void ClientPrint(CBasePlayer ''player'', [[Team_Fortress_2/Scripting/Script_Functions/Constants#EHudNotify|EHudNotify]] ''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.
When printing to chat (''HUD_PRINTTALK''), the color of the text can be changed with certain hex codes:
* <code>\x01</code> - Default chat color
* <code>\x03</code> - Lime
* <code>\x04</code> - Green
* <code>\x05</code> - Olive
* <code>\x06</code> - Black
* <code>\x07</code> - custom color in hexadecimal RRGGBB format. Example: <code>\x07FF3F3F</code>
* <code>\x08</code> - custom color in hexadecimal RRGGBBAA format (i.e. with transparency). Example: <code>\x08FF3F3FCC</code>
Chat messages can contain multiple of these codes. If using color sequences, there MUST be a color sequence at the beginning of the string, or color codes won't work!. 
{{warning|{{hammer}} Will not accept these escape sequences.  As a result, you cannot print colored text with a simple RunScriptCode input. {{workaround|See the [[TF2 VScript Examples|VScript Examples]] page for a workaround that replaces a normal character with <code>\x07</code> at run-time}}}}
{{tip|Standard chat colors:
* Default: <code>FBECCB</code>
* RED: <code>FF3F3F</code>
* BLUE: <code>99CCFF</code>
* Unassigned/spectator: <code>CCCCCC</code>}}
|-
| <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>__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>DumpObject</code>
| <code>void DumpObject(handle ''object'')</code>
| Dumps information about a class or instance.
|-
| <code>Msg</code>
| <code>void Msg(string ''message'')</code>
| Prints message to console without any line feed after.
|-
| <code>printf</code>
| <code>void printf(string ''format'', args...)</code>
| Prints message to console with C style formatting. The line feed is not included.
|-
| <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>Say</code>
| <code>void Say(CBasePlayer ''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>ShowMessage</code>
| <code>void ShowMessage(string ''message'')</code>
| Displays a HUD message defined in <code>scripts/titles.txt</code> to all clients, similar to an [[env_message]] entity.
|}

=== Squirrel Standard Library ===

{{sq}} Functions of both Squirrel's [https://web.archive.org/web/20131225032439/http://www.squirrel-lang.org/doc/squirrel3.html#d0e2358 built-in functions] and [https://web.archive.org/web/20131225032319/http://www.squirrel-lang.org/doc/sqstdlib3.html standard library].

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>array</code>
| <code>array(int ''length'', any ''fill'' = null)</code>
| Returns a new array of the given length where each element is set to <tt>''fill''</tt> (<tt>null</tt> by default).
|-
| <code>assert</code>
| <code>assert(bool ''exp'')</code>
| Throws an assertion error if the given expression evaluates to <code>false</code> (i.e. the values <tt>0, 0.0, null</tt> and <tt>false</tt>)
|-
| <code>callee</code>
| <code>function callee()</code>
| Returns the currently running closure.
|-
| <code>castf2i</code>
| <code>int castf2i(float ''value'')</code>
| Interprets the float's bytes as if it were a 32-bit integer representation
{{warning|This is a '''bit''' reinterpretation, i.e. 1.0 will not result in 1, it will be 1065353216! Use the <code>tointeger()</code> method for an actual conversion.}}
|-
| <code>casti2f</code>
| <code>float casti2f(int ''value'')</code>
| Interprets the integer's bytes as if it were a floating-point encoding
{{warning|This is a '''bit''' reinterpretation, i.e. 420 will not result in 420.0, it will be 5.88545e^-43! Use the <code>tofloat()</code> method for an actual conversion.}}
|-
| <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>any compilestring(string ''string'', string ''buffername'' = null)</code>
| Compiles a string containing a squirrel script into a function and returns it.
|-
| <code>dummy</code>
| <code>dummy()</code>
| 
|-
| <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|
{{pre|
{
	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"
	}
}
}}}}
|-
| <code>newthread</code>
| <code>coroutine newthread(function ''threadfunc'')</code>
| Creates a new cooperative thread object(coroutine) and returns it .
|-
| <code>print</code>
| <code>print(string ''message'')</code>
| Prints the given parameter but with no newline unlike <code>printl()</code>
|-
| <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>setdebughook</code>
| <code>void setdebughook(function ''hook_func'')</code>
| Sets the debug hook.
|-
| <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>swap2</code>
| <code>int swap2(int ''value'')</code>
| Swaps bytes 1 and 2 of the integer
|-
| <code>swap4</code>
| <code>int swap4(int ''value'')</code>
| Reverse byte order of the four bytes
|-
| <code>swapfloat</code>
| <code>float swapfloat(float ''value'')</code>
| Reverse byte order of the four bytes
|-
| <code>type</code>
| <code>type(var)</code>
| Returns var._typeof(), i.e. the type of the given parameter as a string
|}

==== Blob ====
A blob stores a block of binary data. See [https://developer.electricimp.com/squirrel/blob official documentation] for more information.
{{note|Each blob is restricted to a maximum size of 16 megabytes. Blobs are also limited to 32 megabytes total at any given time.}}

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>blob</code>
| <code>blob(int ''initSize'' = 0)</code>
| 
|-
| <code>eos</code>
| <code>int eos()</code>
| 
|-
| <code>flush</code>
| <code>flush()</code>
| 
|-
| <code>len</code>
| <code>int len()</code>
| 
|-
| <code>readblob</code>
| <code>blob readblob(int ''numberOfBytes'')</code>
| 
|-
| <code>readn</code>
| <code>any readn(char ''dataType'')</code>
| 
|-
| <code>resize</code>
| <code>void resize(int ''newSize'')</code>
| 
|-
| <code>seek</code>
| <code>int seek(int ''offset'', int ''offsetBasis'')</code>
| 
|-
| <code>swap2</code>
| <code>void swap2()</code>
| 
|-
| <code>swap4</code>
| <code>void swap4()</code>
| 
|-
| <code>tell</code>
| <code>int tell()</code>
| 
|-
| <code>writeblob</code>
| <code>void writeblob(blob ''blob'')</code>
| 
|-
| <code>writen</code>
| <code>void writen(num ''value'', char ''dataType'')</code>
| 
|}

==== Math ====

{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>abs</code>
| <code>abs(num ''x'')</code>
| Returns <nowiki>|x|</nowiki> as integer unlike <code>fabs()</code>
|-
| <code>acos</code>
| <code>acos(num ''x'')</code>
| Returns cos<sup>-1</sup>(x), -1 ≤ x ≤ 1
|-
| <code>asin</code>
| <code>asin(num ''x'')</code>
| Returns sin<sup>-1</sup>(x), -1 ≤ x ≤ 1
|-
| <code>atan</code>
| <code>atan(num ''x'')</code>
| Returns tan<sup>-1</sup>(x)
|-
| <code>atan2</code>
| <code>atan2(num ''y'', num ''x'')</code> (!)
| Returns the angle between the ray from the point (0, 0) through (x, y) and the positive x-axis, confined to (−PI, PI], See also [[w:atan2|atan2]]. Note the order of the parameters x and y!]
|-
| <code>ceil</code>
| <code>ceil(num ''x'')</code>
| Returns the smallest integer that is ≥ x
|-
| <code>cos</code>
| <code>cos(num ''x'')</code>
| Returns cos(x)
|-
| <code>exp</code>
| <code>exp(num ''x'')</code>
| Returns exp(x) = e<sup>x</sup>
|-
| <code>fabs</code>
| <code>fabs(num ''x'')</code>
| Returns <nowiki>|x|</nowiki> as float unlike <code>abs()</code>
|-
| <code>floor</code>
| <code>floor(num ''x'')</code>
| Returns the largest integer that is ≤ x
|-
| <code>log</code>
| <code>log(num ''x'')</code>
| Returns log<sub>e</sub>(x) = ln(x)
|-
| <code>log10</code>
| <code>log10(num ''x'')</code>
| Returns log<sub>10</sub>(x)
|-
| <code>pow</code>
| <code>pow(num ''x'', num ''y'')</code>
| Returns x<sup>y</sup>
|-
| <code>rand</code>
| <code>rand()</code>
| Returns a random integer with <code>0 &le; rand() &le; RAND_MAX</code>
{{warning|The value of <code>RAND_MAX</code> is 32768 on Windows, but 2147483647 on Linux. This can cause undeterministic behavior between a server running on Windows vs Linux even if the same seed is used with <code>srand</code>. If determinism is needed, [https://learn.microsoft.com/en-us/archive/msdn-magazine/2016/august/test-run-lightweight-random-number-generation roll your own random number generator].}}
|-
| <code>sin</code>
| <code>sin(num ''x'')</code>
| Returns sin(x)
|-
| <code>sqrt</code>
| <code>sqrt(num ''x'')</code>
| Returns the square root of x
|-
| <code>srand</code>
| <code>srand(num ''seed'')</code>
| Sets the starting point for generating a series of pseudorandom integers
|-
| <code>tan</code>
| <code>tan(num ''x'')</code>
| Returns tan(x)
|}

==== Strings ====

The following belong as member methods of the string object, in other words they must be called with the dot operator on a string, e.g. <code>str.slice(0, 5)</code>.
{| class="standard-table" style="width:100%"
|- style="position:sticky; z-index:10; top:0"
! Function
! Signature
! Description
|-
| <code>find</code>
| <code>int find(string ''searchString'', int ''startIndex'' = null)</code>
| Looks for the sub-string passed as its first parameter, starting at either the beginning of the string or at a specific character index if one is provided as a second parameter. If the sub-string is found, returns the index at which it first occurs, otherwise returns null.
|-
| <code>len</code>
| <code>int len()</code>
| Returns the length of the string, ie. the number of characters it comprises.
|-
| <code>slice</code>
| <code>string slice(int ''startIndex'', int ''endIndex'' = null)</code>
| Creates a sub-string from a string. Copies characters from ''startIndex'' to ''endIndex''. If ''endIndex'' is not specified, copies until the last character. If the provided end index is beyond the string, an exception is thrown.
|-
| <code>tofloat</code>
| <code>float tofloat()</code>
| Returns float value represented by the string. Must only contain numeric characters and/or plus and minus symbols. An exception is thrown otherwise.
|-
| <code>tointeger</code>
| <code>int tointeger()</code>
| Returns integer value represented by the string. Must only contain numeric characters. An exception is thrown otherwise. Hexadecimal notation is supported (i.e. <code>0xFF</code>). If a hexadecimal string contains more than 10 characters, including the <code>0x</code>, returns -1.
|-
| <code>tolower</code>
| <code>string tolower()</code>
| Returns a new string with all upper-case characters converted to lower-case.
|-
| <code>toupper</code>
| <code>string toupper()</code>
| Returns a new string with all lower-case characters converted to upper-case.
|}
The following belong as global string functions, e.g. <code>str = format("%d", num)</code>.
{| class="standard-table" style="width:100%"
! Function
! Signature
! Description
|-
| <code>endswith</code>
| <code>bool endswith(string ''str'', string ''cmp'')</code>
| Returns true if the end of the string matches the comparison string.
|-
| <code>escape</code>
| <code>string escape(string ''str'')</code>
| Returns a string with backslashes before characters that need to be escaped: <code>“ a b t n v f r \ ” ’ 0 xNN</code>
|-
| <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 at the beginning of the given string
|-
| <code>rstrip</code>
| <code>string rstrip(string ''str'')</code>
| Removes whitespace at the end of the given string
|-
| <code>split</code>
| <code>array split(string ''str'', string ''separator'', bool ''skipempty'' = false)</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. If skipempty is true, empty strings are not added to array.
|-
| <code>startswith</code>
| <code>bool startswith(string ''str'', string ''cmp'')</code>
| Returns true if the beginning of the string matches the comparison string.
|-
| <code>strip</code>
| <code>string strip(string ''str'')</code>
| Removes whitespace at the beginning and end of the given string
|}

=== Script Debug ===
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 ==
* [[VScript]]
* [[VScript Fundamentals]]
* {{sq}} [[Squirrel]]
* {{tf2}} [[TF2 VScript Examples|VScript Examples]]
* {{csgo}} [[List of CS:GO Script Functions]]
* {{l4d2}} [[Left 4 Dead 2/Script Functions|List of L4D2 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]]
[[Category:Team Fortress 2]]
[[Category:Scripting]]