AutoMovie API
    Preparing search index...

    Type Alias IAutoMovieShotPhysicsAdvice

    IAutoMovieShotPhysicsAdvice:
        | IAutoMovieShotPhysicsAdviceBase & {
            decision: null;
            rationale: null;
            selected: null;
        }
        | IAutoMovieShotPhysicsAdviceBase & {
            decision: "accepted";
            rationale: string;
            selected: IAutoMovieCollisionResponse;
        }
        | IAutoMovieShotPhysicsAdviceBase & {
            decision: "modified";
            rationale: string;
            selected: IAutoMovieCollisionResponse;
        }
        | IAutoMovieShotPhysicsAdviceBase & {
            decision: "rejected";
            rationale: string;
            selected: null;
        }

    One suggested collision response and the author's decision about it, carried as data.

    A collision response from suggestCollisionResponse is advice, not an imposed result: the engine never applies proposal by implication. Shot code or a host analysis pass supplies the list through IAutoMovieEngineShotRuntime.advice; the author may keep an item pending, accept it, replace it with a modified response, or reject it with a rationale. compileDefinedShot refuses an inconsistent item and copies the list onto the compiled result, so the decision stays visible beside the build.

    Type Declaration

    • IAutoMovieShotPhysicsAdviceBase & {
          decision: null;
          rationale: null;
          selected: null;
      }
      • decision: null

        Not adjudicated yet.

      • rationale: null

        Always null while pending; no rationale is invented.

      • selected: null

        Always null while pending.

    • IAutoMovieShotPhysicsAdviceBase & {
          decision: "accepted";
          rationale: string;
          selected: IAutoMovieCollisionResponse;
      }
      • decision: "accepted"

        The proposal is selected unchanged.

      • rationale: string

        Non-blank author reason for accepting the suggestion.

      • selected: IAutoMovieCollisionResponse

        Equal to proposal by value, regardless of key order.

    • IAutoMovieShotPhysicsAdviceBase & {
          decision: "modified";
          rationale: string;
          selected: IAutoMovieCollisionResponse;
      }
      • decision: "modified"

        An authored replacement is selected.

      • rationale: string

        Non-blank author reason for changing the suggestion.

      • selected: IAutoMovieCollisionResponse

        The replacement response; must differ from proposal by value.

    • IAutoMovieShotPhysicsAdviceBase & {
          decision: "rejected";
          rationale: string;
          selected: null;
      }
      • decision: "rejected"

        The suggestion is deliberately rejected.

      • rationale: string

        Non-blank author reason for rejecting the suggestion.

      • selected: null

        Always null: rejection selects no collision response.