AutoMovie API
    Preparing search index...

    Function createPolearm

    • A weapon on a long shaft: a staff or a spear held in two hands, or a cavalry lance couched in one.

      It stands along +Y from its butt at the origin. The shaft is one bar the two hands share, so the hands' spacing and their sliding along it are the wielding act's choice of sites. A spear and a lance carry a flat head above the shaft, its edges toward +Z and -Z; length is the shaft alone and headLength the head above it. tip is the upper end, the way a thrust goes, and butt the lower. A lance also declares grip, the sling at the shaft's midpoint where the one hand holds it; the steel head puts the balance ahead of it, so a couched lance's point is carried forward of the hand. A thrown spear is createJavelin's.

      Parameters

      • params: createPolearm.IParams

        The kind, a spear's head and any dimension the author fixes.

      • Optionalseed: string | number

        The seed that picks the head left free and draws every dimension left free inside its band; absent, the first head and the middle of each band.

      Returns Archetype<createPolearm.Affordance, createPolearm.Dimension>

      The weapon.

      For a head not of the kind, a fixed dimension outside its band or one the head gives, or a head length fixed on a staff, or a lance's shaft length fixed, which its head sets.