An Introduction to Squirrel: Difference between revisions

From SigMod
Jump to navigation Jump to search
No edit summary
No edit summary
 
(58 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Overview ==
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==
This is a relatively brief beginner's guide to the Squirrel language (v3.2) aimed at people with no programming experience interested in trying their hand at [https://developer.valvesoftware.com/wiki/VScript VScript].
This is a relatively brief beginner's guide to the Squirrel language (v3.2) aimed at people with little to no programming experience. While this guide is intended to be used by people wanting to learn VScript for TF2, it doesn't cover anything regarding how to use VScript itself.
If you already have experience with C-like languages or programming in general I would recommend you visit [http://squirrel-lang.org/squirreldoc/reference/index.html The Squirrel Reference Manual] for a more expedited learning experience.


If you already have experience with C-like languages or programming in general I would recommend you visit the [http://squirrel-lang.org/squirreldoc/reference/index.html Squirrel Reference Manual] for a more expedient learning experience aimed at developers.


== Getting Started ==


== Keywords and Identifiers ==
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==
While it's possible to compile the Squirrel source code into binaries with which you can test your code outside of a Source game, simply launching a game and executing your script is much simpler and allows you to start tinkering with Squirrel quicker, so that's what we'll do for the duration of the guide. For guides on VScript itself, the VDC has an excellent collection:
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]


== Constants ==
To get set up, navigate to your tf/ directory and add a scripts/vscripts folder if it doesn't already exist and create a file with any name with the extension .nut. (Mine will be named testing.nut)


== Comments ==
You should have a location something like this: <pre>C:\Program Files (x86)\Steam\steamapps\common\Team Fortress 2\tf\scripts\vscripts\testing.nut</pre>


== Data Types ==
Go ahead and launch your favorite Source game which supports VScript and load into any map on a local server, then bind any key to <code>"script_execute testing"</code>.


== Literals and Operators ==
For example: <code>bind 5 "script_execute testing"</code>


== Expressions ==


== Intro to Functions ==
Tab out of your game, open your .nut file and type:


== Intro to Objects ==
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
printl("Hello World!");
</syntaxhighlight>


== Scope ==
<code>'''printl'''</code> is a function that prints to the developer console, we'll go over what functions are and the syntax for it later in the guide, for now just follow along. After saving the file and pressing our script button in-game, you'll see <code>Hello World!</code> in console.


== Control Flow ==
You just made your first program in VScript! To get started with the guide, choose a chapter in the table below. Make sure to tinker with the examples in the guide to see first hand how Squirrel works!


== Exceptions ==
Good luck!


== Enums ==


== Arrays ==
<hr>


== Tables ==


== Functions ==
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"
 
|-
== Generators ==
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
 
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
== Delegation ==
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters
 
|-
== Weak References ==
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
 
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
== Classes ==
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Variables Variables]
 
|}
== Inheritance ==
|-
 
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
== Metamethods ==
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Comments Comments]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Operators Operators]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Expressions Expressions]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Intro_to_Functions Intro to Functions]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Intro_to_Objects Into to Objects]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Scopes Scopes]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Control_Flow Control Flow]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Exceptions Exceptions]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Enums Enums]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Arrays Arrays]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Tables Tables]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Functions Functions]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Generators Generators]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Delegation Delegation]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Weak_References Weak References]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Classes Classes]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Inheritance Inheritance]
|}
|-
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"
! colspan="1" style="border: 1px solid black; padding-right:64px; background-color: #606060; color: #111111; height: 35px;" | [https://sigwiki.potato.tf/index.php/Squirrel_Metamethods Metamethods]
|}
|}
|}

Latest revision as of 21:25, 22 January 2024

Overview[edit | edit source]

This is a relatively brief beginner's guide to the Squirrel language (v3.2) aimed at people with little to no programming experience. While this guide is intended to be used by people wanting to learn VScript for TF2, it doesn't cover anything regarding how to use VScript itself.

If you already have experience with C-like languages or programming in general I would recommend you visit the Squirrel Reference Manual for a more expedient learning experience aimed at developers.


Getting Started[edit | edit source]

While it's possible to compile the Squirrel source code into binaries with which you can test your code outside of a Source game, simply launching a game and executing your script is much simpler and allows you to start tinkering with Squirrel quicker, so that's what we'll do for the duration of the guide. For guides on VScript itself, the VDC has an excellent collection:

To get set up, navigate to your tf/ directory and add a scripts/vscripts folder if it doesn't already exist and create a file with any name with the extension .nut. (Mine will be named testing.nut)

You should have a location something like this:

C:\Program Files (x86)\Steam\steamapps\common\Team Fortress 2\tf\scripts\vscripts\testing.nut

Go ahead and launch your favorite Source game which supports VScript and load into any map on a local server, then bind any key to "script_execute testing".

For example: bind 5 "script_execute testing"


Tab out of your game, open your .nut file and type:

printl("Hello World!");

printl is a function that prints to the developer console, we'll go over what functions are and the syntax for it later in the guide, for now just follow along. After saving the file and pressing our script button in-game, you'll see Hello World! in console.

You just made your first program in VScript! To get started with the guide, choose a chapter in the table below. Make sure to tinker with the examples in the guide to see first hand how Squirrel works!

Good luck!




Chapters
Variables
Comments
Data Types
Operators
Expressions
Intro to Functions
Into to Objects
Scopes
Control Flow
Exceptions
Enums
Arrays
Tables
Functions
Generators
Delegation
Weak References
Classes
Inheritance
Metamethods