Class BaseHostingService
Base class for hosting services.
Inheritance
Namespace: UnityEditor.AddressableAssets.HostingServices
Syntax
public abstract class BaseHostingService : IHostingService
Properties
DescriptiveName
Set by the HostingServicesManager, primarily used to disambiguate multiple instances of the same service in the GUI.
Declaration
public virtual string DescriptiveName { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Implements
HostingServiceContentRoots
List of content roots for hosting service.
Declaration
public abstract List<string> HostingServiceContentRoots { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.String> |
Implements
InstanceId
uniquely identifies this service within the scope of the HostingServicesManager
Declaration
public virtual int InstanceId { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Implements
IsHostingServiceRunning
Gets the current running status of the hosting service.
Declaration
public abstract bool IsHostingServiceRunning { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Implements
Logger
Get and set the loger for the hosting service.
Declaration
public ILogger Logger { get; set; }
Property Value
| Type | Description |
|---|---|
| ILogger |
Implements
ProfileVariables
Dictionary of profile variables defined by the hosting service.
Declaration
public abstract Dictionary<string, string> ProfileVariables { get; }
Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, System.String> |
Implements
Methods
DisambiguateProfileVar(String)
Declaration
protected virtual string DisambiguateProfileVar(string key)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key |
Returns
| Type | Description |
|---|---|
| System.String |
EvaluateProfileString(String)
Expand special variables from Addressable profiles
Declaration
public virtual string EvaluateProfileString(string key)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | key | Key name to match |
Returns
| Type | Description |
|---|---|
| System.String | replacement string value for key, or null if no match |
Implements
Log(String, Object[])
Declaration
protected void Log(string format, params object[] args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | format | |
| System.Object[] | args |
LogError(String, Object[])
Declaration
protected void LogError(string format, params object[] args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | format | |
| System.Object[] | args |
LogFormat(LogType, String, Object[])
Declaration
protected void LogFormat(LogType logType, string format, object[] args)
Parameters
| Type | Name | Description |
|---|---|---|
| LogType | logType | |
| System.String | format | |
| System.Object[] | args |
LogWarning(String, Object[])
Declaration
protected void LogWarning(string format, params object[] args)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | format | |
| System.Object[] | args |
OnAfterDeserialize(KeyDataStore)
Called immediatley following a domain reload by the HostingServicesManager, for restoring state information after the service is recreated.
Declaration
public virtual void OnAfterDeserialize(KeyDataStore dataStore)
Parameters
| Type | Name | Description |
|---|---|---|
| KeyDataStore | dataStore | A key/value pair data store for use in restoring state information |
Implements
OnBeforeSerialize(KeyDataStore)
Called by the HostingServicesManager before a domain reload, giving the hosting service an opportunity to persist state information.
Declaration
public virtual void OnBeforeSerialize(KeyDataStore dataStore)
Parameters
| Type | Name | Description |
|---|---|---|
| KeyDataStore | dataStore | A key/value pair data store for use in persisting state information |
Implements
OnGUI()
Render the hosting service GUI.
Declaration
public abstract void OnGUI()
Implements
StartHostingService()
Starts the hosting service.
Declaration
public abstract void StartHostingService()
Implements
StopHostingService()
Stops the hosting service.
Declaration
public abstract void StopHostingService()