2022-01-30 07:47:22 +01:00
|
|
|
# Lua Reference
|
|
|
|
|
|
|
|
|
|
The Lua scripting API is in early development.
|
|
|
|
|
|
|
|
|
|
Expect many more things to be supported in the future.
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
## How to install Lua mods
|
|
|
|
|
Lua scripts you make can be placed either the `mods` folder in the base directory, or in `<SAVE FILE LOCATION>/mods`
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
2022-02-05 04:13:15 +01:00
|
|
|
## Tips
|
|
|
|
|
- When developing Lua mods, run the game from a console. Lua errors and logs will appear there.
|
|
|
|
|
- You can use the `print()` command when debugging. Your logs will show up in the console.
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
2022-02-02 03:52:26 +01:00
|
|
|
## Sections
|
|
|
|
|
- [Globals](globals.md)
|
2022-01-30 09:07:50 +01:00
|
|
|
- [Hooks](hooks.md)
|
2022-01-30 07:47:22 +01:00
|
|
|
- [Constants](constants.md)
|
|
|
|
|
- [Functions](functions.md)
|
|
|
|
|
- [Structs](structs.md)
|
|
|
|
|
|
|
|
|
|
<br />
|
|
|
|
|
|
|
|
|
|
## Example Lua mods
|
|
|
|
|
- [Extended Moveset](../../mods/extended-moveset.lua)
|
|
|
|
|
- [Character Movesets](../../mods/character-movesets.lua)
|
|
|
|
|
- [Low Gravity](../../mods/low-gravity.lua)
|
|
|
|
|
- [Faster Swimming](../../mods/faster-swimming.lua)
|
2022-02-05 04:13:15 +01:00
|
|
|
- [Hide and Seek](../../mods/hide-and-seek.lua)
|
2022-02-16 07:15:49 +01:00
|
|
|
- [HUD Rendering](examples/hud.lua)
|
2022-02-26 09:03:21 +01:00
|
|
|
- [Object Spawning](examples/spawn-stuff.lua)
|
2022-03-05 08:14:01 +01:00
|
|
|
- [Custom Ball Behavior](examples/behavior-ball.lua)
|
|
|
|
|
- [Replace Goomba Behavior](examples/behavior-goomba.lua)
|
