Class AddressableAssetSettings | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class AddressableAssetSettings

    TODO - doc

    Inheritance
    System.Object
    AddressableAssetSettings
    Namespace: UnityEditor.AddressableAssets
    Syntax
    public class AddressableAssetSettings : ScriptableObject, ISerializationCallbackReceiver

    Fields

    DefaultConfigFolder

    Declaration
    public const string DefaultConfigFolder = "Assets/AddressableAssetsData"
    Field Value
    Type Description
    System.String

    DefaultConfigName

    Declaration
    public const string DefaultConfigName = "AddressableAssetSettings"
    Field Value
    Type Description
    System.String

    OnModification

    TODO - doc

    Declaration
    public Action<AddressableAssetSettings, AddressableAssetSettings.ModificationEvent, object> OnModification
    Field Value
    Type Description
    Action<AddressableAssetSettings, AddressableAssetSettings.ModificationEvent, System.Object>

    Properties

    activeProfileId

    TODO - doc

    Declaration
    public string activeProfileId { get; set; }
    Property Value
    Type Description
    System.String

    buildSettings

    TODO - doc

    Declaration
    public AddressableAssetSettings.BuildSettings buildSettings { get; }
    Property Value
    Type Description
    AddressableAssetSettings.BuildSettings

    currentHash

    Declaration
    public Hash128 currentHash { get; }
    Property Value
    Type Description
    Hash128

    DefaultGroup

    TODO - doc

    Declaration
    public AddressableAssetGroup DefaultGroup { get; }
    Property Value
    Type Description
    AddressableAssetGroup

    groups

    TODO - doc

    Declaration
    public List<AddressableAssetGroup> groups { get; }
    Property Value
    Type Description
    System.Collections.Generic.List<AddressableAssetGroup>

    profileSettings

    TODO - doc

    Declaration
    public AddressableAssetSettings.ProfileSettings profileSettings { get; }
    Property Value
    Type Description
    AddressableAssetSettings.ProfileSettings

    Methods

    AddLabel(String, Boolean)

    TODO - doc

    Declaration
    public void AddLabel(string label, bool postEvent = true)
    Parameters
    Type Name Description
    System.String label
    System.Boolean postEvent

    ConvertGroup(AddressableAssetGroup, String)

    Declaration
    public void ConvertGroup(AddressableAssetGroup group, string processorType)
    Parameters
    Type Name Description
    AddressableAssetGroup group
    System.String processorType

    CreateGroup(String, String, Boolean)

    TODO - doc

    Declaration
    public AddressableAssetGroup CreateGroup(string name, string processorType, bool setAsDefaultGroup = false)
    Parameters
    Type Name Description
    System.String name
    System.String processorType
    System.Boolean setAsDefaultGroup
    Returns
    Type Description
    AddressableAssetGroup

    CreateOrMoveEntry(String, AddressableAssetGroup, Boolean, Boolean)

    TODO - doc

    Declaration
    public AddressableAssetEntry CreateOrMoveEntry(string guid, AddressableAssetGroup targetParent, bool readOnly = false, bool postEvent = true)
    Parameters
    Type Name Description
    System.String guid
    AddressableAssetGroup targetParent
    System.Boolean readOnly
    System.Boolean postEvent
    Returns
    Type Description
    AddressableAssetEntry

    FindAssetEntry(String)

    TODO - doc

    Declaration
    public AddressableAssetEntry FindAssetEntry(string guid)
    Parameters
    Type Name Description
    System.String guid
    Returns
    Type Description
    AddressableAssetEntry

    FindGroup(String)

    Declaration
    public AddressableAssetGroup FindGroup(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type Description
    AddressableAssetGroup

    GetAllAssets()

    Declaration
    public List<AddressableAssetEntry> GetAllAssets()
    Returns
    Type Description
    System.Collections.Generic.List<AddressableAssetEntry>

    GetDefault(Boolean, Boolean)

    Declaration
    public static AddressableAssetSettings GetDefault(bool create, bool browse)
    Parameters
    Type Name Description
    System.Boolean create
    System.Boolean browse
    Returns
    Type Description
    AddressableAssetSettings

    GetLabelMask(HashSet<String>)

    TODO - doc

    Declaration
    public long GetLabelMask(HashSet<string> maskSet)
    Parameters
    Type Name Description
    HashSet<System.String> maskSet
    Returns
    Type Description
    System.Int64

    IsNotUniqueGroupName(String)

    Declaration
    public bool IsNotUniqueGroupName(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type Description
    System.Boolean

    MoveAssetsFromResources(Dictionary<String, String>, AddressableAssetGroup)

    TODO - doc

    Declaration
    public void MoveAssetsFromResources(Dictionary<string, string> guidToNewPath, AddressableAssetGroup targetParent)
    Parameters
    Type Name Description
    System.Collections.Generic.Dictionary<System.String, System.String> guidToNewPath
    AddressableAssetGroup targetParent

    OnAfterDeserialize()

    Declaration
    public void OnAfterDeserialize()

    OnBeforeSerialize()

    Declaration
    public void OnBeforeSerialize()

    RemoveAssetEntry(String, Boolean)

    Declaration
    public bool RemoveAssetEntry(string guid, bool postEvent = true)
    Parameters
    Type Name Description
    System.String guid
    System.Boolean postEvent
    Returns
    Type Description
    System.Boolean

    RemoveGroup(AddressableAssetGroup, Boolean)

    TODO - doc

    Declaration
    public void RemoveGroup(AddressableAssetGroup g, bool postEvent = true)
    Parameters
    Type Name Description
    AddressableAssetGroup g
    System.Boolean postEvent

    RemoveLabel(String, Boolean)

    TODO - doc

    Declaration
    public void RemoveLabel(string label, bool postEvent = true)
    Parameters
    Type Name Description
    System.String label
    System.Boolean postEvent
    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