AutoMovie API
    Preparing search index...

    Parameters.

    interface IParams {
        beats?: number;
        bpm?: number;
        kind: IAutoMovieMotionHumanDance.Kind;
        lock?: { event?: string; of: string };
        manner?: IAutoMovieMotionManner;
        side?: "left" | "right";
        waltz?: { pivot?: IAutoMovieVector3; reverse?: boolean; turn?: number };
    }
    Index
    beats?: number

    How many beats; 8 when absent. Numeric representation: "uint32". Inclusive minimum: 1. Unit: dimensionless. Admission metadata is enforced by HumanPerformanceParams for generated action and row schemas.

    bpm?: number

    Beats per minute; BPM when absent. Exclusive minimum: 0. Unit: "beats/min". Admission metadata is enforced by HumanPerformanceParams for generated action and row schemas.

    The step.

    lock?: { event?: string; of: string }

    A cue track to lock the beats to (#3340, #3378): beat k falls on the track's k-th instant named event (beat when absent) at or after the action's start, and the tempo is the mean interval of those instants, so bpm is not read. The track is the performance's input, never audio. Unlocked, the beats follow bpm from one period after the start.

    Type Declaration

    • Optionalevent?: string

      Cue event name whose instants are used; defaults to beat.

    • of: string

      Performance cue-track id whose instants entrain the dance beats.

    How it is performed.

    side?: "left" | "right"

    The foot that steps first; right when absent.

    waltz?: { pivot?: IAutoMovieVector3; reverse?: boolean; turn?: number }

    Waltz timing and travel for the box step. Omitted keeps the basic square.

    Type Declaration

    • Optionalpivot?: IAutoMovieVector3

      Shared pivot in world metres. Omitted uses this performer's starting origin.

    • Optionalreverse?: boolean

      Step back on beat one, for the dancer facing the forward-stepping role.

    • Optionalturn?: number

      Signed rotation through the last beat, in degrees. Defaults to zero.