Squirrel (programming language)

<h2 id="language-features">Language features</h2>
<ul><li><a href="/facts/Dynamic_typing/Tz0bAMS9">Dynamic typing</a></li>
<li><a href="/facts/Delegation_(programming)/fhoIL7nh">Delegation</a></li>
<li><a href="/facts/Class_(computer_science)/zvzkSAtE">Classes</a>, <a href="/facts/Inheritance_(object-oriented_programming)/a7R1xv8n">inheritance</a></li>
<li><a href="/facts/Higher_order_functions/VjnjGbpt">Higher order functions</a></li>
<li><a href="/facts/Generator_(computer_science)/nHRrs0GF">Generators</a></li>
<li>Cooperative threads (<a href="/facts/Coroutines/hGCtXsAQ">coroutines</a>)</li>
<li><a href="/facts/Tail_recursion/oLX6hfm3">Tail recursion</a></li>
<li><a href="/facts/Exception_handling/VrJxgb9r">Exception handling</a></li>
<li>Automatic memory management (mainly <a href="/facts/Reference_counting/jbPcXuXe">reference counting</a> with backup <a href="/facts/Garbage_collection_(computer_science)/j2vlIu7g">garbage collector</a>)</li>
<li><a href="/facts/Weak_reference/TCnnws7x">Weak references</a></li>
<li>Both <a href="/facts/Compiler/WNfCDFJe">compiler</a> and <a href="/facts/Virtual_machine/BLevU3sx">virtual machine</a> fit together in about 7k lines of <a href="/facts/C%2B%2B/Et0F2qn9">C++</a> code</li>
<li>Optional <a href="/facts/16-bit/bTGS44Ne">16-bit</a> character <a href="/facts/String_(computer_science)/4ChJu5WS">strings</a></li></ul>
<h2 id="syntax">Syntax</h2>
Squirrel uses a C-like syntax, albeit inspired by that of Lua as well.

Factorial in Squirrel

local function factorial(x) // Getting function which is factorial, then getting value which is x
{
 if (x <= 1) { // if x is less than 1
 return 1; // then the code will just return 1
 }
 else { // if that doesn't work
 return x * factorial(x-1); // then the code will return x times factorial(x-1)
 }
}

Generators

function not_a_random_number_generator(max) {
  local last = 42;
  local IM = 139968;
  local IA = 3877;
  local IC = 29573;
  for(;;) { // loops forever
    yield (max * (last = (last * IA + IC) % IM) / IM);
  }
}

local randtor = not_a_random_number_generator(100);

for(local i = 0; i < 10; i += 1)
 print(">"+resume randtor+"\n");

Classes and inheritance

class BaseVector {
  constructor(...)
  {
    if(vargv.len() >= 3) {
      x = vargv[0];
      y = vargv[1];
      z = vargv[2];
    }
  }
  x = 0;
  y = 0;
  z = 0;
}

class Vector3 extends BaseVector {
  function _add(other)
  {
    if(other instanceof ::Vector3)
      return ::Vector3(x+other.x,y+other.y,z+other.z);
    else
      throw "wrong parameter";
  }
  function Print()
  {
    ::print(x+","+y+","+z+"\n");
  }
}

local v0 = Vector3(1,2,3)
local v1 = Vector3(11,12,13)
local v2 = v0 + v1;
v2.Print();

<h2 id="applications">Applications</h2>
<h3>Applications using Squirrel</h3>
<ul><li><a href="/facts/Code::Blocks/RmzjVnsX">Code::Blocks</a>, integrated development environment</li>
<li><a href="/facts/Enduro/X/oz2e8pw6">Enduro/X</a>, cluster application server</li>
<li>Electric Imp, an end-to-end IoT platform<a class="footnote-ref" id="fnref:5" href="#fn:5">5</a></li></ul>
<h3>Games using Squirrel</h3>

