Class Resources

The Resources class provides APIs to dynamically load and unload Resource objects at runtime.

Hierarchy (view full)

Constructors

constructor

Properties

Methods

duplicate get getByUUID getLoadProgress isAnimationClipDirty isAvailable isDirty load loadAsync loadBackground release revertToCloudVersion setClean setDirty shouldCloneOnSave unloadUnused updateHandleWithClone

Events

onResourceDirtyChanged onResourceLoaded onResourceDestroyed onResourceHandleChanged onResourceReverted

Constructors

constructor

Methods

Staticduplicate

  • duplicate(handle): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Parameters

    Returns Resource

    The duplicated resource or an empty handle if the duplicate failed.

    Note

    Thread safe.

Staticget

StaticgetByUUID

StaticgetLoadProgress

  • getLoadProgress(resource, includeDependencies?): number

  • Returns the loading progress of a Resource that's being asynchronously loaded.

    Parameters

    • resource: ResourceHandle<Resource>

      Resource whose load progress to check.

    • OptionalincludeDependencies: boolean

      If false the progress will reflect the load progress only for this individual resource. If true the progress will reflect load progress of this resource and all of its dependencies.

    Returns number

    Load progress in range [0, 1].

StaticisAnimationClipDirty

  • isAnimationClipDirty(animationClip): boolean

  • Checks is the specific animation resource dirty and needs saving.

    Parameters

    Returns boolean

    True if the resource requires saving, false otherwise.

StaticisAvailable

  • isAvailable(uuid, type): boolean

  • Checks if the packages for the provided Resource and optionally its dependencies are present locally. They may not be present if running in online mode and they haven't been downloaded yet.

    Parameters

    Returns boolean

    True if all the requested packages are available locally.

StaticisDirty

  • isDirty(resource): boolean

  • Checks is the specific resource dirty and needs saving.

    Parameters

    Returns boolean

    True if the resource requires saving, false otherwise.

Staticload

  • load<T>(type, path, flags?): T

  • Loads a Resource from the specified path. If resource is already loaded an existing instance is returned.

    Type Parameters

    Parameters

    • type: ClassOf<T>

      The Type of the resource.

    • path: string

      Path of the resource, relative to game directory. If running from editor this will be relative to the project library. If a sub-resource within a file is needed, append the name of the subresource to the path (for example mymesh.fbx/my_animation).

    • Optionalflags: EnumValue<ResourceLoadFlag, number>

      Optional flags used to control the load process.

    Returns T

    Loaded resource, or null if resource cannot be found.

    Note

    If running outside of the editor you must make sure to mark that the resource gets included in the build. If running inside the editor this has similar functionality as if loading using the project library.

  • load<T>(type, uuid, flags?): T

  • Loads a Resource with the specified UUID. If resource is already loaded an existing instance is returned.

    Type Parameters

    Parameters

    Returns T

    Loaded resource, or null if resource cannot be found.

    Note

    If running outside of the editor you must make sure to mark that the resource gets included in the build. If running inside the editor this has similar functionality as if loading using the project library.

StaticloadAsync

  • loadAsync<T>(type, uuid, flags?): Promise<T>

  • Loads a Resource with the specified UUID asynchonously (on a separate thread). If resource is already loaded an existing instance is returned.

    Type Parameters

    Parameters

    Returns Promise<T>

    Promise that holds the loaded resource handle.

    Note

    If running outside of the editor you must make sure to mark that the resource gets included in the build. If running inside the editor this has similar functionality as if loading using the project library.

