Class AddressableAssetSettings
Inheritance
System.Object
AddressableAssetSettings
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
Declaration
public Action<AddressableAssetSettings, AddressableAssetSettings.ModificationEvent, object> OnModification
Field Value
Properties
activeProfileId
Declaration
public string activeProfileId { get; set; }
Property Value
| Type |
Description |
| System.String |
|
buildSettings
Declaration
public AddressableAssetSettings.BuildSettings buildSettings { get; }
Property Value
currentHash
Declaration
public Hash128 currentHash { get; }
Property Value
DefaultGroup
Declaration
public AddressableAssetGroup DefaultGroup { get; }
Property Value
groups
Declaration
public List<AddressableAssetGroup> groups { get; }
Property Value
profileSettings
Declaration
public AddressableAssetSettings.ProfileSettings profileSettings { get; }
Property Value
Methods
AddLabel(String, Boolean)
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
CreateGroup(String, String, Boolean)
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
CreateOrMoveEntry(String, AddressableAssetGroup, Boolean, Boolean)
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
FindAssetEntry(String)
Declaration
public AddressableAssetEntry FindAssetEntry(string guid)
Parameters
| Type |
Name |
Description |
| System.String |
guid |
|
Returns
FindGroup(String)
Declaration
public AddressableAssetGroup FindGroup(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
GetAllAssets()
Declaration
public List<AddressableAssetEntry> GetAllAssets()
Returns
GetDefault(Boolean, Boolean)
Declaration
public static AddressableAssetSettings GetDefault(bool create, bool browse)
Parameters
| Type |
Name |
Description |
| System.Boolean |
create |
|
| System.Boolean |
browse |
|
Returns
GetLabelMask(HashSet<String>)
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)
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)
Declaration
public void RemoveGroup(AddressableAssetGroup g, bool postEvent = true)
Parameters
RemoveLabel(String, Boolean)
Declaration
public void RemoveLabel(string label, bool postEvent = true)
Parameters
| Type |
Name |
Description |
| System.String |
label |
|
| System.Boolean |
postEvent |
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.