Skip to content
Work in progress. These docs describe Spawnite at launch, and some parts are still being built.

HeldItemProps

Property Type Default value Description
children? ReactNode undefined -
forward? Position [0, 0, -1] The way the held thing’s tip points, in its own axes before rotation: what a cast’s hand turn carries onto the target as the spell releases. A wand whose orb is up its y gives [0, 1, 0].
grip? Partial<HandGrip> { thumb: 0.9, index: 0.75, middle: 0.8, ring: 0.85, little: 0.9 } How far each finger of her hand closes round it while she holds it, from 0, straight, to 1, a fist: a curl you leave out keeps the engine’s grip, which closes round a staff’s or a sword’s handle, and { index: 0 } points the index finger along it. An avatar with no finger bones, and the default body, draw no grip.
position? Position [0, 0, 0] Metres from her hand, in the hand’s axes: y up, -z the way she faces and x to her right while she stands at rest.
rotation? HeldItemRotation [0, 0, 0] Radians the held thing turns in the hand.
scale? number 1 -