Class EditorGameServiceSettingsProvider

Base class to extend for an external service settings provider to become an editor game service settings provider

Inheritance

object

SettingsProvider

EditorGameServiceSettingsProvider

Inherited Members

SettingsProvider.OnActivate(string, VisualElement)

SettingsProvider.OnDeactivate()

SettingsProvider.HasSearchInterest(string)

SettingsProvider.OnGUI(string)

SettingsProvider.OnTitleBarGUI()

SettingsProvider.OnFooterBarGUI()

SettingsProvider.OnInspectorUpdate()

SettingsProvider.Repaint()

SettingsProvider.PopulateSearchKeywordsFromGUIContentProperties<T>()

SettingsProvider.GetSearchKeywordsFromGUIContentProperties<T>()

SettingsProvider.GetSearchKeywordsFromSerializedObject(SerializedObject)

SettingsProvider.GetSearchKeywordsFromPath(string)

SettingsProvider.label

SettingsProvider.settingsPath

SettingsProvider.scope

SettingsProvider.keywords

SettingsProvider.guiHandler

SettingsProvider.titleBarGuiHandler

SettingsProvider.footerBarGuiHandler

SettingsProvider.activateHandler

SettingsProvider.deactivateHandler

SettingsProvider.hasSearchInterestHandler

SettingsProvider.inspectorUpdateHandler

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Core.Editor

Assembly: Unity.Services.Core.Editor.dll

Syntax

public abstract class EditorGameServiceSettingsProvider : SettingsProvider

Constructors

EditorGameServiceSettingsProvider(string, SettingsScope, IEnumerable<string>)

Initializes a new instance of the EditorGameServiceSettingsProvider class.

Declaration

protected EditorGameServiceSettingsProvider(string path, SettingsScope scopes, IEnumerable<string> keywords = null)

Parameters

Type	Name	Description
string	path	The path to the settings. You SHOULD use GenerateProjectSettingsPath(string) to provide it.
SettingsScope	scopes	The scope of the provided settings.
IEnumerable<string>	keywords	Set of keywords for search purposes.

Properties

Description

Description of the service that will be displayed in the Project Settings

Declaration

protected abstract string Description { get; }

Property Value

Type	Description
string

EditorGameService

Editor game service for these project settings

Declaration

protected abstract IEditorGameService EditorGameService { get; }

Property Value

Type	Description
IEditorGameService

Title

Title of the service that will be displayed in the Project Settings

Declaration

protected abstract string Title { get; }

Property Value

Type	Description
string

Methods

GenerateProjectSettingsPath(string)

Use this to standardize Service Project Settings path: usage example: var provider = new MyCloudServiceSettings(GenerateProjectSettingsPath("My Cloud Service"), SettingsScope.Project);

Declaration

protected static string GenerateProjectSettingsPath(string serviceName)

Parameters

Type	Name	Description
string	serviceName	Name of the service to use in path

Returns

Type	Description
string	The path to pass as argument to SettingsProvider

GenerateServiceDetailUI()

Builds and return the Services specific UI as a Visual Element

Declaration

protected abstract VisualElement GenerateServiceDetailUI()

Returns

Type	Description
VisualElement	Return the parent node for this settings' detail UI.

GenerateUnsupportedDetailUI()

The UI to show when the editor API does not support the Services SDK Core package

Declaration

protected virtual VisualElement GenerateUnsupportedDetailUI()

Returns

Type	Description
VisualElement	Custom UI to show when unsupported