Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AssetPatchSettings

Configures a single patch asset built by IncrementalPatchBuilder and served through AssetDeliveryProxy.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
Memory categoryInstances
Tags: [NotCreatable, NotReplicated]

Member index 3

HistoryMember
549ContentId: string
549OutputPath: string
549PatchId: string
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

Defines the settings for an asset produced by IncrementalPatchBuilder and served through AssetDeliveryProxy during local debugging and hot-reload. An AssetPatchSettings instance can only be parented to an IncrementalPatchBuilder, and its Name represents the patch ID. Each child provides the content ID and cache location that the builder uses when it registers a completed patch.

History 4

Members 3

ContentId

TypeDefault
string

The content ID used to override this asset when it is served by AssetDeliveryProxy, for example rbxasset://models/DataModelPatch/DataModelPatch.rbxm. When IncrementalPatchBuilder finishes a build, it registers the serialized patch under this content ID so that requests for that asset return the patched content. Defaults to an empty string.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

OutputPath

TypeDefault
string

The output path for the local cache of the patch asset, for example /path/to/content/models/DataModelPatch/DataModelPatch.rbxm. When set, IncrementalPatchBuilder writes each completed patch to this path, creating any missing parent directories. Defaults to an empty string; when empty, no file is written and an in-memory cache is used instead.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

PatchId

TypeDefault
string

An identifier for distinguishing patches under a single IncrementalPatchBuilder. Has no effect. Defaults to an empty string.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 1

Settings