script
script
is a console command available in all Source games since Left 4 Dead 2.
It is available in all games that have a Squirrel implementation of VScript, namely these.
Description
It executes Squirrel code from the root table. The code can contain spaces without quotation marks used. Despite this, the developer console reads the code like a typical command's value, so special console delimiters like semicolons (;
) cannot be used for scripting needs, making for statements impossible.
Statements can be separated with a new line or ‘
;
’ (or with the keywords case or default if inside a switch/case statement), both symbols are not required if the statement is followed by ‘}
’.linkactivator
, caller
or self
. script ::activator <- Entities.FindByClassname(null, "player")
.Syntax
script <code>
Examples
script printl( GetMapName() )
Prints the name of the current map in the console.
script player <- Entities.FindByClassname(null, "player"); script player.SetMaxHealth( 200 )
Using a variable, find the player with the lowest entity index then set their max health to 200.
script { player <- Entities.FindByClassname(null, "player") } { player.SetMaxHealth(200) }
The same code, but as a single console command, achieved by using curly braces to bypass semicolons. Note that in this example, one pair of curly braces would suffice; if there is no nesting, putting every other statement in curly braces is sufficient. Note also that the statement player <- ...
despite the curly braces, creates a table slot in the root table that persists after the closing brace. If the player variable should be a local variable, its assignment statement must not stand alone inside curly braces, since its scope ends with the closing curly brace.
When executing multiple complicated commands repeatedly using the up ↑ and down ↓ arrow keys in the console it may even be useful to add a comment in the command, for example the following.
script /* SET MAX HEALTH 200 */ { player <- Entities.FindByClassname(null, "player") } { player.SetMaxHealth(200) } // SET MAX HEALTH 200
Squirrel will never see line comments starting with //
because the developer console sees and removes them first.
Block comments /* */
can also be used because Squirrel supports them!