StaticloadBackground

  • loadBackground<T>(type, path, flags?): ResourceHandle<T>

  • Loads a Resource from the specified path asynchonously in the background (on a separate thread). If resource is already loaded an existing instance is returned. Use ResourceHandle.isLoaded to confirm the resource has been loaded before using it. Use getLoadProgress to track the loading progress of the resource.

    Type Parameters

    Parameters

    • type: ClassOf<T>

      The Type of the resource.

    • path: string

      Path of the resource, relative to game directory. If running from editor this will be relative to the project library. If a sub-resource within a file is needed, append the name of the subresource to the path (for example mymesh.fbx/my_animation).

    • Optionalflags: EnumValue<ResourceLoadFlag, number>

      Optional flags used to control the load process.

    Returns ResourceHandle<T>

    Loaded resource, or null if resource cannot be found.

    Note

    If running outside of the editor you must make sure to mark that the resource gets included in the build. If running inside the editor this has similar functionality as if loading using the project library.

    Note

    This is load does not guarantee that the loaded resource matches the type as the load finishes in the background. The caller is responsible to ensure that the loaded resource matches the requested type. It is recommended to use loadAsync as an alternative API that provides type guarantees.

  • loadBackground<T>(type, uuid, flags?): ResourceHandle<T>

  • Loads a Resource with the specified UUID asynchonously in the background (on a separate thread). If resource is already loaded an existing instance is returned. Use ResourceHandle.isLoaded to confirm the resource has been loaded before using it. Use getLoadProgress to track the loading progress of the resource.

    Type Parameters

    Parameters

    • type: ClassOf<T>

      The Type of the resource.

    • uuid: UUID

      Unique identifier of the resource to load.

    • Optionalflags: EnumValue<ResourceLoadFlag, number>

      Optional flags used to control the load process.

    Returns ResourceHandle<T>

    Loaded resource, or null if resource cannot be found.

    Note

    If running outside of the editor you must make sure to mark that the resource gets included in the build. If running inside the editor this has similar functionality as if loading using the project library.

    Note

    This is load does not guarantee that the loaded resource matches the type as the load finishes in the background. The caller is responsible to ensure that the loaded resource matches the requested type. It is recommended to use loadAsync as an alternative API that provides type guarantees.

Staticrelease

  • release(resource): void

  • Releases an internal reference to the Resource held by the resources system. This allows the resource to be unloaded when it goes out of scope, if the resource was loaded with "keepLoaded" parameter.

    Parameters

    Returns void

    Note

    Alternatively you can also skip manually calling release and call unloadUnused which will unload all resources that do not have any external references, but you lose the fine grained control of what will be unloaded.

StaticrevertToCloudVersion

  • revertToCloudVersion(resource): AsyncOp<void, void>

  • Discards all changes from a resource and re-downloads it from the cloud.

    Parameters

    • resource: Resource

      The resource to be reset and re-downloaded from the cloud.

    Returns AsyncOp<void, void>

    Note

    This API is asynchronous and will run in the background.

StaticsetClean

  • setClean(resourceOrUUID): void

  • Marks a resource in the current project as clean.

    Parameters

    Returns void

StaticsetDirty

  • setDirty(resource, isDirty?): void

  • Marks a resource in the current project as dirty.

    Parameters

    • resource: Resource

      Resource to mark as dirty.

    • OptionalisDirty: boolean

      Whether the resource is dirty or it should be marked as clean.

    Returns void

StaticshouldCloneOnSave

  • shouldCloneOnSave(type): boolean

  • Checks if the resource should be cloned before queuing a save operation.

    Parameters

    • type: Type

      Type of the resource.

    Returns boolean

    True if the resource should be cloned.

StaticunloadUnused

  • unloadUnused(): void

  • Unloads all resources that are no longer referenced.

    Returns void

    Note

    This only applies to resources loaded with ResourceLoadFlag.KeepInternalRef flag, as all other resources will be unloaded when they go out of scope.

StaticupdateHandleWithClone

  • updateHandleWithClone(handle, handleToClone): void

  • Updates an existing resource handle with a new resource. The handleToClone will be cloned to as new object for handle. Caller must ensure that new resource type matches the original resource type.

    Parameters

    Returns void

    Note

    Thread safe.

Events

Static ReadonlyonResourceDirtyChanged

onResourceDirtyChanged: Event<[Resource, boolean], void>

An event fired whenever a resource is marked as dirty.

Static ReadonlyonResourceLoaded

onResourceLoaded: Event<[ResourceHandle<Resource>], void>

Called when the resource has been successfully loaded.

Note

It's guaranteed that this event will be called from the main thread.

Static ReadonlyonResourceDestroyed

onResourceDestroyed: Event<[UUID], void>

Called when the resource has been destroyed. Provides UUID of the destroyed resource.

Note

It's guaranteed that this event will be called from the main thread.

Static ReadonlyonResourceHandleChanged

onResourceHandleChanged: Event<[ResourceHandle<Resource>], void>

Called when the internal resource the handle is pointing to has changed.

Note

It's guaranteed that this event will be called from the main thread.

Static ReadonlyonResourceReverted

onResourceReverted: Event<[ResourceHandle<Resource>], void>

Called when the internal resource the handle is pointing to has been reverted.

Note

It's guaranteed that this event will be called from the main thread.

Settings

Member Visibility

On This Page

Constructors
Methods
Events