Class AddressableAssetGroupSchemaSet | Addressables | 1.13.1
docs.unity3d.com
    Show / Hide Table of Contents

    Class AddressableAssetGroupSchemaSet

    Collection of AddressableAssetGroupSchema objects

    Inheritance
    Object
    AddressableAssetGroupSchemaSet
    Inherited Members
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEditor.AddressableAssets.Settings
    Syntax
    [Serializable]
    public class AddressableAssetGroupSchemaSet

    Properties

    Schemas

    List of schemas for this group.

    Declaration
    public List<AddressableAssetGroupSchema> Schemas { get; }
    Property Value
    Type Description
    List<AddressableAssetGroupSchema>

    Types

    Get the list of schema types.

    Declaration
    public List<Type> Types { get; }
    Property Value
    Type Description
    List<Type>

    Methods

    AddSchema(Type, Func<Type, String>)

    Creates and adds a schema of a given type to this group. The schema asset will be created in the GroupSchemas directory relative to the settings asset.

    Declaration
    public AddressableAssetGroupSchema AddSchema(Type type, Func<Type, string> pathFunc)
    Parameters
    Type Name Description
    Type type

    The schema type. This type must not already be added.

    Func<Type, String> pathFunc

    A function that returns the path where this method can save the schema asset. Set to null to not create an in-project asset.

    Returns
    Type Description
    AddressableAssetGroupSchema

    The created schema object.

    AddSchema(AddressableAssetGroupSchema, Func<Type, String>)

    Adds a copy of the provided schema object.

    Declaration
    public AddressableAssetGroupSchema AddSchema(AddressableAssetGroupSchema schema, Func<Type, string> pathFunc)
    Parameters
    Type Name Description
    AddressableAssetGroupSchema schema

    The schema to copy.

    Func<Type, String> pathFunc

    A function that returns the path where this method can save the schema asset. Set to null to not create an in-project asset.

    Returns
    Type Description
    AddressableAssetGroupSchema

    The created schema object.

    ClearSchemas(Boolean)

    Removes all schemas and optionally deletes the assets associated with them.

    Declaration
    public void ClearSchemas(bool deleteAssets)
    Parameters
    Type Name Description
    Boolean deleteAssets

    If true, the schema assets will also be deleted.

    GetSchema(Type)

    Gets an added schema of the specified type.

    Declaration
    public AddressableAssetGroupSchema GetSchema(Type type)
    Parameters
    Type Name Description
    Type type

    The schema type.

    Returns
    Type Description
    AddressableAssetGroupSchema

    The schema if found, otherwise null.

    RemoveSchema(Type)

    Remove a given schema from this group.

    Declaration
    public bool RemoveSchema(Type type)
    Parameters
    Type Name Description
    Type type

    The schema type.

    Returns
    Type Description
    Boolean

    True if the schema was found and removed, false otherwise.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023