VScript: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Added links for Mapbase implementation)
 
(82 intermediate revisions by 27 users not shown)
Line 1: Line 1:
{{otherlang2
{{LanguageBar}}
|zh-cn=VScript:zh-cn
__NOTOC__
|ru=VScript:ru
'''VScript''', introduced since {{l4d2|4}} and later backported to {{tf2|4}} (and [[TF2 branch|other games on its branch]]), is a virtual machine for scripting that acts as an abstract binding layer between the {{source|4}} and {{source2|4}} engine and external scripts. According to the {{astools|4.1}}, the following scripting languages are supported or could be in the near future:
}}
'''VScript''', introduced in {{Game link|Left 4 Dead 2}}, is a virtual machine for scripting that acts as an abstract binding layer between the Source engine and external scripts. According to the {{Game link|Alien Swarm SDK}}, the following scripting languages are, or could be supported in the near future:


* [[Squirrel]]
* [[Squirrel]]
* [http://en.wikipedia.org/wiki/Lua_%28programming_language%29 Lua]
* [[Wikipedia:Lua (programming language)|Lua]]
* [http://en.wikipedia.org/wiki/GameMonkey_Script Gamemonkey]
* [[Wikipedia:GameMonkey Script|Gamemonkey]]
* [http://en.wikipedia.org/wiki/Python_%28programming_language%29 Python]
* [[Wikipedia:Python (programming language)|Python]]


Script files are read from <code>/scripts/vscripts/</code> inside the game directory.
== Implementations ==
{|
|- style="vertical-align:top"
| style="padding-right:2em" |
===[[Squirrel]] {{sq}}===


==Implementations==


===[[Squirrel]]===
{{srcsdk13mp|4|nt=short|addtext={{nbsp}}(2025)}} ({{tf2}} {{css}} {{dods}} {{hl2dm}} {{hldms}}) / {{tf2branch|3}}
;{{game link|Left 4 Dead 2}}
:All of these games runs on same branch as {{tf2}}. Any non-game specific functionality is inherited, but no additional game-specific functionality is added.
:[[Source 2013 MP/Scripting/VScript Examples|Script Examples]]
:[[Source 2013 MP/Scripting/Game Events|Game Events]]
 
:{{tf2|4}}
::[[Team Fortress 2/Scripting/Script Functions|List of Script Functions]]
::[[Team Fortress 2/Scripting/VScript Examples|Script Examples]]
::[[Team Fortress 2/Scripting/Game Events|Game Events]]
 
:{{css|4}}
::[[Counter-Strike: Source/Scripting/VScript Examples|Script Examples]]
::[[Counter-Strike: Source/Scripting/Game Events|Game Events]]
 
:{{dods|4}}
::[[Day of Defeat: Source/Scripting/Game Events|Game Events]]
 
:{{hl2dm|4}}
::[[Half-Life 2: Deathmatch/Scripting/Game Events|Game Events]]
 
:{{hldms|4}}
::[[Half-Life Deathmatch: Source/Scripting/Game Events|Game Events]]
 
{{l4d2|4}}
:[[L4D2 Vscripts|Scripting]]
:[[L4D2 Vscripts|Scripting]]
:[[L4D2_Director_Scripts|Director Scripts]]
:[[L4D2_Director_Scripts|Director Scripts]]
:[[L4D2 Vscript Examples|Script Examples]]
:[[L4D2 Vscript Examples|Script Examples]]
:[[List of L4D2 Script Functions|List of Script Functions]]
:[[Left 4 Dead 2/Script Functions|List of Script Functions]]


;{{game link|Alien Swarm}}
{{as|4}}
:[[Alien Swarm/Scripting/Script Functions|List of Script Functions]]


;{{game link|Portal 2}}
{{portal2|4}}
:[[List of Portal 2 Script Functions|List of Script Functions]]
:[[List of Portal 2 Script Functions|List of Script Functions]]


;{{game link|Source Filmmaker}}
{{Strata|4}}
:{{tf2}} Only exists on the SFM build of TF2. No TF2 or SFM specific API. Unused.
:{{p2ce|4}}
::VScript documentation is covered on its wiki: [https://wiki.stratasource.org/vscript/reference/Globals VScript API Reference]


;{{game link|Counter-Strike: Global Offensive}}
{{sfm|4}}
:[[List_of_Counter-Strike:_Global_Offensive_Script_Functions|List of Script Functions]]
:{{tf2}} Only exists on the SFM build of TF2. No TF2 or SFM-specific API. Unused.
 
{{csgo|4}}
:[[List of CS:GO Script Functions|List of Script Functions]]
:[[Listening to game events in CS:GO|Listening to game events]]
:[[Listening to game events in CS:GO|Listening to game events]]
:[[CSGO_Vscript_Examples|Script Examples]]
:[[CS:GO VScript Examples|VScript Examples]]


;{{game link|Contagion}}
{{con|4}}
:[[List of Contagion Script Functions|List of Script Functions]]
:[[List of Contagion Script Functions|List of Script Functions]]


;{{game link|Nuclear Dawn}}
{{nd|4}}
:[[List of ND Script Functions|List of Script Functions]]
:[[List of ND Script Functions|List of Script Functions]]


;{{game link|Titanfall}}
{{titanfall|4}}
:[[Titanfall/Scripting/Server Script Functions|List of Server Script Functions]]
:[[Titanfall/Scripting/Client Script Functions|List of Client Script Functions]]
:[[Titanfall/Scripting/UI Script Functions|List of UI Script Functions]]


;{{game link|Alien Swarm: Reactive Drop}}
{{Titanfall2|4}}
:[[Titanfall 2/Scripting/Server Script Functions|List of Server Script Functions]]
 
{{apex|4}}
 
{{asrd|4}}
:[[List of Reactive Drop Script Functions|List of Script Functions]]
:[[List of Reactive Drop Script Functions|List of Script Functions]]


;{{game link|Mapbase}} (Custom implementation)
{{mapbase|4}} (Custom implementation)
:[https://github.com/mapbase-source/source-sdk-2013/wiki/VScript-in-Mapbase Scripting]
:[[Mapbase/Scripting|Scripting]]
:[https://github.com/mapbase-source/source-sdk-2013/tree/master/sp/src/vscript GitHub]
:[[Mapbase/Scripting/Script_Functions|Script Functions]]
{{jbep3|4}}
:[[List of Jabroni Brawl: Episode 3 Script Functions|List of Script Functions]]
{{ddd|4}}
:[[Dino D-Day/Scripting/Script Functions|List of Script Functions]]
{{Rl|4}}
:[[Revelations 2012/Scripting/Script Functions|List of Script Functions]]
|style=padding-right:2em|


===Lua===
===Lua {{lua}}===
;{{game link|Portal 2}} (Client/UI only)
<!-- GMOD uses GLua which is not the same as VScript, don't add it here. -->
 
{{dota2|4}}
;{{game link|Dota 2}}
:[[Dota_2_Workshop_Tools/Scripting|Scripting]]
:[[Dota_2_Workshop_Tools/Scripting|Scripting]]
:[[Dota_2_Workshop_Tools/Scripting/API|Scripting API]]
:[[Dota_2_Workshop_Tools/Scripting/API|Scripting API]]


;{{game link|SteamVR Home}}
{{svrh|4}}
:[[SteamVR/Environments/Scripting|Scripting]]
:[[SteamVR/Environments/Scripting|Scripting]]
:[[SteamVR/Environments/Scripting/API|Scripting API]]
:[[SteamVR/Environments/Scripting/API|Scripting API]]
Line 62: Line 104:
:[[SteamVR/Environments/Scripting/Flashlight Tool Tutorial|Scripted Flashlight Tool Tutorial]]
:[[SteamVR/Environments/Scripting/Flashlight Tool Tutorial|Scripted Flashlight Tool Tutorial]]


;{{game link|Half-Life: Alyx}}
{{hla|4}}
:[[Half-Life_Alyx_Scripting_API|Scripting API]]
:[[Half-Life:_Alyx_Workshop_Tools/Lua_Scripting|Scripting]]
:[[Half-Life:_Alyx_Workshop_Tools/Scripting_API|Scripting API]]


;General [[Source 2]]
;General {{source2|4}}
:[[Source 2 Animation System VScript API]]
:[[Source 2 Animation System VScript API]]
{{jbep3|4}}
:[[List of Jabroni Brawl: Episode 3 Script Functions|List of Script Functions]]
|
===Python {{python}}===
;{{Tf2|4}}


===Python===
;{{sfm|4}}
;{{game link|Source Filmmaker}}
:[[SFM/Scripting_with_Python|Scripting/Rigging]]
:[[SFM/Scripting_with_Python|Scripting/Rigging]]
|}


==Scripting Fundamentals==
== See also ==
''Main article [[Vscript_Fundamentals|Vscript Fundamentals]]''
* [[VScript Fundamentals]]
*[[List of Script Libraries]]
*[[Entity Scripts]]
*{{ent|logic_script}} (entity)
*{{ent|script}}, {{ent|script_execute}} (console command)


==See also==
== External Links ==
*[[Entity_Scripts|Entity Scripts]]
* [https://vscripts.lavashik.dev An interactive VScript Book for Beginners]
*[[Logic_script|logic_script]]


[[Category:VScript]]
[[Category:Technical]]
[[Category:Technical]]
[[Category:Scripting]]
[[Category:Scripting]]

Latest revision as of 05:22, 31 October 2025

English (en)Español (es)Русский (ru)中文 (zh)Translate (Translate)

VScript, introduced since Left 4 Dead 2 Left 4 Dead 2 and later backported to Team Fortress 2 Team Fortress 2 (and other games on its branch), is a virtual machine for scripting that acts as an abstract binding layer between the Source Source and Source 2 Source 2 engine and external scripts. According to the Alien Swarm - SDK Alien Swarm - SDK, the following scripting languages are supported or could be in the near future:

Implementations

Squirrel Squirrel

Source SDK Base 2013 - Multiplayer SDK Base 2013 - MP (2025) (Team Fortress 2 Counter-Strike: Source Day of Defeat: Source Half-Life 2: Deathmatch Half-Life Deathmatch: Source) / Team Fortress 2 branch

All of these games runs on same branch as Team Fortress 2. Any non-game specific functionality is inherited, but no additional game-specific functionality is added.
Script Examples
Game Events
Team Fortress 2 Team Fortress 2
List of Script Functions
Script Examples
Game Events
Counter-Strike: Source Counter-Strike: Source
Script Examples
Game Events
Day of Defeat: Source Day of Defeat: Source
Game Events
Half-Life 2: Deathmatch Half-Life 2: Deathmatch
Game Events
Half-Life Deathmatch: Source Half-Life Deathmatch: Source
Game Events

Left 4 Dead 2 Left 4 Dead 2

Scripting
Director Scripts
Script Examples
List of Script Functions

Alien Swarm Alien Swarm

List of Script Functions

Portal 2 Portal 2

List of Script Functions

Strata Source Strata Source

Portal 2: Community Edition Portal 2: Community Edition
VScript documentation is covered on its wiki: VScript API Reference

Source Filmmaker Source Filmmaker

Team Fortress 2 Only exists on the SFM build of TF2. No TF2 or SFM-specific API. Unused.

Counter-Strike: Global Offensive Counter-Strike: Global Offensive

List of Script Functions
Listening to game events
VScript Examples

Contagion Contagion

List of Script Functions

Nuclear Dawn Nuclear Dawn

List of Script Functions

Titanfall Titanfall

List of Server Script Functions
List of Client Script Functions
List of UI Script Functions

Titanfall 2 Titanfall 2

List of Server Script Functions

Apex Legends Apex Legends

Alien Swarm: Reactive Drop Alien Swarm: Reactive Drop

List of Script Functions

Mapbase Mapbase (Custom implementation)

Scripting
Script Functions

Jabroni Brawl: Episode 3 Jabroni Brawl: Episode 3

List of Script Functions

Dino D-Day Dino D-Day

List of Script Functions

Revelations 2012 Revelations 2012

List of Script Functions

Lua Lua

Dota 2 Dota 2

Scripting
Scripting API

SteamVR Home SteamVR Home

Scripting
Scripting API
Scripted Tool Creation
Scripted Flashlight Tool Tutorial

Half-Life: Alyx Half-Life: Alyx

Scripting
Scripting API
General Source 2 Source 2
Source 2 Animation System VScript API

Jabroni Brawl: Episode 3 Jabroni Brawl: Episode 3

List of Script Functions

Python Python

Team Fortress 2 Team Fortress 2
Source Filmmaker Source Filmmaker
Scripting/Rigging

See also

External Links

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=VScript&oldid=491655"