Editing An Introduction to Squirrel (section)

== [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]

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: <pre>C:\Program Files (x86)\Steam\steamapps\common\Team Fortress 2\tf\scripts\vscripts\testing.nut</pre>

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>.

For example: <code>bind 5 "script_execute testing"</code>


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

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

<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.

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!


<hr>


{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"
|-
| 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;"
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters
|-
| 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_Variables Variables]
|}
|-
| 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_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]
|}
|}
|}