AutoMovie API
    Preparing search index...

    Parameters of a ride.

    HumanPerformanceParams checks supplied parameters against the motions schema before planning; the action law owns reach and contact refusals.

    interface IParams {
        equestrian?: {
            jump?: {
                approach: string;
                landing: string;
                recovery: string;
                takeoff: string;
            };
            lookBack?: { cue: string; seconds: number; side: "left"
            | "right" };
            stride?: {
                cue: string;
                gait: "walk" | "trot" | "canter";
                lead?: "left" | "right";
            };
        };
        feet?: Partial<Record<"left" | "right", string>>;
        hands?: Partial<Record<"left" | "right", string>>;
        on: string;
        rising?: number | { cue: string };
        seat?: string;
        seconds: number;
    }
    Index
    equestrian?: {
        jump?: {
            approach: string;
            landing: string;
            recovery: string;
            takeoff: string;
        };
        lookBack?: { cue: string; seconds: number; side: "left"
        | "right" };
        stride?: {
            cue: string;
            gait: "walk" | "trot" | "canter";
            lead?: "left" | "right";
        };
    }

    Optional saddle-relative movement on the named seat point. Cue ids refer to tracks in the performance and their instants are film seconds. At least one of stride, jump and lookBack must be set.

    Type Declaration

    • Optionaljump?: { approach: string; landing: string; recovery: string; takeoff: string }

      Follow an authored jumping support from approach through recovery. Each track must publish exactly one instant within the ride, in the order below. Both feet must enter on their named stirrups. Compose a jump in a ride without rising trot.

      • approach: string

        The beginning of the rider's approach posture.

      • landing: string

        The horse's first forehoof landing.

      • recovery: string

        The end of the rider's recovery.

      • takeoff: string

        The horse's last hind-hoof liftoff.

    • OptionallookBack?: { cue: string; seconds: number; side: "left" | "right" }

      An over-shoulder film pose centred on a single cue. The pelvis remains with the saddle.

      • cue: string

        The track with one instant inside the ride, at the fullest turn.

      • seconds: number

        Total seconds of the turn and return, within the ride. Greater than zero.

      • side: "left" | "right"

        Which shoulder the rider looks over.

    • Optionalstride?: { cue: string; gait: "walk" | "trot" | "canter"; lead?: "left" | "right" }

      Use consecutive touchdowns of the same hoof (or diagonal) as the stride clock. Split the ride at gait or lead changes.

      • cue: string

        The track for the same hoof on successive strides. Use a hind-hoof touchdown for walk and one diagonal's touchdown for trot.

      • gait: "walk" | "trot" | "canter"

        The gait whose rider response is sampled.

      • Optionallead?: "left" | "right"

        The active canter lead. Defaults to left.

    feet?: Partial<Record<"left" | "right", string>>

    The support's point each foot stays on, by its id, for a part that moves within the support: a pedal on its turning crank, a stirrup on a trotting horse (IAutoMovieMotionHumanProp.point). The foot keeps the place it had on that point when the ride began. A foot not named, or a point that only moves with the support, is carried rigidly.

    hands?: Partial<Record<"left" | "right", string>>

    The support's point each hand holds, by its id: a handlebar grip, a rein, a wheel's rim. The hand goes to it over TAKE seconds from the ride's start and stays on it, following a part that moves within the support. The arms are still yielded, so an arm action over the ride takes a hand off for as long as it lasts. The hand turns to the point and closes on it (HumanMountRider.hold).

    on: string

    The moving prop ridden: its subject id in the performance.

    rising?: number | { cue: string }

    A rising trot: the mount's stride time, seconds, or the cue track of the performance that holds its strides (the footfalls of one diagonal, as the mount's own ride publishes them). The rider stands in the stirrups and sits again once a stride, the seat rising POST thigh lengths off the saddle, so both feet must rest on the support. On a cue track the seat is down at each of its instants and seated before the first and after the last. Seated throughout when absent.

    Exclusive minimum: 0. Unit: "s". Admission metadata is enforced by HumanPerformanceParams for generated action and row schemas.

    Type Declaration

    • number
    • { cue: string }
      • cue: string

        Performance cue-track id publishing one diagonal's footfalls; the rising rider sits at each instant and before the first and after the last.

    seat?: string

    The support's point the seat stays on, by its id, where the seat itself moves within the support: a saddle on a horse's trunk, which rises and falls with the stride over the course its root follows. The body is carried with the support alone when absent.

    seconds: number

    Seconds ridden, more than none. Exclusive minimum: 0. Unit: "s". Admission metadata is enforced by HumanPerformanceParams for generated action and row schemas.