Astra Unity 2.6.6
Astra Unity Plugin
|
Provides access to loading different assets More...
Classes | |
class | LoadOptions |
Base class which other loaders can extend from More... | |
Public Types | |
enum | LoadError { Success = 0 , Failed } |
Static Public Member Functions | |
static RigLoadJob | LoadRig (string guid, int parentJobId=Job.kNoParentJobId) |
Loads a RigItem via a guid, since no avatar is provided you will have an empty skeleton structure as a gameobject. It is unusual to call this function directly as you will not likely need to load a rig on it's own. More... | |
static RigLoadJob | LoadRig (RigLoadJob.RigLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads a RigItem via the options struct RigLoadJob.RigLoadOptions. Typically this is attached into a FigureItem by setting the compoundItem option. It is unusual to call this function directly as you will not likely need to load a rig on it's own. More... | |
static PoseLoadJob | LoadPose (string guid, int parentJobId=Job.kNoParentJobId) |
Loads a PoseItem, this is typically automatically attached by setting the param's avatarItem allowing the pose to bind into your avatar. Loading via just the GUID will load a new rig into your scene. Typically you should use the Loader.LoadPose(PoseLoadJob.PoseLoadOptions, int) variant instead and pass in your avatar or rig item. More... | |
static PoseLoadJob | LoadPose (PoseLoadJob.PoseLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads a PoseItem, this is typically automatically attached by setting the param's avatarItem allowing the pose to bind into your avatar. More... | |
static MaterialLoadJob | LoadMaterial (string guid, int parentJobId=Job.kNoParentJobId) |
Load a material, this will generate a UnityEngine.Material as it's result. This is not usually called directly and instead you should load an asset via LoadCloth, LoadHair, etc. More... | |
static MaterialLoadJob | LoadMaterial (MaterialLoadJob.MaterialLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Load a material, this will generate a UnityEngine.Material as it's result. This is not usually called directly and instead you should load an asset via LoadCloth, LoadHair, etc. More... | |
static MaterialVariationLoadJob | LoadMaterialVariation (string guid, int parentJobId=Job.kNoParentJobId) |
Loads the data for a MaterialVariationItem with the given guid, these are useful for adding or replacing an existing asset's material (such as a shirt and changing it's textures or colors). Since this call does not accept a MeshItem or object to bind to, you will not have a MaterialVariationItem. You can then call LinkWithMeshItem yourself to generate the component. More... | |
static MaterialVariationLoadJob | LoadMaterialVariation (MaterialVariationLoadJob.MaterialVariationLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the MaterialVariationItem with the given guid, these are useful for adding or replacing an existing asset's material (such as a shirt and changing it's textures or colors). The side effect will be a MaterialVariationItem which binds to the MeshItem's gameobject and can be toggled and removed. More... | |
static DecalLoadJob | LoadDecal (string guid, int parentJobId=Job.kNoParentJobId) |
Loads the data for a DecalItem with the given guid. Since there are no linking options you will need to call LinkWithMeshItem yourself. More... | |
static DecalLoadJob | LoadDecal (DecalLoadJob.DecalLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the DecalItem with the given options binding against the param.meshItem's gameobject. More... | |
static SchematicLoadJob | LoadSchematic (string guid, int parentJobId=Job.kNoParentJobId) |
Loads the schematic with the given guid. Schematics are generic bases upon which more advanced classes such as Cloth, Hair, Figures, and Avatars are built upon. It is unusual to call this yourself directly instead you should use the high level calls. More... | |
static SchematicLoadJob | LoadSchematic (SchematicLoadJob.SchematicLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the schematic with the given options. Schematics are generic bases upon which more advanced classes such as Cloth, Hair, Figures, and Avatars are built upon. It is unusual to call this yourself directly instead you should use the high level calls. More... | |
static EyeLoadJob | LoadEyes (string guid, int parentJobId=Job.kNoParentJobId) |
Loads an EyeItem asset without binding to an avatar. More... | |
static EyeLoadJob | LoadEyes (EyeLoadJob.EyeLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the EyeItem asset binding to the param.figureItem and param.rigItem. More... | |
static PartLoadJob | LoadPart (string guid, int parentJobId=Job.kNoParentJobId) |
Loads a PartItem such as teeth without binding to an avatar. More... | |
static PartLoadJob | LoadPart (PartLoadJob.PartLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the PartItem such as teeth and binds to the param.avatarItem. More... | |
static ClothLoadJob | LoadCloth (string guid, int parentJobId=Job.kNoParentJobId) |
Loads a ClothItem without binding to an avatar. More... | |
static ClothLoadJob | LoadCloth (ClothLoadJob.ClothLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the ClothItem and attaches it to the supplied param.avatarItem if supplied. More... | |
static HairLoadJob | LoadHair (string guid, int parentJobId=Job.kNoParentJobId) |
Loads a HairItem without binding to an avatar. More... | |
static HairLoadJob | LoadHair (HairLoadJob.HairLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the HairItem and attaches it to the supplied param.avatarItem if supplied. More... | |
static FigureLoadJob | LoadFigure (string guid, int parentJobId=Job.kNoParentJobId) |
Loads a FigureItem without binding to an avatar. More... | |
static FigureLoadJob | LoadFigure (FigureLoadJob.FigureLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the FigureItem and attaches it to the supplied param.avatarItem if supplied. More... | |
static CollectionLoadJob | LoadCollection (string guid, int parentJobId=Job.kNoParentJobId) |
Loads a Collection (which is a grouping of several sub assets such as ClothItem, DecalItem, etc) but does not attach it to an avatar. More... | |
static CollectionLoadJob | LoadCollection (CollectionLoadJob.CollectionLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads a Collection (which is a grouping of several sub assets such as ClothItem, DecalItem, etc) and attaches it to an avatar if supplied via param.avatarItem. More... | |
static MorphableLoadJob | LoadMorphable (string guid, int parentJobId=Job.kNoParentJobId) |
Loads the MorphableItem with the given guid without attaching to an avatar, which is only useful as a way to prefetch an asset since it cannot be attached after loading via this API. More... | |
static MorphableLoadJob | LoadMorphable (MorphableLoadJob.MorphableLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads the MorphableItem and attaches if to the supplied param.avatarItem if specified. More... | |
static AvatarLoadJob | LoadAvatar (string fetchGuid, int parentJobId=Job.kNoParentJobId) |
Loads an existing avatar using a guid into the scene, this will create a new game object. More... | |
static AvatarLoadJob | LoadAvatar (AvatarLoadJob.AvatarLoadOptions param, int parentJobId=Job.kNoParentJobId) |
Loads an existing avatar using all available options such as replacing the existing avatarItem if supplied More... | |
static AvatarLoadJob | LoadAvatar (CatalogEntry avatarEntry, int parentJobId=Job.kNoParentJobId) |
Loads an existing avatar using a catalog entry More... | |
static AvatarLoadJob | LoadAvatarFromUserId (string userId, string remoteType="email", bool useGlobal=false, AvatarLoadJob.AvatarLoadOptions param=null, int parentJobId=Job.kNoParentJobId) |
Loads an avatar using a remoteId and remoteType which is useful if you have your own user management system More... | |
static AvatarLoadJob | LoadAvatarFromRecipe (string recipe, int parentJobId=Job.kNoParentJobId) |
Loads an avatar from a raw JSON recipe, you should avoid using this call and instad load from IDs More... | |
Provides access to loading different assets
|
inlinestatic |
Loads an existing avatar using all available options such as replacing the existing avatarItem if supplied
param | Options for loading the AvatarItem |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads an existing avatar using a catalog entry
avatarEntry | The catalog entry of the avatar you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads an existing avatar using a guid into the scene, this will create a new game object.
fetchGuid | The id of the avatar you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads an avatar from a raw JSON recipe, you should avoid using this call and instad load from IDs
recipe | A JSON formatted string containing an avatar recipe |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads an avatar using a remoteId and remoteType which is useful if you have your own user management system
userId | User Id to retrieve the Avatar recipe for |
remoteType | Type for the remote authentication as provided by Astra Service |
useGlobal | If true will query the user's global avatar recipe as well as the current app, not all users will allow this, so it may fail. If false will only query the recipe for the current active APP_ID |
param | Options for loading the AvatarItem, optional |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the ClothItem and attaches it to the supplied param.avatarItem if supplied.
param | Options for loading the cloth |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a ClothItem without binding to an avatar.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a Collection (which is a grouping of several sub assets such as ClothItem, DecalItem, etc) and attaches it to an avatar if supplied via param.avatarItem.
param | Options for loading the collection |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a Collection (which is a grouping of several sub assets such as ClothItem, DecalItem, etc) but does not attach it to an avatar.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the DecalItem with the given options binding against the param.meshItem's gameobject.
param | Options for loading the Decal |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the data for a DecalItem with the given guid. Since there are no linking options you will need to call LinkWithMeshItem yourself.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the EyeItem asset binding to the param.figureItem and param.rigItem.
param | Options for loading the eyes |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads an EyeItem asset without binding to an avatar.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the FigureItem and attaches it to the supplied param.avatarItem if supplied.
param | Options for loading the figure |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a FigureItem without binding to an avatar.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the HairItem and attaches it to the supplied param.avatarItem if supplied.
param | Options for loading the hair |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a HairItem without binding to an avatar.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Load a material, this will generate a UnityEngine.Material as it's result. This is not usually called directly and instead you should load an asset via LoadCloth, LoadHair, etc.
param | Parameters for loading a material |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Load a material, this will generate a UnityEngine.Material as it's result. This is not usually called directly and instead you should load an asset via LoadCloth, LoadHair, etc.
guid | Guid of the material to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the MaterialVariationItem with the given guid, these are useful for adding or replacing an existing asset's material (such as a shirt and changing it's textures or colors). The side effect will be a MaterialVariationItem which binds to the MeshItem's gameobject and can be toggled and removed.
param | Options for loading the Material Variation |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the data for a MaterialVariationItem with the given guid, these are useful for adding or replacing an existing asset's material (such as a shirt and changing it's textures or colors). Since this call does not accept a MeshItem or object to bind to, you will not have a MaterialVariationItem. You can then call LinkWithMeshItem yourself to generate the component.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the MorphableItem and attaches if to the supplied param.avatarItem if specified.
param | Options for loading the MorphableItem |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the MorphableItem with the given guid without attaching to an avatar, which is only useful as a way to prefetch an asset since it cannot be attached after loading via this API.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the PartItem such as teeth and binds to the param.avatarItem.
param | Options for loading the part |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a PartItem such as teeth without binding to an avatar.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a PoseItem, this is typically automatically attached by setting the param's avatarItem allowing the pose to bind into your avatar.
param | Parameters for loading a pose |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a PoseItem, this is typically automatically attached by setting the param's avatarItem allowing the pose to bind into your avatar. Loading via just the GUID will load a new rig into your scene. Typically you should use the Loader.LoadPose(PoseLoadJob.PoseLoadOptions, int) variant instead and pass in your avatar or rig item.
guid | The GUID of the pose to fetch |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a RigItem via the options struct RigLoadJob.RigLoadOptions. Typically this is attached into a FigureItem by setting the compoundItem option. It is unusual to call this function directly as you will not likely need to load a rig on it's own.
param | Parameters for loading a rig |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads a RigItem via a guid, since no avatar is provided you will have an empty skeleton structure as a gameobject. It is unusual to call this function directly as you will not likely need to load a rig on it's own.
param | |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the schematic with the given options. Schematics are generic bases upon which more advanced classes such as Cloth, Hair, Figures, and Avatars are built upon. It is unusual to call this yourself directly instead you should use the high level calls.
param | Options for loading the schematic |
parentJobId | Id of the parent job, if it applies. Optional. |
|
inlinestatic |
Loads the schematic with the given guid. Schematics are generic bases upon which more advanced classes such as Cloth, Hair, Figures, and Avatars are built upon. It is unusual to call this yourself directly instead you should use the high level calls.
guid | The id of the item you're requesting to load |
parentJobId | Id of the parent job, if it applies. Optional. |