Script Functions

Stub

This article or section is a stub. You can help by expanding it.

This list contains the engine-related Squirrel classes, functions and variables available for VScript in Template:Game name.

The official documentation can be printed in the console by setting developer to non-zero, loading a map, and executing script_help. However, this documentation is very incomplete and most methods are not listed, requiring them to be found by other means instead.

Warning:This page is still work-in-progress, many functions lack documentation and testing.

Note:Most of these functions were dumped externally as they are not exposed by normal means. For these functions, the return is unknown and the arguments may not be fully correct.

^[Todo] THE TRAGIC I-NEED-HELP TODO TABLE ^[Todo]
#1 Todo: Figure out inheritance - CBaseMultiplayerPlayer's inheritance is unclear.
#2 Todo: Constants and variables (e.g. PI)
#3 Todo: Copy over documentation from the L4D2 page, since is derived from the VScript version as .
#4 Todo: Split the Globals section into various sub-sections, especially the built-in Squirrel functions.
#5 Todo: Names for function sigs's params, since params are mysterious magical properties otherwise.
#6 Todo: Format the data types's constructors more nicely
#7 Todo: Script debug functions have no info other than their names!
#8 Todo: Consolidate script function subpages from together into a generic page that describes both and , including any differences both branches have. E.g. TraceLine, ClientPrint...

Instances

Name	Class	Description
`Entities`	`CEntities`	Provides access to currently spawned entities.
`EntityOutputs`	`CScriptEntityOutputs`	Allows manipulation of entity output data
`NetProps`	`CNetPropManager`	Allows reading and updating the network properties of an entity.
`PlayerVoiceListener`	`PlayerVoiceListener`	Tracks if any player is using voice and for how long.

Variables

Name	Type	Value / Description
`Documentation`	table	Contains the printed strings from the `script_help` command.
`print_indent`	integer	0
`_PublishedHelp`	table	NONE

Script Debug

Name	Type	Value
`ScriptDebugDefaultWatchColor`	array	[0, 192, 0]
`ScriptDebugDrawTextEnabled`	bool	true
`ScriptDebugDrawWatchesEnabled`	bool	true
`ScriptDebugInDebugDraw`	bool	false
`ScriptDebugText`	array	NONE
`ScriptDebugTextIndent`	integer	0
`ScriptDebugTextFilters`	table	NONE
`ScriptDebugTraces`	table	NONE
`ScriptDebugTraceAllOn`	bool	false
`ScriptDebugWatches`	array	NONE

Constants

Name	Type	Value
`_charsize_`	integer	1
`_floatsize_`	integer	4
`_intsize_`	integer	4
`_version_`	string	"Squirrel 3.0.4 stable"
`_versionnumber_`	integer	304
`RAND_MAX`	integer	32767
`PI`	float	3.14159

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:

Entities instance.
Entity Scripts only - The self keyword.

Methods

Function	Signature	Description
`__KeyValueFromFloat`	`__KeyValueFromFloat(string, float)`
`__KeyValueFromInt`	`__KeyValueFromInt(string, int)`
`__KeyValueFromString`	`__KeyValueFromString(string, string)`
`__KeyValueFromVector`	`__KeyValueFromVector(string, Vector)`
`ApplyAbsVelocityImpulse`	`void ApplyAbsVelocityImpulse(Vector)`	Apply a Velocity Impulse
`ApplyLocalAngularVelocityImpulse`	`void ApplyLocalAngularVelocityImpulse(Vector)`	Apply an Ang Velocity Impulse
`ConnectOutput`	`void ConnectOutput(string, string)`	Adds an I/O connection that will call the named function when the specified output fires
`Destroy`	`void Destroy()`
`DisableDraw`	`void DisableDraw()`	Enable drawing (removes EF_NODRAW)
`DisconnectOutput`	`void DisconnectOutput(string, string)`	Removes a connected script function from an I/O event.
`DispatchSpawn`	`void DispatchSpawn()`	Alternative dispatch spawn, same as the one in CEntities, for convenience.
`EmitSound`	`void EmitSound(string)`	Plays a sound from this entity.
`EnableDraw`	`void EnableDraw()`	Disable drawing (sets EF_NODRAW)
`entindex`	`int entindex()`
`EyeAngles`	`QAngle EyeAngles()`	Returns the entity's eye angles
`EyePosition`	`Vector EyePosition()`	Get vector to eye position - absolute coords
`FirstMoveChild`	`handle FirstMoveChild()`
`GetAbsAngles`	`QAngle GetAbsAngles()`	Get entity pitch, yaw, roll as QAngles
`GetAbsVelocity`	`Vector GetAbsVelocity()`	Returns the current absolute velocity of the entity
`GetAngles (→ GetAbsAngles)`	`Vector GetAngles()`	Get entity pitch, yaw, roll as a vector
`GetAngularVelocity`	`Vector GetAngularVelocity()`	Get the local angular velocity - returns a vector of pitch,yaw,roll
`GetBaseVelocity`	`Vector GetBaseVelocity()`	Returns any constant velocity currently being imparted onto the entity. This includes being pushed by effects like `trigger_push` and players standing on moving geometry like elevators. Should always returns a zero vector if the entity is not affected by any movement effects.
`GetBoundingMaxs`	`Vector GetBoundingMaxs()`	Get a vector containing max bounds, centered on object
`GetBoundingMaxsOriented`	`Vector GetBoundingMaxsOriented()`	Get a vector containing max bounds, centered on object, taking the object's orientation into account
`GetBoundingMins`	`Vector GetBoundingMins()`	Get a vector containing min bounds, centered on object
`GetBoundingMinsOriented`	`Vector GetBoundingMinsOriented()`	Get a vector containing min bounds, centered on object, taking the object's orientation into account
`GetCenter`	`Vector GetCenter()`	Get vector to center of object - absolute coords
`GetClassname`	`string GetClassname()`
`GetEntityHandle`	`<unknown> GetEntityHandle()`	Get the entity as an EHANDLE
`GetEntityIndex`	`int GetEntityIndex()`
`GetForwardVector`	`Vector GetForwardVector()`	Get the forward vector of the entity
`GetFriction`	`float GetFriction()`	Get PLAYER friction, ignored for objects
`GetHealth`	`int GetHealth()`
`GetLeftVector (→ GetRightVector)`	`Vector GetLeftVector()`	Get the right vector of the entity. This is purely for compatibility.
`GetLocalAngles`	`QAngle GetLocalAngles()`
`GetLocalOrigin`	`Vector GetLocalOrigin()`
`GetLocalVelocity`	`Vector GetLocalVelocity()`	Get Entity relative velocity
`GetMaxHealth`	`int GetMaxHealth()`
`GetModelKeyValues`	`handle GetModelKeyValues()`	Get a KeyValue class instance on this entity's model
`GetModelName`	`string GetModelName()`	Returns the name of the model
`GetMoveParent`	`handle GetMoveParent()`	If in hierarchy, retrieves the entity's parent
`GetMoveType`	`int GetMoveType()`
`GetName`	`string GetName()`
`GetOrigin`	`Vector GetOrigin()`	This is `GetAbsOrigin` with a funny script name for some reason. Not changing it for legacy compat though.
`GetOwner`	`handle GetOwner()`	Gets this entity's owner
`GetPhysAngularVelocity`	`Vector GetPhysAngularVelocity()`
`GetPhysVelocity`	`Vector GetPhysVelocity()`
`GetPreTemplateName`	`string GetPreTemplateName()`	Get the entity name stripped of template unique decoration
`GetRightVector`	`Vector GetRightVector()`	Get the right vector of the entity
`GetRootMoveParent`	`handle GetRootMoveParent()`	If in hierarchy, walks up the hierarchy to find the root parent
`GetScriptId`	`string GetScriptId()`	Retrieve the unique identifier used to refer to the entity within the scripting system.
`GetScriptScope`	`handle GetScriptScope()`	Retrieve the script-side data associated with an entity
`GetScriptThinkFunc`	`string GetScriptThinkFunc()`	Retrieve the name of the current script think func
`GetSoundDuration`	`float GetSoundDuration(string, string)`	Returns float duration of the sound. Takes soundname and optional actormodelname.
`GetTeam`	`int GetTeam()`
`GetUpVector`	`Vector GetUpVector()`	Get the up vector of the entity
`GetVelocity (→ GetAbsVelocity)`	`Vector GetVelocity()`
`IsPlayer`	`bool IsPlayer()`
`IsValid`	`bool IsValid()`
`KeyValueFromFloat`	`bool KeyValueFromFloat(string, float)`	Executes KeyValue with a float
`KeyValueFromInt`	`bool KeyValueFromInt(string, int)`	Executes KeyValue with an int
`KeyValueFromString`	`bool KeyValueFromString(string, string)`	Executes KeyValue with a string
`KeyValueFromVector`	`bool KeyValueFromVector(string, Vector)`	Executes KeyValue with a vector
`Kill`	`void Kill()`
`LocalEyeAngles`	`handle LocalEyeAngles()`	Returns the entity's local eye angles
`NextMovePeer`	`handle NextMovePeer()`
`PrecacheModel`	`void PrecacheModel(string)`
`PrecacheScriptSound`	`void PrecacheScriptSound(string)`
`PrecacheSoundScript`	`void PrecacheSoundScript(string)`	Precache a sound for later playing.
`SetAbsAngles`	`void SetAbsAngles(QAngle)`	Set entity pitch, yaw, roll as QAngles
`SetAbsVelocity`	`void SetAbsVelocity(Vector)`	Sets the current absolute velocity of the entity
`SetAbsOrigin`	`void SetAbsOrigin(Vector)`	SetAbsOrigin
`SetAngles (→ SetAbsAngles)`	`void SetAngles(float, float, float)`	Set entity pitch, yaw, roll.
`SetAngularVelocity`	`void SetAngularVelocity(float, float, float)`	Set the local angular velocity - takes float pitch,yaw,roll velocities
`SetDrawEnabled`	`void SetDrawEnabled(bool)`	Enables drawing if you pass true, disables drawing if you pass false.
`SetForwardVector`	`void SetForwardVector(Vector)`	Set the orientation of the entity to have this forward vector
`SetFriction`	`void SetFriction(float)`	Set PLAYER friction, ignored for objects
`SetGravity`	`void SetGravity(float)`	Set PLAYER gravity, ignored for objects
`SetHealth`	`void SetHealth(int)`
`SetLocalAngles`	`void SetLocalAngles(QAngle)`
`SetLocalOrigin`	`void SetLocalOrigin(Vector)`
`SetMaxHealth`	`void SetMaxHealth(int)`
`SetModel`	`void SetModel(string)`	Set a model for this entity
`SetModelSimple`	`void SetModelSimple(string)`	Set a model for this entity. Matches easier behaviour of the SetModel input, automatically precaches, maintains sequence/cycle if possible.
`SetOrigin (→ SetAbsOrigin)`	`void SetOrigin(Vector)`
`SetOwner`	`void SetOwner(handle)`	Sets this entity's owner
`SetPhysAngularVelocity`	`void SetPhysAngularVelocity(Vector)`
`SetPhysVelocity`	`void SetPhysVelocity(Vector)`
`SetSize`	`void SetSize(Vector, Vector)`
`SetTeam`	`void SetTeam(int)`
`SetVelocity`	`void SetVelocity(Vector)`
`StopSound`	`void StopSound(string)`	Stops a sound on this entity.
`TakeDamage`	`void TakeDamage(float flDamage, int nDamageType, handle hAttacker)`
`Teleport`	`void Teleport(bool, Vector, bool, QAngle, bool, Vector)`	Teleports this entity
`TakeDamageEx`	`void TakeDamageEx(handle hInflictor, handle hAttacker, handle hWeapon, Vector vecDamageForce, Vector vecDamagePosition, float flDamage, int nDamageType)`
`ValidateScriptScope`	`bool ValidateScriptScope()`	Ensure that an entity's script scope has been created

