AutoMovie API
    Preparing search index...

    Function createHolster

    • A container worn on the body that a weapon or its ammunition is drawn from and returned to: a belt holster for a handgun, a sword's scabbard, a knife's or a dagger's sheath, an archer's quiver, or a soldier's cartridge box.

      Each hangs with the wearer's body on its -X side and its front toward +Z; belt is the loop or hanger it hangs by, facing the wearer. The item in it is a separate prop: the container declares where that item sits, and the act takes it. How each kind stands:

      • a holster hangs with the middle of its belt loop at the origin. Its socket is the mouth the pistol is drawn from and returned to, facing up, lowered or raised from the belt line by the ride dimension. It marks where the pistol's butt leaves the mouth; a holstered pistol lies muzzle down in the pouch, which the holstering act places, and no frame of createHandgun seats coincident on the socket to give that.
      • a scabbard and a sheath stand on their tip (the chape) at the origin, the mouth straight up along +Y at the drawn length, the blade's flats toward X. mouth is the opening, facing up: a sheathed blade stands point down in it with its shoulder (createSword's origin) on the mouth. belt is the hanger on the metal throat below the mouth. A throat held while the blade is drawn waits for a source of the throat's size. Its hanging angle is not modelled: it hangs straight, since no source read gives the angle a hanger sets.
      • a quiver stands on its bottom at the origin, a tube open upward. socket is the mouth, facing up, and slot1 to slot<slots> the places the arrows stand in it, each facing up on the mouth's plane; belt hangs it at a hip from its rim, and strap slings it across the back at its middle.
      • a cartridge box stands on its bottom at the origin, its back against the wearer at x = 0, its length along Z. Its two tins' upper parts hold the loose cartridges standing: slot1 to slot<slots> are their places, facing up at the box's top, the 2 x 1.35 in part's 6 in three rows of two and the 1.35 in square part's 4 in two of two. The lid, its flap, turns up and outward on a hinge along the box's back top edge; strap is the shoulder belt's loops at its back, and belt the same loops on a waist belt.

      Parameters

      • params: createHolster.IParams = {}

        The kind, a holster's ride, the blade a scabbard or a sheath is made to, the number of slots of a quiver, and any dimension the author fixes.

      • Optionalseed: string | number

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

      Returns Archetype<createHolster.Affordance, createHolster.Dimension>

      The container.

      For a ride or a blade not of the kind, a fixed dimension outside its band or one the ride gives, or a number of slots that is not a whole number from 1 to the kind's capacity.