Class AddressableAssetGroup
Contains the collection of asset entries associated with this group.
Inheritance
Namespace: UnityEditor.AddressableAssets
Syntax
[Serializable]
public class AddressableAssetGroup : ScriptableObject, IComparer<AddressableAssetEntry>, ISerializationCallbackReceiverProperties
Data
The data store associated with this group.
Declaration
public virtual KeyDataStore Data { get; }Property Value
| Type | Description |
|---|---|
| KeyDataStore |
Default
Is the default group.
Declaration
public virtual bool Default { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
entries
The collection of asset entries.
Declaration
public virtual ICollection<AddressableAssetEntry> entries { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.ICollection<AddressableAssetEntry> |
Guid
The group GUID.
Declaration
public virtual string Guid { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Name
The group name.
Declaration
public virtual string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Processor
Gets the associated group processor. NOTE: This API is going to be replaced soon with a more flexible and user controlled system.
Declaration
public virtual AssetGroupProcessor Processor { get; }Property Value
| Type | Description |
|---|---|
| AssetGroupProcessor |
ReadOnly
Is this group read only. This is normally false. Built in resources (resource folders and the scene list) are put into a special read only group.
Declaration
public virtual bool ReadOnly { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
StaticContent
Is the group static. This property is used in determining which assets need to be moved to a new remote group during the content update process.
Declaration
public virtual bool StaticContent { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Methods
Compare(AddressableAssetEntry, AddressableAssetEntry)
Declaration
public virtual int Compare(AddressableAssetEntry x, AddressableAssetEntry y)Parameters
| Type | Name | Description |
|---|---|---|
| AddressableAssetEntry | x | |
| AddressableAssetEntry | y |
Returns
| Type | Description |
|---|---|
| System.Int32 |
Implements
GatherAllAssets(List<AddressableAssetEntry>, Boolean, Boolean)
Gathers all asset entries. Each explicit entry may contain multiple sub entries. For example, addressable folders create entries for each asset contained within.
Declaration
public virtual void GatherAllAssets(List<AddressableAssetEntry> results, bool includeSelf, bool recurseAll)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<AddressableAssetEntry> | results | The generated list of entries. For simple entries, this will contain just the entry itself if specified. |
| System.Boolean | includeSelf | Determines if the entry should be contained in the result list or just sub entries. |
| System.Boolean | recurseAll | Determines if full recursion should be done when gathering entries. |
GetAssetEntry(String)
Get an entry via the asset guid.
Declaration
public virtual AddressableAssetEntry GetAssetEntry(string guid)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | guid | The asset guid. |
Returns
| Type | Description |
|---|---|
| AddressableAssetEntry |
IsProcessorType(Type)
Check the processor type of this group.
Declaration
public virtual bool IsProcessorType(Type processorType)Parameters
| Type | Name | Description |
|---|---|---|
| System.Type | processorType | The processor type. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if this group has the same processor type. |
OnAfterDeserialize()
Converts data from serializable format.
Declaration
public void OnAfterDeserialize()OnBeforeSerialize()
Converts data to serializable format.
Declaration
public void OnBeforeSerialize()