docs.unity3d.com
    Show / Hide Table of Contents

    Class EditorGameServiceFlagEnabler

    Base class for services which require service flag handling when toggling.

    Inheritance
    Object
    EditorGameServiceFlagEnabler
    Namespace: Unity.Services.Core.Editor
    Syntax
    public abstract class EditorGameServiceFlagEnabler : IEditorGameServiceEnabler

    Properties

    FlagName

    Name of the service in the services flags API

    Declaration
    protected abstract string FlagName { get; }
    Property Value
    Type Description
    String

    Methods

    Disable()

    Also sends an API request to disable the service on the dashboard.

    Declaration
    public void Disable()
    Implements
    IEditorGameServiceEnabler.Disable()

    DisableLocalSettings()

    Disables service.

    Declaration
    protected abstract void DisableLocalSettings()

    Enable()

    Also sends an API request to disable the service on the dashboard.

    Declaration
    public void Enable()
    Implements
    IEditorGameServiceEnabler.Enable()

    EnableLocalSettings()

    Enables the service

    Declaration
    protected abstract void EnableLocalSettings()

    IsEnabled()

    Gets the enablement status of the service

    Declaration
    public abstract bool IsEnabled()
    Returns
    Type Description
    Boolean

    The status of the service

    Implements
    IEditorGameServiceEnabler.IsEnabled()

    Events

    ServiceFlagRequestComplete

    The event fired when the web request that handles setting the service flag is complete

    Declaration
    public event Action ServiceFlagRequestComplete
    Event Type
    Type Description
    Action
    Remarks

    This event is only raised when the constant

    ENABLE_EDITOR_GAME_SERVICES
    is defined. Kept outside of this define to avoid an API breaking change.

    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