<ul><li><a href="/facts/Alien_Swarm/puwokmPk">Alien Swarm</a><a class="footnote-ref" id="fnref:6" href="#fn:6">6</a></li>
<li><a href="/facts/Antinomy_of_Common_Flowers/QQT4WfT2">Antinomy of Common Flowers</a><a class="footnote-ref" id="fnref:7" href="#fn:7">7</a></li>
<li><a href="/facts/Apex_Legends/2qmScImP">Apex Legends</a><a class="footnote-ref" id="fnref:8" href="#fn:8">8</a></li>
<li><a href="/facts/Battle_Brothers/wupjdPzQ">Battle Brothers</a></li>
<li><a href="/facts/Contagion_(video_game)/mCcBM9p8">Contagion</a><a class="footnote-ref" id="fnref:9" href="#fn:9">9</a></li>
<li><a href="/facts/Counter_Strike:_Global_Offensive/dLb5NQrJ">Counter Strike: Global Offensive</a><a class="footnote-ref" id="fnref:10" href="#fn:10">10</a></li>
<li><a href="/facts/CRSED:_F.O.A.D./uzAFXVAH">CRSED: F.O.A.D.</a></li>
<li><a href="/facts/Final_Fantasy_Crystal_Chronicles:_My_Life_as_a_King/7azs7Aaw">Final Fantasy Crystal Chronicles: My Life as a King</a><a class="footnote-ref" id="fnref:11" href="#fn:11">11</a></li>
<li>Gothic Online,<a class="footnote-ref" id="fnref:12" href="#fn:12">12</a> a mod for <a href="/facts/Gothic_II/1c5rdWyw">Gothic II</a></li>
<li><a href="/facts/GTA_IV/8YPnocA6">GTA IV</a>'s IV-MP<a class="footnote-ref" id="fnref:13" href="#fn:13">13</a></li>
<li><a href="/facts/Left_4_Dead_2/KDdLCwll">Left 4 Dead 2</a><a class="footnote-ref" id="fnref:14" href="#fn:14">14</a></li>
<li>Liberty Unleashed<a class="footnote-ref" id="fnref:15" href="#fn:15">15</a></li>
<li><a href="/facts/Mafia_II/FU7ECe7t">Mafia II</a>'s M2-Multiplayer<a class="footnote-ref" id="fnref:16" href="#fn:16">16</a></li>
<li><a href="/facts/Melty_Blood:_Type_Lumina/luHrPhR1">Melty Blood: Type Lumina</a><a class="footnote-ref" id="fnref:17" href="#fn:17">17</a></li>
<li><a href="/facts/Nuclear_Dawn/eFr70a7V">Nuclear Dawn</a><a class="footnote-ref" id="fnref:18" href="#fn:18">18</a></li>
<li><a href="/facts/OpenTTD/6ABJEuBz">OpenTTD</a><a class="footnote-ref" id="fnref:19" href="#fn:19">19</a></li>
<li><a href="/facts/Portal_2/EuKzb5cN">Portal 2</a><a class="footnote-ref" id="fnref:20" href="#fn:20">20</a></li>
<li><a href="/facts/Shadow_Warrior_(2013_video_game)/VHCwMY7h">Shadow Warrior</a></li>
<li><a href="/facts/Simutrans/QFPE4Ic9">Simutrans</a><a class="footnote-ref" id="fnref:21" href="#fn:21">21</a></li>
<li><a href="/facts/Sonic_Unleashed/StmyVaMW">Sonic Unleashed</a> (PS2/Wii)<a class="footnote-ref" id="fnref:22" href="#fn:22">22</a></li>
<li><a href="/facts/SuperTux/M8WJ48y1">SuperTux</a></li>
<li><a href="/facts/Team_Fortress_2/Ta3QvNeE">Team Fortress 2</a><a class="footnote-ref" id="fnref:23" href="#fn:23">23</a></li>
<li><a href="/facts/Thimbleweed_Park/37k9w5tK">Thimbleweed Park</a><a class="footnote-ref" id="fnref:24" href="#fn:24">24</a></li>
<li><a href="/facts/Thief_II/Cr8Tkz3E">Thief II</a> (unofficial NewDark engine update)<a class="footnote-ref" id="fnref:25" href="#fn:25">25</a></li>
<li><a href="/facts/Titanfall/Bu89Lpab">Titanfall</a><a class="footnote-ref" id="fnref:26" href="#fn:26">26</a></li>
<li>Vice City Multiplayer,<a class="footnote-ref" id="fnref:27" href="#fn:27">27</a> a mod for <a href="/facts/Grand_Theft_Auto:_Vice_City/SK74IH5H">Grand Theft Auto: Vice City</a><a class="footnote-ref" id="fnref:28" href="#fn:28">28</a></li>
<li><a href="/facts/Under_Night_In-Birth/Wg3jKbKj">Under Night In-Birth</a><a class="footnote-ref" id="fnref:29" href="#fn:29">29</a></li>
<li><a href="/facts/War_Thunder/0PvHHgwC">War Thunder</a></li>
<li>Zero no Tsukaima - Maigo no Period to Ikusen no Symphony (PS2)</li>
<li>Zero no Tsukaima - Muma ga Tsumugu Yokaze no Nocturne (PS2)</li>
<li>Zero no Tsukaima - Shou-akuma to Harukaze no Concerto (PS2)</li></ul>