CBaseAnimating

Extends CBaseEntity

Script handle class for animatable entities, such as props.

Methods

Function	Signature	Description
`FindBodygroupByName`	`int FindBodygroupByName(string)`	Find a bodygroup id by name
`GetAttachmentAngles`	`QAngle GetAttachmentAngles(int)`	Get the attachement id's angles as a p,y,r vector
`GetAttachmentBone`	`int GetAttachmentBone(int)`	Get the named attachement's parent bone index
`GetAttachmentOrigin`	`Vector GetAttachmentOrigin(int)`	Get the attachement id's origin vector
`GetBodygroup`	`int GetBodygroup(int)`	Get a bodygroup by id
`GetBodygroupName`	`string GetBodygroupName(int)`	Get the bodygroup id's name
`GetBodygroupPartName`	`string GetBodygroupPartName(int, int)`	Get name by group and part
`GetBoneAngles`	`QAngle GetBoneAngles(int)`	Get the bone id's angles as a p,y,r vector
`GetBoneOrigin`	`Vector GetBoneOrigin(int)`	Get the bone id's origin vector
`GetModelScale`	`float GetModelScale()`
`GetSequence`	`int GetSequence()`	Get the current sequence id
`GetSequenceActivityName`	`string GetSequenceActivityName(int)`	Get the activity name for a sequence by id
`GetSequenceDuration`	`float GetSequenceDuration(int)`	Get a sequence duration by id
`GetSequenceName`	`string GetSequenceName(int)`	Get a sequence name by id
`GetSkin`	`int GetSkin()`	Gets the current skin index.
`IsSequenceFinished`	`bool IsSequenceFinished()`	Ask whether the main sequence is done playing
`LookupActivity`	`int LookupActivity(string)`	Get the named activity index
`LookupAttachment`	`int LookupAttachment(string)`	Get the named attachement id
`LookupBone`	`int LookupBone(string)`	Get the named bone index
`LookupSequence`	`int LookupSequence(string)`	Looks up a sequence by sequence name or activity name
`ResetSequence`	`void ResetSequence(int)`	Reset a sequence by id. If the id is different than the current sequence, switch to the new sequence
`SetBodygroup`	`void SetBodygroup(int, int)`	Sets a bodygroup
`SetModelScale`	`void SetModelScale(float, float)`	(scale, change_duration) Changes a model's scale over time
`SetPoseParameter`	`float SetPoseParameter(int, float)`	(id, value) Sets a pose parameter value
`SetSequence`	`void SetSequence(int)`	Set a sequence by id
`SetSkin`	`void SetSkin(int)`	Sets the skin.

CBasePlayer

Extends CBaseAnimating

Script handle class for player entities.

Methods

Function	Signature	Description
`GetForceLocalDraw`	`bool GetForceLocalDraw()`	Gets the state of whether the player is being forced by SetForceLocalDraw to be drawn
`GetPlayerMaxs`	`Vector GetPlayerMaxs()`
`GetPlayerMins`	`Vector GetPlayerMins()`
`GetScriptOverlayMaterial`	`string GetScriptOverlayMaterial()`	Gets the current view overlay material
`IsNoclipping`	`bool IsNoclipping()`	Returns true if the player is in noclip mode.
`SetForceLocalDraw`	`void SetForceLocalDraw(bool)`	Forces the player to be drawn as if they are third person
`SetScriptOverlayMaterial`	`void SetScriptOverlayMaterial(string)`	Sets a view overlay material
`SnapEyeAngles`	`void SnapEyeAngles(QAngle)`	Snap the player's eye angles to this.
`ViewPunch`	`void ViewPunch(QAngle)`	Ow! Punches the player's view
`ViewPunchReset`	`void ViewPunchReset(float)`	Reset's the player's view punch

CBaseMultiplayerPlayer

Extends CBasePlayer

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

CEconEntity

Extends CBaseAnimating

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

Methods

Function	Signature	Description
`AddAttribute`	`void AddAttribute(string, float, float)`	Add an attribute to the entity
`RemoveAttribute`	`void RemoveAttribute(string)`	Remove an attribute to the entity

