editor.build

Handler for triggering editor build operations (lighting, geometry, reflection captures, texture streaming, HLODs, navigation) and querying build status.

← API Reference

editor.build.buildAll

Trigger a full editor build (lighting, geometry, paths, HLODs, etc.).

No parameters.

Returns

Field Type Description
successbooleanWhether the build completed successfully
build_typestringAlways "all"

Example Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "editor.build.buildAll",
  "params": {}
}

Example Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "success": true,
    "build_type": "all"
  }
}

editor.build.buildLighting

Build lighting with configurable quality level.

Name Type Required Description
qualitystringNoQuality level: "preview" (default), "medium", "high", "production"

Returns

Field Type Description
successbooleanWhether the build was initiated successfully
build_typestringAlways "lighting"
qualitystringThe quality level used

Notes: Lighting builds can take significant time depending on quality level and scene complexity. The method returns immediately after initiating the build; use editor.build.getBuildStatus to poll progress.

Example Request

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "editor.build.buildLighting",
  "params": { "quality": "production" }
}

Example Response

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "success": true,
    "build_type": "lighting",
    "quality": "production"
  }
}

editor.build.buildGeometry

Rebuild BSP geometry in the current level.

No parameters.

Returns

Field Type Description
successbooleanWhether the build completed successfully
build_typestringAlways "geometry"

Example Request

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "editor.build.buildGeometry",
  "params": {}
}

editor.build.buildReflectionCaptures

Rebuild all reflection captures in the current level.

No parameters.

Returns

Field Type Description
successbooleanAlways true on completion
build_typestringAlways "reflection_captures"

Example Request

{
  "jsonrpc": "2.0",
  "id": 4,
  "method": "editor.build.buildReflectionCaptures",
  "params": {}
}

editor.build.buildTextureStreaming

Rebuild texture streaming data for the current level.

No parameters.

Returns

Field Type Description
successbooleanWhether the build completed successfully
build_typestringAlways "texture_streaming"

Example Request

{
  "jsonrpc": "2.0",
  "id": 5,
  "method": "editor.build.buildTextureStreaming",
  "params": {}
}

editor.build.buildHLODs

Rebuild Hierarchical Level of Detail (HLOD) actors for the current level.

No parameters.

Returns

Field Type Description
successbooleanWhether the build completed successfully
build_typestringAlways "hlods"

Example Request

{
  "jsonrpc": "2.0",
  "id": 6,
  "method": "editor.build.buildHLODs",
  "params": {}
}

editor.build.buildNavigation

Rebuild navigation mesh / AI paths for the current level.

No parameters.

Returns

Field Type Description
successbooleanWhether the build completed successfully
build_typestringAlways "navigation"

Notes: Navigation builds may run asynchronously; use editor.build.getBuildStatus to poll progress.

Example Request

{
  "jsonrpc": "2.0",
  "id": 7,
  "method": "editor.build.buildNavigation",
  "params": {}
}

editor.build.getBuildStatus

Check whether an editor build is currently in progress.

No parameters.

Returns

Field Type Description
is_buildingbooleanTrue if a build is currently running

Example Request

{
  "jsonrpc": "2.0",
  "id": 8,
  "method": "editor.build.getBuildStatus",
  "params": {}
}

Example Response

{
  "jsonrpc": "2.0",
  "id": 8,
  "result": {
    "is_building": false
  }
}