AutoMovie API
    Preparing search index...

    Interface IAutoMovieIntent

    One subject's intended action: the smallest unit a production composes.

    The engine never interprets capability; it is the production's own vocabulary (a verb a subject can perform), so the same schedule machinery serves any film. Timing, outcomes and state come from the production's pure functions handed to resolveAutoMovieSchedule.

    interface IAutoMovieIntent {
        anchor?: string;
        capability: string;
        goal?: IAutoMovieRelationalGoal;
        parameters?: Readonly<Record<string, unknown>>;
        subject: string;
        until?:
            | { share: number }
            | { event: string }
            | { event: string; index?: number; of: string }
            | {
                proximity: {
                    distance: number;
                    effector: AutoMovieHumanoidRegion;
                    target: IAutoMovieMotionTarget;
                };
            };
    }
    Index
    anchor?: string

    Optional stable id other parts align to with AutoMovieComposition.at; unique in a composition.

    capability: string

    The production's capability name, such as a verb its subject class offers.

    Optional relation the action must realize against another subject.

    parameters?: Readonly<Record<string, unknown>>

    Production data the timing, outcome and state functions read; the engine copies it untouched.

    subject: string

    Stable id of the acting subject.

    until?:
        | { share: number }
        | { event: string }
        | { event: string; index?: number; of: string }
        | {
            proximity: {
                distance: number;
                effector: AutoMovieHumanoidRegion;
                target: IAutoMovieMotionTarget;
            };
        }

    Cut the action short, as an interrupt (a cancel window in fighting-game terms, an interruption source in Unity's animator):

    • { share }: at a share of its duration in [0, 1];
    • { event }: at one of its own named events (resolveAutoMovieSchedule.ITiming.events);
    • { of, event }: when an event of the intent anchored of, usually another subject's action, or of a cue track named of, happens; index picks which occurrence where the name repeats;
    • { proximity }: when the subject's effector region first comes within distance metres of target (zero is contact), which the production's until law finds from its motion; a proximity the motion never reaches cuts nothing, and the action runs to its end.

    The entry then ends at the cut and the next part of a sequence starts there. The production's legality rules decide whether the cut is declared; the resolver only places it. Absent, the action runs to its end.

    Type Declaration

    • { share: number }
      • share: number

        Fraction of the full, uncut duration in [0, 1], checked by AutoMovieScheduleCut.

    • { event: string }
      • event: string

        First matching event from this intent's timing; missing names are rejected.

    • { event: string; index?: number; of: string }
      • event: string

        Event name within that anchor or track; matching preserves the source event order.

      • Optionalindex?: number

        Zero-based occurrence among that name's events; defaults to zero and is rejected when no occurrence exists.

      • of: string

        Earlier placed intent's anchor, fixed cue track, or dynamically supplied cue track.

    • {
          proximity: {
              distance: number;
              effector: AutoMovieHumanoidRegion;
              target: IAutoMovieMotionTarget;
          };
      }
      • proximity: {
            distance: number;
            effector: AutoMovieHumanoidRegion;
            target: IAutoMovieMotionTarget;
        }

        Geometric stopping request interpreted by the production's until law; the scheduler validates only the returned share, not the distance or target.