@modoki/engine / index / BuildRig2DOptions

Interface: BuildRig2DOptions

Skinning

bones

bones: Rig2DBone[]

Bind-pose bones (name + parent index + local x/y/rot in texture space).

---

cellSize?

optional cellSize?: number

Target grid cell size in px when cols/rows are omitted (default 48; grid is clamped to 1..24 divisions per axis).

---

cols?

optional cols?: number

Grid divisions. Omit to auto-derive from cellSize.

---

height

height: number

---

id?

optional id?: string

Rig GUID (top-level id); omit to leave unset (caller mints on save).

---

isInside?

optional isInside?: (u, v) => boolean

Optional UV-space coverage predicate to cull fully-transparent cells.

Parameters

u

number

v

number

Returns

boolean

---

pivotX?

optional pivotX?: number

---

pivotY?

optional pivotY?: number

---

rows?

optional rows?: number

---

sprite

sprite: string

Source texture/sprite GUID.

---

weights?

optional weights?: AutoWeightOptions

---

width

width: number

Sprite dimensions in px.