AutoMovie API
    Preparing search index...

    Interface IAutoMovieReactAction

    Flinch away from a blow.

    Usually the engine emits it from an IAutoMovieLaunchAction's onHit at the computed impact; author it directly for a melee blow whose timing you control. performShot refuses a force outside [0, 1] and a source that does not resolve to one point, which includes the relative kinds and a group naming a formation.

    The reference synthesizer requires an actor rig. It resolves the source at start, projects the horizontal away direction into staged facing/right axes and scales degree deflection by 32 times force, multiplied by 1.5 for unbalance. reactMotion propagates it through head, neck, chest and spine, clamping configured bones, with rest, peak at min(0.16, 0.4 times duration), then rest. A horizontally coincident source uses forward as the away vector and therefore positive flexion. Auto lasts 0.5 seconds; the default region is fullBody.

    interface IAutoMovieReactAction {
        actor: string | string[];
        duration: number | "auto";
        force: number;
        from: IAutoMovieActionTarget;
        physicsIntent?: string;
        region?: AutoMovieBodyRegion;
        repeat?: number;
        start: number;
        unbalance?: boolean;
        verb: "react";
    }

    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.

    force: number

    Blow strength within [0, 1], refused outside it; the peak flinch is 32 * force degrees before the range clamp.

    Where the blow comes from; it must resolve to one point, and the body recoils horizontally away from it.

    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].

    unbalance?: boolean

    Whether the blow is meant to floor or unseat the actor. The reference synthesizer flinches 1.5 times harder; no fall or dismount motion is produced.

    verb: "react"

    Selects an impact reaction as the action family.