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:
| Member | Meaning |
|---|---|
Region | Sizing region of the set, "" when unset |
FirstRing | The first ring — IWeddingRing |
SecondRing | The 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.
| Member | Meaning |
|---|---|
RingSizeLabel / RingSizeRegion / RingDiameterMm | This ring’s size |
Metal | e.g. "GOLD_YELLOW_18" |
Profile | The band section — IWeddingProfile |
Gems | The stones — IWeddingGems |
SetMetal(metal) | By name, e.g. "PLATINUM" |
The band (IWeddingProfile)
| Member | Meaning |
|---|---|
ProfileName | RING_PROFILE asset name, "" when unset |
Width / Height | Band section, mm |
SetProfile(assetName) / SetWidth / SetHeight |
The stones (IWeddingGems)
| Member | Meaning |
|---|---|
Enabled | Whether stones are built |
Shape | "Round" or "Princess" |
Distribution | "Full", "Half", "Onequarter" or "Custom" |
CustomDistance | "Continuous" or "Equidistant" |
NumberOfGems | Used with the "Custom" distribution |
GemSize / MinDistance / Vertical / GemInside | Placement, mm |
InnerWidth / InnerHeight | Inner channel, mm |
ProngType | "None", "Shared" or "Channel" |
ProngHeight / ProngMoveInZ / ProngDiameter | mm |
AutomaticProngDiameter | |
ExtensionManufacturing | mm |
DrillType / DrillWidth / DrillHeight | Drills — type is "NONE", "ROUND" or "QUAD" |
SetEnabled, SetShape, SetDistribution, SetCustomDistance, SetNumberOfGems | The row |
SetGemSize, SetMinDistance, SetVertical, SetGemInside, SetInnerWidth, SetInnerHeight | Placement |
SetProngType, SetProngHeight, SetProngMoveInZ, SetProngDiameter, SetAutomaticProngDiameter | Prongs |
SetExtensionManufacturing, SetDrillType, SetDrillWidth, SetDrillHeight |
String parameters are case-insensitive and tolerate dashes/spaces; an unknown value raises a clear error listing the valid ones.