CTFPlayer

Extends CBaseMultiplayerPlayer

Script handle class for player entities of Team Fortress 2.

Methods

Function	Signature	Description
`AddCond`	`void AddCond(string)`
`AddCondEx`	`void AddCondEx(string, float, handle)`
`AddCustomAttribute`	`void AddCustomAttribute(string, float, float)`	Add a custom attribute to the player
`ApplyPunchImpulseX`	`bool ApplyPunchImpulseX(float)`
`BleedPlayer`	`void BleedPlayer(float)`
`BleedPlayerEx`	`void BleedPlayerEx(float, int, bool, int)`
`CanAirDash`	`bool CanAirDash()`
`CanBeDebuffed`	`bool CanBeDebuffed()`
`CanBreatheUnderwater`	`bool CanBreatheUnderwater()`
`CanDuck`	`bool CanDuck()`	Can the player duck?
`CanGetWet`	`bool CanGetWet()`
`CanJump`	`bool CanJump()`	Can the player jump?
`ClearCustomModelRotation`	`void ClearCustomModelRotation()`
`ClearSpells`	`void ClearSpells()`
`CanPlayerMove`	`bool CanPlayerMove()`	Can the player move?
`DropFlag`	`void DropFlag(bool)`	Force player to drop the flag.
`DropRune`	`void DropRune(bool, int)`	Force player to drop the rune.
`ExtinguishPlayerBurning`	`void ExtinguishPlayerBurning()`
`FiringTalk`	`void FiringTalk()`	Makes eg. a heavy go AAAAAAAAAAaAaa like they are firing their minigun.
`FirstMoveChild`	`FirstMoveChild()`
`ForceChangeTeam`	`void ForceChangeTeam(int, bool)`	Force player to change their team.
`ForceRegenerateAndRespawn`	`void ForceRegenerateAndRespawn(int, bool)`	Force regenerates and respawns the player
`ForceRespawn`	`void ForceRespawn(int)`	Force respawns the player
`GetActiveWeapon`	`handle GetActiveWeapon()`	Get the player's current weapon
`GetBackstabs`	`int GetBackstabs()`
`GetBonusPoints`	`int GetBonusPoints()`
`GetBuildingsDestroyed`	`int GetBuildingsDestroyed()`
`GetCaptures`	`int GetCaptures()`
`GetClassEyeHeight`	`Vector GetClassEyeHeight()`	Gets the eye height of the player
`GetCondDuration`	`float GetCondDuration(string)`
`GetCurrency`	`int GetCurrency()`	Get player's cash for game modes with upgrades, ie. MvM
`GetCurrentTauntMoveSpeed`	`float GetCurrentTauntMoveSpeed()`
`GetDefenses`	`int GetDefenses()`
`GetDisguiseAmmoCount`	`int GetDisguiseAmmoCount()`
`GetDisguiseTarget`	`handle GetDisguiseTarget()`
`GetDisguiseTeam`	`int GetDisguiseTeam()`
`GetDominations`	`int GetDominations()`
`GetGrapplingHookTarget`	`handle GetGrapplingHookTarget()`	What entity is the player grappling?
`GetHeadshots`	`int GetHeadshots()`
`GetHealPoints`	`int GetHealPoints()`
`GetHealTarget`	`handle GetHealTarget()`	Who is the medic healing?
`GetInvulns`	`int GetInvulns()`
`GetKillAssists`	`int GetKillAssists()`
`GetNextChangeClassTime`	`float GetNextChangeClassTime()`	Get next change class time.
`GetNextChangeTeamTime`	`float GetNextChangeTeamTime()`	Get next change team time.
`GetNextRegenTime`	`float GetNextRegenTime()`	Get next health regen time.
`GetPlayerClass`	`int GetPlayerClass()`
`GetRageMeter`	`float GetRageMeter()`
`GetResupplyPoints`	`int GetResupplyPoints()`
`GetRevenge`	`int GetRevenge()`
`GetScoutHypeMeter`	`float GetScoutHypeMeter()`
`GetSpyCloakMeter`	`float GetSpyCloakMeter()`
`GetTeleports`	`int GetTeleports()`
`GetTimeSinceCalledForMedic`	`float GetTimeSinceCalledForMedic()`	When did the player last call medic
`HasItem`	`bool HasItem()`	Currently holding an item? Eg. capture flag
`IgnitePlayer`	`void IgnitePlayer()`
`InAirDueToExplosion`	`bool InAirDueToExplosion()`
`InAirDueToKnockback`	`bool InAirDueToKnockback()`
`InCond`	`bool InCond(string)`
`IsAirDashing`	`bool IsAirDashing()`
`IsAllowedToTaunt`	`bool IsAllowedToTaunt()`
`IsCallingForMedic`	`bool IsCallingForMedic()`	Is this player calling for medic?
`IsCarryingRune`	`bool IsCarryingRune()`
`IsControlStunned`	`bool IsControlStunned()`
`IsCritBoosted`	`bool IsCritBoosted()`
`IsFireproof`	`bool IsFireproof()`
`IsFullyInvisible`	`bool IsFullyInvisible()`
`IsHypeBuffed`	`bool IsHypeBuffed()`
`IsImmuneToPushback`	`bool IsImmuneToPushback()`
`IsInspecting`	`bool IsInspecting()`
`IsInvulnerable`	`bool IsInvulnerable()`
`IsJumping`	`bool IsJumping()`
`IsMiniBoss`	`bool IsMiniBoss()`	Is this player an MvM mini-boss?
`IsParachuteEquipped`	`bool IsParachuteEquipped()`
`IsPlacingSapper`	`bool IsPlacingSapper()`	Returns true if we placed a sapper in the last few moments
`IsPlayer`	`IsPlayer()`
`IsRageDraining`	`bool IsRageDraining()`
`IsRegenerating`	`bool IsRegenerating()`
`IsSapping`	`bool IsSapping()`	Returns true if we are currently sapping
`IsSnared`	`bool IsSnared()`
`IsStealthed`	`bool IsStealthed()`
`IsUsingActionSlot`	`bool IsUsingActionSlot()`
`IsViewingCYOAPDA`	`bool IsViewingCYOAPDA()`
`IsViewingCYOAPDA`	`bool IsViewingCYOAPDA()`
`Regenerate`	`void Regenerate(bool)`	Resupplies a player. If regen health/ammo is set, clears negative conds, gives back player health/ammo
`RemoveAllItems`	`void RemoveAllItems(bool)`
`RemoveAllObjects`	`void RemoveAllObjects(bool)`	Remove all player objects. Eg. dispensers/sentries.
`RemoveCond`	`void RemoveCond(string)`
`RemoveCondEx`	`void RemoveCondEx(string, bool)`
`RemoveCurrency`	`void RemoveCurrency(int)`	Take away money from a player for reasons such as ie. spending.
`RemoveCustomAttribute`	`void RemoveCustomAttribute(string)`	Remove a custom attribute to the player
`RemoveDisguise`	`void RemoveDisguise()`	Undisguise a spy.
`RemoveInvisibility`	`void RemoveInvisibility()`	Un-invisible a spy.
`RemoveTeleportEffect`	`void RemoveTeleportEffect()`
`ResetScores`	`void ResetScores()`
`RollRareSpell`	`void RollRareSpell()`
`SetCondDuration`	`void SetCondDuration(string, float)`
`SetCurrency`	`void SetCurrency(int)`	Set player's cash for game modes with upgrades, ie. MvM
`SetCurrentTauntMoveSpeed`	`void SetCurrentTauntMoveSpeed(float)`
`SetCustomModel`	`void SetCustomModel(string)`
`SetCustomModelOffset`	`void SetCustomModelOffset(Vector)`
`SetCustomModelRotates`	`void SetCustomModelRotates(bool)`
`SetCustomModelRotation`	`void SetCustomModelRotation(QAngle)`
`SetCustomModelVisibleToSelf`	`void SetCustomModelVisibleToSelf(bool)`
`SetCustomModelWithClassAnimations`	`void SetCustomModelWithClassAnimations(string)`
`SetDisguiseAmmoCount`	`void SetDisguiseAmmoCount(int)`
`SetForcedTauntCam`	`void SetForcedTauntCam(int)`
`SetGrapplingHookTarget`	`void SetGrapplingHookTarget(handle, bool)`	Set the player's target grapple entity
`SetIsMiniBoss`	`void SetIsMiniBoss(bool)`	Make this player an MvM mini-boss.
`SetNextChangeClassTime`	`void SetNextChangeClassTime(float)`	Set next change class time.
`SetNextChangeTeamTime`	`void SetNextChangeTeamTime(float)`	Set next change team time.
`SetNextRegenTime`	`void SetNextRegenTime(float)`	Set next health regen time.
`SetPlayerClass`	`void SetPlayerClass(int)`
`SetRageMeter`	`void SetRageMeter(float)`
`SetScoutHypeMeter`	`void SetScoutHypeMeter(float)`
`SetSpyCloakMeter`	`void SetSpyCloakMeter(float)`
`SetUseBossHealthBar`	`void SetUseBossHealthBar(bool)`
`TryToPickupBuilding`	`bool TryToPickupBuilding()`	Make the player attempt to pick up a building in front of them
`WasInCond`	`bool WasInCond(string)`

