AutoMovie API
    Preparing search index...

    Interface IAutoMovieLocomoteAction

    Travel across the ground on one of the actor's own gaits.

    gait is matched by name against the gaits the actor's context supplies (IAutoMovieGait.name), so the vocabulary is the actor's: the shipped humanoid gaits are walk, run, sprint, sneak and march, the horse's walk, trot, gallop and rear, the cat's walk, leap and stalk. performShot refuses a gait the actor does not list when the host supplies gait lists, and a destination that resolves but leaves an actor no horizontal travel, since a gait cannot climb straight up.

    The reference synthesizer (makeActorSynthesizer) carries whole gait cycles to the destination, including its height change, at the actor's ground speed. A numeric duration time-scales that walk to the stated span, and "auto" keeps the engine's sizing. A relative target, direction or offscreen, has no point yet, so the actor steps in place; so does an actor already at the destination. A node destination is read from the staged placement, or where a previous beat left that node, not from its motion in this shot.

    interface IAutoMovieLocomoteAction {
        actor: string | string[];
        duration: number | "auto";
        faceTravel?: boolean;
        gait: string;
        physicsIntent?: string;
        region?: AutoMovieBodyRegion;
        repeat?: number;
        start: number;
        to: IAutoMovieActionTarget;
        verb: "locomote";
    }

    Hierarchy (View Summary)

    Index
    actor: string | string[]

    The scene-node id or ids performing this action, reusing ids from staging. A list applies the same verb to several actors in unison (a chorus line, a crowd, synchronised dancers) instead of repeating the action per actor. Every id must be a staged scene node, and a list must be non-empty with no duplicates. Only a frame action names a camera, and it names exactly one as a string.

    duration: number | "auto"

    Length in seconds, finite and > 0 with start + duration inside the shot, or "auto" to let the engine pick a natural duration (a stride cadence, a punch's snap, a projectile's flight time). The reference synthesizer sizes an "auto" clip itself, while performShot's overlap check and an attachTo treat the span as running to the shot end, and a frame as running until the next camera move. An "auto" action may not start exactly at the shot end, which leaves it no span.

    faceTravel?: boolean

    Turn the body to face the travel direction. Omitted or false, the actor keeps its facing and strafes or backpedals.

    gait: string

    Name of a gait the actor's context supplies, matched exactly.

    physicsIntent?: string

    Free-text acknowledgment of a deliberate physical implausibility, such as "defies-gravity" or "intentional-clip", meant to stop the engine's warning-severity plausibility feedback (see IAutoMovieConstraintViolation.severity) from re-firing on this action. No engine or production path reads this field: the plausibility detectors take their own physicsIntent argument, and no shot pipeline calls them, so setting it changes nothing today.

    The body region this action drives (AutoMovieBodyRegion). Actions whose masked content is disjoint compose concurrently (walk while waving while looking), and actions sharing content take turns. Omitted, the engine's actionRegion infers it from the verb and, for gestures, the kind: locomote is fullBody, because the shipped gaits drive hips, knees, and contralateral arms; gesture and reach are upperBody; lookAt and the nod and shake gestures are head; emote is face; the bow, crouch, kick, stagger, jump, and draw gestures and every other verb are fullBody. Overlap is judged on the content surviving those masks (root, bones, expression), so a fullBody gait still layers with a disjoint head-only lookAt. The engine masks the synthesized clip to the chosen region and performShot reports content the mask drops, so override only when the natural region is wrong for the staging. Camera (frame) and attachTo actions ignore it.

    repeat?: number

    Play the synthesized motion this many times back to back, a positive integer defaulting to 1: a step repeated on the count, an idle sway. compilePerformance concatenates the synthesized clip that many times, so the motion runs repeat clip lengths, while performShot's span and overlap checks read only start + duration.

    start: number

    Seconds into the shot when it begins, within [0, shot duration].

    Where to go. A formation-free node, bone, point or group destination is walked to; a relative target steps in place.

    verb: "locomote"

    Selects locomotion as the action family.