<h2 id="history">History</h2>
The language was made public in 2003 under the <a href="/facts/Zlib_License/lyoPpsHD">zlib/libpng license</a>.<a class="footnote-ref" id="fnref:30" href="#fn:30">30</a>
In November 2010, the license was changed to the <a href="/facts/MIT_license/8llAQtlk">MIT license</a> to enable the project to be hosted on <a href="/facts/Google_Code/1HnjsxRd">Google Code</a>.<a class="footnote-ref" id="fnref:31" href="#fn:31">31</a><a class="footnote-ref" id="fnref:32" href="#fn:32">32</a>
It is developed and maintained by Alberto Demichelis.

<h2 id="see-also">See also</h2>
<ul>
<li>Free and open-source software portal</li></ul>
<ul><li><a href="/facts/Lua_(programming_language)/xkBCgta0">Lua</a></li>
<li><a href="/facts/AngelScript/bVICRvyv">AngelScript</a></li>
<li><a href="/facts/Python_(programming_language)/YbuGqofa">Python</a></li>
<li><a href="/facts/ECMAScript/M7nDHsB5">ECMAScript</a></li>
<li><a href="/facts/Ruby_(programming_language)/BeYSaPSR">Ruby</a></li></ul>

<h2 id="external-links">External links</h2>
<ul><li><a href="http://squirrel-lang.org/">Official website</a> </li></ul>

<h2 id="references">References</h2>

