AutoMovie API
    Preparing search index...

    Interface IAutoMovieAttachAction

    Rigidly couple this actor to another node's bone for the action's span: a sword in a hand, a prop carried. A persistent mount, such as a rider on a horse, belongs in staging (IAutoMovieStageActor.attach) rather than in an action repeated every shot.

    performShot refuses an actor attaching to itself, a parent that is not a staged node or has no rig, and a bone missing from the parent's skeleton. compileAttach bakes the child's translation and rotation from the parent's posed bone and the optional bone-local offset. The authored offset determines the child's pose at the first key, including when switching parents. Playback writes nothing before the first key and holds the last key afterward. An auto duration keeps coupling to the shot end.

    interface IAutoMovieAttachAction {
        actor: string | string[];
        bone: AutoMovieHumanoidBone;
        duration: number | "auto";
        offset?: IAutoMovieRigidTransform;
        parent: string;
        physicsIntent?: string;
        region?: AutoMovieBodyRegion;
        repeat?: number;
        start: number;
        verb: "attachTo";
    }

    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.

    Semantic bone on the parent's skeleton to which the actor is attached.

    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.

    Child frame in the posed bone, in metres with a unit rotation. The child uses the bone frame when omitted.

    parent: string

    Staged, rigged scene node that owns the attachment bone; not the actor.

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

    verb: "attachTo"

    Selects an attachment as the action family.