https://sigwiki.potato.tf/api.php?action=feedcontributions&feedformat=atom&user=MinceSigMod - User contributions [en-gb]2026-06-04T19:14:06ZUser contributionsMediaWiki 1.40.0https://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7534Squirrel Variables2024-01-22T21:29:59Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is made up of instructions called '''statements''' which manipulate data to produce a desired result. Squirrel stores data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''.<br />
<br />
You can think of statements as analogous to sentences in the language we speak to each other; each requires a specific set of items in a certain order to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, whereas statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.<br />
<br />
<br />
Normal variables like the ones we defined above can be changed at any time, however what if we have a variable that we don't want to change or that wouldn't make any sense to change? This is where constants come in.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
const DAYS_IN_WEEK = 7;<br />
const PI = 3.1415926535;<br />
const NAME = "Dell Conagher";<br />
</syntaxhighlight><br />
<br />
Constants are variables which cannot be changed after they are created, however they can only contain certain values. Constants may only be created with integer, float, or string '''literals'''. We go over what these are in depth in the [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types] chapter. For now if you'd like a reference of what those are, the variables in the above example contain the specified types. <code>7</code> is an '''integer''', <code>3.14</code> is a '''float''', and <code>"Dell Conagher"</code> is a '''string'''.</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7533Squirrel Variables2024-01-22T21:29:16Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is made up of instructions called '''statements''' which manipulate data to produce a desired result. Squirrel stores data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''.<br />
<br />
You can think of statements as analogous to sentences in the language we speak to each other; each requires a specific set of items in a specific order to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, and statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.<br />
<br />
<br />
Normal variables like the ones we defined above can be changed at any time, however what if we have a variable that we don't want to change or that wouldn't make any sense to change? This is where constants come in.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
const DAYS_IN_WEEK = 7;<br />
const PI = 3.1415926535;<br />
const NAME = "Dell Conagher";<br />
</syntaxhighlight><br />
<br />
Constants are variables which cannot be changed after they are created, however they can only contain certain values. Constants may only be created with integer, float, or string '''literals'''. We go over what these are in depth in the [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types] chapter. For now if you'd like a reference of what those are, the variables in the above example contain the specified types. <code>7</code> is an '''integer''', <code>3.14</code> is a '''float''', and <code>"Dell Conagher"</code> is a '''string'''.</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7532Squirrel Variables2024-01-22T21:28:32Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is made up of instructions called '''statements''' which manipulate data to produce a desired result. Squirrel stores data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''.<br />
<br />
You can think of statements as analogous to sentences in the language we speak to each other; each requires a specific set of items to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, and statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.<br />
<br />
<br />
Normal variables like the ones we defined above can be changed at any time, however what if we have a variable that we don't want to change or that wouldn't make any sense to change? This is where constants come in.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
const DAYS_IN_WEEK = 7;<br />
const PI = 3.1415926535;<br />
const NAME = "Dell Conagher";<br />
</syntaxhighlight><br />
<br />
Constants are variables which cannot be changed after they are created, however they can only contain certain values. Constants may only be created with integer, float, or string '''literals'''. We go over what these are in depth in the [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types] chapter. For now if you'd like a reference of what those are, the variables in the above example contain the specified types. <code>7</code> is an '''integer''', <code>3.14</code> is a '''float''', and <code>"Dell Conagher"</code> is a '''string'''.</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7531Squirrel Variables2024-01-22T21:28:06Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is made up of instructions called '''statements''' which manipulate data to produce a desired result. Squirrel stores data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''.<br />
<br />
You can think of statements as analogous to sentences in the language we speak to each other, each requires a specific set of items to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, and statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.<br />
<br />
<br />
Normal variables like the ones we defined above can be changed at any time, however what if we have a variable that we don't want to change or that wouldn't make any sense to change? This is where constants come in.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
const DAYS_IN_WEEK = 7;<br />
const PI = 3.1415926535;<br />
const NAME = "Dell Conagher";<br />
</syntaxhighlight><br />
<br />
Constants are variables which cannot be changed after they are created, however they can only contain certain values. Constants may only be created with integer, float, or string '''literals'''. We go over what these are in depth in the [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types] chapter. For now if you'd like a reference of what those are, the variables in the above example contain the specified types. <code>7</code> is an '''integer''', <code>3.14</code> is a '''float''', and <code>"Dell Conagher"</code> is a '''string'''.</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7530Squirrel Variables2024-01-22T21:28:00Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is made up of instructions called '''statements''' which manipulate data to produce a desired result. Squirrel stores data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''.<br />
You can think of statements as analogous to sentences in the language we speak to each other, each requires a specific set of items to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, and statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.<br />
<br />
<br />
Normal variables like the ones we defined above can be changed at any time, however what if we have a variable that we don't want to change or that wouldn't make any sense to change? This is where constants come in.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
const DAYS_IN_WEEK = 7;<br />
const PI = 3.1415926535;<br />
const NAME = "Dell Conagher";<br />
</syntaxhighlight><br />
<br />
Constants are variables which cannot be changed after they are created, however they can only contain certain values. Constants may only be created with integer, float, or string '''literals'''. We go over what these are in depth in the [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types] chapter. For now if you'd like a reference of what those are, the variables in the above example contain the specified types. <code>7</code> is an '''integer''', <code>3.14</code> is a '''float''', and <code>"Dell Conagher"</code> is a '''string'''.</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7529Squirrel Variables2024-01-22T21:27:27Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is made up of instructions called '''statements''' which manipulate data to produce a desired result. Squirrel stores data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''. You can think of statements as analogous to sentences in the language we speak to each other, each requires a specific set of items to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, and statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.<br />
<br />
<br />
Normal variables like the ones we defined above can be changed at any time, however what if we have a variable that we don't want to change or that wouldn't make any sense to change? This is where constants come in.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
const DAYS_IN_WEEK = 7;<br />
const PI = 3.1415926535;<br />
const NAME = "Dell Conagher";<br />
</syntaxhighlight><br />
<br />
Constants are variables which cannot be changed after they are created, however they can only contain certain values. Constants may only be created with integer, float, or string '''literals'''. We go over what these are in depth in the [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types] chapter. For now if you'd like a reference of what those are, the variables in the above example contain the specified types. <code>7</code> is an '''integer''', <code>3.14</code> is a '''float''', and <code>"Dell Conagher"</code> is a '''string'''.</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7528Squirrel Variables2024-01-22T21:26:11Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is made up of instructions called '''statements''' which manipulate data to produce a desired result. Programs store data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''. You can think of statements as analogous to sentences in the language we speak to each other, each requires a specific set of items to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, and statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.<br />
<br />
<br />
Normal variables like the ones we defined above can be changed at any time, however what if we have a variable that we don't want to change or that wouldn't make any sense to change? This is where constants come in.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
const DAYS_IN_WEEK = 7;<br />
const PI = 3.1415926535;<br />
const NAME = "Dell Conagher";<br />
</syntaxhighlight><br />
<br />
Constants are variables which cannot be changed after they are created, however they can only contain certain values. Constants may only be created with integer, float, or string '''literals'''. We go over what these are in depth in the [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types] chapter. For now if you'd like a reference of what those are, the variables in the above example contain the specified types. <code>7</code> is an '''integer''', <code>3.14</code> is a '''float''', and <code>"Dell Conagher"</code> is a '''string'''.</div>Mincehttps://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel&diff=7527An Introduction to Squirrel2024-01-22T21:25:40Z<p>Mince: </p>
<hr />
<div>== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==<br />
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.<br />
<br />
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.<br />
<br />
<br />
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==<br />
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:<br />
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]<br />
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]<br />
<br />
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)<br />
<br />
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><br />
<br />
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>.<br />
<br />
For example: <code>bind 5 "script_execute testing"</code><br />
<br />
<br />
Tab out of your game, open your .nut file and type:<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("Hello World!");<br />
</syntaxhighlight><br />
<br />
<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.<br />
<br />
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!<br />
<br />
Good luck!<br />
<br />
<br />
<hr><br />
<br />
<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|}<br />
|}</div>Mincehttps://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel&diff=7526An Introduction to Squirrel2024-01-22T21:25:13Z<p>Mince: </p>
<hr />
<div>== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==<br />
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.<br />
<br />
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.<br />
<br />
<br />
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==<br />
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:<br />
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]<br />
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]<br />
<br />
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)<br />
<br />
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><br />
<br />
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>.<br />
<br />
For example: <code>bind 5 "script_execute testing"</code><br />
<br />
<br />
Tab out of your game, open your .nut file and type:<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("Hello World!");<br />
</syntaxhighlight><br />
<br />
<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!<br />
<br />
Good luck!<br />
<br />
<br />
<hr><br />
<br />
<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|}<br />
|}</div>Mincehttps://sigwiki.potato.tf/index.php?title=Installing_on_Windows_with_WSL&diff=7524Installing on Windows with WSL2023-12-11T17:57:13Z<p>Mince: C/P correct libraries from tfwiki https://wiki.teamfortress.com/wiki/Linux_dedicated_server</p>
<hr />
<div>== Easy installation script ==<br />
Right click this link and select save link as:<br />
<br />
https://raw.githubusercontent.com/rafradek/sigsegv-mvm/master/windows_install_wsl.bat<br />
<br />
Run the downloaded bat file and follow the instructions printed in console<br />
<br />
== Manual installation ==<br />
Run the bat file and follow instructions printed in console<br />
<br />
Based on guides: https://docs.microsoft.com/en-us/windows/wsl/install-win10 https://wiki.teamfortress.com/wiki/Linux_dedicated_server<br />
<br />
Open PowerShell as administrator, then execute those commands<br />
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart<br />
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart<br />
<br />
Now restart your PC. After that, execute another PowerShell command<br />
wsl --set-default-version 2<br />
echo [wsl2] memory=2GB > $env:USERPROFILE/.wslconfig<br />
Open Microsoft Store and install Ubuntu. Launch Ubuntu from start menu. Fill in username and password info when asked. Install required packages by entering those commands into the window:<br />
sudo dpkg --add-architecture i386<br />
sudo apt-get update<br />
sudo apt-get install lib32z1 libncurses5:i386 libbz2-1.0:i386 lib32gcc-s1 lib32stdc++6 libtinfo5:i386 libcurl3-gnutls:i386 libsdl2-2.0-0:i386<br />
sudo ufw disable<br />
Those Ubuntu commands will install and update server in ~/hlserver/hlserver:<br />
mkdir ~/hlserver<br />
cd ./hlserver<br />
wget https://steamcdn-a.akamaihd.net/client/installer/steamcmd_linux.tar.gz<br />
tar zxf steamcmd_linux.tar.gz<br />
./steamcmd.sh +login anonymous +force_install_dir ./hlserver +app_update 232250 +quit<br />
You can browse server files in windows explorer with this Ubuntu command:<br />
explorer.exe ~/hlserver/hlserver<br />
If you have an existing windows server installation you can copy server files here.<br />
<br />
Install a linux version of sourcemod and mm: source in this location<br />
<br />
Unpack all sigsegv archive contents into tf directory<br />
<br />
Create a server starting file with Ubuntu commands:<br />
echo "#!/bin/sh" > ~/startserver.sh<br />
echo "~/hlserver/hlserver/srcds_run +map bigrock +maxplayers 32" >> ~/startserver.sh<br />
chmod u+x ~/startserver.sh<br />
Run server with Ubuntu command:<br />
~/startserver.sh<br />
Or, to run a server from windows CMD / PowerShell:<br />
wsl ~/startserver.sh<br />
You should check your linux server IP with a command executed in PowerShell. You can use this IP to connect to your server from this Windows PC. IP will change with every system reset:<br />
wsl hostname -I<br />
The section below tells how to connect to the server using your LAN or public IP if available<br />
<br />
<br />
You can make the server autostart by adding a scheduled task in Task Scheduler, on login condition, running wsl as a program with ~/startserver.sh as an argument.<br />
<br />
=Make the server accessible from the Internet and the local network=<br />
Download a program named [http://aluigi.altervista.org/mytoolz/sudppipe.zip sudppipe] (The browser may mark this file as unsafe so you might have to right click and select Save link As)<br />
<br />
Unpack the downloaded archive, then create tf2portpipe.bat file in the unpacked directory alongside sudppipe.exe. Replace port value with your own server port. The port should not be in use by any other program (TF2 client often binds to port 27015).<br />
@ECHO off<br />
<br />
SET port=27015<br />
<br />
FOR /F "tokens=* USEBACKQ" %%F IN (`wsl hostname -I`) DO (<br />
SET ip=%%F<br />
)<br />
%~dp0/sudppipe.exe -q -b 0.0.0.0 %ip% %port% %port%<br />
Run the bat file. If you wish to get rid of the console window, add a run on system startup scheduled task, with run whether user is logged on or not option, launching this script file as a program.<br />
[[Category:Tutorials]]</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Expressions&diff=7501Squirrel Expressions2023-10-31T23:35:28Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Operators BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Intro_to_Functions NEXT]</div><br />
<br />
Expressions are combinations of literals, variables, and operators which are evaluated to return a single value, which can then be used in variable assignment or other tasks.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl(1 + 2 + 3); // 1 + 2 + 3 is an expression which evaluates to the integer 6, 6 is then printed to the console<br />
<br />
local x = 500.0 / 2; // 500 / 2 is an expression which evaluates to 250.0, 250.0 is then assigned to x<br />
</syntaxhighlight><br />
<br />
With all the working parts, especially the operators, you might wonder how the compiler knows what order to parse your code in, or what order of operations to adhere to. This is called operator precedence, which determines what operators are called first over others in the same expression. You can view the [http://squirrel-lang.org/squirreldoc/reference/language/expressions.html?highlight=bitwise#operators-precedence Squirrel Precedence List] in the Squirrel Reference Manual. Keep in mind you should use this as a ''reference'', don't try to memorize the whole list, it's not necessary.<br />
<br />
<br />
Concerning precedence, there a few things that are worth remembering however, The most important is that parentheses have the highest operator precedence. If you're not sure of a particular operator precedence issue you can enforce your own order of operations with parentheses and get along just fine. Another important one is the precedence of logical NOT AND & OR between themselves, these are frequently used in programs together, so it's useful to remember the precedence order. NOT has the highest, then AND, and the lowest is OR. NOT AND OR. The same applies to the bitwise NOT AND OR/XOR. One last precedence issue that might pop up semi-frequently is that bitwise AND has a lower precedence than the relational operators (namely the inequality operator). This is relevant for the example in the previous chapter of testing for the existence of bit flags. (Note the parentheses present in that example)<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("beevus" || !true && "butthead"); // "beevus"<br />
// !true is evaluated first, NOT has the highest precedence, it becomes false<br />
// next is false && "butthead", which becomes false<br />
// next is "beevus" || false, which finally evaluates to "beevus", which is then printed to console<br />
</syntaxhighlight></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Operators&diff=7500Squirrel Operators2023-10-31T23:00:52Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div><br />
<br />
Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.<br />
This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Arithmetic'''</span><br />
<br />
The arithmetic operators <code>'''+, -, *, /, %'''</code> are used for, well, arithmetic! Technically we can use them on certain object types (more on in future sections), however by default they're for use with the integer, float, and (partially) string types. You should be familiar with most of these already.<br />
<br />
<br />
'''Unary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Unary minus<br />
| -<br />
| -x<br />
|Negation of x<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 50;<br />
x = -x; // -50<br />
</syntaxhighlight><br />
<br />
<br />
'''Binary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Addition<br />
| +<br />
| x + y<br />
|x plus y<br />
|- style="text-align:center"<br />
|Subtraction<br />
| -<br />
| x - y<br />
|x minus y<br />
|- style="text-align:center"<br />
|Multiplication<br />
| *<br />
| x * y<br />
|x multiplied by y<br />
|- style="text-align:center"<br />
|Division<br />
| /<br />
| x / y<br />
|x divided by y<br />
|- style="text-align:center"<br />
|Remainder<br />
| %<br />
| x % y<br />
|the remainder from: x divided by y<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 100 + 100; // 200<br />
local w = 0 - 2; // -2<br />
local x = 5.5 * 100; // 550.0<br />
local y = 20 / 2; // 10<br />
local z = 23 % 2; // 1<br />
</syntaxhighlight><br />
<br />
The addition operators <code>'''+'''</code> and <code>'''+='''</code> are the only operators able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.<br />
This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local str1 = "Hello,";<br />
local str2 = " World!";<br />
str1 += str2; // Hello World!<br />
// See next section for +=<br />
<br />
local float = 10 - 7.0 // 3.0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Assignment'''</span><br />
<br />
The assignment operator (<code>'''='''</code>) is used for assigning values to variables. It can be combined with the arithmetic operators to create arithmetic assignment operators (e.g. <code>'''x += 5'''</code>), which is a shortened version of: <code>'''x = x + 5'''</code>.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Assignment<br />
| =<br />
| x = y<br />
|assign value y to variable x<br />
|- style="text-align:center"<br />
|Addition Assignment<br />
| +=<br />
| x += y<br />
|assign x + y to variable x<br />
|- style="text-align:center"<br />
|Subtraction Assignment<br />
| -=<br />
| x -= y<br />
|assign x - y to variable x<br />
|- style="text-align:center"<br />
|Multiplication Assignment<br />
| *=<br />
| x *= y<br />
|assign x * y to variable x<br />
|- style="text-align:center"<br />
|Division Assignment<br />
| /=<br />
| x /= y<br />
|assign x / y to variable x<br />
|- style="text-align:center"<br />
|Remainder Assignment<br />
| %=<br />
| x %= y<br />
|assign x % y to variable x<br />
|- style="text-align:center"<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 100;<br />
x += 5; // equivalent to: x = x + 5<br />
x -= 5; // 100<br />
x *= 100; // 10,000<br />
x /= 2; // 5,000<br />
x %= 2; // 0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Increment/Decrement'''</span><br />
<br />
The increment and decrement operators are used (respectively) to increase or decrease a variable by 1. This can be done '''before''' the variable is returned in the case of the prefixed operators, or it can be done '''after''' the variable has been returned in the case of the postfixed operators.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Pre-increment<br />
| ++<br />
| ++x<br />
|increment x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-increment<br />
| ++<br />
| x++<br />
|copy x, increment variable x by 1, then return the copy<br />
|- style="text-align:center"<br />
|Pre-decrement<br />
| --<br />
| --x<br />
|decrement x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-decrement<br />
| --<br />
| x--<br />
|copy x, decrement variable x by 1, then return the copy<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 1;<br />
local y;<br />
<br />
y = x++; // y = 1, it got the value of x and then x got incremented, x = 2<br />
y = ++x; // y = 3, x got incremented and then y got x's value, x = 3<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Relational'''</span><br />
<br />
The relational operators compare the values of their operands and return a boolean based on their result.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Equality<br />
| ==<br />
| x == y<br />
|true if x equals y, false otherwise<br />
|- style="text-align:center"<br />
|Inequality<br />
| !=<br />
| x != y<br />
|true if x does not equal y, false otherwise<br />
|- style="text-align:center"<br />
|Less than<br />
| <<br />
| x < y<br />
|true if x is less than y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than<br />
| ><br />
| x > y<br />
|true if x is greater than y, false otherwise<br />
|- style="text-align:center"<br />
|Less than or equal to<br />
| <=<br />
| x <= y<br />
|true if x is less than or equal to y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than or equal to<br />
| >=<br />
| x >= y<br />
|true if x is greater than or equal to y, false otherwise<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 5;<br />
local y = 5;<br />
local z;<br />
<br />
z = x == y; // true<br />
z = x != y; // false<br />
z = x > y; // false<br />
z = x >= y; // true<br />
z = x < y; // false<br />
z = x <= y; // true<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Logical'''</span><br />
<br />
The logical operators are primarily used in control flow to create condition based code. We'll go over control flow in a future section, for now just know that they exist and that you can reference back here if you forget what one does.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Logical NOT<br />
| !<br />
| !x<br />
|true if x evaluates to false, otherwise true<br />
|- style="text-align:center"<br />
|Logical AND<br />
| &&<br />
| x && y<br />
|true if both operands evaluate to true, otherwise false<br />
|- style="text-align:center"<br />
|Logical OR<br />
| <nowiki>||</nowiki><br />
| x <nowiki>||</nowiki> y<br />
|true if either operand evaluates to true, otherwise false<br />
|}<br />
<br />
For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.<br />
<pre><br />
Logical AND will return the *first* operand that evaluates to *false*, if none do, it will return the *last* operand.<br />
<br />
Logical OR will return the *first* operand that evaluates to *true*, if none do, it will return the *last* operand.<br />
</pre><br />
A common use case of this functionality with the logical OR operator is to fill a variable with the first value that evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local var = othervar || otherothervar || 1;<br />
</syntaxhighlight><br />
<br />
In some cases we may have access to variables that we don't know the value of, they could be null for all we know! This is a good way of providing "backup" values to use in our program.<br />
<br />
<br />
Certain values evaluate to false, these are: <code>'''false, null, 0, 0.0'''</code>. Everything else evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 0 && 1; // 0<br />
local w = null || "bark"; // "bark"<br />
local x = "" || true; // ""<br />
local y = !0; // true<br />
local z = 5 && "0" // "0"<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Bitwise'''</span><br />
<br />
All data in computer memory is stored as sequences of bits; 0's and 1's. The bitwise operators work directly with those bits for integer values in Squirrel. As a beginner you aren't likely to use these operators unless you have a very specific reason to. We won't go over what each of these does under the hood as it's a bit out of scope for this language introduction, however if you want to learn more about bits and the bitwise operators, [https://www.learncpp.com/cpp-tutorial/bitwise-operators/ learncpp.com] goes over them quite nicely. (Just ignore the C++ specific stuff.)<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Bitwise NOT<br />
| ~<br />
| ~x<br />
|Flips all bits in x; 1 becomes 0 and 0 becomes 1<br />
|- style="text-align:center"<br />
|Bitwise AND<br />
| &<br />
| x & y<br />
|Each bit in x AND each bit in y<br />
|- style="text-align:center"<br />
|Bitwise OR<br />
| <nowiki>|</nowiki><br />
| x <nowiki>|</nowiki> y<br />
|Each bit in x OR each bit in y<br />
|- style="text-align:center"<br />
|Bitwise XOR<br />
| ^<br />
| x ^ y<br />
|Each bit in x Exclusive OR each bit in y<br />
|- style="text-align:center"<br />
|Left shift<br />
| <<<br />
| x << y<br />
|Shift all bits in x left by integer y spaces<br />
|- style="text-align:center"<br />
|Right shift<br />
| >><br />
| x >> y<br />
|Shift all bits in x right by integer y spaces<br />
|- style="text-align:center"<br />
|Unsigned right shift<br />
| >>><br />
| x >>> y<br />
|Same as normal right shift (>>) but treat x as unsigned (only positive values, no negative ones)<br />
|}<br />
<br />
<br />
For day to day use, you're mostly going to be using bitwise AND along with bitwise OR to manipulate '''bit flags''', which are variables where each of the 32 bits (or however big the variable is) represents a boolean flag. So instead of having 32 different boolean variables, you can have 1 variable that represents 32 booleans!<br />
<br />
The m_fFlags datamap of [[CBaseEntity]] in the Source Engine is a real example of this, each of the 32 bits of the integer can represent a flag. Defined in the source code are macros which contain the values for these bits, as you can see below the left shift operator is used to shift the bits (more accurately the only bit) of integer 1 left by an increasing amount of places.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
#define FL_ONGROUND (1<<0) // At rest / on the ground<br />
#define FL_DUCKING (1<<1) // Player flag -- Player is fully crouched<br />
#define FL_ANIMDUCKING (1<<2) // Player flag -- Player is in the process of crouching or uncrouching but could be in transition<br />
#define FL_WATERJUMP (1<<3) // player jumping out of water<br />
#define FL_ONTRAIN (1<<4) // Player is _controlling_ a train, so movement commands should be ignored on client during prediction.<br />
<br />
...<br />
<br />
#define FL_UNBLOCKABLE_BY_PLAYER (1<<31) // pusher that can't be blocked by the player<br />
</syntaxhighlight><br />
<br />
The middle part has been omitted for brevity, the first five macros are equivalent to the integer values: <code>'''1, 2, 4, 8, and 16'''</code> and the last is <code>'''2147483648'''</code>. In VScript, these have been defined in the [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants#FPlayer FPlayer] enum and can be used in your programs when necessary, however the way to manipulate bit flags is a bit different than regular integers, you can't just try to add them together with the addition operator!<br />
<br />
<br />
To add bit flags together, use the bitwise OR (<code>'''|'''</code>) operator.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration<br />
<br />
local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING; // 7 (1 + 2 + 4)<br />
</syntaxhighlight><br />
<br />
To remove a flag, use the bitwise AND (<code>'''&'''</code>) operator along with the bitwise NOT (<code>'''~'''</code>) operator on the flag.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration<br />
<br />
local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING; // 7 (1 + 2 + 4)<br />
<br />
printl(mybitflags & ~FL_ONGROUND); // 6<br />
printl( mybitflags & ~(FL_ONGROUND | FL_ANIMDUCKING) ); // 2<br />
</syntaxhighlight><br />
<br />
To test if a flag is present, use the bitwise AND (<code>'''&'''</code>) operator and compare the result against 0 using the inequality operator.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration<br />
<br />
local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING;<br />
local testflags = FL_ONGROUND | FL_DUCKING;<br />
<br />
printl( (mybitflags & testflags) != 0 ) // true<br />
printl( (mybitflags & FL_ONTRAIN) != 0 ) // false<br />
</syntaxhighlight></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7499Squirrel Variables2023-10-31T22:37:05Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is comprised of a set of instructions called '''statements''' which manipulate data to produce a desired result. Programs store data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''. You can think of statements as analogous to sentences in the language we speak to each other, each requires a specific set of items to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, and statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.<br />
<br />
<br />
Normal variables like the ones we defined above can be changed at any time, however what if we have a variable that we don't want to change or that wouldn't make any sense to change? This is where constants come in.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
const DAYS_IN_WEEK = 7;<br />
const PI = 3.1415926535;<br />
const NAME = "Dell Conagher";<br />
</syntaxhighlight><br />
<br />
Constants are variables which cannot be changed after they are created, however they can only contain certain values. Constants may only be created with integer, float, or string '''literals'''. We go over what these are in depth in the [https://sigwiki.potato.tf/index.php/Squirrel_Data_Types Data Types] chapter. For now if you'd like a reference of what those are, the variables in the above example contain the specified types. <code>7</code> is an '''integer''', <code>3.14</code> is a '''float''', and <code>"Dell Conagher"</code> is a '''string'''.</div>Mincehttps://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel&diff=7498An Introduction to Squirrel2023-10-31T22:19:32Z<p>Mince: </p>
<hr />
<div>== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==<br />
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.<br />
<br />
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.<br />
<br />
<br />
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==<br />
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:<br />
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]<br />
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]<br />
<br />
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)<br />
<br />
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><br />
<br />
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>.<br />
<br />
For example: <code>bind 5 "script_execute testing"</code><br />
<br />
<br />
Tab out of your game, open your .nut file and type:<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("Hello World!");<br />
</syntaxhighlight><br />
<br />
<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. That's all to get started! Get started with the guide by choosing a chapter in the table below. Make sure to tinker with the examples in the guide to see first hand how Squirrel works!<br />
<br />
Good luck!<br />
<br />
<br />
<hr><br />
<br />
<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|}<br />
|}</div>Mincehttps://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel&diff=7497An Introduction to Squirrel2023-10-31T22:19:13Z<p>Mince: </p>
<hr />
<div>== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==<br />
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.<br />
<br />
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.<br />
<br />
<br />
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==<br />
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:<br />
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]<br />
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]<br />
<br />
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)<br />
<br />
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><br />
<br />
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>.<br />
<br />
For example: <code>bind 5 "script_execute testing"</code><br />
<br />
<br />
Tab out of your game, open your .nut file and type:<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("Hello World!");<br />
</syntaxhighlight><br />
<br />
<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. That's all to get started! Get started with the guide by choosing a chapter in the table below. Make sure to tinker with the examples to see first hand how Squirrel works!<br />
<br />
Good luck!<br />
<br />
<br />
<hr><br />
<br />
<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|}<br />
|}</div>Mincehttps://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel&diff=7496An Introduction to Squirrel2023-10-31T22:17:39Z<p>Mince: </p>
<hr />
<div>== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==<br />
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.<br />
<br />
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.<br />
<br />
<br />
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==<br />
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:<br />
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]<br />
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]<br />
<br />
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)<br />
<br />
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><br />
<br />
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>.<br />
<br />
For example: <code>bind 5 "script_execute testing"</code><br />
<br />
<br />
Tab out of your game, open your .nut file and type:<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("Hello World!");<br />
</syntaxhighlight><br />
<br />
<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. That's all to get started! Follow along through the guide and tinker with the examples to see first hand how Squirrel works, good luck!<br />
<br />
<br />
<hr><br />
<br />
<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|}<br />
|}</div>Mincehttps://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel&diff=7495An Introduction to Squirrel2023-10-31T22:16:25Z<p>Mince: </p>
<hr />
<div>== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==<br />
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.<br />
<br />
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.<br />
<br />
<br />
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==<br />
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:<br />
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]<br />
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]<br />
<br />
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)<br />
<br />
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><br />
<br />
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>.<br />
<br />
For example: <code>bind 5 "script_execute testing"</code><br />
<br />
<br />
Tab out of your game, open your .nut file and type:<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("Hello World!");<br />
</syntaxhighlight><br />
<br />
After saving the file and pressing our script button in-game, you'll see <code>Hello World!</code> in console. That's all to get started! Follow along through the guide and tinker with the examples to see first hand how Squirrel works, good luck!<br />
<br />
<br />
<hr><br />
<br />
<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|}<br />
|}</div>Mincehttps://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel&diff=7494An Introduction to Squirrel2023-10-31T22:15:52Z<p>Mince: </p>
<hr />
<div>== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==<br />
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.<br />
<br />
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.<br />
<br />
<br />
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==<br />
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:<br />
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]<br />
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]<br />
<br />
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)<br />
<br />
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><br />
<br />
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>.<br />
<br />
For example: <code>bind 5 "script_execute testing"</code><br />
<br />
<br />
Tab out of your game, open your .nut file and type:<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("Hello World!");<br />
</syntaxhighlight><br />
<br />
After saving the file and pressing our script button in-game, you'll see <code>Hello World!</code> in console. That's all to get started! Follow along through the guide and tinker with your own little programs to see first hand how Squirrel works, good luck!<br />
<br />
<br />
<hr><br />
<br />
<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|}<br />
|}</div>Mincehttps://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel&diff=7493An Introduction to Squirrel2023-10-31T22:12:37Z<p>Mince: </p>
<hr />
<div>== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Overview] ==<br />
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.<br />
<br />
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.<br />
<br />
<br />
== [https://sigwiki.potato.tf/index.php?title=An_Introduction_to_Squirrel Getting Started] ==<br />
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:<br />
* [https://developer.valvesoftware.com/wiki/VScript_Fundamentals VScript Fundamentals]<br />
* [https://developer.valvesoftware.com/wiki/Entity_Scripts Entity Scripts]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions Script Functions]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants Constants]<br />
* [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/VScript_Examples/en VScript Examples]<br />
<br />
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)<br />
<br />
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><br />
<br />
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".<br />
For example: bind 5 "script_execute testing"<br />
<br />
Tab out of your game, open your .nut file and type:<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
printl("Hello World!");<br />
</syntaxhighlight><br />
<br />
This prints the text "Hello World!" to console, we'll cover what all this means later, for now this is just to make sure you have a set up to test with as you read through the guide.<br />
<br />
<br />
<hr><br />
<br />
<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0;"<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable mw-collapsible mw-collapsed" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! colspan="1" style="padding: 25px; background-color: #303030; color: white; border: 2px solid black" | Chapters<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|-<br />
| colspan="1" style="padding: 0; margin: 0; width: 100%;" |<br />
{| class="wikitable" style="margin: 0 auto; width: 100%; padding: 0; border: none;"<br />
! 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]<br />
|}<br />
|}<br />
|}</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Operators&diff=7492Squirrel Operators2023-10-31T22:08:41Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div><br />
<br />
Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.<br />
This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Arithmetic'''</span><br />
<br />
The arithmetic operators <code>'''+, -, *, /, %'''</code> are used for, well, arithmetic! Technically we can use them on certain object types (more on in future sections), however by default they're for use with the integer, float, and (partially) string types. You should be familiar with most of these already.<br />
<br />
<br />
'''Unary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Unary minus<br />
| -<br />
| -x<br />
|Negation of x<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 50;<br />
x = -x; // -50<br />
</syntaxhighlight><br />
<br />
<br />
'''Binary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Addition<br />
| +<br />
| x + y<br />
|x plus y<br />
|- style="text-align:center"<br />
|Subtraction<br />
| -<br />
| x - y<br />
|x minus y<br />
|- style="text-align:center"<br />
|Multiplication<br />
| *<br />
| x * y<br />
|x multiplied by y<br />
|- style="text-align:center"<br />
|Division<br />
| /<br />
| x / y<br />
|x divided by y<br />
|- style="text-align:center"<br />
|Remainder<br />
| %<br />
| x % y<br />
|the remainder from: x divided by y<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 100 + 100; // 200<br />
local w = 0 - 2; // -2<br />
local x = 5.5 * 100; // 550.0<br />
local y = 20 / 2; // 10<br />
local z = 23 % 2; // 1<br />
</syntaxhighlight><br />
<br />
The addition operators <code>'''+'''</code> and <code>'''+='''</code> are the only operators able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.<br />
This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local str1 = "Hello,";<br />
local str2 = " World!";<br />
str1 += str2; // Hello World!<br />
// See next section for +=<br />
<br />
local float = 10 - 7.0 // 3.0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Assignment'''</span><br />
<br />
The assignment operator (<code>'''='''</code>) is used for assigning values to variables. It can be combined with the arithmetic operators to create arithmetic assignment operators (e.g. <code>'''x += 5'''</code>), which is a shortened version of: <code>'''x = x + 5'''</code>.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Assignment<br />
| =<br />
| x = y<br />
|assign value y to variable x<br />
|- style="text-align:center"<br />
|Addition Assignment<br />
| +=<br />
| x += y<br />
|assign x + y to variable x<br />
|- style="text-align:center"<br />
|Subtraction Assignment<br />
| -=<br />
| x -= y<br />
|assign x - y to variable x<br />
|- style="text-align:center"<br />
|Multiplication Assignment<br />
| *=<br />
| x *= y<br />
|assign x * y to variable x<br />
|- style="text-align:center"<br />
|Division Assignment<br />
| /=<br />
| x /= y<br />
|assign x / y to variable x<br />
|- style="text-align:center"<br />
|Remainder Assignment<br />
| %=<br />
| x %= y<br />
|assign x % y to variable x<br />
|- style="text-align:center"<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 100;<br />
x += 5; // equivalent to: x = x + 5<br />
x -= 5; // 100<br />
x *= 100; // 10,000<br />
x /= 2; // 5,000<br />
x %= 2; // 0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Increment/Decrement'''</span><br />
<br />
The increment and decrement operators are used (respectively) to increase or decrease a variable by 1. This can be done '''before''' the variable is returned in the case of the prefixed operators, or it can be done '''after''' the variable has been returned in the case of the postfixed operators.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Pre-increment<br />
| ++<br />
| ++x<br />
|increment x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-increment<br />
| ++<br />
| x++<br />
|copy x, increment variable x by 1, then return the copy<br />
|- style="text-align:center"<br />
|Pre-decrement<br />
| --<br />
| --x<br />
|decrement x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-decrement<br />
| --<br />
| x--<br />
|copy x, decrement variable x by 1, then return the copy<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 1;<br />
local y;<br />
<br />
y = x++; // y = 1, it got the value of x and then x got incremented, x = 2<br />
y = ++x; // y = 3, x got incremented and then y got x's value, x = 3<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Relational'''</span><br />
<br />
The relational operators compare the values of their operands and return a boolean based on their result.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Equality<br />
| ==<br />
| x == y<br />
|true if x equals y, false otherwise<br />
|- style="text-align:center"<br />
|Inequality<br />
| !=<br />
| x != y<br />
|true if x does not equal y, false otherwise<br />
|- style="text-align:center"<br />
|Less than<br />
| <<br />
| x < y<br />
|true if x is less than y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than<br />
| ><br />
| x > y<br />
|true if x is greater than y, false otherwise<br />
|- style="text-align:center"<br />
|Less than or equal to<br />
| <=<br />
| x <= y<br />
|true if x is less than or equal to y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than or equal to<br />
| >=<br />
| x >= y<br />
|true if x is greater than or equal to y, false otherwise<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 5;<br />
local y = 5;<br />
local z;<br />
<br />
z = x == y; // true<br />
z = x != y; // false<br />
z = x > y; // false<br />
z = x >= y; // true<br />
z = x < y; // false<br />
z = x <= y; // true<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Logical'''</span><br />
<br />
The logical operators are primarily used in control flow to create condition based code. We'll go over control flow in a future section, for now just know that they exist and that you can reference back here if you forget what one does.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Logical NOT<br />
| !<br />
| !x<br />
|true if x evaluates to false, otherwise true<br />
|- style="text-align:center"<br />
|Logical AND<br />
| &&<br />
| x && y<br />
|true if both operands evaluate to true, otherwise false<br />
|- style="text-align:center"<br />
|Logical OR<br />
| <nowiki>||</nowiki><br />
| x <nowiki>||</nowiki> y<br />
|true if either operand evaluates to true, otherwise false<br />
|}<br />
<br />
For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.<br />
<pre><br />
Logical AND will return the *first* operand that evaluates to *false*, if none do, it will return the *last* operand.<br />
<br />
Logical OR will return the *first* operand that evaluates to *true*, if none do, it will return the *last* operand.<br />
</pre><br />
A common use case of this functionality with the logical OR operator is to fill a variable with the first value that evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local var = othervar || otherothervar || 1;<br />
</syntaxhighlight><br />
<br />
In some cases we may have access to variables that we don't know the value of, they could be null for all we know! This is a good way of providing "backup" values to use in our program.<br />
<br />
<br />
Certain values evaluate to false, these are: <code>'''false, null, 0, 0.0'''</code>. Everything else evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 0 && 1; // 0<br />
local w = null || "bark"; // "bark"<br />
local x = "" || true; // ""<br />
local y = !0; // true<br />
local z = 5 && "0" // "0"<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Bitwise'''</span><br />
<br />
All data in computer memory is stored as sequences of bits; 0's and 1's. The bitwise operators work directly with those bits for integer values in Squirrel. As a beginner you aren't likely to use these operators unless you have a very specific reason to. We won't go over what each of these does under the hood as it's a bit out of scope for this language introduction, however if you want to learn more about bits and the bitwise operators, [https://www.learncpp.com/cpp-tutorial/bitwise-operators/ learncpp.com] goes over them quite nicely. (Just ignore the C++ specific stuff.)<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Bitwise NOT<br />
| ~<br />
| ~x<br />
|Flips all bits in x; 1 becomes 0 and 0 becomes 1<br />
|- style="text-align:center"<br />
|Bitwise AND<br />
| &<br />
| x & y<br />
|Each bit in x AND each bit in y<br />
|- style="text-align:center"<br />
|Bitwise OR<br />
| <nowiki>|</nowiki><br />
| x <nowiki>|</nowiki> y<br />
|Each bit in x OR each bit in y<br />
|- style="text-align:center"<br />
|Bitwise XOR<br />
| ^<br />
| x ^ y<br />
|Each bit in x Exclusive OR each bit in y<br />
|- style="text-align:center"<br />
|Left shift<br />
| <<<br />
| x << y<br />
|Shift all bits in x left by integer y spaces<br />
|- style="text-align:center"<br />
|Right shift<br />
| >><br />
| x >> y<br />
|Shift all bits in x right by integer y spaces<br />
|- style="text-align:center"<br />
|Unsigned right shift<br />
| >>><br />
| x >>> y<br />
|Same as normal right shift (>>) but treat x as unsigned (only positive values, no negative ones)<br />
|}<br />
<br />
<br />
For day to day use, you're mostly going to be using bitwise AND along with bitwise OR to manipulate '''bit flags''', which are variables where each of the 32 bits (or however big the variable is) represents a boolean flag. So instead of having 32 different boolean variables, you can have 1 variable that represents 32 booleans!<br />
<br />
The m_fFlags datamap of [[CBaseEntity]] in the Source Engine is a real example of this, each of the 32 bits of the integer can represent a flag. Defined in the source code are macros which contain the values for these bits, as you can see below the left shift operator is used to shift the bits (more accurately the only bit) of integer 1 left by an increasing amount of places.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
#define FL_ONGROUND (1<<0) // At rest / on the ground<br />
#define FL_DUCKING (1<<1) // Player flag -- Player is fully crouched<br />
#define FL_ANIMDUCKING (1<<2) // Player flag -- Player is in the process of crouching or uncrouching but could be in transition<br />
#define FL_WATERJUMP (1<<3) // player jumping out of water<br />
#define FL_ONTRAIN (1<<4) // Player is _controlling_ a train, so movement commands should be ignored on client during prediction.<br />
<br />
...<br />
<br />
#define FL_UNBLOCKABLE_BY_PLAYER (1<<31) // pusher that can't be blocked by the player<br />
</syntaxhighlight><br />
<br />
The middle part has been omitted for brevity, the first five macros are equivalent to the integer values: <code>'''1, 2, 4, 8, and 16'''</code> and the last is <code>'''2147483648'''</code>. In VScript, these have been defined in the [https://developer.valvesoftware.com/wiki/Team_Fortress_2/Scripting/Script_Functions/Constants#FPlayer FPlayer] enum and can be used in your programs when necessary, however the way to manipulate bit flags is a bit different than regular integers, you can't just try to add them together with the addition operator!<br />
<br />
<br />
To add bit flags together, use the bitwise OR (<code>'''|'''</code>) operator.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration<br />
<br />
local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING; // 7 (1 + 2 + 4)<br />
</syntaxhighlight><br />
<br />
To remove a flag, use the bitwise AND (<code>'''&'''</code>) operator along with the bitwise NOT (<code>'''~'''</code>) operator on the flag.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration<br />
<br />
local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING; // 7 (1 + 2 + 4)<br />
<br />
printl(mybitflags & ~FL_ONGROUND); // 6<br />
printl( mybitflags & ~(FL_ONGROUND | FL_ANIMDUCKING) ); // 2<br />
</syntaxhighlight><br />
<br />
To test if a flag is present, use the bitwise AND (<code>'''&'''</code>) operator and compare the result against 0 using the inequality operator.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration<br />
<br />
local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING;<br />
local testflags = FL_ONGROUND | FL_DUCKING;<br />
<br />
printl( (mybitflags & testflags) != 0 ) // true<br />
printl( (mybitflags & FL_ONTRAIN) != 0 ) // false<br />
</syntaxhighlight><br />
<br />
<span style="font-size:120%">'''Other Operators'''</span><br />
<br />
in, instanceof, typeof, comma, ternary<br />
<br />
<br />
<span style="font-size:120%">'''Operator Precedence'''</span><br />
<br />
-, ~, !, typeof , ++, -- highest<br />
/, *, % …<br />
+, - <br />
<<, >>, >>> <br />
<, <=, >, >=, instanceof <br />
==, !=, <=> <br />
& <br />
^ <br />
&&, in <br />
+=, =, -=, /=, *=, %= …<br />
, (comma operator) lowest</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Operators&diff=7491Squirrel Operators2023-10-31T20:47:55Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div><br />
<br />
Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.<br />
This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Arithmetic'''</span><br />
<br />
The arithmetic operators <code>'''+, -, *, /, %'''</code> are used for, well, arithmetic! Technically we can use them on certain object types (more on in future sections), however by default they're for use with the integer, float, and (partially) string types. You should be familiar with most of these already.<br />
<br />
<br />
'''Unary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Unary minus<br />
| -<br />
| -x<br />
|Negation of x<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 50;<br />
x = -x; // -50<br />
</syntaxhighlight><br />
<br />
<br />
'''Binary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Addition<br />
| +<br />
| x + y<br />
|x plus y<br />
|- style="text-align:center"<br />
|Subtraction<br />
| -<br />
| x - y<br />
|x minus y<br />
|- style="text-align:center"<br />
|Multiplication<br />
| *<br />
| x * y<br />
|x multiplied by y<br />
|- style="text-align:center"<br />
|Division<br />
| /<br />
| x / y<br />
|x divided by y<br />
|- style="text-align:center"<br />
|Remainder<br />
| %<br />
| x % y<br />
|the remainder from: x divided by y<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 100 + 100; // 200<br />
local w = 0 - 2; // -2<br />
local x = 5.5 * 100; // 550.0<br />
local y = 20 / 2; // 10<br />
local z = 23 % 2; // 1<br />
</syntaxhighlight><br />
<br />
The addition operators <code>'''+'''</code> and <code>'''+='''</code> are the only operators able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.<br />
This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local str1 = "Hello,";<br />
local str2 = " World!";<br />
str1 += str2; // Hello World!<br />
// See next section for +=<br />
<br />
local float = 10 - 7.0 // 3.0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Assignment'''</span><br />
<br />
The assignment operator (<code>'''='''</code>) is used for assigning values to variables. It can be combined with the arithmetic operators to create arithmetic assignment operators (e.g. <code>'''x += 5'''</code>), which is a shortened version of: <code>'''x = x + 5'''</code>.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Assignment<br />
| =<br />
| x = y<br />
|assign value y to variable x<br />
|- style="text-align:center"<br />
|Addition Assignment<br />
| +=<br />
| x += y<br />
|assign x + y to variable x<br />
|- style="text-align:center"<br />
|Subtraction Assignment<br />
| -=<br />
| x -= y<br />
|assign x - y to variable x<br />
|- style="text-align:center"<br />
|Multiplication Assignment<br />
| *=<br />
| x *= y<br />
|assign x * y to variable x<br />
|- style="text-align:center"<br />
|Division Assignment<br />
| /=<br />
| x /= y<br />
|assign x / y to variable x<br />
|- style="text-align:center"<br />
|Remainder Assignment<br />
| %=<br />
| x %= y<br />
|assign x % y to variable x<br />
|- style="text-align:center"<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 100;<br />
x += 5; // equivalent to: x = x + 5<br />
x -= 5; // 100<br />
x *= 100; // 10,000<br />
x /= 2; // 5,000<br />
x %= 2; // 0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Increment/Decrement'''</span><br />
<br />
The increment and decrement operators are used (respectively) to increase or decrease a variable by 1. This can be done '''before''' the variable is returned in the case of the prefixed operators, or it can be done '''after''' the variable has been returned in the case of the postfixed operators.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Pre-increment<br />
| ++<br />
| ++x<br />
|increment x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-increment<br />
| ++<br />
| x++<br />
|copy x, increment variable x by 1, then return the copy<br />
|- style="text-align:center"<br />
|Pre-decrement<br />
| --<br />
| --x<br />
|decrement x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-decrement<br />
| --<br />
| x--<br />
|copy x, decrement variable x by 1, then return the copy<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 1;<br />
local y;<br />
<br />
y = x++; // y = 1, it got the value of x and then x got incremented, x = 2<br />
y = ++x; // y = 3, x got incremented and then y got x's value, x = 3<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Relational'''</span><br />
<br />
The relational operators compare the values of their operands and return a boolean based on their result.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Equality<br />
| ==<br />
| x == y<br />
|true if x equals y, false otherwise<br />
|- style="text-align:center"<br />
|Inequality<br />
| !=<br />
| x != y<br />
|true if x does not equal y, false otherwise<br />
|- style="text-align:center"<br />
|Less than<br />
| <<br />
| x < y<br />
|true if x is less than y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than<br />
| ><br />
| x > y<br />
|true if x is greater than y, false otherwise<br />
|- style="text-align:center"<br />
|Less than or equal to<br />
| <=<br />
| x <= y<br />
|true if x is less than or equal to y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than or equal to<br />
| >=<br />
| x >= y<br />
|true if x is greater than or equal to y, false otherwise<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 5;<br />
local y = 5;<br />
local z;<br />
<br />
z = x == y; // true<br />
z = x != y; // false<br />
z = x > y; // false<br />
z = x >= y; // true<br />
z = x < y; // false<br />
z = x <= y; // true<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Logical'''</span><br />
<br />
The logical operators are primarily used in control flow to create condition based code. We'll go over control flow in a future section, for now just know that they exist and that you can reference back here if you forget what one does.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Logical NOT<br />
| !<br />
| !x<br />
|true if x evaluates to false, otherwise true<br />
|- style="text-align:center"<br />
|Logical AND<br />
| &&<br />
| x && y<br />
|true if both operands evaluate to true, otherwise false<br />
|- style="text-align:center"<br />
|Logical OR<br />
| <nowiki>||</nowiki><br />
| x <nowiki>||</nowiki> y<br />
|true if either operand evaluates to true, otherwise false<br />
|}<br />
<br />
For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.<br />
<br />
Logical AND will return the '''first''' operand that evaluates to '''false''', if none do, it will return the '''last''' operand.<br />
<br />
Logical OR will return the '''first''' operand that evaluates to '''true''', if none do, it will return the '''last''' operand.<br />
<br />
A common use case of this functionality with the logical OR operator is to fill a variable with the first value that evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local var = othervar || otherothervar || 1;<br />
</syntaxhighlight><br />
<br />
In some cases we may have access to variables that we don't know if they are null or not. This is a good way of providing "backup" values to use in our program.<br />
<br />
<br />
Certain values evaluate to false, these are: <code>'''false, null, 0, 0.0'''</code>. Everything else evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 0 && 1; // 0<br />
local w = null || "bark"; // "bark"<br />
local x = "" || true; // ""<br />
local y = !0; // true<br />
local z = 5 && "0" // "0"<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Bitwise'''</span><br />
<br />
All data in computer memory is stored as sequences of bits; 0's and 1's. The bitwise operators work directly with the bits of variables and literals in Squirrel. These operators are rarely used unless you have very specific needs within your program. For day to day use, you're mostly going to be using bitwise AND & bitwise OR to manipulate '''bit flags''', which are variables where each of the 32 bits (or however big the variable is) represents a boolean flag. So instead of having 32 different boolean variables, you can have 1 variable that represents 32 booleans!<br />
&, |, ^, ~, <<, >>, >>><br />
<br />
<span style="font-size:120%">'''Other Operators'''</span><br />
<br />
in, instanceof, typeof, comma, ternary<br />
<br />
<br />
<span style="font-size:120%">'''Operator Precedence'''</span><br />
<br />
-, ~, !, typeof , ++, -- highest<br />
/, *, % …<br />
+, - <br />
<<, >>, >>> <br />
<, <=, >, >=, instanceof <br />
==, !=, <=> <br />
& <br />
^ <br />
&&, in <br />
+=, =, -=, /=, *=, %= …<br />
, (comma operator) lowest<br />
<br />
IntegerLiteral ::= [1-9][0-9]* | '0x' [0-9A-Fa-f]+ | ''' [.]+ ''' | 0[0-7]+<br />
FloatLiteral ::= [0-9]+ '.' [0-9]+<br />
FloatLiteral ::= [0-9]+ '.' 'e'|'E' '+'|'-' [0-9]+<br />
StringLiteral ::= '"'[.]* '"'<br />
VerbatimStringLiteral ::= '@''"'[.]* '"'</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Operators&diff=7490Squirrel Operators2023-10-27T21:55:37Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div><br />
<br />
Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.<br />
This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Arithmetic'''</span><br />
<br />
The arithmetic operators <code>'''+, -, *, /, %'''</code> are used for, well, arithmetic! Technically we can use them on certain object types (more on in future sections), however by default they're for use with the integer, float, and (partially) string types. You should be familiar with most of these already.<br />
<br />
<br />
'''Unary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Unary minus<br />
| -<br />
| -x<br />
|Negation of x<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 50;<br />
x = -x; // -50<br />
</syntaxhighlight><br />
<br />
<br />
'''Binary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Addition<br />
| +<br />
| x + y<br />
|x plus y<br />
|- style="text-align:center"<br />
|Subtraction<br />
| -<br />
| x - y<br />
|x minus y<br />
|- style="text-align:center"<br />
|Multiplication<br />
| *<br />
| x * y<br />
|x multiplied by y<br />
|- style="text-align:center"<br />
|Division<br />
| /<br />
| x / y<br />
|x divided by y<br />
|- style="text-align:center"<br />
|Remainder<br />
| %<br />
| x % y<br />
|the remainder from: x divided by y<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 100 + 100; // 200<br />
local w = 0 - 2; // -2<br />
local x = 5.5 * 100; // 550.0<br />
local y = 20 / 2; // 10<br />
local z = 23 % 2; // 1<br />
</syntaxhighlight><br />
<br />
The addition operators <code>'''+'''</code> and <code>'''+='''</code> are the only operators able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.<br />
This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local str1 = "Hello,";<br />
local str2 = " World!";<br />
str1 += str2; // Hello World!<br />
// See next section for +=<br />
<br />
local float = 10 - 7.0 // 3.0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Assignment'''</span><br />
<br />
The assignment operator (<code>'''='''</code>) is used for assigning values to variables. It can be combined with the arithmetic operators to create arithmetic assignment operators (e.g. <code>'''x += 5'''</code>), which is a shortened version of: <code>'''x = x + 5'''</code>.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Assignment<br />
| =<br />
| x = y<br />
|assign value y to variable x<br />
|- style="text-align:center"<br />
|Addition Assignment<br />
| +=<br />
| x += y<br />
|assign x + y to variable x<br />
|- style="text-align:center"<br />
|Subtraction Assignment<br />
| -=<br />
| x -= y<br />
|assign x - y to variable x<br />
|- style="text-align:center"<br />
|Multiplication Assignment<br />
| *=<br />
| x *= y<br />
|assign x * y to variable x<br />
|- style="text-align:center"<br />
|Division Assignment<br />
| /=<br />
| x /= y<br />
|assign x / y to variable x<br />
|- style="text-align:center"<br />
|Remainder Assignment<br />
| %=<br />
| x %= y<br />
|assign x % y to variable x<br />
|- style="text-align:center"<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 100;<br />
x += 5; // equivalent to: x = x + 5<br />
x -= 5; // 100<br />
x *= 100; // 10,000<br />
x /= 2; // 5,000<br />
x %= 2; // 0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Increment/Decrement'''</span><br />
<br />
The increment and decrement operators are used (respectively) to increase or decrease a variable by 1. This can be done '''before''' the variable is returned in the case of the prefixed operators, or it can be done '''after''' the variable has been returned in the case of the postfixed operators.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Pre-increment<br />
| ++<br />
| ++x<br />
|increment x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-increment<br />
| ++<br />
| x++<br />
|copy x, increment variable x by 1, then return the copy<br />
|- style="text-align:center"<br />
|Pre-decrement<br />
| --<br />
| --x<br />
|decrement x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-decrement<br />
| --<br />
| x--<br />
|copy x, decrement variable x by 1, then return the copy<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 1;<br />
local y;<br />
<br />
y = x++; // y = 1, it got the value of x and then x got incremented, x = 2<br />
y = ++x; // y = 3, x got incremented and then y got x's value, x = 3<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Relational'''</span><br />
<br />
The relational operators compare the values of their operands and return a boolean based on their result.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Equality<br />
| ==<br />
| x == y<br />
|true if x equals y, false otherwise<br />
|- style="text-align:center"<br />
|Inequality<br />
| !=<br />
| x != y<br />
|true if x does not equal y, false otherwise<br />
|- style="text-align:center"<br />
|Less than<br />
| <<br />
| x < y<br />
|true if x is less than y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than<br />
| ><br />
| x > y<br />
|true if x is greater than y, false otherwise<br />
|- style="text-align:center"<br />
|Less than or equal to<br />
| <=<br />
| x <= y<br />
|true if x is less than or equal to y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than or equal to<br />
| >=<br />
| x >= y<br />
|true if x is greater than or equal to y, false otherwise<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 5;<br />
local y = 5;<br />
local z;<br />
<br />
z = x == y; // true<br />
z = x != y; // false<br />
z = x > y; // false<br />
z = x >= y; // true<br />
z = x < y; // false<br />
z = x <= y; // true<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Logical'''</span><br />
<br />
The logical operators are primarily used in control flow to create condition based code. We'll go over control flow in a future section, for now just know that they exist and that you can reference back here if you forget what one does.<br />
<br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Logical NOT<br />
| !<br />
| !x<br />
|true if x evaluates to false, otherwise true<br />
|- style="text-align:center"<br />
|Logical AND<br />
| &&<br />
| x && y<br />
|true if both operands evaluate to true, otherwise false<br />
|- style="text-align:center"<br />
|Logical OR<br />
| <nowiki>||</nowiki><br />
| x <nowiki>||</nowiki> y<br />
|true if either operand evaluates to true, otherwise false<br />
|}<br />
<br />
For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.<br />
<br />
Logical AND will return the '''first''' operand that evaluates to '''false''', if none do, it will return the '''last''' operand.<br />
<br />
Logical OR will return the '''first''' operand that evaluates to '''true''', if none do, it will return the '''last''' operand.<br />
<br />
<br />
Certain values evaluate to false, these are: <code>'''false, null, 0, 0.0'''</code>. Everything else evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 0 && 1; // 0<br />
local w = null || "bark"; // "bark"<br />
local x = "" || true; // ""<br />
local y = !0; // true<br />
local z = 5 && "0" // "0"<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Bitwise'''</span><br />
<br />
All data in computer memory is stored as sequences of bits; 0's and 1's. The bitwise operators work directly with the bits of variables and literals in Squirrel. These operators are rarely used unless you have very specific needs within your program. For day to day use, you're mostly going to be using bitwise AND & bitwise OR to manipulate '''bit flags''', which are variables where each of the 32 bits (or however big the variable is) represents a boolean flag. So instead of having 32 different boolean variables, you can have 1 variable that represents 32 booleans!<br />
&, |, ^, ~, <<, >>, >>><br />
<br />
<span style="font-size:120%">'''Other Operators'''</span><br />
<br />
in, instanceof, typeof, comma, ternary<br />
<br />
<br />
<span style="font-size:120%">'''Operator Precedence'''</span><br />
<br />
-, ~, !, typeof , ++, -- highest<br />
/, *, % …<br />
+, - <br />
<<, >>, >>> <br />
<, <=, >, >=, instanceof <br />
==, !=, <=> <br />
& <br />
^ <br />
&&, in <br />
+=, =, -=, /=, *=, %= …<br />
, (comma operator) lowest<br />
<br />
IntegerLiteral ::= [1-9][0-9]* | '0x' [0-9A-Fa-f]+ | ''' [.]+ ''' | 0[0-7]+<br />
FloatLiteral ::= [0-9]+ '.' [0-9]+<br />
FloatLiteral ::= [0-9]+ '.' 'e'|'E' '+'|'-' [0-9]+<br />
StringLiteral ::= '"'[.]* '"'<br />
VerbatimStringLiteral ::= '@''"'[.]* '"'</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Operators&diff=7489Squirrel Operators2023-10-27T20:45:52Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div><br />
<br />
Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.<br />
This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Arithmetic'''</span><br />
<br />
'''Unary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Unary minus<br />
| -<br />
| -x<br />
|Negation of x<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 50;<br />
x = -x; // -50<br />
</syntaxhighlight><br />
<br />
<br />
'''Binary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Addition<br />
| +<br />
| x + y<br />
|x plus y<br />
|- style="text-align:center"<br />
|Subtraction<br />
| -<br />
| x - y<br />
|x minus y<br />
|- style="text-align:center"<br />
|Multiplication<br />
| *<br />
| x * y<br />
|x multiplied by y<br />
|- style="text-align:center"<br />
|Division<br />
| /<br />
| x / y<br />
|x divided by y<br />
|- style="text-align:center"<br />
|Remainder<br />
| %<br />
| x % y<br />
|the remainder from: x divided by y<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 100 + 100; // 200<br />
local w = 0 - 2; // -2<br />
local x = 5.5 * 100; // 550.0<br />
local y = 20 / 2; // 10<br />
local z = 23 % 2; // 1<br />
</syntaxhighlight><br />
<br />
The addition operators <code>'''+'''</code> and <code>'''+='''</code> are also able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.<br />
This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local str1 = "Hello,";<br />
local str2 = " World!";<br />
str1 += str2; // Hello World!<br />
// See next section for +=<br />
<br />
local float = 10 - 7.0 // 3.0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Assignment'''</span><br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Assignment<br />
| =<br />
| x = y<br />
|assign value y to variable x<br />
|- style="text-align:center"<br />
|Addition Assignment<br />
| +=<br />
| x += y<br />
|assign x + y to variable x<br />
|- style="text-align:center"<br />
|Subtraction Assignment<br />
| -=<br />
| x -= y<br />
|assign x - y to variable x<br />
|- style="text-align:center"<br />
|Multiplication Assignment<br />
| *=<br />
| x *= y<br />
|assign x * y to variable x<br />
|- style="text-align:center"<br />
|Division Assignment<br />
| /=<br />
| x /= y<br />
|assign x / y to variable x<br />
|- style="text-align:center"<br />
|Remainder Assignment<br />
| %=<br />
| x %= y<br />
|assign x % y to variable x<br />
|- style="text-align:center"<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 100;<br />
x += 5; // equivalent to: x = x + 5<br />
x -= 5; // 100<br />
x *= 100; // 10,000<br />
x /= 2; // 5,000<br />
x %= 2; // 0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Increment/Decrement'''</span><br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Pre-increment<br />
| ++<br />
| ++x<br />
|increment x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-increment<br />
| ++<br />
| x++<br />
|copy x, increment variable x by 1, then return the copy<br />
|- style="text-align:center"<br />
|Pre-decrement<br />
| --<br />
| --x<br />
|decrement x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-decrement<br />
| --<br />
| x--<br />
|copy x, decrement variable x by 1, then return the copy<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 1;<br />
local y;<br />
<br />
y = x++; // y = 1, it got the value of x and then x got incremented, x = 2<br />
y = ++x; // y = 3, x got incremented and then y got x's value<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Relational'''</span><br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Equality<br />
| ==<br />
| x == y<br />
|true if x equals y, false otherwise<br />
|- style="text-align:center"<br />
|Inequality<br />
| !=<br />
| x != y<br />
|true if x does not equal y, false otherwise<br />
|- style="text-align:center"<br />
|Less than<br />
| <<br />
| x < y<br />
|true if x is less than y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than<br />
| ><br />
| x > y<br />
|true if x is greater than y, false otherwise<br />
|- style="text-align:center"<br />
|Less than or equal to<br />
| <=<br />
| x <= y<br />
|true if x is less than or equal to y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than or equal to<br />
| >=<br />
| x >= y<br />
|true if x is greater than or equal to y, false otherwise<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 5;<br />
local y = 5;<br />
local z;<br />
<br />
z = x == y; // true<br />
z = x != y; // false<br />
z = x > y; // false<br />
z = x >= y; // true<br />
z = x < y; // false<br />
z = x <= y; // true<br />
</syntaxhighlight><br />
<br />
<br />
<span style="font-size:120%">'''Logical'''</span><br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Logical NOT<br />
| !<br />
| !x<br />
|true if x evaluates to false, otherwise false<br />
|- style="text-align:center"<br />
|Logical AND<br />
| &&<br />
| x && y<br />
|true if both operands evaluate to true, otherwise false<br />
|- style="text-align:center"<br />
|Logical OR<br />
| <nowiki>||</nowiki><br />
| x <nowiki>||</nowiki> y<br />
|true if either operand evaluates to true, otherwise false<br />
|}<br />
<br />
For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.<br />
<br />
Logical AND will return the '''first''' operand that evaluates to false, if none do and both evaluate true the operator will return the '''last''' operand.<br />
<br />
Logical OR will return the first operand that evaluates to true, if none do, it will return the '''last''' operand.<br />
<br />
<br />
Certain values evaluate to false, these are: <code>'''false, null, 0, 0.0'''</code>. Everything else evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 0 && 1; // 0<br />
local w = null || "bark"; // "bark"<br />
local x = "" || true; // ""<br />
local y = !0; // true<br />
local z = 5 && "0" // "0"<br />
</syntaxhighlight><br />
<br />
<span style="font-size:120%">'''Bitwise'''</span><br />
<br />
&, |, ^, ~, <<, >>, >>><br />
<br />
<span style="font-size:120%">'''Other Operators'''</span><br />
<br />
in, instanceof, typeof, comma, ternary<br />
<br />
<br />
<span style="font-size:120%">'''Operator Precedence'''</span><br />
<br />
-, ~, !, typeof , ++, -- highest<br />
/, *, % …<br />
+, - <br />
<<, >>, >>> <br />
<, <=, >, >=, instanceof <br />
==, !=, <=> <br />
& <br />
^ <br />
&&, in <br />
+=, =, -=, /=, *=, %= …<br />
, (comma operator) lowest<br />
<br />
IntegerLiteral ::= [1-9][0-9]* | '0x' [0-9A-Fa-f]+ | ''' [.]+ ''' | 0[0-7]+<br />
FloatLiteral ::= [0-9]+ '.' [0-9]+<br />
FloatLiteral ::= [0-9]+ '.' 'e'|'E' '+'|'-' [0-9]+<br />
StringLiteral ::= '"'[.]* '"'<br />
VerbatimStringLiteral ::= '@''"'[.]* '"'</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Data_Types&diff=7488Squirrel Data Types2023-10-27T20:31:14Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Operators NEXT]</div><br />
<br />
Data stored in variables can have a number of different types which determines what type of object it is and what you can do with it. Below is the full list of data types in Squirrel, however we will only go over the primitive ones in this section. The other data types will receive their own sections later in the guide.<br />
<br />
'''Data Types:'''<br />
* Null<br />
* Integer<br />
* Bool<br />
* Float<br />
* String<br />
* Table<br />
* Array<br />
* Function<br />
* Generator<br />
* Class<br />
* Instance<br />
* Thread<br />
* Userdata<br />
<br />
<br />
To get a variable's data type as a string (see below on strings), you can use the <code>'''typeof'''</code> operator.<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local t = typeof 5; // "integer"<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Null'''</span><br />
<br />
Has one value: <code>'''null'''</code>, it represents the non-existence or lack of a value.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x; // null<br />
<br />
local y = 5;<br />
// ...<br />
y = null;<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Integer'''</span><br />
<br />
Represents a 32 bit whole number, meaning it can store any value from -2,147,483,648 to 2,147,483,647. You can specify the integer base as [https://en.wikipedia.org/wiki/Hexadecimal hexadecimal] by prefixing with <code>'''0x'''</code> or [https://en.wikipedia.org/wiki/Octal octal] with <code>'''0'''</code>. You can also specify [https://www.asciitable.com/ ASCII] char codes between single quotes '''<code>'</code>''' which will be stored as their integer value.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 12345; // Decimal<br />
local y = 0xFFFFFF; // Hexadecimal begins with 0x<br />
local z = 050; // Octal begins with 0<br />
local c = 'a'; // Char code stored as 97<br />
</syntaxhighlight><br />
<br />
These are all integer '''literals''', which are hard coded pieces of data within a program for a specific data type. Other types have literals as well which you'll see in the examples below.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Bool'''</span><br />
<br />
Has two values: <code>'''true'''</code> and <code>'''false'''</code>.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local is_stuck = false;<br />
local should_round = true;<br />
<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Float'''</span><br />
<br />
Represents a 32 bit floating point number, meaning it can store any decimal value from 1.18e-38 to 3.4e38. Due to how floating point numbers are stored in memory, they have a limited amount of accuracy for a certain number of significant digits, for a 32 bit float it's usually around 6 or 7 digits. Any additional digits for the float value may result in rounding errors and precision loss. Keep this in mind when you're working with floats.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local float1 = 1.23456; // 1.23456 (Regular float literal)<br />
local float2 = 1.2e34; // 1.2e+34 (Scientific notation float literal)<br />
<br />
// Precision loss<br />
local float3 = 1.234567; // 1.23457<br />
local float4 = 1234.567; // 1234.57<br />
local float5 = 123456.7; // 123457<br />
local float6 = 12345678999.0; // 1.23457e+10<br />
</syntaxhighlight><br />
<br />
You cannot have a leading floating point for float literals, they must start with at least one digit.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// Invalid<br />
local float1 = .123;<br />
local float2 = .12E5;<br />
<br />
// Valid<br />
local float3 = 0.123;<br />
local float4 = 0.12E5;<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''String'''</span><br />
<br />
Strings are a sequence of characters with any length between quotation marks <code>"</code>. Strings are immutable, meaning they cannot be modified and you must create a new string if you need to change the old one. Regular strings must begin and end on the same line, they cannot contain any new line characters (\n).<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// Strings ...<br />
local str1 = "The quick brown fox jumps over the lazy dog."; // String<br />
local str2 = "123"; // String with number characters, not an integer<br />
local str3 = "a"; // String<br />
local str4 = ""; // Empty string<br />
<br />
// ... compared to char codes<br />
local int1 = 'a'; // NOT a string<br />
local int2 = ''; // Compile error<br />
local int3 = '''; // Compile error<br />
local int4 = '\''; // 39, Valid char code for ' (explained below)<br />
<br />
// Need to make a new string if we want to modify<br />
local name = "bar";<br />
name = "barber";<br />
</syntaxhighlight><br />
<br />
<br />
Strings (and char literals) may contain [https://en.cppreference.com/w/c/language/escape escape sequences], which are special characters that denote that something special should happen. Even though they have multiple characters in their definition, they count as one character when actually in use.<br />
Here are the ones you're most likely to use:<br />
<br />
* <code>'''\t'''</code> - Display a tab<br />
* <code>'''\n'''</code> - Move to a new line<br />
* <code>'''\\'''</code> - Insert \ char<br />
* <code>'''\"'''</code> - Insert " char<br />
* <code>'''\''''</code> - Insert ' char<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local text = "Hello there! Please enter your class:\t"; // Tab<br />
local text2 = "What do you mean you don't \"have one\"?\n"; // " char and new line<br />
</syntaxhighlight><br />
<br />
<br />
There may come a time when you need a string that does not interpret escape sequences or that can span multiple lines, which is where verbatim strings come in handy. Verbatim strings begin with <code>'''@"'''</code> and end with a regular quote <code>'''"'''</code>.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local mystring = @"eenie<br />
meenie<br />
minie<br />
moe";<br />
</syntaxhighlight><br />
<br />
You may also need to add quote characters within the verbatim string, to do so you double up each quotation <code>'''""'''</code>. The double quote will be replaced with a single quote by the compiler.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local mystring = @"eenie<br />
""meenie""<br />
minie<br />
moe";<br />
</syntaxhighlight></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Data_Types&diff=7487Squirrel Data Types2023-10-27T20:24:13Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Operators NEXT]</div><br />
<br />
Data stored in variables can have a number of different types which determines what type of object it is and what you can do with it. Below is the full list of data types in Squirrel, however we will only go over the primitive ones in this section. The other data types will receive their own sections later in the guide.<br />
<br />
'''Data Types:'''<br />
* Null<br />
* Integer<br />
* Bool<br />
* Float<br />
* String<br />
* Table<br />
* Array<br />
* Function<br />
* Generator<br />
* Class<br />
* Instance<br />
* Thread<br />
* Userdata<br />
<br />
<br />
To get a variable's data type as a string (see below on strings), you can use the <code>'''typeof'''</code> operator.<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local t = typeof 5; // "integer"<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Null'''</span><br />
<br />
Has one value: <code>'''null'''</code>, it represents the non-existence or lack of a value.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x; // null<br />
<br />
local y = 5;<br />
// ...<br />
y = null;<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Integer'''</span><br />
<br />
Represents a 32 bit whole number, meaning it can store any value from -2,147,483,648 to 2,147,483,647. You can specify the integer base as [https://en.wikipedia.org/wiki/Hexadecimal hexadecimal] by prefixing with <code>'''0x'''</code> or [https://en.wikipedia.org/wiki/Octal octal] with <code>'''0'''</code>. You can also specify [https://www.asciitable.com/ ASCII] char codes between single quotes '''<code>'</code>''' which will be stored as their integer value.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 12345; // Decimal<br />
local y = 0xFFFFFF; // Hexadecimal begins with 0x<br />
local z = 050; // Octal begins with 0<br />
local c = 'a'; // Char code stored as 97<br />
</syntaxhighlight><br />
<br />
These are all integer '''literals''', which are hard coded pieces of data within a program for a specific data type. Other types have literals as well which you'll see in the examples below.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Bool'''</span><br />
<br />
Has two values: <code>'''true'''</code> and <code>'''false'''</code>.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local is_stuck = false;<br />
local should_round = true;<br />
<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Float'''</span><br />
<br />
Represents a 32 bit floating point number, meaning it can store any decimal value from 1.18e-38 to 3.4e38. Due to how floating point numbers are stored in memory, they have a limited amount of accuracy for a certain number of significant digits, for a 32 bit float it's usually around 6 or 7 digits. Any additional digits for the float value may result in rounding errors and precision loss. Keep this in mind when you're working with floats.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local float1 = 1.23456; // 1.23456 (Regular float literal)<br />
local float2 = 1.2e34; // 1.2e+34 (Scientific notation float literal)<br />
<br />
// Precision loss<br />
local float3 = 1.234567; // 1.23457<br />
local float4 = 1234.567; // 1234.57<br />
local float5 = 123456.7; // 123457<br />
local float6 = 12345678999.0; // 1.23457e+10<br />
</syntaxhighlight><br />
<br />
You cannot have a leading floating point for float literals, they must start with at least one digit.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// Invalid<br />
local float1 = .123;<br />
local float2 = .12E5;<br />
<br />
// Valid<br />
local float3 = 0.123;<br />
local float4 = 0.12E5;<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''String'''</span><br />
<br />
Strings are a sequence of characters with any length between quotation marks <code>"</code>. Strings are immutable, meaning they cannot be modified and you must create a new string if you need to change the old one. Regular strings must begin and end on the same line, they cannot contain any new line characters (\n).<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// Strings ...<br />
local str1 = "The quick brown fox jumps over the lazy dog."; // String<br />
local str2 = "123"; // String with number characters, not an integer<br />
local str3 = "a"; // String<br />
local str4 = ""; // Empty string<br />
<br />
// ... compared to char codes<br />
local int1 = 'a'; // NOT a string<br />
local int2 = ''; // Compile error<br />
local int3 = '''; // Compile error<br />
local int4 = '\''; // 39, Valid char code for ' (explained below)<br />
<br />
// Need to make a new string if we want to modify<br />
local name = "bar";<br />
name = "barber";<br />
</syntaxhighlight><br />
<br />
<br />
Strings (and char literals) may contain [https://en.cppreference.com/w/c/language/escape escape sequences], which special are characters that denote that something special should happen. Even though they have multiple characters in their definition, they count as one character when actually in use.<br />
Here are the ones you're most likely to use:<br />
<br />
* <code>'''\t'''</code> - Display a tab<br />
* <code>'''\n'''</code> - Move to a new line<br />
* <code>'''\\'''</code> - Insert \ char<br />
* <code>'''\"'''</code> - Insert " char<br />
* <code>'''\''''</code> - Insert ' char<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local text = "Hello there! Please enter your class:\t"; // Tab<br />
local text2 = "What do you mean you don't \"have one\"?\n"; // " char and new line<br />
</syntaxhighlight><br />
<br />
<br />
There may come a time when you need a string that does not interpret escape sequences or that can span multiple lines, which is where verbatim strings come in handy. Verbatim strings begin with <code>'''@"'''</code> and end with a regular quote <code>'''"'''</code>.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local mystring = @"eenie<br />
meenie<br />
minie<br />
moe";<br />
</syntaxhighlight><br />
<br />
You may also need to add quote characters within the verbatim string, to do so you double up each quotation <code>'''""'''</code>. The double quote will be replaced with a single quote by the compiler.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local mystring = @"eenie<br />
""meenie""<br />
minie<br />
moe";<br />
</syntaxhighlight></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Metamethods&diff=7486Squirrel Metamethods2023-10-27T03:50:03Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Inheritance BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Variables BACK TO START]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Inheritance&diff=7485Squirrel Inheritance2023-10-27T03:49:54Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Classes BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Metamethods NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Classes&diff=7484Squirrel Classes2023-10-27T03:49:43Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Weak_References BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Inheritance NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Weak_References&diff=7483Squirrel Weak References2023-10-27T03:49:32Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Delegation BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Classes NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Delegation&diff=7482Squirrel Delegation2023-10-27T03:49:22Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Generators BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Weak_References NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Generators&diff=7481Squirrel Generators2023-10-27T03:49:11Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Functions BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Delegation NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Functions&diff=7480Squirrel Functions2023-10-27T03:48:59Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Tables BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Generators NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Tables&diff=7479Squirrel Tables2023-10-27T03:48:48Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Arrays BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Functions NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Arrays&diff=7478Squirrel Arrays2023-10-27T03:48:37Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Enums BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Tables NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Enums&diff=7477Squirrel Enums2023-10-27T03:48:27Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Exceptions BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Arrays NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Exceptions&diff=7476Squirrel Exceptions2023-10-27T03:48:16Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Control_Flow BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Enums NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Control_Flow&diff=7475Squirrel Control Flow2023-10-27T03:48:06Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Scopes BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Exceptions NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Scopes&diff=7474Squirrel Scopes2023-10-27T03:47:56Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Intro_to_Objects BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Control_Flow NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Intro_to_Objects&diff=7473Squirrel Intro to Objects2023-10-27T03:47:45Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Intro_to_Functions BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Scopes NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Intro_to_Functions&diff=7472Squirrel Intro to Functions2023-10-27T03:47:34Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Intro_to_Objects NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Expressions&diff=7471Squirrel Expressions2023-10-27T03:47:23Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Operators BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Intro_to_Functions NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Variables&diff=7470Squirrel Variables2023-10-27T03:47:03Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments NEXT]</div><br />
<br />
Every program in any programming language is comprised of a set of instructions called '''statements''' which manipulate data to produce a desired result. Programs store data into regions of memory as '''objects'''. Objects which we give an '''identifier''' (name) in our programs are called '''variables'''. You can think of statements as analogous to sentences in the language we speak to each other, each requires a specific set of items to be considered valid, and each is ended with a specific character. Sentences are mostly ended with periods, and statements always end with a semicolon.<br />
<br />
<br />
Identifiers have a few considerations to keep in mind:<br />
* '''They are case-sensitive, wep is not the same as WEP'''<br />
* '''The first character must be alphabetical (a-z) or an underscore, afterwards they can have any combination of (a-z), (0-9), or underscores'''<br />
* '''Underscores are the only special character allowed, nothing else'''<br />
<br />
<br />
'''Valid Identifiers:'''<br />
* INDEX<br />
* _weapon<br />
* weapon_sequence<br />
* player123<br />
<br />
'''Invalid Identifiers:'''<br />
* starting-index<br />
* 1_ring_to_rule_them_all<br />
* BOLD&BRASH<br />
* $IMBATMAN<br />
<br />
<br />
In addition, identifiers cannot be the same name as a '''keyword''', which are special identifiers reserved by the language for its use in the syntax. We'll go over most of these throughout the guide, so don't worry about memorizing them just yet.<br />
{| class="wikitable" style="width:75%; margin:auto; text-align:center font-weight:bold; font-size:125%"<br />
|+Keywords<br />
|base<br />
|break<br />
|case<br />
|catch<br />
|class<br />
|clone<br />
|-<br />
|continue<br />
|const<br />
|default<br />
|delete<br />
|else<br />
|enum<br />
|-<br />
|extends<br />
|for<br />
|foreach<br />
|function<br />
|if<br />
|in<br />
|-<br />
|local<br />
|null<br />
|resume<br />
|return<br />
|switch<br />
|this<br />
|-<br />
|throw<br />
|try<br />
|typeof<br />
|while<br />
|yield<br />
|constructor<br />
|-<br />
|instanceof<br />
|true<br />
|false<br />
|static<br />
|__LINE__<br />
|__FILE__<br />
|-<br />
|rawcall<br />
|<br />
|<br />
|<br />
|<br />
|<br />
|}<br />
<br />
<div style="margin-top: 50px;">To define a variable with x as it's identifier, we use the <code>'''local'''</code> keyword:</div><br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;"><br />
local x;<br />
</syntaxhighlight><br />
<br />
We created our variable in this statement but we haven't given it a value, so currently the value for x is <code>'''null'''</code>, which is a special value representing the lack of a value. To give our variable an actual value we have two options; we can set it at the time of definition (which is called initialization), or we can assign it a value with the assignment (<code>'''='''</code>) operator in a separate statement, or both!<br />
<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
local x;<br />
local y = 10;<br />
<br />
printl(y);<br />
<br />
x = 0;<br />
y = 0;<br />
</syntaxhighlight><br />
<br />
Here we define x and initialize y to 10, print y to console, and then set them both to 0 afterwards.</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Comments&diff=7469Squirrel Comments2023-10-27T03:46:47Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Variables BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types NEXT]</div><br />
<br />
A comment is a human readable note which was inserted by a programmer to denote the what, how, or why behind code. Comments are ignored by the compiler and only serve to make the code easier to understand or use for programmers. Comments come in two flavors: single line and multi line comments. Single line comments go until they hit a new line character (\n). Multi line comments have a start and end token, anything between them is commented out.<br />
<br />
<br />
To insert a single line comment, prefix it with <code>'''//'''</code> or <code>'''#'''</code>.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// I'm a comment that takes the whole line<br />
local darth_variable = 404 # I'm an inline comment<br />
</syntaxhighlight><br />
<br />
To insert a multi line comment, use <code>'''/*'''</code> to start and <code>'''*/'''</code> to end.<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
/*I<br />
am<br />
a<br />
multi<br />
line<br />
comment<br />
*/<br />
local foo = 2;<br />
</syntaxhighlight><br />
<br />
You can "nest" single line comments, but you can't do this with multi line comments<br />
<br />
<syntaxhighlight lang="c" line="1" start="1" style="font-weight:bold;><br />
//////////////////////// okay<br />
/* // okay */<br />
/* /* not okay */ */<br />
</syntaxhighlight><br />
<br />
The compiler will end the multi line comment at the first end token (*/) it sees, so the second one is outside of any comments and results in a compile error.</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Data_Types&diff=7468Squirrel Data Types2023-10-27T03:46:37Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Comments BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Operators NEXT]</div><br />
<br />
Data stored in variables can have a number of different types which determines what type of object it is and what you can do with it. Below is the full list of data types in Squirrel, however we will only go over the primitive ones in this section. The other data types will receive their own sections later in the guide.<br />
<br />
'''Data Types:'''<br />
* Null<br />
* Integer<br />
* Bool<br />
* Float<br />
* String<br />
* Table<br />
* Array<br />
* Function<br />
* Generator<br />
* Class<br />
* Instance<br />
* Thread<br />
* Userdata<br />
<br />
<br />
To get a variable's data type as a string (see below on strings), you can use the <code>'''typeof'''</code> operator.<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local t = typeof 5; // "integer"<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Null'''</span><br />
<br />
Has one value: <code>'''null'''</code>, it represents the non-existence or lack of a value.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x; // null<br />
<br />
local y = 5;<br />
// ...<br />
y = null;<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Integer'''</span><br />
<br />
Represents a 32 bit whole number, meaning it can store any value from -2,147,483,648 to 2,147,483,647. You can specify the integer base as [https://en.wikipedia.org/wiki/Hexadecimal hexadecimal] by prefixing with <code>'''0x'''</code> or [https://en.wikipedia.org/wiki/Octal octal] with <code>'''0'''</code>. You can also specify [https://www.asciitable.com/ ASCII] char codes between single quotes '''<code>'</code>''' which will be stored as their integer value.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 12345; // Decimal<br />
local y = 0xFFFFFF; // Hexadecimal begins with 0x<br />
local z = 050; // Octal begins with 0<br />
local c = 'a'; // Char code stored as 97<br />
</syntaxhighlight><br />
<br />
These are all integer '''literals''', which are hard coded pieces of data within a program for a specific data type. Other types have literals as well which you'll see in the examples below.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Bool'''</span><br />
<br />
Has two values: <code>'''true'''</code> and <code>'''false'''</code>.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local is_stuck = false;<br />
local should_round = true;<br />
<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Float'''</span><br />
<br />
Represents a 32 bit floating point number, meaning it can store any decimal value from 1.18e-38 to 3.4e38. Due to how floating point numbers are stored in memory, they have a limited amount of accuracy for a certain number of significant digits, for a 32 bit float it's usually around 6 or 7 digits. Any additional digits for the float value may result in rounding errors and precision loss. Keep this in mind when you're working with floats.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local float1 = 1.23456; // 1.23456 (Regular float literal)<br />
local float2 = 1.2e34; // 1.2e+34 (Scientific notation float literal)<br />
<br />
// Precision loss<br />
local float3 = 1.234567; // 1.23457<br />
local float4 = 1234.567; // 1234.57<br />
local float5 = 123456.7; // 123457<br />
local float6 = 12345678999.0; // 1.23457e+10<br />
</syntaxhighlight><br />
<br />
You cannot have a leading floating point for float literals, they must start with at least one digit.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// Invalid<br />
local float1 = .123;<br />
local float2 = .12E5;<br />
<br />
// Valid<br />
local float3 = 0.123;<br />
local float4 = 0.12E5;<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''String'''</span><br />
<br />
Strings are a sequence of characters with any length between quotation marks <code>"</code>. Strings are immutable, meaning they cannot be modified and you must create a new string if you need to change the old one. Regular strings must begin and end on the same line, they cannot contain any new line characters (\n).<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
// Strings ...<br />
local str1 = "'''@!(&(*@!%&!(%!%(%&FJSGADFJKL@fadjsh141a=-"; // String<br />
local str2 = "123"; // String with number characters, not an integer<br />
local str3 = "a"; // String<br />
local str4 = ""; // Empty string<br />
<br />
// ... compared to char codes<br />
local int1 = 'a'; // NOT a string<br />
local int2 = ''; // Compile error<br />
local int3 = '''; // Compile error<br />
local int4 = '\''; // 39, Valid char code for ' (explained below)<br />
<br />
// Need to make a new string if we want to modify<br />
local name = "bar";<br />
name = "barber";<br />
</syntaxhighlight><br />
<br />
<br />
Strings (and char literals) may contain [https://en.cppreference.com/w/c/language/escape escape sequences], which special are characters that denote that something special should happen. Even though they have multiple characters in their definition, they count as one character when actually in use.<br />
Here are the ones you're most likely to use:<br />
<br />
* <code>'''\t'''</code> - Display a tab<br />
* <code>'''\n'''</code> - Move to a new line<br />
* <code>'''\\'''</code> - Insert \ char<br />
* <code>'''\"'''</code> - Insert " char<br />
* <code>'''\''''</code> - Insert ' char<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local text = "Hello there! Please enter your class:\t"; // Tab<br />
local text2 = "What do you mean you don't \"have one\"?\n"; // " char and new line<br />
</syntaxhighlight><br />
<br />
<br />
There may come a time when you need a string that does not interpret escape sequences or that can span multiple lines, which is where verbatim strings come in handy. Verbatim strings begin with <code>'''@"'''</code> and end with a regular quote <code>'''"'''</code>.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local mystring = @"eenie<br />
meenie<br />
minie<br />
moe";<br />
</syntaxhighlight><br />
<br />
You may also need to add quote characters within the verbatim string, to do so you double up each quotation <code>'''""'''</code>. The double quote will be replaced with a single quote by the compiler.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local mystring = @"eenie<br />
""meenie""<br />
minie<br />
moe";<br />
</syntaxhighlight></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Operators&diff=7467Squirrel Operators2023-10-27T03:46:14Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div><br />
<br />
Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.<br />
This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.<br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Arithmetic'''</span><br />
<br />
'''Unary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Unary minus<br />
| -<br />
| -x<br />
|Negation of x<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 50;<br />
x = -x; // -50<br />
</syntaxhighlight><br />
<br />
<br />
'''Binary Operators'''<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Addition<br />
| +<br />
| x + y<br />
|x plus y<br />
|- style="text-align:center"<br />
|Subtraction<br />
| -<br />
| x - y<br />
|x minus y<br />
|- style="text-align:center"<br />
|Multiplication<br />
| *<br />
| x * y<br />
|x multiplied by y<br />
|- style="text-align:center"<br />
|Division<br />
| /<br />
| x / y<br />
|x divided by y<br />
|- style="text-align:center"<br />
|Remainder<br />
| %<br />
| x % y<br />
|the remainder from: x divided by y<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 100 + 100; // 200<br />
local w = 0 - 2; // -2<br />
local x = 5.5 * 100; // 550.0<br />
local y = 20 / 2; // 10<br />
local z = 23 % 2; // 1<br />
</syntaxhighlight><br />
<br />
The addition operators <code>'''+'''</code> and <code>'''+='''</code> are also able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.<br />
This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local str1 = "Hello,";<br />
local str2 = " World!";<br />
str1 += str2; // Hello World!<br />
// See next section for +=<br />
<br />
local float = 10 - 7.0 // 3.0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Assignment'''</span><br />
<br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Assignment<br />
| =<br />
| x = y<br />
|assign value y to variable x<br />
|- style="text-align:center"<br />
|Addition Assignment<br />
| +=<br />
| x += y<br />
|assign x + y to variable x<br />
|- style="text-align:center"<br />
|Subtraction Assignment<br />
| -=<br />
| x -= y<br />
|assign x - y to variable x<br />
|- style="text-align:center"<br />
|Multiplication Assignment<br />
| *=<br />
| x *= y<br />
|assign x * y to variable x<br />
|- style="text-align:center"<br />
|Division Assignment<br />
| /=<br />
| x /= y<br />
|assign x / y to variable x<br />
|- style="text-align:center"<br />
|Remainder Assignment<br />
| %=<br />
| x %= y<br />
|assign x % y to variable x<br />
|- style="text-align:center"<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 100;<br />
x += 5; // equivalent to: x = x + 5<br />
x -= 5; // 100<br />
x *= 100; // 10,000<br />
x /= 2; // 5,000<br />
x %= 2; // 0<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Increment/Decrement'''</span><br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Pre-increment<br />
| ++<br />
| ++x<br />
|increment x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-increment<br />
| ++<br />
| x++<br />
|copy x, increment variable x by 1, then return the copy<br />
|- style="text-align:center"<br />
|Pre-decrement<br />
| --<br />
| --x<br />
|decrement x by 1, then return x<br />
|- style="text-align:center"<br />
|Post-decrement<br />
| --<br />
| x--<br />
|copy x, decrement variable x by 1, then return the copy<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 1;<br />
local y;<br />
<br />
y = x++; // y = 1, it got the value of x and then x got incremented, x = 2<br />
y = ++x; // y = 3, x got incremented and then y got x's value<br />
</syntaxhighlight><br />
<br />
<br />
<hr><br />
<br />
<br />
<span style="font-size:120%">'''Relational'''</span><br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Equality<br />
| ==<br />
| x == y<br />
|true if x equals y, false otherwise<br />
|- style="text-align:center"<br />
|Inequality<br />
| !=<br />
| x != y<br />
|true if x does not equal y, false otherwise<br />
|- style="text-align:center"<br />
|Less than<br />
| <<br />
| x < y<br />
|true if x is less than y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than<br />
| ><br />
| x > y<br />
|true if x is greater than y, false otherwise<br />
|- style="text-align:center"<br />
|Less than or equal to<br />
| <=<br />
| x <= y<br />
|true if x is less than or equal to y, false otherwise<br />
|- style="text-align:center"<br />
|Greater than or equal to<br />
| >=<br />
| x >= y<br />
|true if x is greater than or equal to y, false otherwise<br />
|}<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local x = 5;<br />
local y = 5;<br />
local z;<br />
<br />
z = x == y; // true<br />
z = x != y; // false<br />
z = x > y; // false<br />
z = x >= y; // true<br />
z = x < y; // false<br />
z = x <= y; // true<br />
</syntaxhighlight><br />
<br />
<br />
<span style="font-size:120%">'''Logical'''</span><br />
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"<br />
|+<br />
!Operator<br />
!Symbol<br />
!Form<br />
!Operation<br />
|- style="text-align:center"<br />
|Logical NOT<br />
| !<br />
| !x<br />
|true if x evaluates to false, otherwise false<br />
|- style="text-align:center"<br />
|Logical AND<br />
| &&<br />
| x && y<br />
|true if both operands evaluate to true, otherwise false<br />
|- style="text-align:center"<br />
|Logical OR<br />
| <nowiki>||</nowiki><br />
| x <nowiki>||</nowiki> y<br />
|true if either operand evaluates to true, otherwise false<br />
|}<br />
<br />
For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.<br />
<br />
Logical AND, if either operand evaluates to false, will return the '''first''' operand that evaluates to false. Otherwise if both evaluate true the operator will return the '''last''' operand.<br />
<br />
Logical OR will return the first operand that evaluates to true, if none do, it will return the '''last''' operand.<br />
<br />
<br />
Certain values evaluate to false, these are: <code>'''false, null, 0, 0.0'''</code>. Everything else evaluates to true.<br />
<br />
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;><br />
local v = 0 && 1; // 0<br />
local w = null || "bark"; // "bark"<br />
local x = "" || true; // ""<br />
local y = !0; // true<br />
local z = 5 && "0" // "0"<br />
</syntaxhighlight><br />
<br />
<span style="font-size:120%">'''Bitwise'''</span><br />
<br />
&, |, ^, ~, <<, >>, >>><br />
<br />
<span style="font-size:120%">'''Other Operators'''</span><br />
<br />
in, instanceof, typeof, comma, ternary<br />
<br />
<br />
<span style="font-size:120%">'''Operator Precedence'''</span><br />
<br />
-, ~, !, typeof , ++, -- highest<br />
/, *, % …<br />
+, - <br />
<<, >>, >>> <br />
<, <=, >, >=, instanceof <br />
==, !=, <=> <br />
& <br />
^ <br />
&&, in <br />
+=, =, -=, /=, *=, %= …<br />
, (comma operator) lowest<br />
<br />
IntegerLiteral ::= [1-9][0-9]* | '0x' [0-9A-Fa-f]+ | ''' [.]+ ''' | 0[0-7]+<br />
FloatLiteral ::= [0-9]+ '.' [0-9]+<br />
FloatLiteral ::= [0-9]+ '.' 'e'|'E' '+'|'-' [0-9]+<br />
StringLiteral ::= '"'[.]* '"'<br />
VerbatimStringLiteral ::= '@''"'[.]* '"'</div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Metamethods&diff=7466Squirrel Metamethods2023-10-27T03:38:50Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Inheritance BACK]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Variables BACK TO START]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Inheritance&diff=7465Squirrel Inheritance2023-10-27T03:37:52Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Classes BACK]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Metamethods NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Classes&diff=7464Squirrel Classes2023-10-27T03:37:37Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Weak_References BACK]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Inheritance NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Weak_References&diff=7463Squirrel Weak References2023-10-27T03:37:16Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Delegation BACK]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Classes NEXT]</div></div>Mincehttps://sigwiki.potato.tf/index.php?title=Squirrel_Delegation&diff=7462Squirrel Delegation2023-10-27T03:37:00Z<p>Mince: </p>
<hr />
<div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Generators BACK]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Weak_References NEXT]</div></div>Mince