Skip to content

IncrementalPatchBuilder

Not yet Class Services NotCreatable NotReplicated Service

Builds signed incremental patches for hot-reloading a running client from script changes detected by a separate file watcher.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members ยท 12 modern Roblox members not implemented yet

Description

Internal tooling service, not for creator game scripts. A separate file-watcher system detects changes in a mapped subtree of scripts; this service rebuilds an in-memory patch tree and serializes that tree into a signed binary patch that can be delivered to a running client for hot-reload.

Builds are debounced so rapid successive edits coalesce into a single patch build. When SerializePatch is true, the resulting patch is delivered through AssetDeliveryProxy and written to the configured output path.

Inheritance

Object โ†’ Instance โ†’ IncrementalPatchBuilder

Properties

Member Signature Summary
AddPathsToBundle AddPathsToBundle: bool Whether each script in the patch is tagged with a FilePath attribute recording its on-disk source path.
BuildDebouncePeriod BuildDebouncePeriod: double The interval, in seconds, used to debounce rebuilds so that rapid script changes are coalesced into a single patch build.
HighCompression HighCompression: bool Whether the serialized patch is written with high-compression settings.
SerializePatch SerializePatch: bool Whether a completed build is serialized into a signed binary patch.
UseFileLevelCompressionInsteadOfChunk UseFileLevelCompressionInsteadOfChunk: bool Whether per-chunk compression is skipped so that the patch is compressed at the file level instead.
ZstdCompression ZstdCompression: bool Whether per-chunk compression of the patch uses the Zstandard algorithm.

Roblox reference: IncrementalPatchBuilder

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.