This article relates to the game "Half-Life: Alyx". Click here for more information.
This article relates to the workshop tools for "Half-Life: Alyx". Click here for more information.
This article's documentation is for Source 2. Click here for more information.

Difference between revisions of "Half-Life: Alyx Workshop Tools/Lua Scripting"

From Valve Developer Community
Jump to: navigation, search
m
(Rewrote parts of the article, added more links)
Line 1: Line 1:
 
{{HLATools page|lua=1}}
 
{{HLATools page|lua=1}}
Half-Life: Alyx, like previous Source titles such as [https://developer.valvesoftware.com/wiki/Garry%27s_Mod Garry's Mod], is able to use Lua scripts natively when building custom levels using the Hammer editor.
+
Half-Life: Alyx, like the previous Source 2 titles [[Dota 2]] and [[SteamVR Home]] features the [[VScript]] scripting system using the Lua programming language. It provides the ability to use Lua scripts natively when building custom levels using the Hammer editor.  
Scripts can be used for a variety of things including creating new game modes, weapons and other types of complicated logic.
+
Scripts can be used for a variety of things including creating new game modes, weapons and other types of complicated logic.  
{{note | As Half-Life: Alyx is a relatively new game, some API functions have not yet been implemented (see: scripting API). This may affect the possible scope of your scripts!}}
+
{{note |Unlike the previous games, only [[Entity_Scripts|entity scripts]] are available, the systems for automatically loaded game mode and map scripts are not currently supported.}}
 +
{{note | As Half-Life: Alyx does not utilize the VScript system in the main game, the feature set is very limited. Access to many of the game systems is not available.}}
  
 
== Introduction to Source 2 VScript  ==
 
== Introduction to Source 2 VScript  ==
Line 9: Line 10:
  
 
== Resources ==
 
== Resources ==
* '''[[Half-Life_Alyx_Scripting_API|Scripting API]]'''
+
* [[Half-Life_Alyx_Scripting_API|Scripting API]]
* '''[[Half-Life:_Alyx_Workshop_Tools/Level_Design/Lua_Scripting/How_Lua_Works_With_The_Api| Making API calls from Lua Scripts]]'''.
+
* [[Half-Life:_Alyx_Workshop_Tools/Level_Design/Lua_Scripting/How_Lua_Works_With_The_Api| Making API calls from Lua Scripts]].
 +
* [[VScript|General VScript documentation]]
 +
* [[Dota_2_Workshop_Tools/Scripting|Dota 2 VScript documentation]]
 +
* [[SteamVR/Environments/Scripting|SteamVR Home VScript documentation]]
 +
 
  
 
[[Category:Modding]]
 
[[Category:Modding]]
 +
[[Category:Scripting]]

Revision as of 03:26, 9 July 2020

Half-Life: Alyx, like the previous Source 2 titles Dota 2 and SteamVR Home features the VScript scripting system using the Lua programming language. It provides the ability to use Lua scripts natively when building custom levels using the Hammer editor. Scripts can be used for a variety of things including creating new game modes, weapons and other types of complicated logic.

Note.png Note: Unlike the previous games, only entity scripts are available, the systems for automatically loaded game mode and map scripts are not currently supported.
Note.png Note:  As Half-Life: Alyx does not utilize the VScript system in the main game, the feature set is very limited. Access to many of the game systems is not available.

Introduction to Source 2 VScript

Resources