Skip to content

.NET API

CharmApi

Flat charm from the default charm profile (the ArtisanCharm tool).

from ArtisanPlugin.Scripting import CharmApi

See also the guide, Accessories › Charm, and the Python package, ra.charm.

Methods

Method
CreateDefaults: width 8, height 6, thickness 2.8.

Create

Guid CharmApi.Create(
    Plane? plane = null,
    double width = 0,
    double height = 0,
    double thickness = 0,
    string profile = null,
    string element = null)

Defaults: width 8, height 6, thickness 2.8. element = name of a saved Charm element (ElementsApi.List(“Charm”)) to start from; explicit arguments override it (profile replaces its curve).

ParameterTypeDefault
planePlane?null
widthdouble0
heightdouble0
thicknessdouble0
profilestringnull
elementstringnull

Returns Guid.