UnityEngine.ContentLoadModule

This struct acts like a handle for accessing a file loaded by Unity.Loading.ContentLoadInterface.LoadContentFileAsync. You can use it to access the status and results of the load operation.

Used to access objects within the Unity.Loading.ContentFile by local file identifier.

The local file identifier. The loaded Object from the Unity.Loading.ContentFile.

This function can be used to access all the Objects loaded in the Unity.Loading.ContentFile.

All the Objects within the Unity.Loading.ContentFile.

This ContentFile can be passed as a dependency to Unity.Loading.ContentLoadInterface.LoadContentFileAsync or Unity.Loading.ContentLoadInterface.LoadSceneAsync to indicate that the external file dependencies should be resolved through the global PersistentManager table. For example, this could be used when the ContentFile references a file loaded through the PersistentManager such as "unity default resources".

Returns true if the Unity.Loading.ContentFile handle is valid.

The loading status of the Unity.Loading.ContentFile.

Begin an asynchronous unload of the Unity.Loading.ContentFile.

A handle that can be used to track the status of the unload operation.

Blocks on the main thread until the load operation completes. This function can be slow and so should be used carefully to avoid frame rate stuttering.

The maximum time in milliseconds this function will wait before returning. Pass 0 to block indefinitely until completion. Returns false if the timeout was reached before ContentFile completed loading.

A handle that can be used to track the progress of an unload operation. This is returned from Unity.Loading.ContentFile.UnloadAsync.

Returns true if the unload operation has completed.

Blocks on the main thread until the unload operation completes. This function can be slow and so should be used carefully to avoid frame rate stuttering.

The maximum time in milliseconds this function will wait before returning. Pass 0 to block indefinitely until completion. Returns false if the timeout was reached before ContentFile completed loading.

API Interface for loading and unloading Content files.

Returns all the Unity.Loading.ContentFile handles associated with the provided Unity.Content.ContentNamespace.

The ContentNamespace used to filter the results. Returns an array of all the Unity.Loading.ContentFiles belonging to the Unity.Content.ContentNamespace.

Gets the target duration allowed per frame to integrate loading or unloading objects, in milliseconds.

An array of all the Unity.Loading.ContentSceneFiles associated with the Unity.Content.ContentNamespace.

The Unity.Content.ContentNamespace used to filter the results. Returns an array of all the Unity.Loading.ContentSceneFiles belonging to the Unity.Content.ContentNamespace.

Loads a serialized file asynchronously from disk.

The Unity.Content.ContentNamespace used to filter the results. Path of the file on disk. List of the Unity.Loading.ContentFiles that will be referenced by the file being loaded. The ordering must match the ordering returned from the build process. Unity.Loading.ContentFile.GlobalTableDependency can be used to indicate that the PersistentManager should be used to resolve references. This allows references to files such as "unity default resources". The load will not begin until this Unity.Jobs.JobHandle completes. A default Unity.Jobs.JobHandle can be used if there is no dependency. Handle to access the results of the load process.

Loads a scene serialized file asynchronously from disk.

List of the ContentFiles that will be referenced by the file being loaded. The ordering must match the ordering returned from the build process. Unity.Loading.ContentFile.GlobalTableDependency can be used to indicate that the PersistentManager should be used to resolve references. This allows references to files such as "unity default resources". The ContentNamespace used to filter the results. Path of the file on disk. The name that will be applied to the scene. Struct that collects the various parameters into a single place. The load will not begin until this JobHandle completes. Handle to access the results of the load process.

Sets the target duration allowed per frame to integrate loading or unloading objects, in milliseconds.

The handle returned from Unity.Loading.ContentLoadInterface.LoadSceneAsync. You can use this handle to access the status and results of the load operation.

Calling this will cause the scene to integrate at the end of the frame.

Returns true if the Unity.Loading.ContentSceneFile handle is valid. A handle becomes invalid after the file is unloaded.

The Scene object being loaded. This is accessible both before and after the load operation completes.

The loading status of the scene.

Will trigger the scene to unload at the end of the frame.

True if successful. False if the scene is not in a state that can be unloaded.

Blocks on the main thread until the load operation completes. This function can be slow and so should be used carefully to avoid frame rate stuttering.

The maximum time in milliseconds this function will wait before returning. Pass 0 to block indefinitely until completion. Returns false if the timeout was reached before ContentFile completed loading.

This struct collects all the Unity.Loading.ContentLoadInterface.LoadSceneAsync parameters in to a single place.

True if the scene should be automatically integrated after the load completes. If this is set to false, the user must call Unity.Loading.ContentSceneFile.IntegrateAtEndOfFrame when they are ready to integrate.

See LoadSceneMode.

See LocalPhysicsMode.

The loading status of a Unity.Loading.ContentFile.

The Unity.Loading.ContentFile has loaded successfully.

The Unity.Loading.ContentFile failed to load. Be sure to still call Unity.Loading.ContentFile.UnloadAsync to free internal resources.

The Unity.Loading.ContentFile is actively loading.

The loading status of a Unity.Loading.ContentSceneFile. This is accessed by ContentSceneFile.Status.

The scene has been loaded and integrated successfully.

A failure occured in the scene loading process. See log for details. Be sure to still call Unity.Loading.ContentSceneFile.UnloadAtEndOfFrame to release internal resources.

The scene load is in progress.

The asynchronous part of the scene loading is complete. You can now safely call Unity.Loading.ContentSceneFile.IntegrateAtEndOfFrame when you are ready to activate the scene.

The scene will integrate at the end of the current frame.

The ContentLoad module implements the ContentLoadInterface class and related APIs to load data from ContentFiles.