Convars

Game Instance: Convars

Provides an interface for getting and setting convars on the server.

Note:Protected convars (e.g. rcon_password) cannot be accessed.

Methods

Function	Signature	Description
`GetBool`	`bool GetClientConvarValue(string name)`	Returns the convar as a bool. May return null if no such convar.
`GetClientConvarValue`	`string GetClientConvarValue(string name, int entindex)`	Returns the convar value for the entindex as a string. Only works on client convars with the FCVAR_USERINFO flag.
`GetInt`	`int GetInt(string name)`	Returns the convar as an int. May return null if no such convar.
`GetStr`	`string GetStr(string name)`	Returns the convar as a string. May return null if no such convar.
`GetFloat`	`float GetFloat(string name)`	Returns the convar as a float. May return null if no such convar.
`IsConVarOnAllowList`	`bool IsConVarOnAllowList(string name)`	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!
`SetValue`	`void SetValue(string name, value)`	Sets the value of the convar. The convar must be in cfg/vscript_convar_allowlist.txt to be set. Supported types are bool, int, float, string.

CEntities

Game Instance: Entities

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:

local ent = null;
while ( ent = Entities.FindByClassname(ent, "tf_weapon_*") )
{
  // ...
}

for (local ent; ent = Entities.FindByName(ent, "tf_weapon_*"); )
{
  // ...
}

Note:

The variable name ent is arbitrary.
Indeed, we mean "=" and not "==" in the loop conditions! The loops end if ent becomes null, 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 for statement.
The string parameters of the FindBy... functions support the wildcard star *. In the above example, FindByClassname only returns either a handle of an entity whose classname begins with "tf_weapon_" or it returns null.

Methods

Function	Signature	Description
`CreateByClassname`	`handle CreateByClassname(string classname)`	Creates an entity by classname
`DispatchSpawn`	`void DispatchSpawn(handle entity)`	Dispatches spawn of an entity!
`FindByClassname`	`handle FindByClassname(handle previous, string classname)`	Find entities by the value of their `classname` keyvalue. Pass 'null' 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.
`FindByClassnameNearest`	`handle FindByClassnameNearest(string classname, Vector center, float radius)`	Find entities by classname nearest to a point.
`FindByClassnameWithin`	`handle FindByClassnameWithin(handle previous, string classname, Vector center, float radius)`	Find entities by classname within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
`FindByModel`	`handle FindByModel(handle previous, string modelname)`	Find entities by the value of their `model` keyvalue. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
`FindByName`	`handle FindByName(handle previous, string targetname)`	Find entities by the value of their `targetname` keyvalue. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
`FindByNameNearest`	`handle FindByNameNearest(string targetname, Vector center, float radius)`	Find entities by targetname nearest to a point.
`FindByNameWithin`	`handle FindByNameWithin(handle previous, string targetname, Vector center, float radius)`	Find entities by targetname within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
`FindByTarget`	`handle FindByTarget(handle previous, string target)`	Find entities by the value of their `target` keyvalue.^[confirm] Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
`FindInSphere`	`handle FindInSphere(handle previous, Vector center, float radius)`	Find entities within a radius. Pass 'null' to start an iteration, or reference to a previously found entity to continue a search
`First`	`handle First()`	Begin an iteration over the list of entities
`Next`	`handle Next(handle previous)`	At the given reference of a previously-found entity, returns the next one after it in the list.

CNetPropManager

Game Instance: NetProps

Allows reading and updating the network properties and datamaps of an entity.

If the entity has multiple netprops with the same name, the data table name can be prepended with a dot to specify which one to use (e.g. "m_itTimer.m_timestamp").

Warning:Each netprop has a set size in bits, exceeding the size may desync the clients from the server causing unpredictable behavior.

Methods

Function	Signature	Description
`GetPropArraySize`	`int GetPropArraySize(handle entity, string propertyName)`	Returns the size of an netprop array, or -1.
`GetPropEntity`	`handle GetPropEntity(handle entity, string propertyName)`	Reads an EHANDLE-valued netprop (21 bit integer). Returns the script handle of the entity.
`GetPropEntityArray`	`handle GetPropEntityArray(handle entity, string propertyName, int arrayElement)`	Reads an EHANDLE-valued netprop (21 bit integer) from an array. Returns the script handle of the entity.
`GetPropFloat`	`float GetPropFloat(handle entity, string propertyName)`	Reads a float-valued netprop.
`GetPropFloatArray`	`float GetPropFloatArray(handle entity, string propertyName, int arrayElement)`	Reads a float-valued netprop from an array.
`GetPropInt`	`int GetPropInt(handle entity, string propertyName)`	Reads an integer-valued netprop.
`GetPropIntArray`	`int GetPropIntArray(handle entity, string propertyName, int arrayElement)`	Reads an integer-valued netprop from an array.
`GetPropString`	`string GetPropString(handle entity, string propertyName)`	Reads an string-valued netprop.
`GetPropStringArray`	`string GetPropStringArray(handle entity, string propertyName, int arrayElement)`	Reads an string-valued netprop from an array.
`GetPropType`	`string GetPropType(handle entity, string propertyName)`	Returns the name of the netprop type as a string.
`GetPropVector`	`Vector GetPropVector(handle entity, string propertyName)`	Reads a 3D vector-valued netprop. Todo: Does it work for other dimensions too?
`GetPropVectorArray`	`Vector GetPropVectorArray(handle entity, string propertyName, int arrayElement)`	Reads a 3D vector-valued netprop from an array.
`HasProp`	`bool HasProp(handle entity, string propertyName)`	Checks if a netprop exists.
`SetPropEntity`	`void SetPropEntity(handle entity, string propertyName, handle value)`	Sets an EHANDLE-valued netprop (21 bit integer) to reference the specified entity.
`SetPropEntityArray`	`void SetPropEntityArray(handle entity, string propertyName, handle value, int arrayElement)`	Sets an EHANDLE-valued netprop (21 bit integer) from an array to reference the specified entity.
`SetPropFloat`	`void SetPropFloat(handle entity, string propertyName, float value)`	Sets a netprop to the specified float.
`SetPropFloatArray`	`void SetPropFloatArray(handle entity, string propertyName, float value, int arrayElement)`	Sets a netprop from an array to the specified float.
`SetPropInt`	`void SetPropInt(handle entity, string propertyName, int value)`	Sets a netprop to the specified integer.
`SetPropIntArray`	`void SetPropInt(handle entity, string propertyName, int value, int arrayElement)`	Sets a netprop from an array to the specified integer.
`SetPropString`	`void SetPropString(handle entity, string propertyName, string value)`	Sets a netprop to the specified string.
`SetPropStringArray`	`void SetPropStringArray(handle entity, string propertyName, string value, int arrayElement)`	Sets a netprop from an array to the specified string.
`SetPropVector`	`void SetPropVector(handle entity, string propertyName, Vector value)`	Sets a netprop to the specified vector.
`SetPropVectorArray`	`void SetPropVectorArray(handle entity, string propertyName, Vector value, int arrayElement)`	Sets a netprop from an array to the specified vector.

