API

Interface IKHRInteractivityExportOptions

Options used to create a KHR_interactivity export plan.

interface IKHRInteractivityExportOptions {
    additionalExtensionsRequired?: readonly string[];
    defaultGraphIndex?: number;
    document?: IKHRInteractivityDocument;
    preserveSourceDocument?: boolean;
    required?: boolean;
    sourceGLTF?: IGLTF;
    targetFps?: number;
}
Index
additionalExtensionsRequired?: readonly string[]

Additional extensions that must be required together with the behavior graph.

defaultGraphIndex?: number

Root default graph index. Defaults to the canonical document selection or zero.

Canonical Phase 1 document associated with the FlowGraphs. Required for a lossless export.

preserveSourceDocument?: boolean

Whether export patches the retained source document instead of reserializing the scene. Preserves source entity indices, extension-backed pointers, and imported compatibility flow sockets. Requires sourceGLTF and buildWithSourceIndices; runtime scene changes are not exported.

required?: boolean

Whether the emitted KHR_interactivity extension is required. Defaults to true.

sourceGLTF?: IGLTF

Loader glTF tree used to resolve original entity references.

targetFps?: number

Target animation frame rate used by imported animation composites. Defaults to 60.