Skip to content

Scripting API

IWedding

Returned by WeddingApi — a wedding set: two rings baked together as one group. Multiple gems, so no single mother gem. Adds to IParametricObject:

MemberMeaning
RegionSizing region of the set, "" when unset
FirstRingThe first ring — IWeddingRing
SecondRingThe second ring — IWeddingRing

Both rings are live views over the set’s stored parameters: their getters read the current values and every setter regenerates the whole set in place (same Guid), re-baking both bands, their stones and their prongs.

from ArtisanPlugin.Scripting import WeddingApi as wedding, Transaction

pair = wedding.All()[0]
with Transaction.Begin("Hers in rose gold with a half row"):
    pair.SecondRing.SetMetal("GOLD_ROSE_18")
    pair.SecondRing.Gems.SetEnabled(True)
    pair.SecondRing.Gems.SetDistribution("Half")

One ring (IWeddingRing)

The same section backs IWeddingBand.

MemberMeaning
RingSizeLabel / RingSizeRegion / RingDiameterMmThis ring’s size
Metale.g. "GOLD_YELLOW_18"
ProfileThe band section — IWeddingProfile
GemsThe stones — IWeddingGems
SetMetal(metal)By name, e.g. "PLATINUM"

The band (IWeddingProfile)

MemberMeaning
ProfileNameRING_PROFILE asset name, "" when unset
Width / HeightBand section, mm
SetProfile(assetName) / SetWidth / SetHeight

The stones (IWeddingGems)

MemberMeaning
EnabledWhether stones are built
Shape"Round" or "Princess"
Distribution"Full", "Half", "Onequarter" or "Custom"
CustomDistance"Continuous" or "Equidistant"
NumberOfGemsUsed with the "Custom" distribution
GemSize / MinDistance / Vertical / GemInsidePlacement, mm
InnerWidth / InnerHeightInner channel, mm
ProngType"None", "Shared" or "Channel"
ProngHeight / ProngMoveInZ / ProngDiametermm
AutomaticProngDiameter
ExtensionManufacturingmm
DrillType / DrillWidth / DrillHeightDrills — type is "NONE", "ROUND" or "QUAD"
SetEnabled, SetShape, SetDistribution, SetCustomDistance, SetNumberOfGemsThe row
SetGemSize, SetMinDistance, SetVertical, SetGemInside, SetInnerWidth, SetInnerHeightPlacement
SetProngType, SetProngHeight, SetProngMoveInZ, SetProngDiameter, SetAutomaticProngDiameterProngs
SetExtensionManufacturing, SetDrillType, SetDrillWidth, SetDrillHeight

String parameters are case-insensitive and tolerate dashes/spaces; an unknown value raises a clear error listing the valid ones.