View source for List of CS:GO Script Functions

{{LanguageBar}}
{{Delisted|csgo}}

{{toc-right}}

{{sq}} This list contains the engine-related Squirrel classes, functions and variables available for [[VScript]] in {{csgo|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>.


== Variables ==
{| class="standard-table"
!Instance
!Type
!Description
|-
|<code>Entities</code>
|<code>[[#CEntities|CEntities]]</code>
|Provides access to spawned entities in the server.
|-
|}


== Constants ==
{| class="standard-table"
!Instance
!Type
!Value
|-
|<code>_charsize_</code>
|integer
| 1
|-
|<code>_floatsize_</code>
|integer
| 4
|-
|<code>_intsize_</code>
|integer
| 4
|-
|<code>_version_</code>
|string
| "Squirrel 2.2.3 stable"
|-
|<code>RAND_MAX</code>
|integer
| 32767
|-
|<code>PI</code>
|float
| 3.14159
|}

{{note|These are simply global variables, namely table slots in the root table. They can be changed at will, for example <code>::PI {{=}} 3</code>.}}

== Classes ==


=== CBaseEntity ===
This is a script handle class for entities. All entities spawned have a script handle using this or one of its subclasses. 

All script handles in-game are accessible from [[#CEntities|Entities]]. Entity scripts can use <code>self</code> to access their own script handle. <code>activator</code> and <code>caller</code> variables can be accessed on function calls.


==== Methods ====
{| class="standard-table" style="width: 75%;"
! Function
! Signature
! Description
|-
| <code>__KeyValueFromInt</code>
| <code>bool __KeyValueFromInt(string ''key'', int ''value'')</code>
| Sets entity [[keyvalue]] from an integer.
|-
| <code>__KeyValueFromFloat</code>
| <code>bool __KeyValueFromFloat(string ''key'', float ''value'')</code>
| Sets entity keyvalue from a float.
|-
| <code>__KeyValueFromString</code>
| <code>bool __KeyValueFromString(string ''key'', string ''value'')</code>
| Sets entity keyvalue from a string.
|-
| <code>__KeyValueFromVector</code>
| <code>bool __KeyValueFromVector(string ''key'', Vector ''value'')</code>
| Sets entity keyvalue from a [[#Vector|Vector]].
|-
| <code>ConnectOutput</code>
| <code>void ConnectOutput(string ''output'', string ''function'')</code>
| Adds an [[I/O]] connection that will call the named function when the specified output fires. 
|-
| <code>DisconnectOutput</code>
| <code>void DisconnectOutput(string ''output'', string ''function'')</code>
| Removes a connected script function from an I/O event.
|-
| <code>Destroy</code>
| <code>void Destroy()</code>
| Kills the entity.
|-
| <code>EmitSound</code>
| <code>void EmitSound(string ''soundname'')</code>
| Plays a sound from this entity.
|-
| <code>entindex</code>
| <code>int entindex()</code>
| Returns the entity index.
|-
| <code>EyePosition</code>
| <code>Vector EyePosition()</code>
| Get vector to the eye position - absolute coordinates.
|-
| <code>FirstMoveChild</code>
| <code>handle FirstMoveChild()</code>
| If in hierarchy, get the first move child.
|-
| <code>GetAngles</code>
| <code>Vector GetAngles()</code>
| Get the entity local angles ([[angles|pitch, yaw, roll]]) as a Vector object.
|-
| <code>GetAngularVelocity</code>
| <code>Vector GetAngularVelocity()</code>
| Get the local angular velocity - returns a Vector of pitch, yaw, roll.
|-
| <code>GetBoundingMaxs</code>
| <code>Vector GetBoundingMaxs()</code>
| Get a vector containing max bounds in local space.
|-
| <code>GetBoundingMaxsOriented</code>
| <code>Vector GetBoundingMaxsOriented()</code>
| Get a vector containing max bounds, centered on object, taking the object's orientation into account.
|-
| <code>GetBoundingMins</code>
| <code>Vector GetBoundingMins()</code>
| Get a vector containing min bounds in local space.
|-
| <code>GetBoundingMinsOriented</code>
| <code>Vector GetBoundingMinsOriented()</code>
| Get a vector containing min bounds, centered on object, taking the object's orientation into account.
|-
| <code>GetCenter</code>
| <code>Vector GetCenter()</code>
| Get vector to center of object in world space.
|-
| <code>GetClassname</code>
| <code>string GetClassname()</code>
| Get entity [[classname]].
|-
| <code>GetForwardVector</code>
| <code>Vector GetForwardVector()</code>
| Get the forward vector of the entity in world space.
|-
| <code>GetHealth</code>
| <code>int GetHealth()</code>
| Returns the current [[health]].
|-
| <code>GetLeftVector</code>
| <code>Vector GetLeftVector()</code>
| Get the ''right'' vector of the entity in world space.
|-
| <code>GetMaxHealth</code>
| <code>int GetMaxHealth()</code>
| Returns the maximum health.
|-
| <code>GetModelKeyValues</code>
| <code>CScriptKeyValues GetModelKeyValues()</code>
| Returns the [[$keyvalues]] block of the entity's model as a [[#CScriptKeyValues]] object. Note that this is ''not'' the keyvalues of the entity itself.
|-
| <code>GetModelName</code>
| <code>string GetModelName()</code>
| Returns the value of the entity's <code>model</code> keyvalue or <code>""</code>.
|-
| <code>GetMoveParent</code>
| <code>handle GetMoveParent()</code>
| If in hierarchy, retrieves the entity's parent.
|-
| <code>GetName</code>
| <code>string GetName()</code>
| Returns the [[targetname]] of the entity.
|-
| <code>GetOrigin</code>
| <code>Vector GetOrigin()</code>
| Returns this entity's local origin.
|-
| <code>GetOwner</code>
| <code>handle GetOwner()</code>
| Gets this entity's owner.
|-
| <code>GetPreTemplateName</code>
| <code>string GetPreTemplateName()</code>
| Get the entity name stripped of template unique decoration. This is the <code>&048</code> suffix added by templates that do not preserve the entity name.
|-
| <code>GetRootMoveParent</code>
| <code>handle GetRootMoveParent()</code>
| If in hierarchy, walks up the hierarchy to find the root parent.
|-
| <code>GetScriptId</code>
| <code>string GetScriptId()</code>
| Returns the thinkfunction keyvalue of the entity.
|-
| <code>GetScriptScope</code>
| <code>handle GetScriptScope()</code>
| Retrieve the table storing the Entity Script data associated with this entity.
|-
| <code>GetSoundDuration</code>
| <code>float GetSoundDuration(string ''soundname'', string ''actormodel'')</code>
| Returns float duration of the sound. {{todo|Does this work correctly only with .wav files?}}
|-
| <code>GetTeam</code>
| <code>int GetTeam()</code>
| Get the team this entity is on.
|-
| <code>GetUpVector</code>
| <code>Vector GetUpVector()</code>
| Get the up vector of the entity in world space.
|-
| <code>GetVelocity</code>
| <code>Vector GetVelocity()</code>
| Get the velocity of the entity.
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| Whether the handle belongs to a valid entity.
|-
| <code>NextMovePeer</code>
| <code>handle NextMovePeer()</code>
| Return the next entity in the same movement hierarchy.
|-
| <code>PrecacheModel</code>
| <code>void PrecacheModel(string ''modelname'')</code>
| Precache a model. Expensive.
|-
| <code>PrecacheScriptSound</code>
| <code>void PrecacheScriptSound(string ''soundname'')</code>
| Precache a sound. Expensive.
|-
| <code>PrecacheSoundScript</code>
| <code>void PrecacheSoundScript(string ''soundscript'')</code>
| Precache a sound for later playing. Expensive.
|-
| <code>SetAbsOrigin</code>
| <code>void SetAbsOrigin(Vector ''position'')</code>
| Set absolute origin.
|-
| <code>SetAngles</code>
| <code>void SetAngles(float ''pitch'', float ''yaw'', float ''roll'')</code>
| Set entity local angles ([[angles|pitch, yaw, roll]]).
|-
| <code>SetAngularVelocity</code>
| <code>void SetAngularVelocity(float ''pitch'', float ''yaw'', float ''roll'')</code>
| Set the local angular velocity - takes float pitch, yaw, roll velocities.
|-
| <code>SetForwardVector</code>
| <code>void SetForwardVector(Vector ''forwardvec'')</code>
| Sets entity forward vector in local space.
|-
| <code>SetHealth</code>
| <code>void SetHealth(int ''health'')</code>
| Sets the current [[health]].
|-
| <code>SetMaxHealth</code>
| <code>void SetMaxHealth(int ''health'')</code>
| Sets the maximum health.
|-
| <code>SetModel</code>
| <code>void SetModel(string ''modelname'')</code>
| Changes the model of the entity. Does not precache the model.
|-
| <code>SetOrigin</code>
| <code>void SetOrigin(Vector ''position'')</code>
| Set local origin. "Teleports" the entity.
|-
| <code>SetOwner</code>
| <code>void SetOwner(handle ''owner'')</code>
| Sets this entity's owner.
|-
| <code>SetSize</code>
| <code>void SetSize(Vector ''mins'', Vector ''maxs'')</code>
| Sets the bounding box size.
|-
| <code>SetTeam</code>
| <code>void SetTeam(int ''team'')</code>
| Set the team this entity is on.
|-
| <code>SetVelocity</code>
| <code>void SetVelocity(Vector ''velocity'')</code>
| Set local velocity.
|-
| <code>StopSound</code>
| <code>void StopSound(string ''soundname'')</code>
| Stops a sound on this entity.
|-
| <code>ValidateScriptScope</code>
| <code>bool ValidateScriptScope()</code>
| Ensure that an entity's script scope has been created.
|-
|}

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

{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>Input''InputName''</code>
| <code>bool Input''InputName''()</code>
| Called when the entity receives an input from the I/O system. The name of the function needs to be <code>Input</code> followed by the name of the input in CamelCase, for example <code>InputFireUser1</code> for the FireUser1 input. The function needs to return a boolean value. Setting it to <code>true</code> allows the entity to process the input, while <code>false</code> cancels it.
|-
| <code>OnPostSpawn</code>
| <code>void OnPostSpawn()</code>
| This is called after the entity has spawned.
|-
| <code>Precache</code>
| <code>void Precache()</code>
| This is called during entity spawning and after restore to allow scripts to precache any resources they need.
|}


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

Script handle class for animating entities such as props.


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetAttachmentAngles</code>
| <code>Vector GetAttachmentAngles(int ''id'')</code>
| Get the attachment ID's angles as a pitch, yaw, roll vector.
|-
| <code>GetAttachmentOrigin</code>
| <code>Vector GetAttachmentOrigin(int ''id'')</code>
| Get the attachment ID's origin vector.
|-
| <code>IsSequenceFinished</code>
| <code>bool IsSequenceFinished()</code>
| Ask whether the main sequence is done playing.
|-
| <code>LookupAttachment</code>
| <code>int LookupAttachment(string ''attachmentName'')</code>
| Get the named attachment ID.
|-
| <code>SetBodygroup</code>
| <code>void SetBodygroup(int ''groupIndex'', int ''value'')</code>
| Sets the models bodygroup value by index.
|}


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


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetCurrentScene</code>
| <code>handle GetCurrentScene()</code>
| Returns the instance of the oldest active scene entity (if any).
|-
| <code>GetSceneByIndex</code>
| <code>handle GetSceneByIndex(int ''index'')</code>
| Returns the instance of the scene entity at the specified index.
|}


=== CBasePlayer ===
Extends [[#CBaseAnimating|CBaseAnimating]]


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>IsNoclipping</code>
| <code>bool IsNoclipping()</code>
| Returns true if the player is in noclip mode.
|}


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

Script handle class for the CS:GO players. No additional methods.


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

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

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

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

<source lang="cpp">
local ent = SpawnMyEntity( {
	rendercolor = Vector( RandomInt(0, 255), RandomInt(0, 255), RandomInt(0, 255) )
} )

printl( ent )
</source>


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


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


=== CTriggerCamera ===
Extends [[#CBaseEntity|CBaseEntity]]


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetFov</code>
| <code>int GetFov()</code>
| Get cameras current Field Of View setting as integer.
|-
| <code>SetFov</code>
| <code>void SetFov(int ''fov'', float ''rate'')</code>
| Set cameras current FOV in integer degrees and FOV change rate as float.
|}


==== Hooks ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>ScriptStartCameraShot</code>
| <code>void ScriptStartCameraShot(string ''shotType'', handle ''sceneEntity'', handle ''actor1'', handle ''actor2'', float ''duration'')</code>
| ''Called from SceneEntity in response to a CChoreoEvent::CAMERA sent from a VCD.'' {{todo}}
|}


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


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


=== CHostage ===
Extends [[#CBaseEntity|CBaseEntity]]


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>IsBeingCarried</code>
| <code>bool IsBeingCarried()</code>
| Get whether the hostage is currently being carried or not. 
|}


=== CGameCoopMissionManager ===
Extends [[#CBaseEntity|CBaseEntity]]


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>GetWaveNumber</code>
| <code>int GetWaveNumber()</code>
| Get the number of waves the players have completed.
|}


=== CEntities ===
Script 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 <code>null</code> to the ''previous'' argument in the appropriate method to start an iteration, or reference to a previously found entity 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=cpp>
local ent = null;
while ( ent = Entities.FindByClassname(ent, "weapon_*") )
{
  // ...
}
</source>
|
<source lang=cpp>
for (local ent; ent = Entities.FindByName(ent, "weapon_*"); )
{
  // ...
}
</source>
|}

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

==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>CreateByClassname</code>
| <code>handle CreateByClassname(string ''classname'')</code>
| Creates an entity by [[classname]] with the initial origin <code>(0,0,0)</code>. {{note|The classname keyvalue of an entity can be manipulated and does not necessarily reflect its code class. Also, there are entities that have a different classname than the one they are created with.}}
|-
| <code>FindByClassname</code>
| <code>handle FindByClassname(handle ''previous'', string ''classname'')</code>
| Find entities by the value of their <code>classname</code> keyvalue.
|-
| <code>FindByClassnameNearest</code>
| <code>handle FindByClassnameNearest(string ''class'', Vector ''origin'', float ''radius'')</code>
| Find the entity by the value of its <code>classname</code> keyvalue nearest to the specified <code>origin</code>.
|-
| <code>FindByClassnameWithin</code>
| <code>handle FindByClassnameWithin(handle ''previous'', string ''classname'', Vector ''origin'', float ''radius'')</code>
| Find entities by the value of their <code>classname</code> keyvalue within a <code>radius</code> around an <code>origin</code>.
|-
| <code>FindByModel</code>
| <code>handle FindByModel(handle ''previous'', string ''modelname'')</code>
| Find entities by the value of their <code>model</code> keyvalue. {{tip|Useful to distinguish between entities with an identical classname keyvalue, for example {{ent|weapon_mp7}} and {{ent|weapon_mp5sd}}, see [[:Category:Counter-Strike: Global Offensive Weapons#Manipulating Weapons|Category: CS:GO Weapons]].}}
|-
| <code>FindByName</code>
| <code>handle FindByName(handle ''previous'', string ''targetname'')</code>
| Find entities by the value of their <code>[[targetname]]</code> keyvalue.
|-
| <code>FindByNameNearest</code>
| <code>handle FindByNameNearest(string ''targetname'', Vector ''origin'', float ''radius'')</code>
| Find entities by the value of their <code>targetname</code> keyvalue nearest to a point.
|-
| <code>FindByNameWithin</code>
| <code>handle FindByNameWithin(handle ''previous'', string ''targetname'', Vector ''origin'', float ''radius'')</code>
| Find entities by the value of their <code>targetname</code> keyvalue within a radius.
|-
| <code>FindByTarget</code>
| <code>handle FindByTarget(handle ''previous'', string ''target'')</code>
| Find entities by the value of their <code>target</code> keyvalue.
|-
| <code>FindInSphere</code>
| <code>handle FindInSphere(handle ''previous'', Vector ''origin'', float ''radius'')</code>
| Find entities within a <code>radius</code> around an <code>origin</code>.
|-
| <code>First</code>
| <code>handle First()</code>
| Returns the first entity, typically ''[[worldspawn]]''. Equivalent to <code>Entities.Next(null)</code>
|-
| <code>Next</code>
| <code>handle Next(handle ''previous'')</code>
| At the given reference of a previously-found entity, returns the next one after it in the list.
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| Whether the handle belongs to a valid entity.
|}

=== CPlayerVoiceListener ===
{{warning|Broken! This class is implemented in CS:GO, but the required <code>PlayerVoiceListener</code> instance is not.}}


==== 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.
|-
| <code>IsValid</code>
| <code>bool IsValid()</code>
| Whether the handle belongs to a valid entity.
|}


=== CScriptKeyValues ===
Script handle representation of a models [[$keyvalues]] block.
Sub keys are instances of the same class.


==== Methods ====
{| class="standard-table" style="width: 100%;"
! 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.
|}

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

=== LateBinder ===
Late binding: allows a table to refer to parts of itself, it's children, it's owner, and then have the references fixed up after it's fully parsed.
<source lang=cpp>
// Usage:
lateBinder <- LateBinder();
lateBinder.Begin( this );

Test1 <-
{   
   Foo=1
}   

Test2 <-
{   
   FooFoo = "I'm foo foo"
   BarBar="@Test1.Foo"
   SubTable = { boo=[bah, "@Test2.FooFoo", "@Test1.Foo"], booboo2={one=bah, two="@Test2.FooFoo", three="@Test1.Foo"} }
   booboo=[bah, "@Test2.FooFoo", "@Test1.Foo"]
   booboo2={one=bah, two="@Test2.FooFoo", three="@Test1.Foo"}
   bah=wha
}   

lateBinder.End();
delete lateBinder;
</source>

When End() is called, all of the unresolved symbols in the tables and arrays will be resolved, any left unresolved will become a string prepended with '~', which later code can deal with.


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


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


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


=== Vector ===
Squirrel equivalent of the C++ [[Vector]] class.

Three-dimensional vector.

Has overloaded operations for the following:
<code>Vector * number</code>
<code>Vector + Vector</code>
<code>Vector - Vector</code>


==== Methods ====
{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>constructor</code>
| <code>Vector(float ''x'' = 0, float ''y'' = 0, float ''z'' = 0)</code>
| Creates a new vector with the specified Cartesian coordiantes.
|-
| <code>Cross</code>
| <code>float Cross(Vector ''factor'')</code>
| The [[wiki:Cross product|vector product]] of two vectors. Returns a vector orthogonal to the input vectors.
|-
| <code>Dot</code>
| <code>float Dot(Vector ''factor'')</code>
| The [[wiki:Dot product|scalar product]] of two vectors. 
|-
| <code>Length</code>
| <code>float Length()</code>
| Length of the vector.
|-
| <code>LengthSqr</code>
| <code>float LengthSqr()</code>
| Length of the vector squared. Cheaper than the above method.
|-
| <code>Length2D</code>
| <code>float Length2D()</code>
| Returns the length of the vector on the x-y plane.
|-
| <code>Length2DSqr</code>
| <code>float Length2DSqr()</code>
| Returns the square of the length of the vector on the x-y plane. Cheaper than the above method.
|-
| <code>Norm</code>
| <code>float Norm()</code>
| Normalises the vector, returns the vector length.
|-
| <code>ToKVString</code>
| <code>string ToKVString()</code>
| Returns a string without separations commas.
|}


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


== Global functions ==


=== Printing and drawing ===

{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>DebugDrawBox</code>
| <code>void DebugDrawBox(vector ''origin'', vector ''mins'', vector ''maxs'', int ''r'', int ''g'', int ''b'', int ''alpha'', float ''duration'')</code>
| Draw a debug overlay box in the specified color for the specified duration with two corners being <code>origin + mins</code> and <code>origin + maxs</code>. The <code>alpha</code> is the fill rate (0-255). Set ''duration'' to 0 if drawn every tick.
|-
| <code>DebugDrawBoxAngles</code>
| <code>void DebugDrawBoxAngles(Vector ''origin'', Vector ''mins'', Vector ''maxs'', Vector ''angles'', int ''r'', int ''g'', int ''b'', int ''alpha'', float ''duration'')</code>
| Draw a debug overlay box with angles in the specified color for the specified duration with two corners being <code>origin + mins</code> and <code>origin + maxs</code> + <code>angles</code>. The <code>alpha</code> is the fill rate (0-255). Set ''duration'' to 0 if drawn every tick.
|-
| <code>DebugDrawLine</code>
| <code>void DebugDrawLine(Vector ''start'', Vector ''end'', int ''r'', int ''g'', int ''b'', bool ''noDepthTest'', float ''duration'')</code>
| Draw a debug line between the points <code>start</code> and <code>end</code> in the specified color for the specified duration. Set ''duration'' to 0 if drawn every tick.
|-
| <code>Msg</code>
| <code>void Msg(string ''message'')</code>
| Equivalent to <code>print</code>
|-
| <code>print</code>
| <code>void print(string ''message'')</code>
| Prints the given message to the developer console.
|-
| <code>printl</code>
| <code>void printl(string ''message'')</code>
| Prints the given message to the developer console with newline. Equivalent to <code>print(message + "\n")</code>
|-
| <code>ScriptPrintMessageCenterAll</code>
| <code>void ScriptPrintMessageCenterAll(string ''message'')</code>
| Prints an alert message in the center of the screen to all players.
|-
| <code>ScriptPrintMessageCenterAllWithParams</code>
| <code>void ScriptPrintMessageCenterAllWithParams(string ''message'', string ''param1'', string ''param2'', string ''param3'')</code>
| Prints an alert message in the center print method to all players. Needs to pass token/message.
|-
| <code>ScriptPrintMessageCenterTeam</code>
| <code>void ScriptPrintMessageCenterTeam(int, string)</code>
| Prints an alert message in the center of the screen to the specified team.
* 0 : None
* 1 : Spectators
* 2 : Terrorists
* 3 : Counter-Terrorists
{{Warning|Game crashes for other team numbers!}}
|-
| <code>ScriptPrintMessageChatAll</code>
| <code>void ScriptPrintMessageChatAll(string ''message'')</code>
| Prints a message in chat to all players.
|-
| <code>ScriptPrintMessageChatTeam</code>
| <code>void ScriptPrintMessageChatTeam(int ''team'', string ''message'')</code>
| Prints a message in chat to the specified team.
{{Warning|Game crashes for other team numbers than the above!}}
|-
| <code>ShowMessage</code>
| <code>void ShowMessage(string)</code>
| Print a hud message on all clients. {{Note|Uses localized strings as found in <code>/scripts/titles.txt</code>}}
|-
| <code>__DumpScope</code>
| <code>void __DumpScope(int ''indentation'', table ''scope'')</code>
| Dumps the contents of ''scope''.
|-
|}


=== Training Course ===

{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>ScriptGetBestTrainingCourseTime</code>
| <code>int ScriptGetBestTrainingCourseTime()</code>
| Gets the player's best time for completing the timed course.
|-
| <code>ScriptGetPlayerCompletedTraining</code>
| <code>bool ScriptGetPlayerCompletedTraining()</code>
| Returns true if the player has completed the initial portion of the training map.
|-
| <code>ScriptGetValveTrainingCourseTime</code>
| <code>int ScriptGetValveTrainingCourseTime()</code>
| Gets Valve's best time for completing the timed course.
|-
| <code>ScriptHighlightAmmoCounter</code>
| <code>void ScriptHighlightAmmoCounter()</code>
| Sends an event that is just used by the instructor system to show a hint highlighting the ammo counter.
|-
| <code>ScriptSetBestTrainingCourseTime</code>
| <code>void ScriptSetBestTrainingCourseTime(int ''time'')</code>
| Sets the player's best time for completing the timed course.
|-
| <code>ScriptSetMiniScoreHidden</code>
| <code>void ScriptSetMiniScoreHidden(bool ''hide'')</code>
| Toggles the visibility of the miniscoreboard hud element.
|-
| <code>ScriptSetPlayerCompletedTraining</code>
| <code>void ScriptSetPlayerCompletedTraining(bool ''completed'')</code>
| Sets whether the player has completed the initial portion of the training map.
|-
| <code>ScriptSetRadarHidden</code>
| <code>void ScriptSetRadarHidden(bool ''hide'')</code>
| Toggles the visibility of the radar hud element.
|-
| <code>ScriptShowExitDoorMsg</code>
| <code>void ScriptShowExitDoorMsg()</code>
| Shows a message box in trainign when the player exits through the exit door
|-
| <code>ScriptShowFinishMsgBox</code>
| <code>void ScriptShowFinishMsgBox()</code>
| Shows a message box to let players know what to do next after finishing the training course.
|-
| <code>ScriptTrainingGivePlayerAmmo</code>
| <code>void ScriptTrainingGivePlayerAmmo()</code>
| Refills ammo to max for all weapons the player has (only works in training).
|-
|}


=== [[Creating a Co-op Strike Map|Co-op Strike]] ===

{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>ScriptCoopCollectBonusCoin</code>
| <code>void ScriptCoopCollectBonusCoin()</code>
| Marks one of the [[Item coop coin|bonus coins]] as collected.
|-
| <code>ScriptCoopGiveC4sToCTs</code>
| <code>void ScriptCoopGiveC4sToCTs(int)</code>
| Will give the number of specified [[weapon_c4|C4]]s to all alive CT players.
|-
| <code>ScriptCoopMissionGetMissionNumber</code>
| <code>int ScriptCoopMissionGetMissionNumber()</code>
| Gets the mission number for the current map - maps can have multiple missions on them.
|-
| <code>ScriptCoopMissionRespawnDeadPlayers</code>
| <code>void ScriptCoopMissionRespawnDeadPlayers()</code>
| Respawns players only.
|-
| <code>ScriptCoopMissionSetDeadPlayerRespawnEnabled</code>
| <code>void ScriptCoopMissionSetDeadPlayerRespawnEnabled(bool)</code>
| Controls whether player respawns can happen.
|-
| <code>ScriptCoopMissionSetNextRespawnIn</code>
| <code>void ScriptCoopMissionSetNextRespawnIn(float, bool)</code>
| Set the next respawn wave to happen in this many seconds.
|-
| <code>ScriptCoopMissionSpawnFirstEnemies</code>
| <code>void ScriptCoopMissionSpawnFirstEnemies(int)</code>
| Spawns the first wave of enemies in coop.
|-
| <code>ScriptCoopMissionSpawnNextWave</code>
| <code>void ScriptCoopMissionSpawnNextWave(int)</code>
| Tells the next wave of enemies to spawn in coop.  Also respawns player.
|-
| <code>ScriptCoopResetRoundStartTime</code>
| <code>void ScriptCoopResetRoundStartTime()</code>
| Resets the round time and starts the mission.
|-
| <code>ScriptCoopSetBotQuotaAndRefreshSpawns</code>
| <code>void ScriptCoopSetBotQuotaAndRefreshSpawns(int)</code>
| Sets the [[bot quota]] considering the # of players connected and refreshes the spawns.
|-
| <code>ScriptCoopExtendRoundDurationTime</code>
| <code>void ScriptCoopExtendRoundDurationTime(float)</code>
| Extends the round time after checkpoint during the mission.
|-
| <code>ScriptCoopToggleEntityOutlineHighlights</code>
| <code>void ScriptCoopToggleEntityOutlineHighlights(bool)</code>
| Highlights all dropped weapons for players, or removes all highlights.
|-
| <code>ScriptMissionResetDangerZones</code>
| <code>void ScriptMissionResetDangerZones()</code>
| Resets all danger zone entities.
|-
| <code>ScriptMissionCreateAndDetonateDangerZone</code>
| <code>void ScriptMissionCreateAndDetonateDangerZone(Vector, Vector)</code>
| Creates and detonates a danger zone at the given location moving towards target location.
|-
|}


=== Premier Mode ===

{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>ScriptLobbyMapVetoFinished</code>
| <code>void ScriptLobbyMapVetoFinished(string mapname, bool, bool, string)</code>
| Switch to the selected map after lobby map veto finished.
|-
|}


=== Math ===

The built-in [http://www.squirrel-lang.org/mainsite/doc/sqstdlib2.html#d0e1519 Squirrel math library].

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


=== Other ===

{| class="standard-table" style="width: 100%;"
! Function
! Signature
! Description
|-
| <code>Assert</code>
| <code>void Assert(''exp'', string ''message'' = null)</code>
| Throws an exception if ''exp'' equates to false, optionally with message.
|-
| <code>CreateProp</code>
| <code>handle CreateProp(string ''classname'', Vector ''origin'', string ''model'', int ''animation'')</code>
| Create a prop with the specified class and model. Both [[prop_physics]], [[prop_dynamic]] as well as some other entity classes with models work. Does not precache the model.
|-
| <code>CreateSceneEntity</code>
| <code>CSceneEntity CreateSceneEntity(string ''scene'')</code>
| Create a scene entity to play the specified scene [[VCD|.vcd file]].
|-
| <code>DispatchParticleEffect</code>
| <code>void DispatchParticleEffect(string ''particle'', Vector ''position'', Vector ''orientation'')</code>
| Dispatches a one-off particle system. See [[List of CS:GO Particles]]. Does not work if the particle is not precached.{{how}} {{note|Looped animations will stay until the round is reset.}}
|-
| <code>DoIncludeScript</code>
| <code>bool DoIncludeScript(string ''filename'', table ''scope'')</code>
| Execute the script file <code>"csgo/scripts/vscripts/" + filename</code> in the scope of <code>scope</code>. The extension <code>.nut</code> can be omitted. Returns true if the script was found and executed, otherwise false.
|-
| <code>IncludeScript</code>
| <code>bool IncludeScript(string ''filename'', table ''scope'' = null)</code>
| Execute the script file <code>"csgo/scripts/vscripts/" + filename</code> in the scope of <code>scope</code>, <code>this</code> by default. The extension <code>.nut</code> can be omitted. Returns true if the script was found and executed, otherwise false.
|-
| <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.
|-
| <code>EntFire</code>
| <code>void EntFire(string ''target'', string ''action'', string ''value'' = "", float ''delay'' = 0.0, handle ''activator'' = null)</code>
| Generate an entity I/O event.
|-
| <code>EntFireByHandle</code>
| <code>void EntFireByHandle(handle ''target'', string ''action'', string ''value'', float ''delay'', handle ''activator'', handle ''caller'')</code>
| Generate an entity I/O event.
|-
| <code>FrameTime</code>
| <code>float FrameTime()</code>
| Get the time spent on the server in the last frame.
|-
| <code>GetDeveloperLevel</code>
| <code>int GetDeveloperLevel()</code>
| Gets the level of the ''developer'' mode. Equivalent to <code>developer()</code>.
|-
| <code>GetMapName</code>
| <code>string GetMapName()</code>
| Get the name of the map, e.g. <code>"de_dust2"</code>.
|-
| <code>LoopSinglePlayerMaps</code>
| <code>bool LoopSinglePlayerMaps()</code>
| Returns the boolean value of the ConVar <code>loopsingleplayermaps</code>, i.e. whether the single player maps are run in a continuous loop.
|-
| <code>PrintHelp</code>
| <code>void PrintHelp(string ''string'' = "*", bool ''exact'' = false)</code>
| Output help for script functions, optionally with a search string.
|-
| <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>RecordAchievementEvent</code>
| <code>void RecordAchievementEvent(string, int)</code>
| Records achievement event or progress.
|-
| <code>RetrieveNativeSignature</code>
| <code>void RetrieveNativeSignature(string ''nativeFunction'')</code>
| {{todo}}
|-
| <code>ScriptGetGameMode</code>
| <code>int ScriptGetGameMode()</code>
| Gets the current [[game mode]].
|-
| <code>ScriptGetGameType</code>
| <code>int ScriptGetGameType()</code>
| Gets the current [[game type]].
|-
| <code>ScriptGetRoundsPlayed</code>
| <code>int ScriptGetRoundsPlayed()</code>
| Get the number of rounds that any team has won so far. {{Warning | Drawn rounds are not counted, except they were ended using a [[game_round_end]] entity.}}
|-
| <code>ScriptIsLocalPlayerUsingController</code>
| <code>bool ScriptIsLocalPlayerUsingController()</code>
| Returns whether the player is playing with a controller or not.
|-
| <code>ScriptIsWarmupPeriod</code>
| <code>bool ScriptIsWarmupPeriod()</code>
| Is it warmup or not.
|-
| <code>SendToConsole</code>
| <code>void SendToConsole(string ''command'')</code>
| Send a string to the console as a client command. The command is executed through the local player or listen server host. If no player is found, this function will only print the developer message <code>Cannot execute "''<command>''", no player</code> in the console.
|-
| <code>SendToConsoleServer</code>
| <code>void SendToConsoleServer(string ''command'')</code>
| Send a string that gets executed on the server as a ServerCommand using [[whitelistcmd]]. Commands or ConVars that are not whitelisted are not executed or changed.
|-
| <code>Time</code>
| <code>float Time()</code>
| Get the current server time in seconds.
|-
| <code>TraceLine</code>
| <code>float TraceLine(Vector ''start'', Vector ''end'', handle ''ignore'')</code>
| Given 2 points and an entity to ignore, returns fraction along line that only hits world.
|-
| <code>TraceLinePlayersIncluded</code>
| <code>float TraceLinePlayersIncluded(Vector ''start'', Vector ''end'', handle ''ignore'')</code>
| Given 2 points and entity to ignore, returns fraction along line that hits world, models, players and NPCs. {{Note| Blocking entities are not limited to [[player]], almost everything will block it.}}
|-
| <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 root string. Useful for adding data to tables when not sure what keys are already in use in that table. Equivalent to <code>DoUniqueString(suffix)</code>.
|-
| <code>DoUniqueString</code>
| <code>string DoUniqueString(string ''suffix'')</code>
| Generate a string guaranteed to be unique across the life of the script VM, with an optional root string. Useful for adding data to tables when not sure what keys are already in use in that table.
|-
| <code>__ReplaceClosures</code>
| <code>void __ReplaceClosures(function ''script'', table ''scope'')</code>
| Internal function called in <code>script_reload_</code> server commands.
|}

== See also ==
* [[VScript]]
* [[VScript Fundamentals]]
* [[Listening to game events in CS:GO|Listening to game events]]
* {{sq}} [[Squirrel]]
* {{csgo}} [[CS:GO VScript Examples|VScript Examples]]
* {{l4d2}} [[Left 4 Dead 2/Script Functions]]
* {{portal2}} [[List of Portal 2 Script Functions]]
* {{tf2}} [[Team Fortress 2/Scripting/Script Functions|List of Team Fortress 2 Script Functions]]

{{csgo-navbox}}
{{csgo topicon}}
[[Category:VScript functions]]
[[Category:Scripting]]