AutoMovie API
    Preparing search index...

    Interface IAutoMovieLaunchAction

    Loose a projectile at a target. The engine computes when it lands, so the model never hand-times the target's reaction: it gives onHit, and the engine schedules the struck node's recoil at the computed impact ("shoot him off his horse" without knowing when the arrow arrives).

    performShot requires finite positive speed, a staged projectile distinct from its launching actors and a resolvable aim; a node aim cannot name that projectile, and onHit needs a single non-camera actor. compileLaunch uses the direct ballistic arc under Earth gravity from staged projectile position, optionally leading a live bone or a node with locomote actions. An unreachable aim or landing more than 1e-9 seconds after shot end produces a range finding at speed. Flight keys are shot-local: before start they write nothing, after landing they hold. The solve emits contact, hit for a node aim and fall for an unbalance reaction; these events do not establish actual geometry contact or falling motion. The launcher gets no reference motion, so a throw or draw needs a separate gesture.

    interface IAutoMovieLaunchAction {
        actor: string | string[];
        at: IAutoMovieActionTarget;
        duration: number | "auto";
        onHit?: IAutoMovieOnHitReaction;
        physicsIntent?: string;
        projectile: string;
        region?: AutoMovieBodyRegion;
        repeat?: number;
        speed: number;
        start: number;
        verb: "launch";
    }

    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.

    What the projectile is aimed at, a target that resolves to one point: a node, a bone, a literal point, or a group without formations.

    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.

    Recoil the engine schedules on the struck node at the computed impact. Requires a node or bone aim identifying an actor, not a point, group or camera. Omitted, the flight and its events are baked without a reaction.

    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.

    projectile: string

    Staged scene node that flies, such as an arrow prop; its staged position is the launch origin, and it may not be one of the launching actors.

    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.

    speed: number

    Launch speed in metres per second, finite and > 0.

    start: number

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

    verb: "launch"

    Selects a projectile launch as the action family.