Type alias GameplayTestResult

Type declaration

• assertions: GameplayTestAssertion[]

• consoleLogs: GameplayTestLog[]

• durationMs: number

• errors: string[]

• eventLog: GameplayTestEvent[]

• finalState: {
      objectCounts: {
          [objectName: string]: integer;
      };
      sceneName: string;
      sceneVariables: GameplayTestVariableSummary[];
      sceneVariablesNote?: string;
      watchedObjects: {
          [objectName: string]: GameplayTestObjectSnapshot[];
      };
      watchedObjectsNote?: string;
  }

  • objectCounts: {
        [objectName: string]: integer;
    }

    • [objectName: string]: integer

  • sceneName: string

  • sceneVariables: GameplayTestVariableSummary[]

  • Optional sceneVariablesNote?: string

    Says how to read what the summaries leave out.

  • watchedObjects: {
        [objectName: string]: GameplayTestObjectSnapshot[];
    }

    • [objectName: string]: GameplayTestObjectSnapshot[]

  • Optional watchedObjectsNote?: string

• framesExecuted: integer

• gameTimeMs: number

• hiddenStallMs: number

  Time during which the game was frozen by the browser because the page was hidden (tab in the background, window minimized or covered by another one): animation frames stop, so the game stops stepping. Excluded from the timeoutMs budget - being looked away from is not a reason for a test to fail.

• loadingMs: number

  Time spent waiting for the game to boot and for scene assets to load, excluded from the timeoutMs budget. durationMs includes it: durationMs - loadingMs is what counted against the budget.

• performance: {
      avgStepMs: number;
      worstStepMs: number;
  } | null

• profiles: GameplayTestProfilingResult[]

  The stopProfiling() summaries captured during the run.

• screenshots: GameplayTestScreenshot[]

• screenshotsTakenCount: integer

  Screenshots taken, including the ones not kept in screenshots.

• status: "passed" | "failed" | "error" | "stopped" | "timeout"

• testName: string

• timeoutMs: number

  The wall-clock budget the run had, loading excluded (durationMs - loadingMs close to it means the test is at risk of timing out on a slower machine).

• warnings: string[]

  Problems the harness itself noticed in the game, whatever the assertions of the test did or did not check (a custom object rendering nothing, for instance). Never a failure by itself.