AutoMovie API
    Preparing search index...

    A throw's plan: an action plan with its launch.

    interface IPlan {
        aimed?: IAutoMovieHumanoidSurfaces.ITangent;
        balanceWindow?: IAutoMovieMotionHumanBalance.Window;
        base?: IAutoMovieMotionHumanBase;
        channels?: readonly AutoMovieMotionHumanChannelClaim[];
        contact?: number;
        contacts: IAutoMovieMotionHumanContactWindow[];
        drives?: readonly IAutoMovieMotionPropDrive[];
        duration: number;
        enteredChannels?: readonly (
            | "head"
            | "leftHand"
            | "rightHand"
            | "root"
            | "trunk"
            | "leftArm"
            | "rightArm"
            | "leftLeg"
            | "rightLeg"
        )[];
        events: IAutoMovieMotionEvent[];
        feigned?: number;
        flight?: IAutoMovieMotionHumanFlight;
        hands?: readonly ("left" | "right")[];
        holds?: readonly IAutoMovieMotionPropHold[];
        launch: IAutoMovieMotionHumanThrowObjectLaunch.ILaunch;
        launches?: readonly IAutoMovieMotionPropLaunch[];
        legsStill?: readonly [number, number];
        mounts?: readonly IAutoMovieMotionPropMount[];
        physicalWindow?: IPhysicalWindow | null;
        still?: readonly [number, number];
        weapons?: readonly IAutoMovieMotionWeaponPath[];
        wears?: readonly IAutoMovieMotionPropWear[];
        wields?: IAutoMovieMotionWieldedTool;
        yields?: readonly AutoMovieMotionHumanChannelClaim[];
        airborne?(
            rotation: (seconds: number) => IAutoMovieHumanPostureRotation,
        ): void;
        posture(
            seconds: number,
            channels?: readonly (
                | "head"
                | "leftHand"
                | "rightHand"
                | "root"
                | "trunk"
                | "leftArm"
                | "rightArm"
                | "leftLeg"
                | "rightLeg"
            )[],
            resolution?: IAutoMoviePoseResolution.ISource,
            projection?: (pose: IAutoMoviePose) => IAutoMoviePose,
        ): IAutoMovieMotionHumanPosture;
        settle?(): void;
        stop?(events: readonly IAutoMovieMotionWeaponContact[]): void;
    }

    Hierarchy (View Summary)

    Index

    Where within its target region a strike is aimed, as an offset from the region's own point on the region's tangent plane, when this repeat of the strike varies. The striker's aim, the defence that answers it and the strike's record all read this one value, so they agree on the point. Absent, the strike is aimed at the region's own point.

    The balance window this plan actually uses, or null when its balance is off.

    The base the action leaves the body on at its end, declared by an action that changes what carries the body: sitting down declares the seat, kneeling the kneel, rising the stand. Absent for an action that keeps the base it is entered on, which the performance then passes on to the next action unchanged (IAutoMovieMotionHumanEntryState.base).

    channels?: readonly AutoMovieMotionHumanChannelClaim[]

    The channels the plan's own movements write, when it is composed of part primitives over a base: what an overlay takes from its carrier. Absent for a plan that writes the whole body.

    contact?: number

    Seconds from the start to the decisive instant (an impact, a landing, a grip), when the action has one.

    Contact windows, shares of the duration.

    drives?: readonly IAutoMovieMotionPropDrive[]

    Articulations of props this action moves: a door's hinge the hand swings, a trigger it presses, a slider it draws. Each writes the travel of one articulation over a window of the action; the performance poses the prop by them (HumanPerformance.state), and after a drive ends its last travel holds. A drive writes travel only, never the prop's frame.

    duration: number

    Duration, seconds; positive.

    enteredChannels?: readonly (
        | "head"
        | "leftHand"
        | "rightHand"
        | "root"
        | "trunk"
        | "leftArm"
        | "rightArm"
        | "leftLeg"
        | "rightLeg"
    )[]

    Claimed channels whose authored transport starts from the displayed entry pose. Their planned movement already includes acquisition from the carrier. Release of these channels still follows the overlay handback.

    Named instants, shares of the duration.

    feigned?: number

    Seconds from the start to the contact a feint pretends: the instant its committed twin would land, which an observer who takes the feint for the real action prepares for. Present only on an action that shows a decisive instant it never reaches, so it never accompanies contact.

    The span in which the body flies, touching nothing, and the angular momentum it flies with (#3427). The performance turns the composed body through it after placement (HumanPerformanceFlight): the shape the carrier, its overlays and its layers give, integrated by conserved angular momentum, handed back through airborne. Absent for an action with no flight, or one whose flight does not turn.

    hands?: readonly ("left" | "right")[]

    Hands this action drives with no contact window, such as a wave or a point. A hand with a contact window is driven anyway. An action that drives a held hand without taking its prop over is refused.

    holds?: readonly IAutoMovieMotionPropHold[]

    Props this action leaves held: each persists into the performer's later actions until one of them declares its own grip window on that hand for that prop (a put-down, a hand-over, a drink), which takes the hand over. While a hold persists and the active action does not drive that hand, the performance carries the hand with the trunk and keeps its fingers, and the prop rides the hand.

    The launch.

    launches?: readonly IAutoMovieMotionPropLaunch[]

    Props this action sets flying: a thrown bottle at the hand's opening, an arrow at the loose, a ball at the trigger's break. From its second the prop leaves every grip and flies from the launch's point and velocity until its flight ends (HumanPerformance.flights).

    legsStill?: readonly [number, number]

    Seconds since the action's start, from and to, over which posture keeps its root, its heading, its trunk and both legs' goals and joints one and the same while only the head, the arms or the hands move (a composed action whose primitives write only those, over a base that holds still): every record a leg fit reads is the same there, so a reader may keep the legs' fit of one second for another. Absent, no such window is declared.

    mounts?: readonly IAutoMovieMotionPropMount[]

    Props this action sets on another prop's socket: an arrow nocked on a bow's string. From its instant the prop rides that socket, posed where the other prop's articulations put it at every second (the arrow drawn with the string), until a later grip takes it off: a prop parented to a socket in the scene graph, as a worn prop is to a bone.

    physicalWindow?: IPhysicalWindow | null

    Physical phase in action seconds. Null marks a kinematic outcome of a physical law. Omission preserves its whole-span judgement.

    still?: readonly [number, number]

    Seconds since the action's start, from and to, over which posture returns one and the same posture, for a plan that holds still there (a stand without sway once it has settled). A reader may treat the body as not moving there; absent, no such window is declared.

    weapons?: readonly IAutoMovieMotionWeaponPath[]

    Striking surfaces this action moves on free paths, for the performance's simultaneous-contact resolution: every active weapon of every person is stopped at its first contact with another person's colliders, in time order, each later weapon seeing the earlier stops (resolveAutoMovieContactEvents).

    wears?: readonly IAutoMovieMotionPropWear[]

    Props this action puts on the performer's body: from its instant the prop rides the named bone with the offset it has there, as a worn hat, holster or watch does, until a later grip takes it off (IAutoMovieMotionHumanProp.worn).

    The tool the action works with in a hand: the held prop and which of its affordances are its working point and its edge. Another performer's law that answers this action (a parry of a cut, a flinch from a muzzle) reads the tool here through IAutoMovieMotionHumanActionContext.action. Absent for an action performed with the bare body.

    What this instance lets an overlay take, where its parameters decide it apart from its law (IAutoMovieMotionHumanActionLaw.yields): a carry in one hand yields its free arm, one in both hands none. The law's when absent.

    • The posture at a second of the action.

      Parameters

      • seconds: number

        Seconds since the action's start, in [0, duration]; outside, the nearest end.

      • Optionalchannels: readonly (
            | "head"
            | "leftHand"
            | "rightHand"
            | "root"
            | "trunk"
            | "leftArm"
            | "rightArm"
            | "leftLeg"
            | "rightLeg"
        )[]

        Optional demand for these channels only. A reader using it inspects only these channels; implementations may still compute the whole posture. Omission requests every channel.

      • Optionalresolution: IAutoMoviePoseResolution.ISource

        Optional exact FK source borrowed only for this synchronous unchanged-body evaluation; never retained in the plan, posture, preparation evidence or a returned callback.

      • Optionalprojection: (pose: IAutoMoviePose) => IAutoMoviePose

        Optional genuine same-body ROM projector borrowed for this call only; every actual direct joint is still projected, and unknown functions fall back to ordinary admission.

      Returns IAutoMovieMotionHumanPosture

      The borrowed posture; when a demand is supplied, only requested channels are guaranteed current.