Files
webeditor3d/src/document/scene-document-validation.ts

2906 lines
76 KiB
TypeScript
Raw Normal View History

import {
type AudioAssetMetadata,
type ImageAssetMetadata,
type ModelAssetMetadata,
type ProjectAssetBoundingBox,
type ProjectAssetRecord
} from "../assets/project-assets";
import type { ModelInstance } from "../assets/model-instances";
import { isModelInstanceCollisionMode } from "../assets/model-instances";
import { WHITEBOX_SELECTION_MODES } from "../core/whitebox-selection-mode";
import {
isPlayerStartColliderMode,
isPlayerStartGamepadActionBinding,
isPlayerStartGamepadCameraLookBinding,
isPlayerStartGamepadBinding,
isPlayerStartKeyboardBindingCode,
isPlayerStartMovementTemplateKind,
2026-04-11 11:14:24 +02:00
isPlayerStartNavigationMode,
getPlayerStartColliderHeight,
type InteractableEntity,
type PointLightEntity,
type PlayerStartEntity,
type SceneEntryEntity,
type SceneExitEntity,
type SoundEmitterEntity,
type SpotLightEntity,
type TeleportTargetEntity,
type TriggerVolumeEntity
} from "../entities/entity-instances";
import { type InteractionLink } from "../interactions/interaction-links";
import {
BOX_FACE_IDS,
BOX_VERTEX_IDS,
MAX_BOX_BRUSH_WATER_FOAM_CONTACT_LIMIT,
hasPositiveBoxSize,
isBoxBrushVolumeMode
} from "./brushes";
import {
createSceneDocumentFromProject,
type ProjectDocument,
type SceneDocument
} from "./scene-document";
import {
isAdvancedRenderingWaterReflectionMode,
isAdvancedRenderingShadowMapSize,
isAdvancedRenderingShadowType,
isBoxVolumeRenderPath,
isAdvancedRenderingToneMappingMode,
isHexColorString,
type WorldSettings
} from "./world-settings";
2026-03-31 03:40:57 +02:00
export type SceneDiagnosticSeverity = "error" | "warning";
export type SceneDiagnosticScope = "document" | "build";
export interface SceneDiagnostic {
code: string;
severity: SceneDiagnosticSeverity;
scope: SceneDiagnosticScope;
message: string;
path?: string;
}
export interface SceneDocumentValidationResult {
diagnostics: SceneDiagnostic[];
errors: SceneDiagnostic[];
warnings: SceneDiagnostic[];
}
2026-03-31 03:41:06 +02:00
export function createDiagnostic(
2026-03-31 03:40:57 +02:00
severity: SceneDiagnosticSeverity,
code: string,
message: string,
path?: string,
scope: SceneDiagnosticScope = "document"
): SceneDiagnostic {
return {
code,
severity,
scope,
message,
path
};
}
function isFiniteNumber(value: unknown): value is number {
return typeof value === "number" && Number.isFinite(value);
}
function isFiniteVec3(vector: {
x: unknown;
y: unknown;
z: unknown;
}): vector is { x: number; y: number; z: number } {
return (
isFiniteNumber(vector.x) &&
isFiniteNumber(vector.y) &&
isFiniteNumber(vector.z)
);
2026-03-31 03:40:57 +02:00
}
function hasPositiveFiniteVec3(vector: {
x: unknown;
y: unknown;
z: unknown;
}): vector is { x: number; y: number; z: number } {
return isFiniteVec3(vector) && vector.x > 0 && vector.y > 0 && vector.z > 0;
}
function isNonNegativeFiniteNumber(value: unknown): value is number {
return isFiniteNumber(value) && value >= 0;
}
function isPositiveFiniteNumber(value: unknown): value is number {
return isFiniteNumber(value) && value > 0;
}
function isPositiveInteger(value: unknown): value is number {
return isFiniteNumber(value) && Number.isInteger(value) && value > 0;
}
function isPositiveIntegerInRange(
value: unknown,
max: number
): value is number {
return isPositiveInteger(value) && value <= max;
}
function isBoolean(value: unknown): value is boolean {
return typeof value === "boolean";
}
function hasNonZeroVectorLength(vector: {
x: number;
y: number;
z: number;
}): boolean {
return vector.x !== 0 || vector.y !== 0 || vector.z !== 0;
}
function validateWorldSettings(
world: WorldSettings,
document: SceneDocument,
diagnostics: SceneDiagnostic[]
) {
if (world.background.mode === "solid") {
if (!isHexColorString(world.background.colorHex)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-background-color",
"Solid world backgrounds must use #RRGGBB colors.",
"world.background.colorHex"
)
);
}
} else if (world.background.mode === "verticalGradient") {
if (!isHexColorString(world.background.topColorHex)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-background-top-color",
"Gradient world backgrounds must use #RRGGBB colors for the top color.",
"world.background.topColorHex"
)
);
}
if (!isHexColorString(world.background.bottomColorHex)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-background-bottom-color",
"Gradient world backgrounds must use #RRGGBB colors for the bottom color.",
"world.background.bottomColorHex"
)
);
}
} else {
if (
typeof world.background.assetId !== "string" ||
world.background.assetId.trim().length === 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-background-asset-id",
"World background images must reference a non-empty asset id.",
"world.background.assetId"
)
);
} else {
const backgroundAsset = document.assets[world.background.assetId];
if (backgroundAsset === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-world-background-asset",
`World background image asset ${world.background.assetId} does not exist.`,
"world.background.assetId"
)
);
} else if (backgroundAsset.kind !== "image") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-background-asset-kind",
"World background images must reference image assets.",
"world.background.assetId"
)
);
}
}
if (!isNonNegativeFiniteNumber(world.background.environmentIntensity)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-background-environment-intensity",
"World background environment intensity must be a non-negative finite number.",
"world.background.environmentIntensity"
)
);
}
}
if (!isHexColorString(world.ambientLight.colorHex)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-ambient-color",
"World ambient light must use a #RRGGBB color.",
"world.ambientLight.colorHex"
)
);
}
if (!isNonNegativeFiniteNumber(world.ambientLight.intensity)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-ambient-intensity",
"World ambient light intensity must remain finite and zero or greater.",
"world.ambientLight.intensity"
)
);
}
if (!isHexColorString(world.sunLight.colorHex)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-sun-color",
"World sun color must use a #RRGGBB color.",
"world.sunLight.colorHex"
)
);
}
if (!isNonNegativeFiniteNumber(world.sunLight.intensity)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-sun-intensity",
"World sun intensity must remain finite and zero or greater.",
"world.sunLight.intensity"
)
);
}
if (
!isFiniteVec3(world.sunLight.direction) ||
!hasNonZeroVectorLength(world.sunLight.direction)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-world-sun-direction",
"World sun direction must remain finite and must not be the zero vector.",
"world.sunLight.direction"
)
);
}
const advancedRendering = world.advancedRendering;
if (!isBoolean(advancedRendering.enabled)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-enabled",
"Advanced rendering enabled must be a boolean.",
"world.advancedRendering.enabled"
)
);
}
if (!isBoolean(advancedRendering.shadows.enabled)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-shadows-enabled",
"Advanced rendering shadow enabled must be a boolean.",
"world.advancedRendering.shadows.enabled"
)
);
}
if (!isAdvancedRenderingShadowMapSize(advancedRendering.shadows.mapSize)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-shadow-map-size",
"Advanced rendering shadow map size must be one of 512, 1024, 2048, or 4096.",
"world.advancedRendering.shadows.mapSize"
)
);
}
if (!isAdvancedRenderingShadowType(advancedRendering.shadows.type)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-shadow-type",
"Advanced rendering shadow type must be basic, pcf, or pcfSoft.",
"world.advancedRendering.shadows.type"
)
);
}
if (!isFiniteNumber(advancedRendering.shadows.bias)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-shadow-bias",
"Advanced rendering shadow bias must be a finite number.",
"world.advancedRendering.shadows.bias"
)
);
}
if (!isBoolean(advancedRendering.ambientOcclusion.enabled)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-ao-enabled",
"Advanced rendering ambient occlusion enabled must be a boolean.",
"world.advancedRendering.ambientOcclusion.enabled"
)
);
}
if (
!isNonNegativeFiniteNumber(advancedRendering.ambientOcclusion.intensity)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-ao-intensity",
"Advanced rendering ambient occlusion intensity must be a non-negative finite number.",
"world.advancedRendering.ambientOcclusion.intensity"
)
);
}
if (!isNonNegativeFiniteNumber(advancedRendering.ambientOcclusion.radius)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-ao-radius",
"Advanced rendering ambient occlusion radius must be a non-negative finite number.",
"world.advancedRendering.ambientOcclusion.radius"
)
);
}
if (!isPositiveInteger(advancedRendering.ambientOcclusion.samples)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-ao-samples",
"Advanced rendering ambient occlusion samples must be a positive integer.",
"world.advancedRendering.ambientOcclusion.samples"
)
);
}
if (!isBoolean(advancedRendering.bloom.enabled)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-bloom-enabled",
"Advanced rendering bloom enabled must be a boolean.",
"world.advancedRendering.bloom.enabled"
)
);
}
if (!isNonNegativeFiniteNumber(advancedRendering.bloom.intensity)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-bloom-intensity",
"Advanced rendering bloom intensity must be a non-negative finite number.",
"world.advancedRendering.bloom.intensity"
)
);
}
if (!isNonNegativeFiniteNumber(advancedRendering.bloom.threshold)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-bloom-threshold",
"Advanced rendering bloom threshold must be a non-negative finite number.",
"world.advancedRendering.bloom.threshold"
)
);
}
if (!isNonNegativeFiniteNumber(advancedRendering.bloom.radius)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-bloom-radius",
"Advanced rendering bloom radius must be a non-negative finite number.",
"world.advancedRendering.bloom.radius"
)
);
}
if (!isAdvancedRenderingToneMappingMode(advancedRendering.toneMapping.mode)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-tone-mapping-mode",
"Advanced rendering tone mapping mode must be none, linear, reinhard, cineon, or acesFilmic.",
"world.advancedRendering.toneMapping.mode"
)
);
}
if (!isPositiveFiniteNumber(advancedRendering.toneMapping.exposure)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-tone-mapping-exposure",
"Advanced rendering tone mapping exposure must be a positive finite number.",
"world.advancedRendering.toneMapping.exposure"
)
);
}
if (!isBoolean(advancedRendering.depthOfField.enabled)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-dof-enabled",
"Advanced rendering depth of field enabled must be a boolean.",
"world.advancedRendering.depthOfField.enabled"
)
);
}
if (
!isNonNegativeFiniteNumber(advancedRendering.depthOfField.focusDistance)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-dof-focus-distance",
"Advanced rendering depth of field focus distance must be a non-negative finite number.",
"world.advancedRendering.depthOfField.focusDistance"
)
);
}
if (!isPositiveFiniteNumber(advancedRendering.depthOfField.focalLength)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-dof-focal-length",
"Advanced rendering depth of field focal length must be a positive finite number.",
"world.advancedRendering.depthOfField.focalLength"
)
);
}
if (!isPositiveFiniteNumber(advancedRendering.depthOfField.bokehScale)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-dof-bokeh-scale",
"Advanced rendering depth of field bokeh scale must be a positive finite number.",
"world.advancedRendering.depthOfField.bokehScale"
)
);
}
if (!isBoxVolumeRenderPath(advancedRendering.fogPath)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-fog-path",
"Advanced rendering fog path must be performance or quality.",
"world.advancedRendering.fogPath"
)
);
}
if (!isBoxVolumeRenderPath(advancedRendering.waterPath)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-water-path",
"Advanced rendering water path must be performance or quality.",
"world.advancedRendering.waterPath"
)
);
}
if (
!isAdvancedRenderingWaterReflectionMode(
advancedRendering.waterReflectionMode
)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-advanced-rendering-water-reflection-mode",
"Advanced rendering water reflection mode must be none, world, or all.",
"world.advancedRendering.waterReflectionMode"
)
);
}
}
function validatePointLightEntity(
entity: PointLightEntity,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-point-light-position",
"Point Light position must remain finite on every axis.",
`${path}.position`
)
);
}
if (!isHexColorString(entity.colorHex)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-point-light-color",
"Point Light color must use a #RRGGBB color.",
`${path}.colorHex`
)
);
}
if (!isNonNegativeFiniteNumber(entity.intensity)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-point-light-intensity",
"Point Light intensity must remain finite and zero or greater.",
`${path}.intensity`
)
);
}
if (!isPositiveFiniteNumber(entity.distance)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-point-light-distance",
"Point Light distance must remain finite and greater than zero.",
`${path}.distance`
)
);
}
}
function validateSpotLightEntity(
entity: SpotLightEntity,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-spot-light-position",
"Spot Light position must remain finite on every axis.",
`${path}.position`
)
);
}
if (
!isFiniteVec3(entity.direction) ||
!hasNonZeroVectorLength(entity.direction)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-spot-light-direction",
"Spot Light direction must remain finite and must not be the zero vector.",
`${path}.direction`
)
);
}
if (!isHexColorString(entity.colorHex)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-spot-light-color",
"Spot Light color must use a #RRGGBB color.",
`${path}.colorHex`
)
);
}
if (!isNonNegativeFiniteNumber(entity.intensity)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-spot-light-intensity",
"Spot Light intensity must remain finite and zero or greater.",
`${path}.intensity`
)
);
}
if (!isPositiveFiniteNumber(entity.distance)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-spot-light-distance",
"Spot Light distance must remain finite and greater than zero.",
`${path}.distance`
)
);
}
if (
!isFiniteNumber(entity.angleDegrees) ||
entity.angleDegrees <= 0 ||
entity.angleDegrees >= 180
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-spot-light-angle",
"Spot Light angle must remain a finite degree value between 0 and 180.",
`${path}.angleDegrees`
)
);
}
}
function validateProjectAssetBoundingBox(
boundingBox: ProjectAssetBoundingBox | null,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (boundingBox === null) {
return;
}
if (!isFiniteVec3(boundingBox.min)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-asset-bounding-box-min",
"Model asset bounding boxes must have finite minimum coordinates.",
`${path}.min`
)
);
}
if (!isFiniteVec3(boundingBox.max)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-asset-bounding-box-max",
"Model asset bounding boxes must have finite maximum coordinates.",
`${path}.max`
)
);
}
if (
!isFiniteVec3(boundingBox.size) ||
boundingBox.size.x < 0 ||
boundingBox.size.y < 0 ||
boundingBox.size.z < 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-asset-bounding-box-size",
"Model asset bounding boxes must have finite, zero-or-greater size values.",
`${path}.size`
)
);
}
}
function validateModelAssetMetadata(
metadata: ModelAssetMetadata,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (metadata.format !== "glb" && metadata.format !== "gltf") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-asset-format",
"Model asset format must be glb or gltf.",
`${path}.format`
)
);
}
if (metadata.sceneName !== null && metadata.sceneName.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-asset-scene-name",
"Model asset scene names must be non-empty when authored.",
`${path}.sceneName`
)
);
}
if (!isNonNegativeFiniteNumber(metadata.nodeCount)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-asset-node-count",
"Model asset node counts must be finite and zero or greater.",
`${path}.nodeCount`
)
);
}
if (!isNonNegativeFiniteNumber(metadata.meshCount)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-asset-mesh-count",
"Model asset mesh counts must be finite and zero or greater.",
`${path}.meshCount`
)
);
}
if (
!Array.isArray(metadata.materialNames) ||
metadata.materialNames.some((name) => typeof name !== "string")
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-asset-material-names",
"Model asset material names must be string arrays.",
`${path}.materialNames`
)
);
}
if (
!Array.isArray(metadata.textureNames) ||
metadata.textureNames.some((name) => typeof name !== "string")
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-asset-texture-names",
"Model asset texture names must be string arrays.",
`${path}.textureNames`
)
);
}
if (
!Array.isArray(metadata.animationNames) ||
metadata.animationNames.some((name) => typeof name !== "string")
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-asset-animation-names",
"Model asset animation names must be string arrays.",
`${path}.animationNames`
)
);
}
validateProjectAssetBoundingBox(
metadata.boundingBox,
`${path}.boundingBox`,
diagnostics
);
if (
!Array.isArray(metadata.warnings) ||
metadata.warnings.some((warning) => typeof warning !== "string")
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-asset-warnings",
"Model asset warnings must be string arrays.",
`${path}.warnings`
)
);
}
}
function validateImageAssetMetadata(
metadata: ImageAssetMetadata,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (!isPositiveFiniteNumber(metadata.width)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-image-asset-width",
"Image asset width must be finite and greater than zero.",
`${path}.width`
)
);
}
if (!isPositiveFiniteNumber(metadata.height)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-image-asset-height",
"Image asset height must be finite and greater than zero.",
`${path}.height`
)
);
}
if (!isBoolean(metadata.hasAlpha)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-image-asset-alpha",
"Image asset alpha flags must be booleans.",
`${path}.hasAlpha`
)
);
}
if (
!Array.isArray(metadata.warnings) ||
metadata.warnings.some((warning) => typeof warning !== "string")
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-image-asset-warnings",
"Image asset warnings must be string arrays.",
`${path}.warnings`
)
);
}
}
function validateAudioAssetMetadata(
metadata: AudioAssetMetadata,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (
metadata.durationSeconds !== null &&
!isNonNegativeFiniteNumber(metadata.durationSeconds)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-audio-asset-duration",
"Audio asset durations must be finite and zero or greater when authored.",
`${path}.durationSeconds`
)
);
}
if (
metadata.channelCount !== null &&
!isPositiveFiniteNumber(metadata.channelCount)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-audio-asset-channel-count",
"Audio asset channel counts must be finite and greater than zero when authored.",
`${path}.channelCount`
)
);
}
if (
metadata.sampleRateHz !== null &&
!isPositiveFiniteNumber(metadata.sampleRateHz)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-audio-asset-sample-rate",
"Audio asset sample rates must be finite and greater than zero when authored.",
`${path}.sampleRateHz`
)
);
}
if (
!Array.isArray(metadata.warnings) ||
metadata.warnings.some((warning) => typeof warning !== "string")
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-audio-asset-warnings",
"Audio asset warnings must be string arrays.",
`${path}.warnings`
)
);
}
}
function validateProjectAsset(
asset: ProjectAssetRecord,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (asset.sourceName.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-asset-source-name",
"Asset source names must be non-empty strings.",
`${path}.sourceName`
)
);
}
if (asset.mimeType.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-asset-mime-type",
"Asset mime types must be non-empty strings.",
`${path}.mimeType`
)
);
}
if (asset.storageKey.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-asset-storage-key",
"Asset storage keys must be non-empty strings.",
`${path}.storageKey`
)
);
}
if (!isPositiveFiniteNumber(asset.byteLength)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-asset-byte-length",
"Asset byte lengths must be finite and greater than zero.",
`${path}.byteLength`
)
);
}
switch (asset.kind) {
case "model":
validateModelAssetMetadata(
asset.metadata,
`${path}.metadata`,
diagnostics
);
break;
case "image":
validateImageAssetMetadata(
asset.metadata,
`${path}.metadata`,
diagnostics
);
break;
case "audio":
validateAudioAssetMetadata(
asset.metadata,
`${path}.metadata`,
diagnostics
);
break;
}
}
function validateModelInstance(
modelInstance: ModelInstance,
path: string,
document: SceneDocument,
diagnostics: SceneDiagnostic[]
) {
if (
modelInstance.name !== undefined &&
modelInstance.name.trim().length === 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-instance-name",
"Model instance names must be non-empty when authored.",
`${path}.name`
)
);
}
if (!isFiniteVec3(modelInstance.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-instance-position",
"Model instance positions must remain finite on every axis.",
`${path}.position`
)
);
}
if (!isFiniteVec3(modelInstance.rotationDegrees)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-instance-rotation",
"Model instance rotations must remain finite on every axis.",
`${path}.rotationDegrees`
)
);
}
if (!hasPositiveFiniteVec3(modelInstance.scale)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-instance-scale",
"Model instance scales must remain finite and positive on every axis.",
`${path}.scale`
)
);
}
if (!isModelInstanceCollisionMode(modelInstance.collision.mode)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-instance-collision-mode",
"Model instance collision mode must be one of none, terrain, static, static-simple, dynamic, or simple.",
`${path}.collision.mode`
)
);
}
if (!isBoolean(modelInstance.collision.visible)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-instance-collision-visibility",
"Model instance collision visibility must be a boolean.",
`${path}.collision.visible`
)
);
}
const asset = document.assets[modelInstance.assetId];
if (asset === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-model-instance-asset",
`Model instance asset ${modelInstance.assetId} does not exist.`,
`${path}.assetId`
)
);
return;
}
if (asset.kind !== "model") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-model-instance-asset-kind",
"Model instances may only reference model assets.",
`${path}.assetId`
)
);
}
}
function validateEntityName(
name: string | undefined,
path: string,
diagnostics: SceneDiagnostic[]
) {
2026-04-03 01:05:13 +02:00
if (name !== undefined && name.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-entity-name",
"Entity names must be non-empty when authored.",
`${path}.name`
)
);
2026-04-03 01:05:13 +02:00
}
}
function validatePlayerStartEntity(
entity: PlayerStartEntity,
path: string,
diagnostics: SceneDiagnostic[]
) {
2026-03-31 03:40:57 +02:00
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-position",
"Player Start position must remain finite on every axis.",
`${path}.position`
)
2026-03-31 03:40:57 +02:00
);
}
if (!isFiniteNumber(entity.yawDegrees)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-yaw",
"Player Start yaw must remain a finite number.",
`${path}.yawDegrees`
)
);
2026-03-31 03:40:57 +02:00
}
2026-04-11 11:14:24 +02:00
if (!isPlayerStartNavigationMode(entity.navigationMode)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-navigation-mode",
"Player Start navigation mode must be firstPerson or thirdPerson.",
`${path}.navigationMode`
)
);
}
if (!isPlayerStartMovementTemplateKind(entity.movementTemplate?.kind)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-movement-template-kind",
"Player Start movement template must be a supported typed template.",
`${path}.movementTemplate.kind`
)
);
}
if (
!isFiniteNumber(entity.movementTemplate?.moveSpeed) ||
(entity.movementTemplate?.moveSpeed ?? 0) <= 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-movement-speed",
"Player Start movement template move speed must remain a finite number greater than zero.",
`${path}.movementTemplate.moveSpeed`
)
);
}
if (typeof entity.movementTemplate?.capabilities?.jump !== "boolean") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-jump-capability",
"Player Start movement template jump capability must be a boolean.",
`${path}.movementTemplate.capabilities.jump`
)
);
}
if (typeof entity.movementTemplate?.capabilities?.sprint !== "boolean") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-sprint-capability",
"Player Start movement template sprint capability must be a boolean.",
`${path}.movementTemplate.capabilities.sprint`
)
);
}
if (typeof entity.movementTemplate?.capabilities?.crouch !== "boolean") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-crouch-capability",
"Player Start movement template crouch capability must be a boolean.",
`${path}.movementTemplate.capabilities.crouch`
)
);
}
if (!isPlayerStartKeyboardBindingCode(entity.inputBindings?.keyboard.moveForward)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-move-forward-keyboard-binding",
"Player Start move-forward keyboard binding must be a supported key code.",
`${path}.inputBindings.keyboard.moveForward`
)
);
}
if (!isPlayerStartKeyboardBindingCode(entity.inputBindings?.keyboard.moveBackward)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-move-backward-keyboard-binding",
"Player Start move-backward keyboard binding must be a supported key code.",
`${path}.inputBindings.keyboard.moveBackward`
)
);
}
if (!isPlayerStartKeyboardBindingCode(entity.inputBindings?.keyboard.moveLeft)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-move-left-keyboard-binding",
"Player Start move-left keyboard binding must be a supported key code.",
`${path}.inputBindings.keyboard.moveLeft`
)
);
}
if (!isPlayerStartKeyboardBindingCode(entity.inputBindings?.keyboard.moveRight)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-move-right-keyboard-binding",
"Player Start move-right keyboard binding must be a supported key code.",
`${path}.inputBindings.keyboard.moveRight`
)
);
}
if (!isPlayerStartKeyboardBindingCode(entity.inputBindings?.keyboard.jump)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-jump-keyboard-binding",
"Player Start jump keyboard binding must be a supported key code.",
`${path}.inputBindings.keyboard.jump`
)
);
}
if (!isPlayerStartKeyboardBindingCode(entity.inputBindings?.keyboard.sprint)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-sprint-keyboard-binding",
"Player Start sprint keyboard binding must be a supported key code.",
`${path}.inputBindings.keyboard.sprint`
)
);
}
if (!isPlayerStartKeyboardBindingCode(entity.inputBindings?.keyboard.crouch)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-crouch-keyboard-binding",
"Player Start crouch keyboard binding must be a supported key code.",
`${path}.inputBindings.keyboard.crouch`
)
);
}
if (!isPlayerStartGamepadBinding(entity.inputBindings?.gamepad.moveForward)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-move-forward-gamepad-binding",
"Player Start move-forward gamepad binding must be a supported standard-gamepad input.",
`${path}.inputBindings.gamepad.moveForward`
)
);
}
if (!isPlayerStartGamepadBinding(entity.inputBindings?.gamepad.moveBackward)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-move-backward-gamepad-binding",
"Player Start move-backward gamepad binding must be a supported standard-gamepad input.",
`${path}.inputBindings.gamepad.moveBackward`
)
);
}
if (!isPlayerStartGamepadBinding(entity.inputBindings?.gamepad.moveLeft)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-move-left-gamepad-binding",
"Player Start move-left gamepad binding must be a supported standard-gamepad input.",
`${path}.inputBindings.gamepad.moveLeft`
)
);
}
if (!isPlayerStartGamepadBinding(entity.inputBindings?.gamepad.moveRight)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-move-right-gamepad-binding",
"Player Start move-right gamepad binding must be a supported standard-gamepad input.",
`${path}.inputBindings.gamepad.moveRight`
)
);
}
if (!isPlayerStartGamepadActionBinding(entity.inputBindings?.gamepad.jump)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-jump-gamepad-binding",
"Player Start jump gamepad binding must be a supported standard-gamepad action input.",
`${path}.inputBindings.gamepad.jump`
)
);
}
if (!isPlayerStartGamepadActionBinding(entity.inputBindings?.gamepad.sprint)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-sprint-gamepad-binding",
"Player Start sprint gamepad binding must be a supported standard-gamepad action input.",
`${path}.inputBindings.gamepad.sprint`
)
);
}
if (!isPlayerStartGamepadActionBinding(entity.inputBindings?.gamepad.crouch)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-crouch-gamepad-binding",
"Player Start crouch gamepad binding must be a supported standard-gamepad action input.",
`${path}.inputBindings.gamepad.crouch`
)
);
}
if (
!isPlayerStartGamepadCameraLookBinding(
entity.inputBindings?.gamepad.cameraLook
)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-camera-look-gamepad-binding",
"Player Start camera-look gamepad binding must be a supported standard-gamepad camera input.",
`${path}.inputBindings.gamepad.cameraLook`
)
);
}
if (!isPlayerStartColliderMode(entity.collider.mode)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-collider-mode",
"Player Start collider mode must be capsule, box, or none.",
`${path}.collider.mode`
)
);
}
if (
!isFiniteNumber(entity.collider.eyeHeight) ||
entity.collider.eyeHeight <= 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-eye-height",
"Player Start eye height must remain a finite number greater than zero.",
`${path}.collider.eyeHeight`
)
);
}
if (
!isFiniteNumber(entity.collider.capsuleRadius) ||
entity.collider.capsuleRadius <= 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-capsule-radius",
"Player Start capsule radius must remain a finite number greater than zero.",
`${path}.collider.capsuleRadius`
)
);
}
if (
!isFiniteNumber(entity.collider.capsuleHeight) ||
entity.collider.capsuleHeight <= 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-capsule-height",
"Player Start capsule height must remain a finite number greater than zero.",
`${path}.collider.capsuleHeight`
)
);
}
if (
!isFiniteVec3(entity.collider.boxSize) ||
entity.collider.boxSize.x <= 0 ||
entity.collider.boxSize.y <= 0 ||
entity.collider.boxSize.z <= 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-box-size",
"Player Start box size must remain finite and positive on every axis.",
`${path}.collider.boxSize`
)
);
}
if (entity.collider.capsuleHeight < entity.collider.capsuleRadius * 2) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-capsule-proportions",
"Player Start capsule height must be at least twice the capsule radius.",
`${path}.collider.capsuleHeight`
)
);
}
const colliderHeight = getPlayerStartColliderHeight(entity.collider);
if (colliderHeight !== null && entity.collider.eyeHeight > colliderHeight) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-player-start-eye-height",
"Player Start eye height must fit within the authored collider height.",
`${path}.collider.eyeHeight`
)
);
}
2026-03-31 03:40:57 +02:00
}
function validateSoundEmitterAudioAsset(
entity: SoundEmitterEntity,
path: string,
document: SceneDocument,
diagnostics: SceneDiagnostic[],
missingSeverity: SceneDiagnosticSeverity
): ProjectAssetRecord | null {
if (entity.audioAssetId === null) {
diagnostics.push(
createDiagnostic(
missingSeverity,
"missing-sound-emitter-audio-asset",
entity.autoplay
? "Sound Emitter autoplay requires an assigned audio asset."
: "Sound Emitter has no audio asset assigned yet.",
`${path}.audioAssetId`
)
);
return null;
}
const asset = document.assets[entity.audioAssetId];
if (asset === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-sound-emitter-audio-asset",
`Sound Emitter audio asset ${entity.audioAssetId} does not exist.`,
`${path}.audioAssetId`
)
);
return null;
}
if (asset.kind !== "audio") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-audio-asset-kind",
"Sound Emitter audioAssetId must reference an audio asset.",
`${path}.audioAssetId`
)
);
return null;
}
return asset;
}
function validateSoundEmitterEntity(
entity: SoundEmitterEntity,
path: string,
document: SceneDocument,
diagnostics: SceneDiagnostic[]
) {
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-position",
"Sound Emitter position must remain finite on every axis.",
`${path}.position`
)
);
}
if (!isNonNegativeFiniteNumber(entity.volume)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-volume",
"Sound Emitter volume must remain finite and zero or greater.",
`${path}.volume`
)
);
}
if (!isPositiveFiniteNumber(entity.refDistance)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-ref-distance",
"Sound Emitter ref distance must remain finite and greater than zero.",
`${path}.refDistance`
)
);
}
if (!isPositiveFiniteNumber(entity.maxDistance)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-max-distance",
"Sound Emitter max distance must remain finite and greater than zero.",
`${path}.maxDistance`
)
);
}
if (
isPositiveFiniteNumber(entity.refDistance) &&
isPositiveFiniteNumber(entity.maxDistance) &&
entity.maxDistance < entity.refDistance
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-distance-order",
"Sound Emitter max distance must be greater than or equal to ref distance.",
`${path}.maxDistance`
)
);
}
if (!isBoolean(entity.autoplay)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-autoplay",
"Sound Emitter autoplay must remain a boolean.",
`${path}.autoplay`
)
);
}
if (!isBoolean(entity.loop)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-loop",
"Sound Emitter loop must remain a boolean.",
`${path}.loop`
)
);
}
validateSoundEmitterAudioAsset(
entity,
path,
document,
diagnostics,
entity.autoplay ? "error" : "warning"
);
}
function validateTriggerVolumeEntity(
entity: TriggerVolumeEntity,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-trigger-volume-position",
"Trigger Volume position must remain finite on every axis.",
`${path}.position`
)
);
}
if (!hasPositiveFiniteVec3(entity.size)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-trigger-volume-size",
"Trigger Volume size must remain finite and positive on every axis.",
`${path}.size`
)
);
}
if (!isBoolean(entity.triggerOnEnter)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-trigger-volume-enter-flag",
"Trigger Volume triggerOnEnter must remain a boolean.",
`${path}.triggerOnEnter`
)
);
}
if (!isBoolean(entity.triggerOnExit)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-trigger-volume-exit-flag",
"Trigger Volume triggerOnExit must remain a boolean.",
`${path}.triggerOnExit`
)
);
}
}
function validateTeleportTargetEntity(
entity: TeleportTargetEntity,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-teleport-target-position",
"Teleport Target position must remain finite on every axis.",
`${path}.position`
)
);
}
if (!isFiniteNumber(entity.yawDegrees)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-teleport-target-yaw",
"Teleport Target yaw must remain a finite number.",
`${path}.yawDegrees`
)
);
}
}
function validateInteractableEntity(
entity: InteractableEntity,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-interactable-position",
"Interactable position must remain finite on every axis.",
`${path}.position`
)
);
}
if (!isPositiveFiniteNumber(entity.radius)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-interactable-radius",
"Interactable radius must remain finite and greater than zero.",
`${path}.radius`
)
);
}
if (typeof entity.prompt !== "string" || entity.prompt.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-interactable-prompt",
"Interactable prompt must remain a non-empty string.",
`${path}.prompt`
)
);
}
if (!isBoolean(entity.enabled)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-interactable-enabled",
"Interactable enabled must remain a boolean.",
`${path}.enabled`
)
);
}
}
function validateSceneEntryEntity(
entity: SceneEntryEntity,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-entry-position",
"Scene Entry position must remain finite on every axis.",
`${path}.position`
)
);
}
if (!isFiniteNumber(entity.yawDegrees)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-entry-yaw",
"Scene Entry yaw must remain a finite number.",
`${path}.yawDegrees`
)
);
}
}
function validateSceneExitEntity(
entity: SceneExitEntity,
path: string,
diagnostics: SceneDiagnostic[]
) {
if (!isFiniteVec3(entity.position)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-exit-position",
"Scene Exit position must remain finite on every axis.",
`${path}.position`
)
);
}
if (!isPositiveFiniteNumber(entity.radius)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-exit-radius",
"Scene Exit radius must remain finite and greater than zero.",
`${path}.radius`
)
);
}
if (typeof entity.prompt !== "string" || entity.prompt.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-exit-prompt",
"Scene Exit prompt must remain a non-empty string.",
`${path}.prompt`
)
);
}
if (!isBoolean(entity.enabled)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-exit-enabled",
"Scene Exit enabled must remain a boolean.",
`${path}.enabled`
)
);
}
if (
typeof entity.targetSceneId !== "string" ||
entity.targetSceneId.trim().length === 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-exit-target-scene",
"Scene Exit target scene id must remain a non-empty string.",
`${path}.targetSceneId`
)
);
}
if (
typeof entity.targetEntryEntityId !== "string" ||
entity.targetEntryEntityId.trim().length === 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-exit-target-entry",
"Scene Exit target entry id must remain a non-empty string.",
`${path}.targetEntryEntityId`
)
);
}
}
function validateInteractionLink(
link: InteractionLink,
path: string,
document: SceneDocument,
diagnostics: SceneDiagnostic[]
) {
const sourceEntity = document.entities[link.sourceEntityId];
if (sourceEntity === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-interaction-source-entity",
`Interaction source entity ${link.sourceEntityId} does not exist.`,
`${path}.sourceEntityId`
)
);
return;
}
if (
sourceEntity.kind !== "triggerVolume" &&
sourceEntity.kind !== "interactable"
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-interaction-source-kind",
"Interaction links may only source from Trigger Volume or Interactable entities in the current slice.",
`${path}.sourceEntityId`
)
);
}
if (sourceEntity.kind === "triggerVolume") {
if (link.trigger !== "enter" && link.trigger !== "exit") {
diagnostics.push(
createDiagnostic(
"error",
"unsupported-interaction-trigger",
"Trigger Volume links may only use enter or exit triggers.",
`${path}.trigger`
)
);
}
} else if (sourceEntity.kind === "interactable") {
if (link.trigger !== "click") {
diagnostics.push(
createDiagnostic(
"error",
"unsupported-interaction-trigger",
"Interactable links may only use the click trigger.",
`${path}.trigger`
)
);
}
}
switch (link.action.type) {
case "teleportPlayer": {
const targetEntity = document.entities[link.action.targetEntityId];
if (targetEntity === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-teleport-target-entity",
`Teleport target entity ${link.action.targetEntityId} does not exist.`,
`${path}.action.targetEntityId`
)
);
return;
}
if (targetEntity.kind !== "teleportTarget") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-teleport-target-kind",
"Teleport player actions must target a Teleport Target entity.",
`${path}.action.targetEntityId`
)
);
}
break;
}
case "toggleVisibility":
if (document.brushes[link.action.targetBrushId] === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-visibility-target-brush",
`Visibility target brush ${link.action.targetBrushId} does not exist.`,
`${path}.action.targetBrushId`
)
);
}
if (
link.action.visible !== undefined &&
typeof link.action.visible !== "boolean"
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-visibility-action-visible",
"Visibility actions must use a boolean visible value when authored.",
`${path}.action.visible`
)
);
}
break;
case "playAnimation": {
const targetModelInstance =
document.modelInstances[link.action.targetModelInstanceId];
if (targetModelInstance === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-play-animation-target-instance",
`Play animation target model instance ${link.action.targetModelInstanceId} does not exist.`,
`${path}.action.targetModelInstanceId`
)
);
return;
}
if (link.action.clipName.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-play-animation-clip-name",
"Play animation clip name must be non-empty.",
`${path}.action.clipName`
)
);
return;
}
const targetAsset = document.assets[targetModelInstance.assetId];
if (targetAsset === undefined || targetAsset.kind !== "model") {
return;
}
if (!targetAsset.metadata.animationNames.includes(link.action.clipName)) {
diagnostics.push(
createDiagnostic(
"error",
"missing-play-animation-clip",
`Play animation clip ${link.action.clipName} does not exist on model asset ${targetAsset.id}.`,
`${path}.action.clipName`
)
);
}
break;
}
case "stopAnimation":
// Validate that the target model instance exists in the document
if (
document.modelInstances[link.action.targetModelInstanceId] === undefined
) {
diagnostics.push(
createDiagnostic(
"error",
"missing-stop-animation-target-instance",
`Stop animation target model instance ${link.action.targetModelInstanceId} does not exist.`,
`${path}.action.targetModelInstanceId`
)
);
}
break;
case "playSound":
case "stopSound": {
const targetEntity = document.entities[link.action.targetSoundEmitterId];
if (targetEntity === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-sound-emitter-entity",
`Sound emitter entity ${link.action.targetSoundEmitterId} does not exist.`,
`${path}.action.targetSoundEmitterId`
)
);
break;
}
if (targetEntity.kind !== "soundEmitter") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-sound-emitter-kind",
"Sound playback actions must target a Sound Emitter entity.",
`${path}.action.targetSoundEmitterId`
)
);
break;
}
if (targetEntity.audioAssetId === null) {
diagnostics.push(
createDiagnostic(
"error",
"missing-sound-emitter-audio-asset",
"Sound playback actions require a Sound Emitter that references an audio asset.",
`${path}.action.targetSoundEmitterId`
)
);
}
break;
}
default:
diagnostics.push(
createDiagnostic(
"error",
"unsupported-interaction-action",
`Unsupported interaction action ${(link.action as { type: string }).type}.`,
`${path}.action.type`
)
);
break;
}
}
function registerAuthoredId(
id: string,
path: string,
seenIds: Map<string, string>,
diagnostics: SceneDiagnostic[]
) {
2026-03-31 03:40:57 +02:00
const previousPath = seenIds.get(id);
if (previousPath !== undefined) {
diagnostics.push(
createDiagnostic(
"error",
"duplicate-authored-id",
`Duplicate authored id ${id} is already used at ${previousPath}.`,
path
)
2026-03-31 03:40:57 +02:00
);
return;
}
seenIds.set(id, path);
}
function prefixDiagnosticPath(
prefix: string,
path?: string
): string | undefined {
return path === undefined ? undefined : `${prefix}${path}`;
}
function validateProjectResources(
document: Pick<ProjectDocument, "materials" | "assets">,
diagnostics: SceneDiagnostic[]
) {
const seenIds = new Map<string, string>();
for (const [materialKey, material] of Object.entries(document.materials)) {
const path = `materials.${materialKey}`;
if (material.id !== materialKey) {
diagnostics.push(
createDiagnostic(
"error",
"material-id-mismatch",
"Material ids must match their registry key.",
`${path}.id`
)
);
}
registerAuthoredId(material.id, path, seenIds, diagnostics);
}
for (const [assetKey, asset] of Object.entries(document.assets)) {
const path = `assets.${assetKey}`;
if (asset.id !== assetKey) {
diagnostics.push(
createDiagnostic(
"error",
"asset-id-mismatch",
"Asset ids must match their registry key.",
`${path}.id`
)
);
}
registerAuthoredId(asset.id, path, seenIds, diagnostics);
validateProjectAsset(asset, path, diagnostics);
}
}
function filterProjectSceneDiagnostics(
diagnostics: SceneDiagnostic[]
): SceneDiagnostic[] {
return diagnostics.filter(
(diagnostic) =>
diagnostic.path === undefined ||
(!diagnostic.path.startsWith("materials.") &&
!diagnostic.path.startsWith("assets."))
);
}
function validateProjectSceneLoadingScreen(
scene: ProjectDocument["scenes"][string],
scenePath: string,
diagnostics: SceneDiagnostic[]
) {
if (!isHexColorString(scene.loadingScreen.colorHex)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-loading-color",
"Scene loading overlays must use #RRGGBB colors.",
`${scenePath}.loadingScreen.colorHex`
)
);
}
if (
scene.loadingScreen.headline !== null &&
scene.loadingScreen.headline.trim().length === 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-loading-headline",
"Scene loading overlay headlines must be non-empty when authored.",
`${scenePath}.loadingScreen.headline`
)
);
}
if (
scene.loadingScreen.description !== null &&
scene.loadingScreen.description.trim().length === 0
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-loading-description",
"Scene loading overlay descriptions must be non-empty when authored.",
`${scenePath}.loadingScreen.description`
)
);
}
}
function validateProjectSceneEditorPreferences(
scene: ProjectDocument["scenes"][string],
scenePath: string,
diagnostics: SceneDiagnostic[]
) {
const preferences = scene.editorPreferences;
if (!WHITEBOX_SELECTION_MODES.includes(preferences.whiteboxSelectionMode)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-editor-selection-mode",
"Scene editor selection mode must be one of object, face, edge, or vertex.",
`${scenePath}.editorPreferences.whiteboxSelectionMode`
)
);
}
if (
preferences.viewportLayoutMode !== "single" &&
preferences.viewportLayoutMode !== "quad"
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-editor-layout-mode",
"Scene editor viewport layout must be single or quad.",
`${scenePath}.editorPreferences.viewportLayoutMode`
)
);
}
if (
preferences.activeViewportPanelId !== "topLeft" &&
preferences.activeViewportPanelId !== "topRight" &&
preferences.activeViewportPanelId !== "bottomLeft" &&
preferences.activeViewportPanelId !== "bottomRight"
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-editor-active-panel",
"Scene editor active viewport panel must reference a supported panel id.",
`${scenePath}.editorPreferences.activeViewportPanelId`
)
);
}
if (!isPositiveFiniteNumber(preferences.whiteboxSnapStep)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-editor-snap-step",
"Scene editor snap step must be greater than zero.",
`${scenePath}.editorPreferences.whiteboxSnapStep`
)
);
}
if (!isFiniteNumber(preferences.viewportQuadSplit.x)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-editor-quad-split-x",
"Scene editor quad split X must be finite.",
`${scenePath}.editorPreferences.viewportQuadSplit.x`
)
);
}
if (!isFiniteNumber(preferences.viewportQuadSplit.y)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-editor-quad-split-y",
"Scene editor quad split Y must be finite.",
`${scenePath}.editorPreferences.viewportQuadSplit.y`
)
);
}
for (const [panelId, panelPreferences] of Object.entries(
preferences.viewportPanels
)) {
if (
panelPreferences.viewMode !== "perspective" &&
panelPreferences.viewMode !== "top" &&
panelPreferences.viewMode !== "front" &&
panelPreferences.viewMode !== "side"
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-editor-panel-view-mode",
"Scene editor panel view mode must be perspective, top, front, or side.",
`${scenePath}.editorPreferences.viewportPanels.${panelId}.viewMode`
)
);
}
if (
panelPreferences.displayMode !== "normal" &&
panelPreferences.displayMode !== "authoring" &&
panelPreferences.displayMode !== "wireframe"
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-editor-panel-display-mode",
"Scene editor panel display mode must be normal, authoring, or wireframe.",
`${scenePath}.editorPreferences.viewportPanels.${panelId}.displayMode`
)
);
}
}
}
2026-03-31 03:40:57 +02:00
export function formatSceneDiagnostic(diagnostic: SceneDiagnostic): string {
return diagnostic.path === undefined
? diagnostic.message
: `${diagnostic.path}: ${diagnostic.message}`;
2026-03-31 03:40:57 +02:00
}
export function formatSceneDiagnosticSummary(
diagnostics: SceneDiagnostic[],
limit = 3
): string {
2026-03-31 03:40:57 +02:00
if (diagnostics.length === 0) {
return "No diagnostics.";
}
const visibleDiagnostics = diagnostics.slice(0, Math.max(1, limit));
const summary = visibleDiagnostics
.map((diagnostic) => formatSceneDiagnostic(diagnostic))
.join("; ");
2026-03-31 03:40:57 +02:00
const remainingCount = diagnostics.length - visibleDiagnostics.length;
return remainingCount > 0 ? `${summary}; +${remainingCount} more` : summary;
}
export function validateSceneDocument(
document: SceneDocument
): SceneDocumentValidationResult {
2026-03-31 03:40:57 +02:00
const diagnostics: SceneDiagnostic[] = [];
const seenIds = new Map<string, string>();
validateWorldSettings(document.world, document, diagnostics);
2026-03-31 03:40:57 +02:00
for (const [materialKey, material] of Object.entries(document.materials)) {
const path = `materials.${materialKey}`;
if (material.id !== materialKey) {
diagnostics.push(
createDiagnostic(
"error",
"material-id-mismatch",
"Material ids must match their registry key.",
`${path}.id`
)
2026-03-31 03:40:57 +02:00
);
}
registerAuthoredId(material.id, path, seenIds, diagnostics);
}
for (const [assetKey, asset] of Object.entries(document.assets)) {
const path = `assets.${assetKey}`;
if (asset.id !== assetKey) {
diagnostics.push(
createDiagnostic(
"error",
"asset-id-mismatch",
"Asset ids must match their registry key.",
`${path}.id`
)
);
}
registerAuthoredId(asset.id, path, seenIds, diagnostics);
validateProjectAsset(asset, path, diagnostics);
}
2026-03-31 03:40:57 +02:00
for (const [brushKey, brush] of Object.entries(document.brushes)) {
const path = `brushes.${brushKey}`;
if (brush.id !== brushKey) {
diagnostics.push(
createDiagnostic(
"error",
"brush-id-mismatch",
"Brush ids must match their registry key.",
`${path}.id`
)
);
2026-03-31 03:40:57 +02:00
}
registerAuthoredId(brush.id, path, seenIds, diagnostics);
if (brush.name !== undefined && brush.name.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-name",
"Box brush names must be non-empty when authored.",
`${path}.name`
)
);
}
if (!isFiniteVec3(brush.center)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-center",
"Box brush centers must remain finite on every axis.",
`${path}.center`
)
);
}
if (!isFiniteVec3(brush.rotationDegrees)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-rotation",
"Box brush rotations must remain finite on every axis.",
`${path}.rotationDegrees`
)
);
}
2026-03-31 03:40:57 +02:00
if (!isFiniteVec3(brush.size) || !hasPositiveBoxSize(brush.size)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-size",
"Box brush sizes must remain finite and positive on every axis.",
`${path}.size`
)
2026-03-31 03:40:57 +02:00
);
}
for (const vertexId of BOX_VERTEX_IDS) {
if (!isFiniteVec3(brush.geometry.vertices[vertexId])) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-geometry-vertex",
"Box brush geometry vertices must remain finite on every axis.",
`${path}.geometry.vertices.${vertexId}`
)
);
}
}
2026-03-31 03:40:57 +02:00
for (const faceId of BOX_FACE_IDS) {
const materialId = brush.faces[faceId].materialId;
if (materialId !== null && document.materials[materialId] === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-material-ref",
`Face material reference ${materialId} does not exist in the document material registry.`,
`${path}.faces.${faceId}.materialId`
)
);
}
}
const volume = brush.volume as Record<string, unknown>;
if (!isBoxBrushVolumeMode(volume.mode)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-volume-mode",
"Box volume mode must be none, water, or fog.",
`${path}.volume.mode`
)
);
continue;
}
if (volume.mode === "water") {
const water = volume.water as Record<string, unknown> | undefined;
if (water === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-water-settings",
"Water volumes must define water settings.",
`${path}.volume.water`
)
);
} else {
if (
typeof water.colorHex !== "string" ||
!isHexColorString(water.colorHex)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-water-color",
"Water volume color must use #RRGGBB format.",
`${path}.volume.water.colorHex`
)
);
}
if (!isNonNegativeFiniteNumber(water.surfaceOpacity)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-water-surface-opacity",
"Water surface opacity must be a non-negative finite number.",
`${path}.volume.water.surfaceOpacity`
)
);
}
if (!isNonNegativeFiniteNumber(water.waveStrength)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-water-wave-strength",
"Water wave strength must be a non-negative finite number.",
`${path}.volume.water.waveStrength`
)
);
}
if (
!isPositiveIntegerInRange(
water.foamContactLimit,
MAX_BOX_BRUSH_WATER_FOAM_CONTACT_LIMIT
)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-water-foam-contact-limit",
`Water foam contact limit must be a positive integer between 1 and ${MAX_BOX_BRUSH_WATER_FOAM_CONTACT_LIMIT}.`,
`${path}.volume.water.foamContactLimit`
)
);
}
if (typeof water.surfaceDisplacementEnabled !== "boolean") {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-water-surface-displacement-enabled",
"Water surface displacement must be enabled or disabled explicitly.",
`${path}.volume.water.surfaceDisplacementEnabled`
)
);
}
}
}
if (volume.mode === "fog") {
const fog = volume.fog as Record<string, unknown> | undefined;
if (fog === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-fog-settings",
"Fog volumes must define fog settings.",
`${path}.volume.fog`
)
);
} else {
if (
typeof fog.colorHex !== "string" ||
!isHexColorString(fog.colorHex)
) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-fog-color",
"Fog volume color must use #RRGGBB format.",
`${path}.volume.fog.colorHex`
)
);
}
if (!isNonNegativeFiniteNumber(fog.density)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-fog-density",
"Fog volume density must be a non-negative finite number.",
`${path}.volume.fog.density`
)
);
}
if (!isNonNegativeFiniteNumber(fog.padding)) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-box-fog-padding",
"Fog volume padding must be a non-negative finite number.",
`${path}.volume.fog.padding`
)
);
}
}
}
2026-03-31 03:40:57 +02:00
}
for (const [modelInstanceKey, modelInstance] of Object.entries(
document.modelInstances
)) {
const path = `modelInstances.${modelInstanceKey}`;
if (modelInstance.id !== modelInstanceKey) {
diagnostics.push(
createDiagnostic(
"error",
"model-instance-id-mismatch",
"Model instance ids must match their registry key.",
`${path}.id`
)
);
}
registerAuthoredId(modelInstance.id, path, seenIds, diagnostics);
validateModelInstance(modelInstance, path, document, diagnostics);
}
2026-03-31 03:40:57 +02:00
for (const [entityKey, entity] of Object.entries(document.entities)) {
const path = `entities.${entityKey}`;
if (entity.id !== entityKey) {
diagnostics.push(
createDiagnostic(
"error",
"entity-id-mismatch",
"Entity ids must match their registry key.",
`${path}.id`
)
);
2026-03-31 03:40:57 +02:00
}
registerAuthoredId(entity.id, path, seenIds, diagnostics);
validateEntityName(entity.name, path, diagnostics);
2026-03-31 03:40:57 +02:00
switch (entity.kind) {
case "pointLight":
validatePointLightEntity(entity, path, diagnostics);
break;
case "spotLight":
validateSpotLightEntity(entity, path, diagnostics);
break;
case "playerStart":
validatePlayerStartEntity(entity, path, diagnostics);
break;
case "sceneEntry":
validateSceneEntryEntity(entity, path, diagnostics);
break;
case "soundEmitter":
validateSoundEmitterEntity(entity, path, document, diagnostics);
break;
case "triggerVolume":
validateTriggerVolumeEntity(entity, path, diagnostics);
break;
case "teleportTarget":
validateTeleportTargetEntity(entity, path, diagnostics);
break;
case "interactable":
validateInteractableEntity(entity, path, diagnostics);
break;
case "sceneExit":
validateSceneExitEntity(entity, path, diagnostics);
break;
default:
diagnostics.push(
createDiagnostic(
"error",
"unsupported-entity-kind",
`Unsupported entity kind ${(entity as { kind: string }).kind}.`,
`${path}.kind`
)
);
break;
2026-03-31 03:40:57 +02:00
}
}
for (const [linkKey, link] of Object.entries(document.interactionLinks)) {
const path = `interactionLinks.${linkKey}`;
if (link.id !== linkKey) {
diagnostics.push(
createDiagnostic(
"error",
"interaction-link-id-mismatch",
"Interaction link ids must match their registry key.",
`${path}.id`
)
);
}
registerAuthoredId(link.id, path, seenIds, diagnostics);
validateInteractionLink(link, path, document, diagnostics);
}
2026-03-31 03:40:57 +02:00
return {
diagnostics,
errors: diagnostics.filter((diagnostic) => diagnostic.severity === "error"),
warnings: diagnostics.filter(
(diagnostic) => diagnostic.severity === "warning"
)
2026-03-31 03:40:57 +02:00
};
}
export function assertSceneDocumentIsValid(document: SceneDocument) {
const validation = validateSceneDocument(document);
if (validation.errors.length > 0) {
throw new Error(
`Scene document has ${validation.errors.length} validation error(s): ${formatSceneDiagnosticSummary(validation.errors)}`
);
2026-03-31 03:40:57 +02:00
}
}
export function validateProjectDocument(
document: ProjectDocument
): SceneDocumentValidationResult {
const diagnostics: SceneDiagnostic[] = [];
if (document.name.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-project-name",
"Project names must be non-empty.",
"name"
)
);
}
if (Object.keys(document.scenes).length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"missing-project-scenes",
"Project documents must contain at least one scene.",
"scenes"
)
);
}
if (document.scenes[document.activeSceneId] === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-active-scene",
`Project active scene ${document.activeSceneId} does not exist.`,
"activeSceneId"
)
);
}
validateProjectResources(document, diagnostics);
for (const [sceneKey, scene] of Object.entries(document.scenes)) {
const scenePath = `scenes.${sceneKey}`;
if (scene.id !== sceneKey) {
diagnostics.push(
createDiagnostic(
"error",
"scene-id-mismatch",
"Scene ids must match their registry key.",
`${scenePath}.id`
)
);
}
if (scene.name.trim().length === 0) {
diagnostics.push(
createDiagnostic(
"error",
"invalid-scene-name",
"Scene names must be non-empty.",
`${scenePath}.name`
)
);
}
2026-04-11 04:14:33 +02:00
validateProjectSceneLoadingScreen(scene, scenePath, diagnostics);
validateProjectSceneEditorPreferences(scene, scenePath, diagnostics);
2026-04-11 04:14:33 +02:00
const sceneDocument = createSceneDocumentFromProject(document, sceneKey);
for (const diagnostic of filterProjectSceneDiagnostics(
validateSceneDocument(sceneDocument).diagnostics
)) {
diagnostics.push({
...diagnostic,
path: prefixDiagnosticPath(`${scenePath}.`, diagnostic.path)
});
}
for (const [entityId, entity] of Object.entries(scene.entities)) {
if (entity.kind !== "sceneExit") {
continue;
}
const targetScenePath = `${scenePath}.entities.${entityId}.targetSceneId`;
const targetEntryPath =
`${scenePath}.entities.${entityId}.targetEntryEntityId`;
const targetScene = document.scenes[entity.targetSceneId];
if (targetScene === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-scene-exit-target-scene",
`Scene Exit target scene ${entity.targetSceneId} does not exist in this project.`,
targetScenePath
)
);
continue;
}
const targetEntry = targetScene.entities[entity.targetEntryEntityId];
if (targetEntry === undefined) {
diagnostics.push(
createDiagnostic(
"error",
"missing-scene-exit-target-entry",
`Scene Exit target entry ${entity.targetEntryEntityId} does not exist in scene ${targetScene.name}.`,
targetEntryPath
)
);
continue;
}
if (targetEntry.kind !== "sceneEntry") {
diagnostics.push(
createDiagnostic(
"error",
"scene-exit-target-entry-kind-mismatch",
`Scene Exit target ${entity.targetEntryEntityId} in scene ${targetScene.name} is not a Scene Entry.`,
targetEntryPath
)
);
}
}
}
return {
diagnostics,
errors: diagnostics.filter((diagnostic) => diagnostic.severity === "error"),
warnings: diagnostics.filter(
(diagnostic) => diagnostic.severity === "warning"
)
};
}
export function assertProjectDocumentIsValid(document: ProjectDocument) {
const validation = validateProjectDocument(document);
if (validation.errors.length > 0) {
throw new Error(
`Project document has ${validation.errors.length} validation error(s): ${formatSceneDiagnosticSummary(validation.errors)}`
);
}
}