AutoMovie API
    Preparing search index...

    Function createStairs

    • A straight flight of stairs with its top landing and its handrails.

      The flight rises along +Z from the floor at the origin: the first riser stands at z = 0, and each of the steps risers lifts by the same riser onto a tread of the same tread depth, the last onto the landing. Every nosing is a ledge named step1 upward, facing down the flight, so a foot is placed from the nosing by the tread's depth. A handrail is a bar along the flight's slope at the rail height above the line of the nosings, on the climber's left (+X) or right.

      Parameters

      • params: createStairs.IParams = {}

        The number of risers, the rails, the occupant class and any dimension the author fixes.

      • Optionalseed: string | number

        The seed that draws the occupant class when it is not given and every dimension left free inside its band; absent, the first class and the middle of each band.

      Returns Archetype<createStairs.Affordance, createStairs.Dimension>

      The flight.

      For an occupant class the code does not list, a fixed dimension outside its band, or a number of risers that is not a whole number from 2 to 20.