CScriptEntityOutputs

Game Instance: EntityOutputs

Allows reading and manipulation of entity output data.

Methods

Function	Signature	Description
`AddOutput`	`void AddOutput(handle entity, string outputName, string targetName, string inputName, string parameter, float delay, int timesToFire)`	Adds a new output to the entity.
`GetNumElements`	`int GetNumElements(handle ntity entity, string outputName)`	Returns the number of array elements.
`GetOutputTable`	`void GetOutputTable(handle entity, string outputName, table, int arrayElement)`	Fills the passed table with output information.
`HasAction`	`bool HasAction(handle entity, string outputName)`	Returns true if an action exists for the output.
`HasOutput`	`bool HasOutput(handle entity, string outputName)`	Returns true if the output exists.
`RemoveOutput`	`void RemoveOutput(handle entity, string outputName, string targetName, string inputName, string parameter)`	Removes an output from the entity.

CScriptKeyValues

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

Methods

Function	Signature	Description
`constructor`
`FindKey`	`CScriptKeyValues FindKey(string key)`	Find a sub key by the key name.
`GetFirstSubKey`	`CScriptKeyValues GetFirstSubKey()`	Return the first sub key object.
`GetKeyBool`	`bool GetKeyBool(string key)`	Return the key value as a bool.
`GetKeyFloat`	`float GetKeyFloat(string key)`	Return the key value as a float.
`GetKeyInt`	`int GetKeyInt(string key)`	Return the key value as an integer.
`GetKeyString`	`string GetKeyString(string key)`	Return the key value as a string.
`GetNextKey`	`CScriptKeyValues GetNextKey()`	Return the next neighbor key object to the one the method is called on.
`IsKeyEmpty`	`bool IsKeyEmpty(string key)`	Returns true if the named key has no value.
`IsValid`	`bool IsValid()`	Whether the handle belongs to a valid key.
`ReleaseKeyValues`	`void ReleaseKeyValues()`	Releases the contents of the instance.

CPlayerVoiceListener

Game Instance: PlayerVoiceListener

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

Methods

Function	Signature	Description
`GetPlayerSpeechDuration`	`float GetPlayerSpeechDuration(int)`	Returns the number of seconds the player has been continuously speaking.
`IsPlayerSpeaking`	`bool IsPlayerSpeaking(int)`	Returns whether the player specified is speaking.

CEnvEntityMaker

Extends CBaseEntity

Script handle class for env_entity_maker.

Methods

Function	Signature	Description
`SpawnEntity`	`void SpawnEntity()`	Create an entity at the location of the maker
`SpawnEntityAtEntityOrigin`	`void SpawnEntityAtEntityOrigin(handle)`	Create an entity at the location of a specified entity instance
`SpawnEntityAtLocation`	`void SpawnEntityAtLocation(Vector, Vector)`	Create an entity at a specified location and orientaton, orientation is Euler angle in degrees (pitch, yaw, roll)
`SpawnEntityAtNamedEntityOrigin`	`void SpawnEntityAtNamedEntityOrigin(string)`	Create an entity at the location of a named entity

CFuncTrackTrain

Extends CBaseEntity

Script handle class for func_tracktrain.

Methods

Function	Signature	Description
`GetFuturePosition`	`Vector GetFuturePosition(float, float)`	Get a position on the track x seconds in the future

CPointScriptTemplate

Extends CBaseEntity

Script handle class for point_script_template.

Methods

Function	Signature	Description
`AddTemplate`	`void AddTemplate(string, handle)`	Add an entity to the template spawner
`SetGroupSpawnTables`	`void SetGroupSpawnTables(handle, handle)`	Cache the group spawn tables

CSceneEntity

Extends CBaseEntity

Script handle class for scripted_scene, which make use of VCD data.

Methods

Function	Signature	Description
`AddBroadcastTeamTarget`	`void AddBroadcastTeamTarget(int)`	Adds a team (by index) to the broadcast list
`EstimateLength`	`float EstimateLength()`	Returns length of this scene in seconds.
`FindNamedEntity`	`handle FindNamedEntity(string)`	given an entity reference, such as !target, get actual entity from scene object
`IsPaused`	`bool IsPaused()`	If this scene is currently paused.
`IsPlayingBack`	`bool IsPlayingBack()`	If this scene is currently playing.
`LoadSceneFromString`	`bool LoadSceneFromString(string, string)`	given a dummy scene name and a vcd string, load the scene
`RemoveBroadcastTeamTarget`	`void RemoveBroadcastTeamTarget(int)`	Removes a team (by index) from the broadcast list

CSimpleCallChainer

Has the same members as CCallChainer. ^[Todo]

Methods

Function	Signature	Description
`Call`	`Call()`
`chain`	`chain()`
`constructor`	`constructor()`
`PostScriptExecute`	`PostScriptExecute()`
`prefix`	`prefix()`
`scope`	`scope()`

CCallChainer

Methods

Function	Signature	Description
`Call`	`Call()`
`chains`	`chains()`
`constructor`	`constructor()`
`PostScriptExecute`	`PostScriptExecute()`
`prefix`	`prefix()`
`scope`	`scope()`

LateBinder

^[Todo]

Methods

Function	Signature	Description
`Begin`	`Begin()`
`End`	`End()`
`EstablishDelegation`	`EstablishDelegation()`
`HookRootMetamethod`	`HookRootMetamethod()`
`Log`	`Log()`
`m_bindNamesStack`	`m_bindNamesStack()`
`m_fixupSet`	`m_fixupSet()`
`m_targetTable`	`m_targetTable()`
`RemoveDelegation`	`RemoveDelegation()`
`Resolve`	`Resolve()`
`UnhookRootMetamethod`	`UnhookRootMetamethod()`

regexp

The built-in Squirrel class for regular expressions.

Methods

Function	Signature	Description
`constructor`	`regexp()`
`capture`	`table capture(str, [start])`	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.
`match`	`bool match(str)`	Returns a true if the regular expression matches the string str, otherwise returns false.
`search`	`table search(str, [start])`	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.
`subexpcount`	`subexpcount()`

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

Function	Signature	Description
`constructor`	`Vector()`	Creates a new null vector.
`constructor`	`Vector(float x, float y, float z)`	Creates a new vector with the specified Cartesian coordiantes.
`Cross`	`float Cross(Vector factor)`	The vector product of two vectors. Returns a vector orthogonal to the input vectors.
`Dot`	`float Dot(Vector factor)`	The scalar product of two vectors.
`Length`	`float Length()`	Magnitude of the vector.
`LengthSqr`	`float LengthSqr()`	The magnitude of the vector squared. Faster than the above method.
`Length2D`	`float Length2D()`	Returns the magnitude of the vector on the x-y plane. Meant to be used when working with the client's HUD.
`Length2DSqr`	`float Length2DSqr()`	Returns the square of the magnitude of the vector on the x-y plane. Faster than the above method.
`Norm`	`float Norm()`	Seems to also return the vector length.
`Scale`	`Vector Scale(float factor)`	Scales the vector magnitude.
`ToKVString`	`string ToKVString()`	Returns a string without separations commas.
`tostring`	`string tostring()`	Returns a human-readable string.

Members

Instance	Type	Description
`x`	`float`	Cartesian X axis.
`y`	`float`	Cartesian Y axis.
`z`	`float`	Cartesian Z axis.

Operations

Operation	Return Type	Description
`Vector + Vector`	`Vector`	Returns the sum of both classes's members (XYZ).
`QAngle + Vector`	`Vector`	Returns the sum of both classes's members (XYZ).
`Vector - Vector`	`Vector`	Returns the subtraction of both classes's members (XYZ).
`QAngle + Vector`	`Vector`	Returns the subtraction of both classes's members (XYZ).
`Vector * integer`	`Vector`	Returns the multiplication of a Vector against a scalar.
`Vector * float`	`Vector`	Returns the multiplication of a Vector against a scalar.

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. ^[Todo]

