AutoMovie API
    Preparing search index...

    Parameters of presenting the weapon.

    interface IPresent {
        anchor?: Anchor;
        carriage?: Carriage;
        edge?: string;
        extended?: boolean;
        from?: string;
        gun?: string;
        hand?: AutoMovieHumanSide;
        hands?: 1 | 2;
        manner?: IAutoMovieMotionManner;
        seconds?: number;
        shot?: { lock?: number; prop: string; speed: number };
        target?: IAutoMovieMotionTarget;
        tip?: string;
        track?: boolean;
    }

    Hierarchy (View Summary)

    Index
    anchor?: Anchor

    Where the line of aim starts on the body; the eye for a handgun and the cheek for a long gun when absent.

    carriage?: Carriage

    The carriage; aim when absent.

    edge?: string

    The weapon's sighting affordance, square to its line; sight when absent.

    extended?: boolean

    Whether the presenting arm reaches straight out along the line of aim to its own reach, a bow arm extended to the target; otherwise the working point is held the presentation's own share of the arm out. Not extended when absent.

    from?: string

    The affordance the working line runs from toward tip; absent, the point's declared direction supplies it.

    gun?: string

    The held weapon's prop subject id; the bare hand when absent.

    The shooting hand; right when absent.

    hands?: 1 | 2

    How many hands hold it; 2 when absent.

    How it is performed: a tempo that stretches the clock; at its neutral the clock is the law's own.

    seconds?: number

    Seconds the carriage is held once reached; 1 when absent. Inclusive minimum: 0. Unit: "s". Admission metadata is enforced by HumanPerformanceParams for generated action and row schemas.

    shot?: { lock?: number; prop: string; speed: number }

    What a shot launches (#3488): the prop that flies (a ball the scene gives), its speed out of the muzzle in m/s (the gun's muzzle velocity) and the lock's time from the break to the launch in seconds (the gun's lock time; 0 when absent). Nothing is launched when absent.

    Type Declaration

    • Optionallock?: number

      Lock delay after trigger break, seconds; defaults to zero.

    • prop: string

      Scene subject id of the projectile launched from the weapon's muzzle.

    • speed: number

      Muzzle speed relative to the weapon, metres per second; support velocity is added by the launch planner.

    What it is aimed at; a place straight ahead at eye height when absent. A ready position faces it without aiming.

    tip?: string

    The weapon's working point affordance, put on the line; muzzle when absent.

    track?: boolean

    Whether the aim follows the target while the carriage is held; false when absent.