AutoMovie API
    Preparing search index...

    The contact and model for one authored breakaway.

    interface IRequest<Piece extends IAutoMovieMotionHumanObject.IModel> {
        budget: { energy: number; momentum: IAutoMovieVector3 };
        hit: string;
        model: IAutoMovieMotionHumanObject.IModel & {
            broken(
                budget: { energy: number; momentum: IAutoMovieVector3 },
            ):
                | {
                    fragments: readonly {
                        archetype: Piece;
                        id: string;
                        velocity: IAutoMovieVector3;
                    }[];
                    remainder: Piece
                    | null;
                }
                | null;
        };
        subject: string;
    }

    Type Parameters

    Index
    budget: { energy: number; momentum: IAutoMovieVector3 }

    Authored energy in joules and fragment momentum in kg m/s in the model's frame.

    hit: string

    The id of a hit on that prop, as returned by the performance's hit reader.

    model: IAutoMovieMotionHumanObject.IModel & {
        broken(
            budget: { energy: number; momentum: IAutoMovieVector3 },
        ):
            | {
                fragments: readonly {
                    archetype: Piece;
                    id: string;
                    velocity: IAutoMovieVector3;
                }[];
                remainder: Piece
                | null;
            }
            | null;
    }

    The same breakaway model used to place the prop.

    Type Declaration

    • broken: function
      • Split deterministically from the authored budget, or return null when intact.

        Parameters

        Returns
            | {
                fragments: readonly {
                    archetype: Piece;
                    id: string;
                    velocity: IAutoMovieVector3;
                }[];
                remainder: Piece
                | null;
            }
            | null

    subject: string

    The placed prop that changes at the contact.