Methods

Function	Signature	Description
`constructor`	`constructor()`
`Forward`	`Forward()`
`Left`	`Left()`
`Pitch`	`Pitch()`
`Roll`	`Roll()`
`ToKVString`	`ToKVString()`
`ToQuat`	`ToQuat()`
`Up`	`Up()`
`Yaw`	`Yaw()`

Members

Instance	Type	Description
`x`	`float`	Pitch in degrees.
`y`	`float`	Yaw in degrees.
`z`	`float`	Roll in degrees.

Operations

Operation	Return Type	Description
`QAngle + QAngle`	`QAngle`	Sum of both classes's members (XYZ).
`Vector + QAngle`	`QAngle`	Sum of both classes's members (XYZ).
`QAngle - QAngle`	`QAngle`	Subtraction of both classes's members (XYZ).
`Vector - QAngle`	`QAngle`	Subtraction of both classes's members (XYZ).
`QAngle * int`	`QAngle`	QAngle multiplied by a number.
`QAngle * float`	`QAngle`	QAngle multiplied by a number.

Vector2D, Vector4D

Two and four-dimensional equivalents to Vector.

Methods

Function	Signature	Description
`constructor`	`VectorXD(float x, float y, ...)`	Creates a new vector with the specified Cartesian coordiantes.
`Dot`	`float Dot(VectorXD factor)`	The scalar product of two vectors.
`Length`	`float Length()`	Magnitude of the vector.
`LengthSqr`	`float LengthSqr()`	The magnitude of the vector squared. Faster than the above method.
`Norm`	`float Norm()`	Seems to also return the vector length.
`ToKVString`	`string ToKVString()`	Returns a string without separations commas.

Quaternion

Quaternion represents rotations in three-dimensional space.

Methods

Function	Signature	Description
`constructor`	`Quaternion()`	Creates a new identity quaternion.
`constructor`	`Quaternion(float x,float y,float z,float w)`	Creates a new quaternion of the form `w + xi + yj + zk`.
`Dot`	`float Dot(Quaternion factor)`	The 4D scalar product of two quaternions. represents the angle between the quaternions in the range [1, 0].
`Invert`	`Quaternion Invert()`	Returns a quaternion with the complimentary rotation.
`Norm`	`Quaternion Norm()`	Normalizes the 4D vector length. Todo: What effect does this have in quaternions?
`SetPitchYawRoll`	`void SetPitchYawRoll(float pitch, float yaw, float roll)`	Recomputes the quaternion from the supplied Euler angles.
`ToKVString`	`string ToKVString()`	Returns a string with the values separated by one space.
`ToQAngle`	`QAngle ToQAngle()`	Returns the angles resulting from the rotation.

Members

Instance	Type	Description
`x`	`float`	Vector component along the i axis.
`y`	`float`	Vector component along the j axis.
`z`	`float`	Vector component along the k axis.
`w`	`float`	Scalar part.

Operations

Todo: Descriptions of the operations are lacking details.

Operation	Return Type	Description
`Quaternion + Quaternion`	`Quaternion`	Sum of the two Quaternions.
`Quaternion - Quaternion`	`Quaternion`	Subtraction of the two Quaternions.
`Quaternion * integer`	`Quaternion`	Quaternion multiplied by a number.
`Quaternion * float`	`Quaternion`	Quaternion multiplied by a number.

Globals

Indices:
Function	Signature	Description
`AddThinkToEnt`	`void AddThinkToEnt(handle entity, string FuncName)`	Sets a function in the entity's script to rerun by itself constantly. Pass null as the function name to remove a think function.
`AddToScriptHelp`	`AddToScriptHelp()`
`AllowThirdPersonCamera`	`bool AllowThirdPersonCamera()`
`ArePlayersInHell`	`bool ArePlayersInHell()`
`Assert`	`void Assert(bool value, string optional message)`	Test value and if not true, throws exception, optionally with message.
`BeginScriptDebug`	`BeginScriptDebug()`
`ClearGameEventCallbacks`	`void ClearGameEventCallbacks()`	Empties the tables of game event callback functions.
`CreateProp`	`handle CreateProp(string, Vector, string, int)`	Create a physics prop
`CreateSceneEntity`	`handle CreateSceneEntity(string)`	Create a scene entity to play the specified scene.
`developer`	`int developer()`	The current level of the `developer` console variable.
`DispatchParticleEffect`	`void DispatchParticleEffect(string, Vector, Vector)`	Dispatches a one-off particle system
`Document`	`void Document(unknown symbolOrTable, unknown itemIfSymbol = null, string descriptionIfSymbol = null)`
`DoEntFire`	`void DoEntFire(string target, string action, string value, float delay, handle activator, handle caller)`	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.
`DoIncludeScript`	`bool DoIncludeScript(string file, handle/table scope)`	Execute a script. and put all its content for the argument passed to the`scope`parameter. (internal)
`IncludeScript`	`bool IncludeScript(string file, handle scope = null)`	Wrapper for DoIncludeScript
`EmitAmbientSoundOn`	`void EmitAmbientSoundOn(string soundName, float volume, int soundlevel, int pitch, handle entity)`	Play named sound on an entity using configurations similar to ambient_generic.
`StopAmbientSoundOn`	`void StopAmbientSoundOn(string soundName, handle entity)`	Stop named sound on an entity using configurations similar to ambient_generic.
`EmitSoundOn`	`void EmitSoundOn(string soundScript, handle entity)`	Play named sound on an entity.
`StopSoundOn`	`void StopSoundOn(string soundScript, handle entity)`	Stop named sound on an entity.
`EmitSoundOnClient`	`void EmitSoundOnClient(string soundScript, handle player)`	Play named sound only on the client for the specified player.
`EndScriptDebug`	`EndScriptDebug()`
`EntFire`	`void EntFire(string target, string action, string value = null, float delay = 0, handle activator = null)`	Wrapper for DoEntFire() that sets`activator` to null, but has no`caller`param.
`EntFireByHandle`	`void EntFireByHandle(handle, string, string, float, handle, handle)`	Generate and entity i/o event. First parameter is an entity instance.
`EntIndexToHScript`	`handle EntIndexToHScript(int entIndex)`	Turn an entity index integer to an HScript representing that entity's script instance.
`FileToString`	`string FileToString(string file)`	Reads a string from file. Returns the string from the file, null if no file or file is greater than 16384 bytes. The game will crash to desktop if the file is exactly 16384 bytes.
`FindCircularReference`	`FindCircularReference()`
`FindCircularReferences`	`FindCircularReferences()`
`FireGameEvent`	`bool FireGameEvent(string, handle)`	Fire a game event to a listening callback function in script. Parameters are passed in a squirrel table.
`FireScriptEvent`	`void FireScriptEvent(string event, table params)`	Wrapper for `__RunEventCallbacks()`
`ForceEnableUpgrades`	`void ForceEnableUpgrades(int)`	Whether to force on MvM-styled upgrades on/off. 0 -> default, 1 -> force off, 2 -> force on
`FlagsMayBeCapped`	`bool FlagsMayBeCapped()`	May a flag be captured?
`FrameTime`	`float FrameTime()`	Get the time spent on the server in the last frame
`GameModeUsesCurrency`	`bool GameModeUsesCurrency()`	Does the current gamemode have currency?
`GameModeUsesMiniBosses`	`bool GameModeUsesMiniBosses()`	Does the current gamemode have minibosses?
`GameModeUsesUpgrades`	`bool GameModeUsesUpgrades()`	Does the current gamemode have upgrades?
`GetClassLimit`	`int GetClassLimit(int)`	Get class limit for class. Indices:
`GetDeveloperLevel`	`int GetDeveloperLevel()`	Gets the level of 'developer'
`GetFrameCount`	`int GetFrameCount()`	Returns the engines current frame count
`GetFriction`	`float GetFriction(handle player)`	Returns the Friction on a player entity, meaningless if not a player
`GetFunctionSignature`	`GetFunctionSignature()`
`GetGravityMultiplier`	`float GetGravityMultiplier()`
`GetListenServerHost`	`handle GetListenServerHost()`	Get the local player on a listen server.
`GetMannVsMachineAlarmStatus`	`bool GetMannVsMachineAlarmStatus()`
`GetMapName`	`string GetMapName()`	Get the name of the map.
`GetModelIndex`	`int GetModelIndex(string filename)`	Returns the index of the named model.
`GetOvertimeAllowedForCTF`	`bool GetOvertimeAllowedForCTF()`
`GetPhysAngularVelocity`	`Vector GetPhysAngularVelocity(handle entity)`	Returns the Angular velocity of the entity.
`GetPhysVelocity`	`Vector GetPhysVelocity(handle entity)`	Returns the velocity of the entity.
`GetPlayerFromUserID`	`handle GetPlayerFromUserID(int ID)`	Given a user id, return the entity, or null.
`GetRoundState`	`int GetRoundState()`	Get current round state. Indices:
`GetSoundDuration`	`float GetSoundDuration(string soundname, string actormodel)`	Returns float dur
`GetStopWatchState`	`int GetStopWatchState()`	Get the current stopwatch state. Indices:
`GetWinningTeam`	`int GetWinningTeam()`	Who won!
`HaveStopWatchWinner`	`bool HaveStopWatchWinner()`
`InMatchStartCountdown`	`bool InMatchStartCountdown()`	Are we in the pre-match state?
`InOvertime`	`bool InOvertime()`	Currently in overtime?
`IsAttackDefenseMode`	`bool IsAttackDefenseMode()`
`IsBirthday`	`bool IsBirthday()`	Are we in birthday mode?
`IsCompetitiveMode`	`bool IsCompetitiveMode()`	Playing competitive?
`IsDedicatedServer`	`bool IsDedicatedServer()`	Returns true if this server is a dedicated server.
`IsDefaultGameMode`	`bool IsDefaultGameMode()`	The absence of arena, mvm, tournament mode, etc
`IsHolidayActive`	`bool IsHolidayActive(int holiday)`	class="mw-collapsible mw-collapsed" style="background:rgba(0,0,0,0.05) ;float:no;margin-bottom:1em;margin-left:0;padding-right:0.5em;border:1px solid rgba(255,255,255,0.1); border-left:solid 1px #8bb9e0; padding-left:1em;"
0: kHoliday_None 1: kHoliday_TFBirthday 2: kHoliday_Halloween 3: kHoliday_Christmas 4: kHoliday_CommunityUpdate 5: kHoliday_EOTL 6: kHoliday_Valentines 7: kHoliday_MeetThePyro 8: kHoliday_FullMoon 9: kHoliday_HalloweenOrFullMoon 10: kHoliday_HalloweenOrFullMoonOrValentines 11: kHoliday_AprilFools 12: kHoliday_Soldier

