Astra Unity 2.6.6
Astra Unity Plugin
Astra.Asset.CollectionLoadJob Class Reference

Loader for a collection item, which contains a number of assets such as hair items, cloth items, or figures. More...

Inheritance diagram for Astra.Asset.CollectionLoadJob:

Classes

class  CollectionLoadOptions
 Options for loading a collection More...
 
class  CollectionLoadResult
 Results from loading a collection More...
 

Public Member Functions

override Loader.LoadError GetError ()
 When the job is complete this function can be called by the developer to access the error data set which can be of any type (defined as T2). This needs to be defined if your derived class as an override. More...
 
override CollectionLoadResult GetResult ()
 When the job is complete this function can be called by the developer to access the result data set which can be of any type (defined as T1). This needs to be defined if your derived class as an override. More...
 
- Public Member Functions inherited from Astra.ApiJobWithResult< CollectionLoadJob.CollectionLoadResult, Loader.LoadError >
IEnumerator AsCoroutine (Action< float > progress=null, Action< T1 > onComplete=null, Action< T2 > onFailed=null)
 Wraps a job to be used within a coroutine More...
 

Detailed Description

Loader for a collection item, which contains a number of assets such as hair items, cloth items, or figures.

Member Function Documentation

◆ GetError()

override Loader.LoadError Astra.Asset.CollectionLoadJob.GetError ( )
inlinevirtual

When the job is complete this function can be called by the developer to access the error data set which can be of any type (defined as T2). This needs to be defined if your derived class as an override.

Returns
Yields the error result data

Implements Astra.ApiJobWithResult< CollectionLoadJob.CollectionLoadResult, Loader.LoadError >.

◆ GetResult()

override CollectionLoadResult Astra.Asset.CollectionLoadJob.GetResult ( )
inlinevirtual

When the job is complete this function can be called by the developer to access the result data set which can be of any type (defined as T1). This needs to be defined if your derived class as an override.

Returns
Yields the success result data

Implements Astra.ApiJobWithResult< CollectionLoadJob.CollectionLoadResult, Loader.LoadError >.


The documentation for this class was generated from the following file: