C++ Interface

The Squirrel VMs can be manipulated and controlled by Northstar and Plugins.

All functions and macros documented are defined and used in the Northstar Client. For plugins it’s recommended to use F1F7Y’s template that mirrors the definitions to an extend or rrplug if you prefer Rust. Note that this documentation only covers the C++ API available in the Launcher.

For more information you can read the official library documentation. However be aware that implementations or behaviour might be different and features are missing in Respawn’s Squirrel fork.

• Stack
  • Stack Indexes
  • Stack manipulation
• Object creation and handling
  • SquirrelManager
  • Pushing Objects to the stack
  • Getting Objects from the stack
  • Stack Infos
  • Other
• Creating / Manipulating Objects
  • Arrays
  • Tables
  • Structs
  • Userdata
• Squirrel Functions
  • Adding Squirrel Functions
  • Replacing Squirrel Functions
  • Script Contexts
  • Script Returns
  • Calling
  • Errors