| Send a string to the console as a command.

Note:This obeys the behavior of the sv_allow_point_servercommand convar. By default, this command will do nothing unless the server has this command to set to "always"

|- | SendToServerConsole | void SendToServerConsole(string command) | Send a string that gets executed on the server as a ServerCommand. |- | SendToConsoleServer | void SendToConsoleServer(string command) | Copy of SendToServerConsole with another name for compat. |- | SetFakeClientConVarValue | void SetFakeClientConVarValue(handle bot, string cvar, string value) | Sets a USERINFO client ConVar for a fakeclient. |- | SetGravityMultiplier | void SetGravityMultiplier(float multiplier) | |- | SetMannVsMachineAlarmStatus | void SetMannVsMachineAlarmStatus(bool status) | |- | SetOvertimeAllowedForCTF | void SetOvertimeAllowedForCTF(bool state) | |- | SetPlayersInHell | void SetPlayersInHell(bool state) | |- | SetUsingSpells | void SetUsingSpells(bool state) | |- | SpawnEntityFromTable | handle SpawnEntityFromTable(string name, handle keyvalues) | Spawn entity from KeyValues in table - 'name' is entity name, rest are KeyValues for spawn. |- | SpawnEntityGroupFromTable | bool SpawnEntityGroupFromTable(handle entityGroup) | Hierarchically spawn an entity group from a set of spawn tables. See L4D2_EMS/Appendix:_Spawning. |- | StringToFile | void StringToFile(string file, string string) | Stores a string as a file. |- | Time | float Time() | Get the current server time |- | TraceLine | float TraceLine(Vector, Vector, handle) | given 2 points & ent to ignore, return fraction along line that hits world or models |- | TraceLineEx | bool TraceLineEx(table traceTable) | Input Table: start, end, mask, ignore
Output Table: pos, fraction, hit, enthit, allsolid, startpos, endpos, startsolid, plane_normal, plane_dist, surface_name, surface_flags, surface_props |- | TraceLinePlayersIncluded | float TraceLinePlayersIncluded(Vector, Vector, handle) | given 2 points & ent to ignore, return fraction along line that hits world, models, players or npcs |- | TraceHull | bool TraceHull(table traceTable) | Input Table: start, end, hullmin, hullmax, mask, ignore
Output Table: pos, fraction, hit, enthit, allsolid, startpos, endpos, startsolid, plane_normal, plane_dist, surface_name, surface_flags, surface_props |- | UniqueString | string UniqueString(string input) | 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. |- | DoUniqueString | string DoUniqueString(string input) | Unknown; presumably an internal function called by UniqueString, so call that instead. |- | UsePlayerReadyStatusMode | bool UsePlayerReadyStatusMode() | |- | VSquirrel_OnCreateScope | table VSquirrel_OnCreateScope(any value, table scope) | Creates a new scope with the name of value in the submitted table (includes unique params). |- | VSquirrel_OnReleaseScope | void VSquirrel_OnReleaseScope(table createdScope) | Removes a scope created via VSquirrel_OnCreateScope. |- | __CollectEventCallbacks | void __CollectEventCallbacks(scope, prefix, globalTableName, regFunc) | Overloaded function. Its only used for this: __CollectEventCallbacks(scope, "OnGameEvent_", "GameEventCallbacks", ::RegisterScriptGameEventListener) |- | __CollectGameEventCallbacks | void __CollectGameEventCallbacks(scope) | Wrapper that registers callbacks for both OnGameEvent_x and OnScriptEvent_ functions. Done using the __CollectEventCallbacks function. |- | __ReplaceClosures | void __ReplaceClosures(script, scope) | |- | __RunEventCallbacks | void __RunEventCallbacks(event, params, prefix, globalTableName, bWarnIfMissing) | Call all functions in the callback array for the given game event |- | __RunGameEventCallbacks | void __RunGameEventCallbacks(event, params | Wrapper for __RunEventCallbacks() |}

Printing and Drawing

