AutoMovie API
    Preparing search index...

    Interface IAutoMovieEnginePerformShotGateContext

    The staged world and lookups performShot builds once and every one of its input gates reads.

    performShot creates one per call after reading its inputs, and passes it to the action, target, camera, blocking and overlap gates, so each gate judges an action against the same tables and reports into the same collector. The lookups are read-only for the gates; only out is written.

    interface IAutoMovieEnginePerformShotGateContext {
        base: string;
        cameraIds: ReadonlySet<string>;
        formationById: ReadonlyMap<string, IAutoMovieCompiledFormation>;
        formationPoints: ReadonlyMap<string, IAutoMovieVector3>;
        gaits: ((node: string) => readonly string[] | undefined) | undefined;
        hasActorContext: ((node: string) => boolean) | undefined;
        nodeIds: ReadonlySet<string>;
        nodePositions: Map<string, IAutoMovieVector3>;
        out: IAutoMovieViolationCollector;
        performance: IAutoMoviePerformance;
        skeleton: (node: string) => IAutoMovieSkeleton | null;
        staged: IAutoMovieStagedSet.ISuccess;
        targetAt:
            | (
                (
                    target: IAutoMovieActionTarget,
                    seconds: number,
                ) => IAutoMovieVector3 | null
            )
            | undefined;
    }
    Index
    base: string

    Path prefix of the performing action list: $input.revise.final when the revise pass produced one, $input.draft otherwise.

    cameraIds: ReadonlySet<string>

    Ids of the staged cameras.

    formationById: ReadonlyMap<string, IAutoMovieCompiledFormation>

    The compiled formations this shot may frame, by id.

    formationPoints: ReadonlyMap<string, IAutoMovieVector3>

    Each compiled formation's world centroid at the shot's opening, metres.

    gaits: ((node: string) => readonly string[] | undefined) | undefined

    The gait names each actor supplies; undefined, or undefined for a node, skips the locomote gait check.

    hasActorContext: ((node: string) => boolean) | undefined

    Actor-registry membership; undefined when the caller supplies no actor context, in which case a bone target is not checked against it.

    nodeIds: ReadonlySet<string>

    Ids of the staged scene nodes.

    nodePositions: Map<string, IAutoMovieVector3>

    World position of every staged node and camera, in metres.

    Collector every gate reports into, in gate order.

    The beat's performance, whose actions and duration are gated.

    skeleton: (node: string) => IAutoMovieSkeleton | null

    Rig lookup; null for a staged node with no skeleton.

    The validated stage result the shot performs on.

    targetAt:
        | (
            (
                target: IAutoMovieActionTarget,
                seconds: number,
            ) => IAutoMovieVector3 | null
        )
        | undefined

    Live resolver for a target whose point moves during the shot; undefined when the caller supplies none, and its null falls back to the staged placement.