Overview
Available scripting methods
In-Game Lua Editor
You can access the in-game Lua Editor by clicking on Scripting on the top bar or by right clicking on an object, choosing Scripting, and then selecting Lua Editor from the contextual menu. In the Lua Editor, the tabs on the left of the editor let you switch between the Global and the Object scripts. Once your Lua code is written, you can use the Save and Play button to commit your changes to your save file and reload for quick iteration. Save and Play will only commit your script changes, any changes made that weren't scripting will be lost.
The advantage of this method is it requires no additional setup. However it lacks many features included in some of the other options.
Official Atom Plugin
The preferred method of writing Lua scripts is using our Official Plugin for the Atom Text Editor. It has all of the functionality of the in-game editor plus line numbers, syntax highlighting, autocomplete, and a modern look. Click here for setup instructions.
External Editor API
It is also possible to edit inside of other envionments which are not officially supported. Using the External Editor API it is possible to work in other enviornments (like Notepad++).
Warning
This method does not, by default, include many features that Atom provides, like auto-completion of Tabletop Simulator functions/class members.
Lua Standard Libraries
We include a subset of the Lua standard libraries into our interpreter to provide a safe sandbox for user scripts to run.
| Library | Description |
|---|---|
| Basic | The basic methods. Includes assert, collectgarbage, error, print, select, type, tonumber, and tostring. |
| Bit32 | The bit32 package. |
| Coroutine | The coroutine package. |
| Dynamic | The dynamic package (introduced by MoonSharp). |
| ErrorHandling | The error handling methods: pcall and xpcall. |
| GlobalConsts | The global constants: _G, _VERSION, and _MOONSHARP. |
| Math | The math package. |
| Metatables | The metatable methods : setmetatable, getmetatable, rawset, rawget, rawequal, and rawlen. |
| OS_Time | The time methods of the os package: clock, difftime, date, and time. |
| String | The string package. |
| Table | The table package. |
| TableIterators | The table iterators: next, ipairs, and pairs. |