Function	Signature	Description
`ClientPrint`	`void ClientPrint(CBasePlayer player, int destination, string message)`	Print a client message. If you pass null instead of a valid player, the message will be sent to all clients.
`DebugDrawBox`	`void DebugDrawBox(Vector origin, vector min, vector max, int r, int g, int b, int alpha, float duration)`	Draw a debug overlay box.
`DebugDrawBoxAngles`	`void DebugDrawBoxAngles(Vector origin, Vector min, Vector max, QAngle direction, Vector rgb, int alpha, float duration)`	Draw a debug oriented box (cent, min, max, angles(p,y,r), vRgb, a, duration).
`DebugDrawBoxDirection`	`void DebugDrawBoxDirection(Vector center, Vector min, Vector max, Vector forward, Vector rgb, float alpha, float duration)`	Draw a debug forward box.
`DebugDrawCircle`	`void DebugDrawCircle(Vector center, Vector rgb, float alpha, float radius, bool ztest, float duration)`	Draw a debug circle.
`DebugDrawClear`	`void DebugDrawClear()`	Try to clear all the debug overlay info.
`DebugDrawLine`	`void DebugDrawLine(Vector start, Vector end, int red, int green, int blue', bool zTest, float time)`	Draw a debug overlay line.
`DebugDrawLine_vCol`	`void DebugDrawLine_vCol(Vector start, vector end, vector rgb, bool ztest, float duration)`	Draw a debug line using color vec.
`DebugDrawScreenTextLine`	`void DebugDrawScreenTextLine(float x, float y, int lineOffset, string text, int r, int g, int b, int a, float duration)`	Draw text with a line offset.
`DebugDrawText`	`void DebugDrawText(Vector origin, string text, bool useViewCheck, float duration)`	Draw text on the screen, starting on the position of origin.
`__DumpScope`	`void __DumpScope(int indentation, handle scope)`	Dumps contents of everything in the scope.
`DumpObject`	`void DumpObject(handle object)`	Dumps information about a class or instance.
`Msg`	`void Msg(string message)`	Prints message to console without any line feed after.
`printl`	`void printl(string message)`	Prints message to console with a line feed after.
`realPrint`	`void realPrint(string message)`	Identical to print. print seems to be a wrapper for this.
`Say`	`void Say(CBasePlayer player, string message, bool teamOnly)`	Calling this will have the specified player send the message to chat, either to teamOnly (true) or to everyone.
`ShowMessage`	`void ShowMessage(string message)`	Print a hud message on all clients

Squirrel Standard Library

Functions of both Squirrel's built-in functions and standard library.

Function Signature Description

array array(int length, any fill = null) Returns a new array of the given length where each element is set to fill (null by default).

assert assert(bool exp) Throws an assertion error if the given expression evaluates to false (i.e. the values 0, 0.0, null and false)

callee function callee() Returns the currently running closure.

collectgarbage int collectgarbage() Runs the garbage collector and returns the number of reference cycles found(and deleted) This function only works on garbage collector builds.

compilestring any compilestring(string string, string buffername = null) Compiles a string containing a squirrel script into a function and returns it.

dummy dummy()

enabledebuginfo void enabledebuginfo(any enable) Enable/disable the debug line information generation at compile time. enable != null enables . enable == null disables.

error void error(string x) Prints x in the standard error output .

getconsttable table getconsttable() Returns the const table of the VM.

getroottable table getroottable() Returns the root table of the VM.

getstackinfos

table getstackinfos(int stacklevel)

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.

Example
{ 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" } }

newthread coroutine newthread(function threadfunc) Creates a new cooperative thread object(coroutine) and returns it .

print print(string message) Prints the given parameter but with no newline unlike printl()

resurrectunreachable array resurrectunreachable() 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.

setconsttable table setconsttable(table consttable) Sets the const table of the VM which also returns the previous const table.

setdebughook void setdebughook(function hook_func) Sets the debug hook.

seterrorhandler void seterrorhandler(function func) Sets the runtime error handler .

setroottable table setroottable(table roottable) Sets the root table of the VM which also returns the previous root table.

suspend void suspend(any ret) Suspends the coroutine that called this function.

type type(var) Returns var._typeof(), i.e. the type of the given parameter as a string

Math

Function	Signature	Description
`abs`	`abs(num x)`	Returns \|x\| as integer unlike `fabs()`
`acos`	`acos(num x)`	Returns cos^-1(x), -1 ≤ x ≤ 1
`asin`	`asin(num x)`	Returns sin^-1(x), -1 ≤ x ≤ 1
`atan`	`atan(num x)`	Returns tan^-1(x)
`atan2`	`atan2(num y, num x)` (!)	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 atan2. Note the order of the parameters x and y!
`ceil`	`ceil(num x)`	Returns the smallest integer that is ≥ x
`cos`	`cos(num x)`	Returns cos(x)
`exp`	`exp(num x)`	Returns exp(x) = e^x
`fabs`	`fabs(num x)`	Returns \|x\| as float unlike `abs()`
`floor`	`floor(num x)`	Returns the largest integer that is ≤ x
`log`	`log(num x)`	Returns log_e(x) = ln(x)
`log10`	`log10(num x)`	Returns log₁₀(x)
`pow`	`pow(num x, num y)`	Returns x^y
`rand`	`rand()`	Returns a random integer with `0 ≤ rand() ≤ RAND_MAX`
`sin`	`sin(num x)`	Returns sin(x)
`sqrt`	`sqrt(num x)`	Returns the square root of x
`srand`	`srand(num seed)`	Sets the starting point for generating a series of pseudorandom integers
`tan`	`tan(num x)`	Returns tan(x)

Strings

Function	Signature	Description
`format`	`format(string, args...)`	Returns a formatted string
`lstrip`	`lstrip(string)`	Removes whitespace at the beginning of the given string
`rstrip`	`rstrip(string)`	Removes whitespace at the end of the given string
`split`	`string split(string str, string separator')`	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.
`strip`	`strip(string)`	Removes whitespace at the beginning and end of the given string

Script Debug

^[Todo]

Function	Signature	Description
`ScriptDebugAddTextFilter`	`void ScriptDebugAddTextFilter()`
`ScriptDebugAddTrace`	`void ScriptDebugAddTrace()`
`ScriptDebugAddWatch`	`void ScriptDebugAddWatch()`
`ScriptDebugAddWatches`	`void ScriptDebugAddWatches()`
`ScriptDebugAddWatchPattern`	`void ScriptDebugAddWatchPattern()`
`ScriptDebugClearTraces`	`void ScriptDebugClearTraces()`
`ScriptDebugClearWatches`	`void ScriptDebugClearWatches()`
`ScriptDebugDefaultWatchColor`	`void ScriptDebugDefaultWatchColor()`
`ScriptDebugDraw`	`void ScriptDebugDraw()`
`ScriptDebugDrawWatches`	`void ScriptDebugDrawWatches()`
`ScriptDebugDumpKeys`	`void ScriptDebugDumpKeys()`
`ScriptDebugHook`	`void ScriptDebugHook()`
`ScriptDebugIterateKeys`	`void ScriptDebugIterateKeys()`
`ScriptDebugIterateKeysRecursive`	`void ScriptDebugIterateKeysRecursive()`
`ScriptDebugRemoveTextFilter`	`void ScriptDebugRemoveTextFilter()`
`ScriptDebugRemoveTrace`	`void ScriptDebugRemoveTrace()`
`ScriptDebugRemoveWatch`	`void ScriptDebugRemoveWatch()`
`ScriptDebugRemoveWatches`	`void ScriptDebugRemoveWatches()`
`ScriptDebugRemoveWatchPattern`	`void ScriptDebugRemoveWatchPattern()`
`ScriptDebugText`	`void ScriptDebugText()`
`ScriptDebugTextDraw`	`void ScriptDebugTextDraw()`
`ScriptDebugTextPrint`	`void ScriptDebugTextPrint()`
`ScriptDebugTextTrace`	`void ScriptDebugTextTrace()`
`ScriptDebugTraceAll`	`void ScriptDebugTraceAll()`
`ScriptDebugWatches`	`void ScriptDebugWatches()`
`__VScriptServerDebugHook`	`__VScriptServerDebugHook()`

Script Functions

Instances

Variables

Script Debug

Constants

Classes

CBaseEntity

Methods

CBaseAnimating

Methods

CBasePlayer

Methods

CBaseMultiplayerPlayer

CEconEntity

Methods

CTFPlayer

Methods

Convars

Methods

CEntities

Methods

CNetPropManager

Methods

CScriptEntityOutputs

Methods

CScriptKeyValues

Methods

CPlayerVoiceListener

Methods

CEnvEntityMaker

Methods

CFuncTrackTrain

Methods

CPointScriptTemplate

Methods

CSceneEntity

Methods

CSimpleCallChainer

Methods

CCallChainer

Methods

LateBinder

Methods

regexp

Methods

Data Types

Vector

Methods

Members

Operations

QAngle

Methods

Members

Operations

Vector2D, Vector4D

Methods

Quaternion

Methods

Members

Operations

Globals

Printing and Drawing

Squirrel Standard Library

Math

Strings

Script Debug

See also

Navigation menu

Search