Class BundledAssetGroupSchema

Schema used for bundled asset groups.

Inheritance

Object

AddressableAssetGroupSchema

BundledAssetGroupSchema

Inherited Members

AddressableAssetGroupSchema.Group

AddressableAssetGroupSchema.SetDirty(Boolean)

AddressableAssetGroupSchema.ShowMixedValue(SerializedProperty, List<AddressableAssetGroupSchema>, Type, String)

Namespace: UnityEditor.AddressableAssets.Settings.GroupSchemas

Syntax

public class BundledAssetGroupSchema : AddressableAssetGroupSchema, IHostingServiceConfigurationProvider, ISerializationCallbackReceiver

Properties

AssetBundleProviderType

The provider type to use for loading asset bundles.

Declaration

public SerializedType AssetBundleProviderType { get; }

Property Value

Type	Description
SerializedType

BuildPath

The path to copy asset bundles to.

Declaration

public ProfileValueReference BuildPath { get; }

Property Value

Type	Description
ProfileValueReference

BundledAssetProviderType

The provider type to use for loading assets from bundles.

Declaration

public SerializedType BundledAssetProviderType { get; }

Property Value

Type	Description
SerializedType

BundleMode

Controls how bundles are packed. If set to PackTogether, a single asset bundle will be created for the entire group, with the exception of scenes, which are packed in a second bundle. If set to PackSeparately, an asset bundle will be created for each entry in the group; in the case that an entry is a folder, one bundle is created for the folder and all of its sub entries.

Declaration

public BundledAssetGroupSchema.BundlePackingMode BundleMode { get; set; }

Property Value

Type	Description
BundledAssetGroupSchema.BundlePackingMode

BundleNaming

Naming style to use for generated AssetBundle(s).

Declaration

public BundledAssetGroupSchema.BundleNamingStyle BundleNaming { get; set; }

Property Value

Type	Description
BundledAssetGroupSchema.BundleNamingStyle

ChunkedTransfer

Indicates whether the UnityWebRequest system should employ the HTTP/1.1 chunked-transfer encoding method.

Declaration

public bool ChunkedTransfer { get; set; }

Property Value

Type	Description
Boolean

Compression

Build compression.

Declaration

public BundledAssetGroupSchema.BundleCompressionMode Compression { get; set; }

Property Value

Type	Description
BundledAssetGroupSchema.BundleCompressionMode

ForceUniqueProvider

If true, the bundle and asset provider for assets in this group will get unique provider ids and will only provide for assets in this group.

Declaration

public bool ForceUniqueProvider { get; set; }

Property Value

Type	Description
Boolean

HostingServicesContentRoot

Returns the Hosting Service content root path for the given AddressableAssetGroup

Declaration

public string HostingServicesContentRoot { get; }

Property Value

Type	Description
String

Implements

IHostingServiceConfigurationProvider.HostingServicesContentRoot

IncludeInBuild

If true, the assets in this group will be included in the build of bundles.

Declaration

public bool IncludeInBuild { get; set; }

Property Value

Type	Description
Boolean

LoadPath

The path to load bundles from.

Declaration

public ProfileValueReference LoadPath { get; }

Property Value

Type	Description
ProfileValueReference

RedirectLimit

Indicates the number of redirects which this UnityWebRequest will follow before halting with a “Redirect Limit Exceeded” system error.

Declaration

public int RedirectLimit { get; set; }

Property Value

Type	Description
Int32

RetryCount

Indicates the number of times the request will be retried.

Declaration

public int RetryCount { get; set; }

Property Value

Type	Description
Int32

Timeout

Sets UnityWebRequest to attempt to abort after the number of seconds in timeout have passed.

Declaration

public int Timeout { get; set; }

Property Value

Type	Description
Int32

UseAssetBundleCache

If true, the CRC and Hash values of the asset bundle are used to determine if a bundle can be loaded from the local cache instead of downloaded.

Declaration

public bool UseAssetBundleCache { get; set; }

Property Value

Type	Description
Boolean

UseAssetBundleCrc

If true, the CRC and Hash values of the asset bundle are used to determine if a bundle can be loaded from the local cache instead of downloaded.

Declaration

public bool UseAssetBundleCrc { get; set; }

Property Value

Type	Description
Boolean

UseAssetBundleCrcForCachedBundles

If true, the CRC and Hash values of the asset bundle are used to determine if a bundle can be loaded from the local cache instead of downloaded.

Declaration

public bool UseAssetBundleCrcForCachedBundles { get; set; }

Property Value

Type	Description
Boolean

Methods

GetAssetCachedProviderId()

Returns the id of the asset provider needed to load from this group.

Declaration

public string GetAssetCachedProviderId()

Returns

Type	Description
String	The id of the cached provider needed for this group.

GetBuildCompressionForBundle(String)

Gets the build compression settings for bundles in this group.

Declaration

public virtual BuildCompression GetBuildCompressionForBundle(string bundleId)

Parameters

Type	Name	Description
String	bundleId

Returns

Type	Description
BuildCompression	The build compression.

GetBundleCachedProviderId()

Returns the id of the bundle provider needed to load from this group.

Declaration

public string GetBundleCachedProviderId()

Returns

Type	Description
String	The id of the cached provider needed for this group.

OnAfterDeserialize()

Impementation of ISerializationCallbackReceiver, used to set callbacks for ProfileValueReference changes.

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

Impementation of ISerializationCallbackReceiver, does nothing.

Declaration

public void OnBeforeSerialize()

OnGUI()

Used to display the GUI of the schema.

Declaration

public override void OnGUI()

Overrides

AddressableAssetGroupSchema.OnGUI()

OnGUIMultiple(List<AddressableAssetGroupSchema>)

Used to display the GUI of multiple selected groups.

Declaration

public override void OnGUIMultiple(List<AddressableAssetGroupSchema> otherSchemas)

Parameters

Type	Name	Description
List<AddressableAssetGroupSchema>	otherSchemas	Schema instances in the other selected groups

Overrides

AddressableAssetGroupSchema.OnGUIMultiple(List<AddressableAssetGroupSchema>)

OnSetGroup(AddressableAssetGroup)

Set default values taken from the assigned group.

Declaration

protected override void OnSetGroup(AddressableAssetGroup group)

Parameters

Type	Name	Description
AddressableAssetGroup	group	The group this schema has been added to.

Overrides

AddressableAssetGroupSchema.OnSetGroup(AddressableAssetGroup)

ShowAllProperties()

Used for drawing properties in the inspector.

Declaration

public override void ShowAllProperties()

Overrides

AddressableAssetGroupSchema.ShowAllProperties()