Skip to content

Scripting API

IWeddingBand

Returned by WeddingBandApi — a single wedding band, the one-ring counterpart of the wedding set. Multiple gems, so no single mother gem. Adds to IParametricObject:

MemberMeaning
RegionSizing region, "" when unset
RingThe band itself — IWeddingRing, the same section a wedding set uses for each of its two rings

The section is a live view over the band’s stored parameters: its getters read the current values and every setter regenerates the band in place (same Guid), re-baking its stones and prongs.

from ArtisanPlugin.Scripting import WeddingBandApi as band, Transaction

b = band.All()[0]
with Transaction.Begin("Wider band, no stones"):
    b.Ring.Profile.SetWidth(4.0)
    b.Ring.Gems.SetEnabled(False)