Skip to content

Lua Overview

Welcome to the Lua docs for the Bopl Battle Map Maker! Here, you’ll find info on all different functions, types, and tools you can use to make Lua code for maps. Check out the sections below to dive into what you can do:

  • Useful Code Snippets
    Commonly used useful lua code snippets I've gathered for you to implement into your map easily.

  • Arrays
    Info about arrays, which are tables with numeric keys in order.

  • Notes
    Important things regarding map maker's technical details.

  • Spawn Functions
    A list of functions related to spawning objects.

  • Raycast Functions
    Functions the get/shoot an object/ray from the scene based on a point, angle, or index.

  • Miscellaneous Functions
    Global functions that aren't specific to any particular category.

  • Player
    Everything about the Player class: properties, methods, and functions.

  • Platform
    Everything about the Platform class: properties, methods, and functions.

  • BoplBody
    Everything about the BoplBody class: properties, methods, and functions.

  • BlackHole
    Everything about the BlackHole class: properties, methods, and functions.

  • Errors
    Understanding error handling in Lua.

  • Default Lua APIs
    List of built-in Lua APIs you can use.


New to Lua?

If you're just starting out with Lua, take a look at tutorials to get a feel for how lua works. From there, explore different functions to interact with the game world.

You can also learn the basics of Lua through some tutorials:

And don’t forget to check the default Lua APIs for built-in Lua features.