Squirrel (programming language)

From HandWiki
Short description: Computer programming language
Squirrel
ParadigmMulti-paradigm: scripting, imperative, functional, object-oriented
Designed byAlberto Demichelis
First appearedSeptember 6, 2003; 20 years ago (2003-09-06)
Typing disciplineDynamic
OSCross-platform
LicenseMIT license
Filename extensions.nut
Website{{{1}}}
Influenced by
C++, JavaScript, Lua, Python
Influenced
MiniD

Squirrel is a high level imperative, object-oriented programming language, designed to be a lightweight scripting language that fits in the size, memory bandwidth, and real-time requirements of applications like video games.

MirthKit, a simple toolkit for making and distributing open source, cross-platform 2D games, uses Squirrel for its platform.[1] It is used extensively by Code for scripting and was also used in Final Fantasy Crystal Chronicles: My Life as a King.[2][3] It is also used in Left 4 Dead 2, Portal 2 and Thimbleweed Park for scripted events and in NewDark, an unofficial Thief 2: The Metal Age engine update, to facilitate additional, simplified means of scripting mission events, aside of the regular C scripting.[4]

Language features

Syntax

Squirrel uses a C-like syntax.

Factorial in Squirrel
function factorial(x)
{
  if (x <= 1) {
    return 1;
  }
  else {
    return x * 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();

Applications

Applications using Squirrel

  • Code, integrated development environment
  • Enduro/X, cluster application server
  • Electric Imp, an end-to-end IoT platform[5]

Games using Squirrel


History

The language was made public in 2003 under the zlib/libpng license.[19] In November 2010, the license was changed to the MIT license to enable the project to be hosted on Google Code.[20][21] It is developed and maintained by Alberto Demichelis.

See also

References

  1. MirthKit Developer Wiki
  2. 2.0 2.1 Brandon Boyer (21 February 2008). "Gamasutra - GDC 2008 Event Coverage". gamasutra.com. Gamasutra. http://www.gamasutra.com/view/news/17560/GDC_Tsuchida_Shiraishi_Talk_Square_Enixs_New_WiiWare_Choices.php. 
  3. "Exclusive: Behind The Scenes of Final Fantasy's WiiWare Debut". gamasutra.com. Gamasutra. 23 June 2008. http://www.gamasutra.com/view/news/19143/Exclusive_Behind_The_Scenes_of_Final_Fantasys_WiiWare_Debut.php. 
  4. "L4D2 Vscripts - Valve Developer Community" (in en). http://developer.valvesoftware.com/wiki/L4D2_Vscripts. 
  5. "Electric Imp programming guide". https://developer.electricimp.com/squirrel/squirrel-guide/introduction. 
  6. 6.0 6.1 6.2 6.3 6.4 6.5 6.6 6.7 "VScript". 2014-08-20. https://developer.valvesoftware.com/wiki/VScript. 
  7. "th155-decomp". https://github.com/mathfreak231/th155-decomp/tree/v1.10d. 
  8. "WHAT in the hell, is consumable nut? Please help this is an error code I got, have any of you got this before?". 2019-03-24. https://www.reddit.com/r/apexlegends/comments/b4ohol/what_in_the_hell_is_consumable_nut_please_help/. 
  9. "iv-multiplayer.com". http://wiki.iv-multiplayer.com/wiki/index.php?title=FAQ. 
  10. "Liberty Unleashed". http://liberty-unleashed.co.uk. 
  11. "m2-multiplayer.com" (in en). http://www.m2-multiplayer.com/. 
  12. "AI:Main Page - OpenTTD" (in en). http://wiki.openttd.org/?title=AI:Main_Page&oldid=76593. 
  13. "Simutrans-Squirrel-API: Main Page". https://dwachs.github.io/simutrans-sqapi-doc/. 
  14. "The VG Resource Wiki". https://wiki.vg-resource.com/Sonic_Unleashed_(SD). 
  15. "Thimbleweed Park Blog- Engine". http://blog.thimbleweedpark.com/engine. 
  16. "NewDark 1.25: Squirrel script?". 2017-03-20. https://www.ttlg.com/forums/showthread.php?t=147690. 
  17. Vice City Multiplayer
  18. "Welcome To VC-MP website!". https://vc-mp.org/. 
  19. "The Squirrel programming language" (in en). http://sourceforge.net/projects/squirrel/. 
  20. "Moving to code.google.com and MIT License - The Language - Squirrel - The Programming Language". http://forum.squirrel-lang.org/default.aspx?g=posts&m=4152. 
  21. "Google Code Archive - Long-term storage for Google Code Project Hosting." (in en). https://code.google.com/p/squirrel/. 

External links