List of CS:GO Script Functions: Difference between revisions

Revision as of 05:10, 27 September 2015

This list contains the engine-related Squirrel classes, functions and variables available for VScript in Counter-Strike: Global Offensive . Some of it can be printed in the console by setting developer to at least 1, loading a map and executing script_help. Note that developer only needs to be non-zero during map-loading, so to dump script_help to a file do something like this:

developer 3
map de_nuke
developer 0
con_logfile dump.txt
script_help
con_logfile ""

Variables

Instance	Type	Description
`Entities`	`CEntities`	Provides access to currently spawned entities.

Constants

Instance	Type	Description
`_charsize_`	integer
`_floatsize_`	integer
`_intsize_`	integer
`_version_`	string	The version of squirrel.
`_versionnumber_`	integer	The version of squirrel as an integer.
`RAND_MAX`	integer

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 Entities. Entity Scripts can use self to access their own script handle.

Methods

Function	Signature	Description
`__KeyValueFromInt`	`void __KeyValueFromInt(string key, int value)`	Sets a keyvalue from an integer, the keys available for all __KeyValue are from the DEFINE_KEYFIELD in baseentity.cpp (classname,rendermode, renderfx, etc.).
`__KeyValueFromString`	`void __KeyValueFromString(string key, string value)`	Sets a keyvalue from a string, the keys available for all __KeyValue are from the DEFINE_KEYFIELD in baseentity.cpp (classname,rendermode, renderfx, etc.).
`__KeyValueFromVector`	`void __KeyValueFromVector(string key, Vector value)`	Sets a keyvalue from a vector, the keys available for all __KeyValue are from the DEFINE_KEYFIELD in baseentity.cpp (classname,rendermode, renderfx, etc.).
`ConnectOutput`	`void ConnectOutput(string output, string function)`	Adds an I/O connection that will call the named function when the specified output fires.
`DisconnectOutput`	`void DisconnectOutput(string output, string function)`	Removes a connected script function from an I/O event.
`Destroy`	`void Destroy()`	Deletes the entity.
`EmitSound`	`void EmitSound(string soundScript)`	Plays a sound from this entity.
`entindex`	`int entindex()`	Returns the entity index.
`EyePosition`	`Vector EyePosition()`	Get vector to the eye position - absolute coordinates.
`FirstMoveChild`	`handle FirstMoveChild()`	^[Todo]
`GetAngles`	`Vector GetAngles()`	Get the entity pitch, yaw, roll as a Vector object.
`GetAngularVelocity`	`Vector GetAngularVelocity()`	Get the local angular velocity - returns a Vector of pitch, yaw, roll.
`GetBoundingMaxs`	`Vector GetBoundingMaxs()`	Returns the maximum extent of the entity bounding box as a local vector.
`GetBoundingMins`	`Vector GetBoundingMins()`	Returns the maximum extent of the entity bounding box as a local vector.
`GetCenter`	`Vector GetCenter()`	Returns a local vector of the bounding box center.
`GetClassname`	`string GetClassname()`	Returns the entity class. This includes `player`.
`GetForwardVector`	`Vector GetForwardVector()`	Get the forward vector of the entity.
`GetHealth`	`int GetHealth()`	Returns the current health.
`GetLeftVector`	`Vector GetLeftVector()`	Get the left vector of the entity.
`GetMaxHealth`	`int GetMaxHealth()`	Returns the maximum health.
`GetModelKeyValues`	`Keyvalues GetModelKeyValues()`	Returns the [$keyvalues] block of the entitys model as a #Keyvalues object. Note that this is not the keyvalues of the entity itself.
`GetModelName`	`string GetModelName()`	Returns the file name of the entitys model.
`GetMoveParent`	`CBaseEntity GetMoveParent()`	If in hierarchy, retrieves the entitys parent.
`GetName`	`string GetName()`	Returns the targetname of the entity.
`GetOrigin`	`Vector GetOrigin()`	Returns the Entity position in the world.
`GetOwner`	`handle GetOwner()`	Gets this entity's owner.
`GetPreTemplateName`	`string GetPreTemplateName()`	Get the entity name stripped of template unique decoration.
`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 table storing the Entity Script data associated with this entity.
`GetSoundDuration`	`float GetSoundDuration(string soundName, string actorModelName = "")`	Returns float duration of the sound. Takes soundname and optional actormodelname.
`GetTeam`	`int GetTeam()`	Returns the team number of a player. Terrorists = 2, CTs = 3.
`GetUpVector`	`Vector GetUpVector()`	Get the up vector of the entity.
`GetVelocity`	`Vector GetVelocity()`	Returns a local velocity Vector.
`IsValid`	`bool IsValid()`	Whether the handle belongs to a valid entity.
`NextMovePeer`	`handle NextMovePeer()`
`PrecacheSoundScript`	`void PrecacheSoundScript(string soundScript)`	Precache a sound for later playing.
`SetAbsOrigin`	`void SetAbsOrigin(Vector position)`	Same as SetOrigin().
`SetAngles`	`void SetAngles(float pitch, float yaw, float roll)`	Set entity pitch, yaw, roll. Note that it doesn't take a Vector object.
`SetAngularVelocity`	`void SetAngularVelocity(float pitch, float yaw, float roll)`	Set the local angular velocity - takes float pitch, yaw, roll velocities.
`SetForwardVector`	`void SetForwardVector(Vector forwardVector)`	Set the orientation of the entity to have this forward vector.
`SetHealth`	`void SetHealth(int newHealth)`	Sets the current health.
`SetMaxHealth`	`void SetMaxHealth(int maxHealth)`	Sets a new maximum health.
`SetModel`	`void SetModel(string modelName)`	Changes the model of the entity. Does not Precache the model. Todo: Check for side effects
`SetOrigin`	`void SetOrigin(Vector position)`	Moves the entity to this global position vector.
`SetOwner`	`void SetOwner(handle owner)`	Sets this entity's owner.
`SetSize`	`void SetSize(Vector, Vector)`	^[Todo]
`SetTeam`	`void SetTeam(int teamNumber)`	Instantly switches a players team. Terrorists = 2, CTs = 3.
`SetVelocity`	`void SetVelocity(Vector velocity)`	Gives the entity a new local velocity.
`ValidateScriptScope`	`bool ValidateScriptScope()`	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.

Function	Signature	Description
`InputInputName`	`bool InputInputName()`	Called when the entity receives an input from the I/O system. The name of the function needs to be `Input` followed by the name of the input in CamelCase, for example `InputFireUser1` for the FireUser1 input. When the function is called, the activating and calling entities Script Handles are written to the receiving entitys Script Scope in the `activator` and `caller` variables. The function needs to return a boolean value. Setting it to `true` allows the entity to process the input, while `false` cancels it.
`OnPostSpawn`	`void OnPostSpawn()`	Called immediately after the entity spawns. This could be used to have an entity register itself with a master script, or adjusting the entity parameters in a programmatic way.
`Precache`	`void Precache()`	Called after the script executes. Can be used to call precache functions for models and sounds on map load.

CBaseAnimating

Extends CBaseEntity

Script handle class for animating entities such as props.

Methods

Function	Signature	Description
`GetAttachmentAngles`	`Vector GetAttachmentAngles(int id)`	Get the attachment ID's angles as a pitch, yaw, roll vector.
`GetAttachmentOrigin`	`Vector GetAttachmentOrigin(int 'id')`	Get the attachment ID's origin vector.
`IsSequenceFinished`	`bool IsSequenceFinished()`	Ask whether the main sequence is done playing.
`LookupAttachment`	`int LookupAttachment(string attachmentName)`	Get the named attachment ID.
`SetBodygroup`	`void SetBodygroup(int groupIndex, int value)`	Sets the models bodygroup value by index. Todo: How do you find the index?

CBaseFlex

Extends CBaseAnimating

Methods

Function	Signature	Description
`GetCurrentScene`	`handle GetCurrentScene()`	Returns the instance of the oldest active scene entity (if any).
`GetSceneByIndex`	`handle GetSceneByIndex(int index)`	Returns the instance of the scene entity at the specified index.

CBasePlayer extends

Extends CBaseAnimating

Methods

Function	Signature	Description
`IsNoclipping`	`bool IsNoclipping()`	Returns true if the player is in noclip mode.

CBaseMultiplayerPlayer

Extends CBasePlayer

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

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(CBaseEntity entity)`	Create an entity at the location of a specified entity instance.
`SpawnEntityAtLocation`	`void SpawnEntityAtLocation(Vector origin, Vector orientation)`	Create an entity at a specified location and orientation, orientation is Euler angle in degrees (pitch, yaw, roll).
`SpawnEntityAtNamedEntityOrigin`	`void SpawnEntityAtNamedEntityOrigin(string targetName)`	Create an entity at the location of a named entity.

