AutoMovie API
    Preparing search index...

    Interface IAutoMoviePlaybackEvent

    A shot-local interaction event placed on the sequence output clock.

    sequenceEventTimeline emits one per play of an event inside an entry's trimmed range, so a source event replayed by two entries appears twice, and orders them by globalTime, then entry, then event id. The inherited fields, time included, are copied from the shot's event unchanged.

    interface IAutoMoviePlaybackEvent {
        actionIndex: number | null;
        actor: string | null;
        bone?: AutoMovieHumanoidBone;
        entry: number;
        exit?: IAutoMovieVector3;
        globalTime: number;
        id: string;
        impulse?: IAutoMovieVector3;
        kind: AutoMovieInteractionEventKind;
        mass?: number;
        normal?: IAutoMovieVector3;
        object: string | null;
        outcome?: "stick" | "bounce" | "roll" | "pass";
        point: IAutoMovieVector3 | null;
        reaction: string | null;
        region?: AutoMovieHumanoidRegion;
        shot: string;
        shotTime: number;
        source: AutoMovieInteractionEventSource;
        target: string | null;
        time: number;
        velocity?: IAutoMovieVector3;
    }

    Hierarchy (View Summary)

    Index
    actionIndex: number | null

    Integer index of the source action in the performance action list, or null when the event has no single source action.

    actor: string | null

    Initiating or affected node id, or null when no single node is known.

    The struck person's bone, when the target is a person; absent otherwise.

    entry

    entry: number

    Index of the playing entry in sequence.shots.

    The striking object's world velocity just after the contact, metres per second: zero for stick; with velocity and mass it gives the momentum delivered, mass (velocity - exit).

    globalTime: number

    Output seconds at which this play shows the event, after trims, rate changes and transitions.

    id: string

    Intended event identity within the shot. Producers embed kind, participants and formatted time, which can collide; the artifact gate checks nonblank spelling without uniqueness.

    The impulse delivered, world newton seconds, set only by a producer that has no striking mass, such as a blast; a consumer uses it unchanged.

    Semantic event category.

    mass?: number

    The striking object's mass in kilograms: a projectile's, or a limb's effective striking mass; absent when the producer has none.

    The struck surface's outward unit normal at point, world frame; absent when the producer computed none.

    object: string | null

    Projectile or carried object node id, or null when none is involved.

    outcome?: "stick" | "bounce" | "roll" | "pass"

    What the striking object did at the contact, which decides the momentum it delivers: stick stops in the struck body (a melee stop, an arrow in a butt), bounce and roll leave its surface, pass goes through. Absent when the producer decided none.

    point: IAutoMovieVector3 | null

    World point of contact in metres, or null when the engine computed none; review skips a contact whose point or target is missing.

    reaction: string | null

    Node id whose reaction was scheduled from this event, or null.

    The struck person's named region nearest the contact, when the target is a person; absent otherwise.

    shot: string

    Id of the shot that owns the source event.

    shotTime: number

    Shot-local seconds of the source event, equal to the inherited time.

    Producer that created the event.

    target: string | null

    Receiving node or parent id, or null when no single node is known.

    time: number

    Finite shot-local seconds; artifact admission accepts [0, duration + 1e-9].

    The striking object's world velocity at contact, metres per second; absent when the producer computed none.