Interface ParticleAuthoringPreviewResponse

Structured response returned for every accepted or rejected preview command.

interface ParticleAuthoringPreviewResponse {
    command: "invalid" | ParticleAuthoringPreviewCommand;
    diagnostics: readonly Readonly<ParticleAuthoringDiagnostic>[];
    ir?: Readonly<ParticleAuthoringIR>;
    protocolVersion: 1;
    requestId: string;
    state: Readonly<ParticleAuthoringPreviewState>;
    success: boolean;
}

Index

Properties

command diagnostics ir? protocolVersion requestId state success

Properties

`Readonly`command

command: "invalid" | ParticleAuthoringPreviewCommand

`Readonly`diagnostics

diagnostics: readonly Readonly<ParticleAuthoringDiagnostic>[]

`Optional` `Readonly`ir

ir?: Readonly<ParticleAuthoringIR>

Present after successful compilation so external inspectors can rebuild without runtime access.

`Readonly`protocolVersion

protocolVersion: 1

`Readonly`requestId

requestId: string

`Readonly`state

state: Readonly<ParticleAuthoringPreviewState>

`Readonly`success

success: boolean