Class BaseHostingService
Inheritance
System.Object
BaseHostingService
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
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
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
Declaration
public abstract bool IsHostingServiceRunning { get; }
Property Value
Type |
Description |
System.Boolean |
|
Implements
Logger
Declaration
public ILogger Logger { get; set; }
Property Value
Implements
ProfileVariables
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 |
|
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()
Declaration
public abstract void OnGUI()
Implements
StartHostingService()
Declaration
public abstract void StartHostingService()
Implements
StopHostingService()
Declaration
public abstract void StopHostingService()
Implements
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.