docs.unity3d.com
    Show / Hide Table of Contents

    Class XRConfigurationDataAttribute

    This attribute is used to tag classes as providing build settings support for an XR provider. The unified setting system will present the settings as an inspectable object in the Unified Settings window using the built-in inspector UI.

    The implementor of the settings is able to create their own custom UI and the Unified Settings system will use that UI in place of the build in inspector. See the <a href="https://docs.unity3d.com/Manual/ExtendingTheEditor.html">>Extending the Editor</a> portion of the Unity documentation for information and instructions on doing this.

    Inheritance
    Object
    XRConfigurationDataAttribute
    Namespace: UnityEngine.XR.Management
    Syntax
    public sealed class XRConfigurationDataAttribute : Attribute

    Constructors

    XRConfigurationDataAttribute(String, String)

    Constructor for attribute

    Declaration
    public XRConfigurationDataAttribute(string displayName, string buildSettingsKey)
    Parameters
    Type Name Description
    String displayName

    The display name to use in the Project Settings window.

    String buildSettingsKey

    The key to use to get/set build settings with.

    Properties

    buildSettingsKey

    The key that will be used to store the singleton instance of these settings within EditorBuildSettings.

    See <a href="https://docs.unity3d.com/ScriptReference/EditorBuildSettings.html">EditorBuildSettings</a> scripting API documentation on how this is beign done.

    Declaration
    public string buildSettingsKey { get; set; }
    Property Value
    Type Description
    String

    displayName

    The display name to be presented to the user in the Unified Settings window.

    Declaration
    public string displayName { get; set; }
    Property Value
    Type Description
    String
    Back to top
    Terms of use
    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