This article's documentation is for anything that uses the Source engine. Click here for more information.


From Valve Developer Community
Jump to: navigation, search

 script is a console command available in all Source Source games. script is a console command in all Source Source games since Left 4 Dead 2 Left 4 Dead 2 that have a Squirrel Squirrel implementation of VScript, namely these, and also in Team Fortress 2 Team Fortress 2.


It executes Squirrel code from the root table, which 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.

Tip.pngTip:In Team Fortress 2, backticks (`) can be used to create `strings` safely with this command.
Tip.pngTip:Instead of delimiting two script statements with a semicolon, one can put each statement inside curly braces, as long as this works in terms of scope. In the Squirrel documentation, it says:
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 ‘}’.link
Note.pngNote:Since the code is not executed from an entity's script scope and not in response to I/O, one can most likely not execute code that calls the variables activator, caller or self.
PlacementTip.pngWorkaround: Define the variables as needed temporarily, e.g. script ::activator <- Entities.FindByClassname(null, "player").


script <code>


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!

See also