<ol>
<li id="fn:1">MirthKit Developer Wiki Archived 2014-02-11 at the Wayback Machine <a href="http://devs.mirthkit.com" target="_blank">http://devs.mirthkit.com</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></li>
<li id="fn:2">Brandon Boyer (21 February 2008). "Gamasutra - GDC 2008 Event Coverage". gamasutra.com. Gamasutra. <a href="http://www.gamasutra.com/view/news/17560/GDC_Tsuchida_Shiraishi_Talk_Square_Enixs_New_WiiWare_Choices.php" target="_blank">http://www.gamasutra.com/view/news/17560/GDC_Tsuchida_Shiraishi_Talk_Square_Enixs_New_WiiWare_Choices.php</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></li>
<li id="fn:3">"Exclusive: Behind The Scenes of Final Fantasy's WiiWare Debut". gamasutra.com. Gamasutra. 23 June 2008. Retrieved 22 September 2011. <a href="http://www.gamasutra.com/view/news/19143/Exclusive_Behind_The_Scenes_of_Final_Fantasys_WiiWare_Debut.php" target="_blank">http://www.gamasutra.com/view/news/19143/Exclusive_Behind_The_Scenes_of_Final_Fantasys_WiiWare_Debut.php</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></li>
<li id="fn:4">"L4D2 Vscripts - Valve Developer Community". developer.valvesoftware.com. Retrieved 2018-07-06. <a href="http://developer.valvesoftware.com/wiki/L4D2_Vscripts" target="_blank">http://developer.valvesoftware.com/wiki/L4D2_Vscripts</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></li>
<li id="fn:5">"Electric Imp programming guide". electricimp.com. <a href="https://developer.electricimp.com/squirrel/squirrel-guide/introduction" target="_blank">https://developer.electricimp.com/squirrel/squirrel-guide/introduction</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></li>
<li id="fn:6">"VScript". valvesoftware.com. 2014-08-20. Retrieved 2015-01-17. <a href="https://developer.valvesoftware.com/wiki/VScript" target="_blank">https://developer.valvesoftware.com/wiki/VScript</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></li>
<li id="fn:7">"th155-decomp". GitHub. Retrieved 2020-10-19. <a href="https://github.com/mathfreak231/th155-decomp/tree/v1.10d" target="_blank">https://github.com/mathfreak231/th155-decomp/tree/v1.10d</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></li>
<li id="fn:8">"WHAT in the hell, is consumable nut? Please help this is an error code I got, have any of you got this before?". reddit.com. 2019-03-24. Retrieved 2021-09-04. <a href="https://www.reddit.com/r/apexlegends/comments/b4ohol/what_in_the_hell_is_consumable_nut_please_help/" target="_blank">https://www.reddit.com/r/apexlegends/comments/b4ohol/what_in_the_hell_is_consumable_nut_please_help/</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></li>
<li id="fn:9">"VScript". valvesoftware.com. 2014-08-20. Retrieved 2015-01-17. <a href="https://developer.valvesoftware.com/wiki/VScript" target="_blank">https://developer.valvesoftware.com/wiki/VScript</a> <a href="#fnref:9" class="footnote-back-ref">↩</a></li>
<li id="fn:10">"VScript". valvesoftware.com. 2014-08-20. Retrieved 2015-01-17. <a href="https://developer.valvesoftware.com/wiki/VScript" target="_blank">https://developer.valvesoftware.com/wiki/VScript</a> <a href="#fnref:10" class="footnote-back-ref">↩</a></li>
<li id="fn:11">Brandon Boyer (21 February 2008). "Gamasutra - GDC 2008 Event Coverage". gamasutra.com. Gamasutra. <a href="http://www.gamasutra.com/view/news/17560/GDC_Tsuchida_Shiraishi_Talk_Square_Enixs_New_WiiWare_Choices.php" target="_blank">http://www.gamasutra.com/view/news/17560/GDC_Tsuchida_Shiraishi_Talk_Square_Enixs_New_WiiWare_Choices.php</a> <a href="#fnref:11" class="footnote-back-ref">↩</a></li>
<li id="fn:12">Gothic 2 Online <a href="https://gothic-online.com/" target="_blank">https://gothic-online.com/</a> <a href="#fnref:12" class="footnote-back-ref">↩</a></li>
<li id="fn:13">"iv-multiplayer.com". www.iv-multiplayer.com. Archived from the original on 2012-06-07. Retrieved 2018-07-06. <a href="https://web.archive.org/web/20120607080245/http://wiki.iv-multiplayer.com/wiki/index.php?title=FAQ" target="_blank">https://web.archive.org/web/20120607080245/http://wiki.iv-multiplayer.com/wiki/index.php?title=FAQ</a> <a href="#fnref:13" class="footnote-back-ref">↩</a></li>
<li id="fn:14">"VScript". valvesoftware.com. 2014-08-20. Retrieved 2015-01-17. <a href="https://developer.valvesoftware.com/wiki/VScript" target="_blank">https://developer.valvesoftware.com/wiki/VScript</a> <a href="#fnref:14" class="footnote-back-ref">↩</a></li>
<li id="fn:15">"Liberty Unleashed". Retrieved 2019-12-04. <a href="http://liberty-unleashed.co.uk" target="_blank">http://liberty-unleashed.co.uk</a> <a href="#fnref:15" class="footnote-back-ref">↩</a></li>
<li id="fn:16">"m2-multiplayer.com". www.m2-multiplayer.com. Archived from the original on 2013-01-02. Retrieved 2018-07-06. <a href="https://web.archive.org/web/20130102090238/http://www.m2-multiplayer.com/" target="_blank">https://web.archive.org/web/20130102090238/http://www.m2-multiplayer.com/</a> <a href="#fnref:16" class="footnote-back-ref">↩</a></li>
<li id="fn:17">"undernightinbirth". GitHub. Retrieved 2024-08-18. <a href="https://github.com/Fatih120/undernightinbirth" target="_blank">https://github.com/Fatih120/undernightinbirth</a> <a href="#fnref:17" class="footnote-back-ref">↩</a></li>
<li id="fn:18">"VScript". valvesoftware.com. 2014-08-20. Retrieved 2015-01-17. <a href="https://developer.valvesoftware.com/wiki/VScript" target="_blank">https://developer.valvesoftware.com/wiki/VScript</a> <a href="#fnref:18" class="footnote-back-ref">↩</a></li>
<li id="fn:19">"AI:Main Page - OpenTTD". wiki.openttd.org. Retrieved 2018-07-06. <a href="http://wiki.openttd.org/?title=AI:Main_Page&oldid=76593" target="_blank">http://wiki.openttd.org/?title=AI:Main_Page&oldid=76593</a> <a href="#fnref:19" class="footnote-back-ref">↩</a></li>
<li id="fn:20">"VScript". valvesoftware.com. 2014-08-20. Retrieved 2015-01-17. <a href="https://developer.valvesoftware.com/wiki/VScript" target="_blank">https://developer.valvesoftware.com/wiki/VScript</a> <a href="#fnref:20" class="footnote-back-ref">↩</a></li>
<li id="fn:21">"Simutrans-Squirrel-API: Main Page". dwachs.github.io. Retrieved 2018-07-06. <a href="https://dwachs.github.io/simutrans-sqapi-doc/" target="_blank">https://dwachs.github.io/simutrans-sqapi-doc/</a> <a href="#fnref:21" class="footnote-back-ref">↩</a></li>
<li id="fn:22">"The VG Resource Wiki". wiki.vg-resource.com. Retrieved 2021-09-04. <a href="https://wiki.vg-resource.com/Sonic_Unleashed_(SD)" target="_blank">https://wiki.vg-resource.com/Sonic_Unleashed_(SD)</a> <a href="#fnref:22" class="footnote-back-ref">↩</a></li>
<li id="fn:23">"VScript". valvesoftware.com. 2014-08-20. Retrieved 2015-01-17. <a href="https://developer.valvesoftware.com/wiki/VScript" target="_blank">https://developer.valvesoftware.com/wiki/VScript</a> <a href="#fnref:23" class="footnote-back-ref">↩</a></li>
<li id="fn:24">"Thimbleweed Park Blog- Engine". blog.thimbleweedpark.com. Retrieved 2018-07-06. <a href="http://blog.thimbleweedpark.com/engine" target="_blank">http://blog.thimbleweedpark.com/engine</a> <a href="#fnref:24" class="footnote-back-ref">↩</a></li>
<li id="fn:25">"NewDark 1.25: Squirrel script?". ttlg.com. 2017-03-20. Retrieved 2019-12-25. <a href="https://www.ttlg.com/forums/showthread.php?t=147690" target="_blank">https://www.ttlg.com/forums/showthread.php?t=147690</a> <a href="#fnref:25" class="footnote-back-ref">↩</a></li>
<li id="fn:26">"VScript". valvesoftware.com. 2014-08-20. Retrieved 2015-01-17. <a href="https://developer.valvesoftware.com/wiki/VScript" target="_blank">https://developer.valvesoftware.com/wiki/VScript</a> <a href="#fnref:26" class="footnote-back-ref">↩</a></li>
<li id="fn:27">Vice City Multiplayer <a href="https://vc-mp.org/" target="_blank">https://vc-mp.org/</a> <a href="#fnref:27" class="footnote-back-ref">↩</a></li>
<li id="fn:28">"Welcome To VC-MP website!". Archived from the original on 2006-04-05. Retrieved 2014-05-04. <a href="https://web.archive.org/web/20060405045618/http://www.vicecitymultiplayer.com/" target="_blank">https://web.archive.org/web/20060405045618/http://www.vicecitymultiplayer.com/</a> <a href="#fnref:28" class="footnote-back-ref">↩</a></li>
<li id="fn:29">"undernightinbirth". GitHub. Retrieved 2024-08-18. <a href="https://github.com/Fatih120/undernightinbirth" target="_blank">https://github.com/Fatih120/undernightinbirth</a> <a href="#fnref:29" class="footnote-back-ref">↩</a></li>
<li id="fn:30">"The Squirrel programming language". SourceForge. Retrieved 2018-07-06. <a href="http://sourceforge.net/projects/squirrel/" target="_blank">http://sourceforge.net/projects/squirrel/</a> <a href="#fnref:30" class="footnote-back-ref">↩</a></li>
<li id="fn:31">"Moving to code.google.com and MIT License - The Language - Squirrel - The Programming Language". forum.squirrel-lang.org. Retrieved 2018-07-06. <a href="http://forum.squirrel-lang.org/default.aspx?g=posts&m=4152" target="_blank">http://forum.squirrel-lang.org/default.aspx?g=posts&m=4152</a> <a href="#fnref:31" class="footnote-back-ref">↩</a></li>
<li id="fn:32">"Google Code Archive - Long-term storage for Google Code Project Hosting". code.google.com. Retrieved 2018-07-06. <a href="https://code.google.com/p/squirrel/" target="_blank">https://code.google.com/p/squirrel/</a> <a href="#fnref:32" class="footnote-back-ref">↩</a></li>
</ol>

Squirrel (programming language) open-in-new

Squirrel (programming language)