• Messages for controlling and interacting with collection proxies which are used to dynamically load collections into the runtime.

See CollectionProxyMessages for related messages.

Static methods

@:native("get_resources")staticgetResources(collectionProxy:Url):LuaArray<String>

  • Returns an indexed table of resources for a collection proxy. Each entry is a hexadecimal string that represents the data of the specific resource. This representation corresponds with the filename for each individual resource that is exported when you bundle an application with LiveUpdate functionality.

Parameters:

collectionProxy

the collection proxy to check

Returns:

the necessary resources

@:native("missing_resources")staticmissingResources(collectionProxy:Url):LuaArray<String>

  • Return an indexed table of missing resources for a collection proxy.

Each entry is a hexadecimal string that represents the data of the specific resource. This representation corresponds with the filename for each individual resource that is exported when you bundle an application with LiveUpdate functionality. It should be considered good practise to always check whether or not there are any missing resources in a collection proxy before attempting to load the collection proxy.

Parameters:

collectionProxy

the collection proxy to check for missing resources.

Returns:

the missing resources

@:multiReturn@:native("set_collection")staticsetCollection(collectionProxy:Url, prototype:Null<String>):CollectionProxySetCollectionResult

  • Changes the collection for a collection proxy.

The collection should be loaded by the collection proxy. Setting the collection to null will revert it back to the original collection. The collection proxy shouldn't be loaded and should have the 'Exclude' checkbox checked. This functionality is designed to simplify the management of Live Update resources.

Parameters:

collectionProxy

the collection proxy component

prototype

the path to the new collection, or null to reset

Returns:

tuple (success, code). If unsuccessful, code is one of the CollectionProxyResult constants.