CPointTemplate

Extends CBaseEntity

Script handle class for point_template.

Hooks

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

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

function PreSpawnInstance( entityClass, entityName )
{
	return 
	{ 
   		rendercolor = "0 255 0"
   		targetname = "mySpawnedEntity"
	};	
}

void PostSpawn(table entities): 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.

function PostSpawn( entities )
{
	foreach( name, handle in entities )
	{
		printl( name + ": " + handle );
	}
}

CSceneEntity

Extends CBaseEntity

Methods

Function	Signature	Description
`AddBroadcastTeamTarget`	`void AddBroadcastTeamTarget(int index)`	Adds a team (by index) to the broadcast list.
`EstimateLength`	`float EstimateLength()`	Returns length of this scene in seconds.
`FindNamedEntity`	`handle FindNamedEntity(string reference)`	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 sceneName, string scene)`	Given a dummy scene name and a vcd string, load the scene.
`RemoveBroadcastTeamTarget`	`void RemoveBroadcastTeamTarget(int index)`	Removes a team (by index) from the broadcast list.

CTriggerCamera

Extends CBaseEntity

Methods

Function	Signature	Description
`GetFov`	`int GetFov()`	Get cameras current Field Of View setting as integer.
`SetFov`	`void SetFov(int fov, float rate)`	Set cameras current FOV in integer degrees and FOV change rate as float.

CCallChainer

^[Todo]

Methods

Function	Signature	Description
`constructor`	`^[Todo] constructor()`
`PostScriptExecute`	`^[Todo] PostScriptExecute()`
`Call`	`^[Todo] Call()`

Members

Instance	Type	Description
`chains`	`null`
`prefix`	`null`
`scope`	`null`

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 argument in the appropriate method to start an iteration, or reference to a previously found entity to continue a search.

Methods

Function	Signature	Description
`CreateByClassname`	`handle CreateByClassname(string class)`	Creates an entity by class name.
`FindByClassname`	`handle FindByClassname(handle previous, string class)`	Find entities by class name.
`FindByClassnameNearest`	`handle FindByClassnameNearest(string class, Vector origin, float radius)`	Find the entity with the given class name nearest to the specified point.
`FindByClassnameWithin`	`handle FindByClassnameWithin(handle previous, string class, Vector origin, float radius)`	Find entities by class name within a radius.
`FindByModel`	`handle FindByModel(handle previous, string filename)`	Find entities by model name.
`FindByName`	`handle FindByName(handle previous, string name)`	Find entities by name.
`FindByNameNearest`	`handle FindByNameNearest(string name, Vector origin, float radius)`	Find entities by name nearest to a point.
`FindByNameWithin`	`handle FindByNameWithin(handle previous, string name, Vector origin, float radius)`	Find entities by name within a radius.
`FindByTarget`	`handle FindByTarget(handle previous, string targetname)`	Find entities by its target.
`FindInSphere`	`handle FindInSphere(handle previous, Vector origin, float radius)`	Find entities within a radius.
`First`	`handle First()`	Begin an iteration over the list of entities.
`Next`	`handle Next(handle previous)`	Continue an iteration over the list of entities, providing reference to a previously found entity.
`IsValid`	`bool IsValid()`	Whether the handle belongs to a valid entity.

CPlayerVoiceListener

Todo: What is the int parameter to the methods.

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.
`IsValid`	`bool IsValid()`	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

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

CSimpleCallChainer

Seems to have the same members as CCallChainer. ^[Todo]

LateBinder

Methods

Function	Signature	Description
`Begin`
`End`
`EstablishDelegation`
`HookRootMetamethod`
`Log`
`m_bindNamesStack`
`m_fixupSet`
`m_log`
`m_logIndent`
`m_targetTable`
`RemoveDelegation`
`Resolve`
`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`

Vector

Squirrel equivalent of the C++ Vector class.

Three-dimensional vector.

Has overloaded arithmetic operations with both Vectors and scalar values.

Note:Example declaration and manipulation of Vector

Methods

Function	Signature	Description
`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.
`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.
`ToKVString`	`string ToKVString()`	Returns a string without separations commas.

Members

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

Global functions

Printing and Drawing

Function	Signature	Description
`DebugDrawBox`	`void DebugDrawBox(vector origin, vector min, vector max, int r, int g, int b, int alpha, float duration)`	Draw a debug overlay box.
`DebugDrawLine`	`void DebugDrawLine(Vector start, Vector end, int red, int green, int blue', bool zTest, float time)`	Draw a debug line between two points.
`Msg`	`void Msg(string message)`	Equivalent to `print`
`print`	`void print(string message)`	Prints the given message to the developer console.
`printl`	`void printl(string message)`	Prints the given message to the developer console just like print but also appends a newline.
`ScriptPrintMessageCenterAll`	`void ScriptPrintMessageCenterAll(string message)`	Prints an alert message in the center of the screen to all players.
`ScriptPrintMessageCenterTeam`	`void ScriptPrintMessageCenterTeam(int, string)`	Prints an alert message in the center of the screen to the specified team.
`ScriptPrintMessageChatAll`	`void ScriptPrintMessageChatAll(string message)`	Prints a message in chat to all players.
`ScriptPrintMessageChatTeam`	`void ScriptPrintMessageChatTeam(int teamNumber, string message)`	Prints a message in chat to the specified team.
`ShowMessage`	`void ShowMessage(string)`	Print a hud message on all clients. Bug:Non-functional [todo tested in ?]
`__DumpScope`	`void __DumpScope(int indentation, handle scope)`	Dumps contents of everything in the scope.

Training Course related

Function	Signature	Description
`ScriptGetBestTrainingCourseTime`	`int ScriptGetBestTrainingCourseTime()`	Gets the player's best time for completing the timed course.
`ScriptGetPlayerCompletedTraining`	`bool ScriptGetPlayerCompletedTraining()`	Returns true if the player has completed the initial portion of the training map.
`ScriptGetValveTrainingCourseTime`	`int ScriptGetValveTrainingCourseTime()`	Gets Valve's best time for completing the timed course.
`ScriptHighlightAmmoCounter`	`void ScriptHighlightAmmoCounter()`	Sends an event that is just used by the instructor system to show a hint highlighting the ammo counter.
`ScriptSetBestTrainingCourseTime`	`void ScriptSetBestTrainingCourseTime(int bestTime)`	Sets the player's best time for completing the timed course.
`ScriptSetMiniScoreHidden`	`void ScriptSetMiniScoreHidden(bool scoreHidden)`	Toggles the visibility of the miniscoreboard hud element.
`ScriptSetPlayerCompletedTraining`	`void ScriptSetPlayerCompletedTraining(bool trainingCompleted)`	Sets whether the player has completed the initial portion of the training map.
`ScriptShowExitDoorMsg`	`void ScriptShowExitDoorMsg()`	Shows a message box in trainign when the player exits through the exit door
`ScriptShowFinishMsgBox`	`void ScriptShowFinishMsgBox()`	Shows a message box to let players know what to do next after finishing the training course.
`ScriptTrainingGivePlayerAmmo`	`void ScriptTrainingGivePlayerAmmo()`	Refills ammo to max for all weapons the player has (only works in training).

Other

Function	Signature	Description
`Assert`	`void Assert(bool value, string optional message)`	Test value and if not true, throws exception, optionally with message.
`CreateProp`	`handle CreateProp(string class, Vector origin, string model, int animation)`	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. Bug:Does not initialize the physics of the prop. [todo tested in ?]
`CreateSceneEntity`	`CSceneEntity CreateSceneEntity(string scene)`	Create a scene entity to play the specified scene .vcd file.
`DoIncludeScript`	`bool DoIncludeScript(string filename, table scope)`	Execute a script with the script scope set to the specified table.
`DoEntFire`	`void DoEntFire(string target, string action, string value, float delay, handle activator, handle caller)`	Generate an entity I/O event. The caller argument takes a script handle, so it can be used with target set to !self to fire inputs to entities without usable targetnames.
`EntFire`	`function EntFire(string target, string action, string value, float delay = 0.0, handle activator = null)`	Generate and entity I/O event.
`EntFireByHandle`	`void EntFireByHandle(handle target, string action, string 'value, float delay, handle activator, handle caller)`	Generate and entity I/O event. The first parameter is an entity instance, so the handles of nameless or script generated entities can be passed easily.
`FrameTime`	`float FrameTime()`	Get the time spent on the server in the last frame
`GetDeveloperLevel`	`int GetDeveloperLevel()`	Gets the level of the developer mode.
`GetMapName`	`string GetMapName()`	Get the name of the map.
`LoopSinglePlayerMaps`	`bool LoopSinglePlayerMaps()`	Run the single player maps in a continuous loop.
`PrintHelp`		^[Todo]
`RandomFloat`	`float RandomFloat()`	Generate a random floating point number.
`RandomFloat`	`float RandomFloat(float min, float max)`	Generate a random floating point number within a range, inclusive
`RandomInt`	`int RandomInt()`	Generate a random integer.
`RandomInt`	`int RandomInt(int min, int max)`	Generate a random integer within a range, inclusive
`RecordAchievementEvent`	`void RecordAchievementEvent(string, int)`	Records achievement event or progress
`RetrieveNativeSignature`	`void RetrieveNativeSignature(string or func)`	Name suggests it would print the calling format for a native function, but I can't get it to output anything other than `<unnamed>`
`ScriptGetGameMode`	`int ScriptGetGameMode()`	Retrieves the set game_mode. See this list for a settings vs modes overview.
`ScriptGetGameType`	`int ScriptGetGameType()`	Retrieves the set game_type. See this list for a settings vs modes overview.
`ScriptIsLocalPlayerUsingController`	`bool ScriptIsLocalPlayerUsingController()`	Returns whether the player is playing with a controller or not.
`ScriptSetRadarHidden`	`void ScriptSetRadarHidden(bool hideRadar)`	Toggles the visibility of the radar hud element.
`SendToConsole`	`void SendToConsole(string command)`	Send a string to the console as a command.
`SendToConsoleServer`	`void SendToConsoleServer(string)`	Send a string that gets executed on the server as a ServerCommand
`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
`UniqueString`	`function UniqueString(string)`	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.
`__ReplaceClosures`

List of CS:GO Script Functions: Difference between revisions

Revision as of 05:10, 27 September 2015

Variables

Constants

Classes

CBaseEntity

Methods

Hooks

CBaseAnimating

Methods

CBaseFlex

Methods

CBasePlayer extends

Methods

CBaseMultiplayerPlayer

CEnvEntityMaker

Methods

CPointTemplate

Hooks

CSceneEntity

Methods

CTriggerCamera

Methods

CCallChainer

Methods

Members

CEntities

Methods

CPlayerVoiceListener

Methods

CScriptKeyValues

Methods

CSimpleCallChainer

LateBinder

Methods

regexp

Methods

Vector

Methods

Members

Global functions

Printing and Drawing

Training Course related

Other

See Also

Navigation menu

Search