Plugin Marketplace
Sign in

Documentation

Lua API: every module and type
Lua API · Module

api

Slice Plugin API module

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

Fields

Functions

make_cubeCreates a cube mesh.
make_sphereCreates a sphere mesh.
make_cylinderCreates a cylinder mesh.
make_coneCreates a cone mesh.
make_tetrahedronCreates a tetrahedron mesh.
make_prismCreates a prism mesh.
make_frustumCreates a frustum mesh.
make_frustum_dowelCreates a frustum dowel mesh.
make_pyramidCreates a pyramid mesh.
make_snapCreates a snap joint mesh.
make_torusCreates a torus mesh.
emboss_svgEmbosses an SVG file into a mesh.
load_stlLoads an STL file into a mesh.
fontsRetrieves a list of all available fonts.
get_default_fontRetrieves the default font descriptor.
get_fontSearches for a font by name.
emboss_textEmbosses text into a mesh.

#make_cube

function
api.make_cube(width: number, height: number, depth: number) → Mesh

Creates a cube mesh.

Parameters
widthnumber
Width [mm]
heightnumber
Height [mm]
depthnumber
Depth [mm]
Returns
Meshmesh
A constructed geometry

#make_sphere

function
api.make_sphere(radius: number, fa: number?) → Mesh

Creates a sphere mesh.

Parameters1 optional
radiusnumber
Radius [mm]
fanumberoptional
Optional facet angle [degrees].
Returns
Meshmesh
A constructed geometry

#make_cylinder

function
api.make_cylinder(radius: number, height: number, fa: number?) → Mesh

Creates a cylinder mesh.

Parameters1 optional
radiusnumber
Radius [mm]
heightnumber
Height [mm]
fanumberoptional
Optional facet angle [degrees].
Returns
Meshmesh
A constructed geometry

#make_cone

function
api.make_cone(radius: number, height: number, fa: number?) → Mesh

Creates a cone mesh.

Parameters1 optional
radiusnumber
Radius [mm]
heightnumber
Height [mm]
fanumberoptional
Optional facet angle [degrees].
Returns
Meshmesh
A constructed geometry

#make_tetrahedron

function
api.make_tetrahedron(size: number) → Mesh

Creates a tetrahedron mesh.

Parameters
sizenumber
Edge length [mm]
Returns
Meshmesh
A constructed geometry

#make_prism

function
api.make_prism(width: number, length: number, height: number) → Mesh

Creates a prism mesh.

Parameters
widthnumber
Width [mm]
lengthnumber
Lenght [mm]
heightnumber
Height [mm]
Returns
Meshmesh
A constructed geometry

#make_frustum

function
api.make_frustum(radius: number, height: number, fa: number?) → Mesh

Creates a frustum mesh.

Parameters1 optional
radiusnumber
Radius [mm]
heightnumber
Height [mm]
fanumberoptional
Optional facet angle [degrees].
Returns
Meshmesh
A constructed geometry

#make_frustum_dowel

function
api.make_frustum_dowel( radius: number, height: number, sector_count: integer ) → Mesh

Creates a frustum dowel mesh.

Parameters
radiusnumber
Radius [mm]
heightnumber
Height [mm]
sector_countinteger
—
Returns
Meshmesh
A constructed geometry

#make_pyramid

function
api.make_pyramid(base: number, height: number) → Mesh

Creates a pyramid mesh.

Parameters
basenumber
Base size [mm]
heightnumber
Height [mm]
Returns
Meshmesh
A constructed geometry

#make_snap

function
api.make_snap( radius: number, height: number, space_proportion: number?, bulge_proportion: number? ) → Mesh

Creates a snap joint mesh.

Parameters2 optional
radiusnumber
Radius [mm]
heightnumber
Height [mm]
space_proportionnumberoptional
—
bulge_proportionnumberoptional
—
Returns
Meshmesh
A constructed geometry

#make_torus

function
api.make_torus(r: number, t: number, ra: number?, ta: number?) → Mesh

Creates a torus mesh.

Parameters2 optional
rnumber
Major radius [mm].
tnumber
Minor radius [mm].
ranumberoptional
Optional major facet angle [degrees].
tanumberoptional
Optional minor facet angle [degrees].
Returns
Meshmesh
A constructed geometry

#emboss_svg

function
api.emboss_svg(path: string, depth: number) → Mesh

Embosses an SVG file into a mesh.

Parameters
pathstring
The path to the SVG file.
depthnumber
Extrusion depth [mm].
Returns
Meshmesh
A constructed geometry

#load_stl

function
api.load_stl(path: string) → Mesh

Loads an STL file into a mesh.

Parameters
pathstring
The path to the STL file.
Returns
Meshmesh
A constructed geometry

#fonts

function
api.fonts() → FontDescriptor[]

Retrieves a list of all available fonts.

Returns
FontDescriptor[]
—

#get_default_font

function
api.get_default_font() → FontDescriptor

Retrieves the default font descriptor.

Returns
FontDescriptor
—

#get_font

function
api.get_font(name: string) → FontDescriptor

Searches for a font by name.

Parameters
namestring
The name or partial name of the font.
Returns
FontDescriptor
—

#emboss_text

function
api.emboss_text(opts: EmbossTextOpts) → Mesh

Embosses text into a mesh.

Parameters
optsEmbossTextOpts
—
Returns
Meshmesh
A constructed geometry
Esc

    ↑↓ move↵ openAPI 1.0.0