Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

OnDemandResourcesRequest

class in UnityEngine.iOS

/

Inherits from: AsyncOperation

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Represents a request for On Demand Resources (ODR). It's an AsyncOperation and can be yielded in a coroutine.

NOTE: only available on iOS.

Creating an OnDemandResourcesRequest is equivalent of calling beginAccessingResourcesWithCompletionHandler on NSBundleResourceRequest class. The request will keep ODR resource alive until either Dispose() is called or request object is collected by a garbage collector, which is equivalent of calling endAccessingResources on NSBundleResourceRequest class.


static class Loader
{
	public static IEnumerator LoadAsset(string resourceName)
	{
		// Create the request
		var request = OnDemandResources.PreloadAsync(new string[] { "Asset's ODR tag" });

// Wait until request is completed yield return request;

// Check for errors if (request.error != null) throw new Exception("ODR request failed: " + request.error);

// Get path to the resource and use it var path = request.GetResourcePath(resourceName);

// Call Dispose() when resource is no longer needed. request.Dispose(); } }

Variables

errorReturns an error after operation is complete.
loadingPrioritySets the priority for request.

Public Functions

DisposeRelease all resources kept alive by On Demand Resources (ODR) request.
GetResourcePathGets file system's path to the resource available in On Demand Resources (ODR) request.

Inherited members

Variables

allowSceneActivationAllow scenes to be activated as soon as it is ready.
isDoneHas the operation finished? (Read Only)
priorityPriority lets you tweak in which order async operation calls will be performed.
progressWhat's the operation's progress. (Read Only)