Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AssetDeliveryProxy

Runs a local HTTP server that serves assets to real devices.

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.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 3

HistoryMember
563Interface: string
563Port: int
563StartServer: bool
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
723IsInSandbox: bool
553Name: string
553Parent: Instance
702PredictionMode: PredictionMode
670Sandboxed: bool
680UniqueId: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

Internal service for remote asset delivery; not intended for game scripts. It backs the remote hot-reload workflow: IncrementalPatchBuilder builds a signed patch and this proxy serves it, along with any overridden assets, over HTTP to the connected device. The server runs on its own thread and is controlled through AssetDeliveryProxy.StartServer, AssetDeliveryProxy.Interface, and AssetDeliveryProxy.Port.

History 12

Members 3

Interface

TypeDefault
string

Sets the local network interface (address) that the proxy's HTTP server binds to when it starts. Defaults to an empty string. Assigning a value schedules the server to restart, but a new interface only takes effect while the server is running — that is, once AssetDeliveryProxy.StartServer is true (it defaults to false).

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

Port

TypeDefault
int0

The TCP port the proxy's HTTP server listens on. Defaults to 0, which tells the server to pick an available port automatically. While the server is running, reading this property returns the port actually in use rather than the configured value. A new port only takes effect when the server (re)starts via AssetDeliveryProxy.StartServer (defaults to false).

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

StartServer

TypeDefault
boolfalse

Controls whether the proxy's HTTP server is running. Setting it to true schedules the server to start; setting it to false stops it. Defaults to false, so the server is off until you enable it. Because the server only (re)starts while this is true, changes to AssetDeliveryProxy.Interface and AssetDeliveryProxy.Port take effect only when this property is true.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 4

Settings