IncrementalPatchBuilder
Builds signed incremental patches for hot-reloading a running client from script changes detected by a separate file watcher.
| Memory category | Instances |
|---|
Member index 6
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.
History 23
- 731 Change Default of ZstdCompression from to false
- 731 Change Default of UseFileLevelCompressionInsteadOfChunk from to false
- 731 Change Default of SerializePatch from to true
- 731 Change Default of HighCompression from to false
- 731 Change Default of BuildDebouncePeriod from to 0.10000000000000000555
- 731 Change Default of AddPathsToBundle from to false
- 726 Change Default of ZstdCompression from false to
- 726 Change Default of UseFileLevelCompressionInsteadOfChunk from false to
- 726 Change Default of SerializePatch from true to
- 726 Change Default of HighCompression from false to
- 726 Change Default of BuildDebouncePeriod from 0.10000000000000000555 to
- 726 Change Default of AddPathsToBundle from false to
- 693 Add UseFileLevelCompressionInsteadOfChunk
- 569 Add BuildDebouncePeriod
- 567 Add SerializePatch
- 557 Add AddPathsToBundle
- 554 Remove AddPathsToBundle
- 555 Add AddPathsToBundle
- 553 Change Default of ZstdCompression from to false
- 553 Change Default of HighCompression from to false
- 547 Add ZstdCompression
- 547 Add HighCompression
- 468 Add IncrementalPatchBuilder
Members 6
AddPathsToBundle
| Type | Default | |
|---|---|---|
| bool | false | |
Defaults to false. When true, and the builder is running alongside a
CoreScriptSyncService, each script instance added to the patch is given
a FilePath attribute set to the on-disk path of the file it was synced
from. When false, no path attributes are written.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 5
- 731 Change Default of AddPathsToBundle from to false
- 726 Change Default of AddPathsToBundle from false to
- 557 Add AddPathsToBundle
- 554 Remove AddPathsToBundle
- 555 Add AddPathsToBundle
BuildDebouncePeriod
| Type | Default | |
|---|---|---|
| double | 0.10000000000000000555 | |
Defaults to 0.1 (100 milliseconds). When the separate file watcher
reports a script change, the builder waits this interval before
rebuilding, and any additional changes that arrive during the window are
batched into the same build. Larger values reduce redundant rebuilds
during bursts of edits, at the cost of added latency before the patch
updates.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 3
- 731 Change Default of BuildDebouncePeriod from to 0.10000000000000000555
- 726 Change Default of BuildDebouncePeriod from 0.10000000000000000555 to
- 569 Add BuildDebouncePeriod
HighCompression
| Type | Default | |
|---|---|---|
| bool | false | |
Defaults to false. When true, the builder writes the binary patch with
high-compression settings, trading additional build time for a smaller
patch.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 731 Change Default of HighCompression from to false
- 726 Change Default of HighCompression from false to
- 553 Change Default of HighCompression from to false
- 547 Add HighCompression
SerializePatch
| Type | Default | |
|---|---|---|
| bool | true | |
Defaults to true. When true, each successful build is serialized into
a signed binary patch, delivered through AssetDeliveryProxy, and
written to the configured output path. When false, the builder still
produces the in-memory patch tree but skips serialization, so no patch
file is emitted.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 3
- 731 Change Default of SerializePatch from to true
- 726 Change Default of SerializePatch from true to
- 567 Add SerializePatch
UseFileLevelCompressionInsteadOfChunk
| Type | Default | |
|---|---|---|
| bool | false | |
Defaults to false. When true, the builder disables the serializer's
per-chunk compression, storing the patch's chunks uncompressed so that
compression can be applied at the file level instead. This property takes
precedence over
ZstdCompression: when it
is true, the Zstandard setting has no effect.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 3
- 731 Change Default of UseFileLevelCompressionInsteadOfChunk from to false
- 726 Change Default of UseFileLevelCompressionInsteadOfChunk from false to
- 693 Add UseFileLevelCompressionInsteadOfChunk
ZstdCompression
| Type | Default | |
|---|---|---|
| bool | false | |
Defaults to false. When true, the builder compresses the patch's
chunks with the Zstandard algorithm. This applies only while
UseFileLevelCompressionInsteadOfChunk
is at its default of false, because that property takes precedence and
disables per-chunk compression entirely.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | true |
History 4
- 731 Change Default of ZstdCompression from to false
- 726 Change Default of ZstdCompression from false to
- 553 Change Default of ZstdCompression from to false
- 547 Add ZstdCompression