AutoMovie API
    Preparing search index...

    Interface IAutoMovieEngineShotRuntime

    Host-owned capabilities and compiled facts compileDefinedShot needs to turn a shot program's thin verbs into dense, validated motion.

    The shot program states what happens; this record supplies what only the host knows: the rig and model of each staged node, the action synthesizer, the delivery raster, builder-owned formations and clips, the previous beat's end state, and any collision advice. compileDefinedShot forwards the capabilities to performShot, the measurement inputs to realizeShotContract, previous to blockBeat, plants to the closing continuity snapshot, and advice to its own validation. Every optional member, when omitted, disables only the check or measurement it feeds, as stated on that member.

    interface IAutoMovieEngineShotRuntime {
        advice?: readonly IAutoMovieShotPhysicsAdvice[];
        cameraClearance?: IAutoMovieCameraClearanceRuntime;
        collisions?: readonly string[];
        formationDesigns?: ReadonlyMap<string, IAutoMovieFormationDesign>;
        formationMotions?: readonly IAutoMovieFormationMotion[];
        formations?: readonly IAutoMovieCompiledFormation[];
        frameFormat: Pick<
            IAutoMovieProductionDesign["frameFormat"],
            "width"
            | "height",
        >;
        lightMotions?: readonly IAutoMovieClip[];
        models?: readonly IAutoMovieModel[];
        objectMotions?: readonly IAutoMovieClip[];
        plants?: readonly {
            node: string;
            plants: readonly IAutoMovieBeatEndFootPlant[];
        }[];
        practicalLights?: readonly IAutoMoviePracticalLightBinding[];
        previous?: IAutoMovieBeatEndState;
        props?: readonly IAutoMoviePropSpec[];
        synthesize: IAutoMovieActionSynthesizer;
        world?: IAutoMovieWorldDesign
        | null;
        gaits?(node: string): readonly string[] | undefined;
        hasActorContext?(node: string): boolean;
        jointAxes?(
            node: string,
        ): Partial<Record<AutoMovieHumanoidBone, IAutoMovieJointAxes>> | undefined;
        restFrames?(
            node: string,
        ): Partial<Record<AutoMovieHumanoidBone, IAutoMovieRestFrame>> | undefined;
        skeleton(node: string): IAutoMovieSkeleton | null;
        targetAt?(
            target: IAutoMovieActionTarget,
            seconds: number,
        ): IAutoMovieVector3 | null;
    }
    Index
    advice?: readonly IAutoMovieShotPhysicsAdvice[]

    Collision-response suggestions from shot code or a host analysis pass, with the author's decisions; validated, then copied onto the compiled result and never applied to motion.

    Geometry revision and fixed inspection clock for camera-body clearance. Required only when a delivered staged camera declares a clearance envelope; such a camera without it is a violation.

    collisions?: readonly string[]

    Ids of formation slots that collided with an authored scene node while the builder materialized this shot; each one fails the contract realization.

    formationDesigns?: ReadonlyMap<string, IAutoMovieFormationDesign>

    Formation designs by id, cited by the registered participant contract; omitted means none.

    formationMotions?: readonly IAutoMovieFormationMotion[]

    The shot's compact formation cues.

    A camera framing a unit and the realization grading that frame both measure the unit where the cue playing at that instant has put it, so the cues have to reach the performance boundary rather than being attached to the source artifact after it is built. Omitted, every formation is measured at rest.

    formations?: readonly IAutoMovieCompiledFormation[]

    Compiler-owned compact formation runtimes present in this shot, so a camera can frame a mass; a group target naming a formation absent here is a violation.

    frameFormat: Pick<IAutoMovieProductionDesign["frameFormat"], "width" | "height">

    Delivery raster in pixels, used to project required camera subjects at the opening, review and closing times and to fit framing horizontally.

    lightMotions?: readonly IAutoMovieClip[]

    The shot's own light clips, carried onto the compiled shot.

    The source states them beside its verbs and the host hands them here; the performance boundary checks that each addresses a staged light, as it checks every other reference the source makes.

    models?: readonly IAutoMovieModel[]

    Compiler-owned models of the staged nodes, used to measure what a camera frames and what the contract grades; omitted, the rig span or a stand-in height is measured instead.

    objectMotions?: readonly IAutoMovieClip[]

    The shot's own object clips, carried onto the compiled shot's objectMotions.

    A building's panel and a prop's leaf are the two things a shot can move that no verb reaches, and both are one node in the staged graph turned over the shot's clock. The performance boundary admits the nodes this shot may drive and bounds a driven joint by the travel its prop declares in props.

    plants?: readonly {
        node: string;
        plants: readonly IAutoMovieBeatEndFootPlant[];
    }[]

    Ground-IK stance runs carried into the closing continuity snapshot, one entry per node; a node this shot replants replaces its entry.

    practicalLights?: readonly IAutoMoviePracticalLightBinding[]

    Practical lights bound to staged prop emitters. Compiled from the final object clips, using the corresponding prop model in models, and appended to lightMotions. Omit when no practical source follows a prop.

    The previous beat's verified end state, used as this shot's opening condition: actors resume its placement, facing, pose, gait phase, velocity, plants and mount. Omitted for a first beat.

    props?: readonly IAutoMoviePropSpec[]

    Forged props this shot stages, whose joints those clips may address.

    Rig-specific action synthesizer; the engine composes its clips and applies the ROM and artifact gates after it.

    world?: IAutoMovieWorldDesign | null

    World landmarks cited by contract predicates; omitted or null, a predicate citing a landmark fails the compile with a contract-phase diagnostic.

    • Whether a staged node has an actor context in the host's registry.

      performShot reports a bone target on a staged node without a context as missing context, which keeps it distinct from a present actor that simply has no rig. Omitted, every staged node is taken to have a context.

      Parameters

      • node: string

      Returns boolean