Editing Squirrel Operators

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 9: Line 9:


<span style="font-size:120%">'''Arithmetic'''</span>
<span style="font-size:120%">'''Arithmetic'''</span>
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.


'''Unary Operators'''
'''Unary Operators'''
Line 75: Line 72:
</syntaxhighlight>
</syntaxhighlight>


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


Line 92: Line 89:


<span style="font-size:120%">'''Assignment'''</span>
<span style="font-size:120%">'''Assignment'''</span>
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>.


{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
Line 149: Line 143:


<span style="font-size:120%">'''Increment/Decrement'''</span>
<span style="font-size:120%">'''Increment/Decrement'''</span>
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.
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
|+
Line 186: Line 176:


y = x++; // y = 1, it got the value of x and then x got incremented, x = 2
y = x++; // y = 1, it got the value of x and then x got incremented, x = 2
y = ++x; // y = 3, x got incremented and then y got x's value, x = 3
y = ++x; // y = 3, x got incremented and then y got x's value
</syntaxhighlight>
</syntaxhighlight>


Line 194: Line 184:


<span style="font-size:120%">'''Relational'''</span>
<span style="font-size:120%">'''Relational'''</span>
The relational operators compare the values of their operands and return a boolean based on their result.
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
|+
Line 248: Line 234:
z = x <= y; // true
z = x <= y; // true
</syntaxhighlight>
</syntaxhighlight>
<hr>




<span style="font-size:120%">'''Logical'''</span>
<span style="font-size:120%">'''Logical'''</span>
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.
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
|+
Line 268: Line 247:
| !
| !
| !x
| !x
|true if x evaluates to false, otherwise true
|true if x evaluates to false, otherwise false
|- style="text-align:center"
|- style="text-align:center"
|Logical AND
|Logical AND
Line 282: Line 261:


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.
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.
<pre>
Logical AND will return the *first* operand that evaluates to *false*, if none do, it will return the *last* operand.
Logical OR will return the *first* operand that evaluates to *true*, if none do, it will return the *last* operand.
</pre>
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.


<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
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.
local var = othervar || otherothervar || 1;
</syntaxhighlight>


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.
Logical OR will return the first operand that evaluates to true, if none do, it will return the '''last''' operand.




Line 305: Line 276:
local z = 5 && "0"        // "0"
local z = 5 && "0"        // "0"
</syntaxhighlight>
</syntaxhighlight>
<hr>


<span style="font-size:120%">'''Bitwise'''</span>
<span style="font-size:120%">'''Bitwise'''</span>


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.)
&, |, ^, ~, <<, >>, >>>
 
 
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
!Operator
!Symbol
!Form
!Operation
|- style="text-align:center"
|Bitwise NOT
| ~
| ~x
|Flips all bits in x; 1 becomes 0 and 0 becomes 1
|- style="text-align:center"
|Bitwise AND
| &
| x & y
|Each bit in x AND each bit in y
|- style="text-align:center"
|Bitwise OR
| <nowiki>|</nowiki>
| x <nowiki>|</nowiki> y
|Each bit in x OR each bit in y
|- style="text-align:center"
|Bitwise XOR
| ^
| x ^ y
|Each bit in x Exclusive OR each bit in y
|- style="text-align:center"
|Left shift
| <<
| x << y
|Shift all bits in x left by integer y spaces
|- style="text-align:center"
|Right shift
| >>
| x >> y
|Shift all bits in x right by integer y spaces
|- style="text-align:center"
|Unsigned right shift
| >>>
| x >>> y
|Same as normal right shift (>>) but treat x as unsigned (only positive values, no negative ones)
|}
 
 
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!
 
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.
 
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
#define FL_ONGROUND (1<<0) // At rest / on the ground
#define FL_DUCKING (1<<1) // Player flag -- Player is fully crouched
#define FL_ANIMDUCKING (1<<2) // Player flag -- Player is in the process of crouching or uncrouching but could be in transition
#define FL_WATERJUMP (1<<3) // player jumping out of water
#define FL_ONTRAIN (1<<4)  // Player is _controlling_ a train, so movement commands should be ignored on client during prediction.
 
...
 
#define FL_UNBLOCKABLE_BY_PLAYER (1<<31) // pusher that can't be blocked by the player
</syntaxhighlight>
 
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!
 
 
To add bit flags together, use the bitwise OR (<code>'''|'''</code>) operator.


<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
<span style="font-size:120%">'''Other Operators'''</span>
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration


local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING; // 7  (1 + 2 + 4)
in, instanceof, typeof, comma, ternary
</syntaxhighlight>


To remove a flag, use the bitwise AND (<code>'''&'''</code>) operator along with the bitwise NOT (<code>'''~'''</code>) operator on the flag.


<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
<span style="font-size:120%">'''Operator Precedence'''</span>
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration


local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING; // 7  (1 + 2 + 4)
-, ~, !, typeof , ++, -- highest
/, *, % …
+, -
<<, >>, >>>
<, <=, >, >=, instanceof
==, !=, <=>
&
^
&&, in
+=, =, -=, /=, *=, %= …
, (comma operator) lowest


printl(mybitflags & ~FL_ONGROUND); // 6
IntegerLiteral        ::=  [1-9][0-9]* | '0x' [0-9A-Fa-f]+ | ''' [.]+ ''' | 0[0-7]+
printl( mybitflags & ~(FL_ONGROUND | FL_ANIMDUCKING) ); // 2
FloatLiteral          ::=  [0-9]+ '.' [0-9]+
</syntaxhighlight>
FloatLiteral          ::= [0-9]+ '.' 'e'|'E' '+'|'-' [0-9]+
 
StringLiteral        ::= '"'[.]* '"'
To test if a flag is present, use the bitwise AND (<code>'''&'''</code>) operator and compare the result against 0 using the inequality operator.
VerbatimStringLiteral ::=  '@''"'[.]* '"'
 
<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
// In real code, you would need to prefix these with "Constants.FPlayer." (e.g. Constants.FPlayer.FL_ONGROUND), this is just a brief demonstration
 
local mybitflags = FL_ONGROUND | FL_DUCKING | FL_ANIMDUCKING;
local testflags = FL_ONGROUND | FL_DUCKING;
 
printl( (mybitflags & testflags) != 0 ) // true
printl( (mybitflags & FL_ONTRAIN) != 0 ) // false
</syntaxhighlight>
Please note that all contributions to SigMod are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see SigMod:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Retrieved from ‘https://sigwiki.potato.tf/index.php/Squirrel_Operators’