Lua API: every module and type

Lua API reference

Everything a PrusaSlicer plugin can call: the api module, the values it hands back and the tables it takes.

API version1.0.0manifest.json"project.plugin": "1.0.0"From PrusaSlicer3.0.0-alpha13Editor stubsDownload .zip

A first plugin

A plugin is one Lua file with an info table and an execute function. This one asks for a size and adds a cube of it to the project. Write your first plugin walks through it.

cube.lua

info = {
    id = "com.example.cube",
    type = "project.plugin",
    title = "Cube",
    menu = "Examples/Cube",
    params = {
        { name = "size", label = "Size [mm]", type = "float", default = 20 },
    },
}

function execute(params)
    local cube = api.make_cube(params.size, params.size, params.size)
    api.project:add_object({ mesh = cube })
end

Modules

apimoduleSlice Plugin API modulemake_cubemake_spheremake_cylindermake_conemake_tetrahedronmake_prismmake_frustummake_frustum_dowel+9 more1 field · 17 functions

Classes

Values the API gives your plugin, and the tables you build to pass to it.

BedInstRefprinter_config(), printer_presets(), print_presets(), tool_print_presets(), material_presets()5 methods BoundingBoxmin_x, max_x, min_y, max_y, min_z, max_z6 fields ConfigBoxvalue(), set()2 methods EmbossTextOptsfont, text, depth, line_height4 fields FloatOrPercentageget_abs_value()1 field · 1 method FontDescriptorname1 field HwPrinterConfigname, tool_count, tools3 fields HwToolConfigfeature(), nozzle_diameter()2 methods Meshtranslate(), bounds()2 methods ModelElementtype1 field ObjectDefinition: VolumeDefinitionobject_params, other_volumes2 fields ProjectApiadd_object(), insert_layer_custom_gcode(), clear_layer_custom_steps(), current_bed()4 methods Vector3Shapex, y, z3 fields VolumeDefinitionmesh, translate, rotate, type, params5 fields

Enums

VolumeTypeenumDefines the behavior or role of a specific volume within a model.SolidNegativeModifierSupportBlockerSupportEnforcerInvalid

Globals

Names every plugin file sees without a require.

VolumeTypeVolumeType

apiapi

In your editor

The same API ships as annotated Lua stubs. Point your editor's Lua language server at them for completion, hover docs and type checks; an AI agent can read them too.Set up your editor.

Download the stubs for 1.0.0

Documentation