docs.unity3d.com
    Show / Hide Table of Contents

    Class ARCoreSettings

    Holds settings that are used to configure the Google ARCore XR Plug-in.

    Inheritance
    Object
    UnityEngine.Object
    UnityEngine.ScriptableObject
    ARCoreSettings
    Inherited Members
    UnityEngine.ScriptableObject.SetDirty()
    UnityEngine.ScriptableObject.CreateInstance(System.String)
    UnityEngine.ScriptableObject.CreateInstance(System.Type)
    UnityEngine.ScriptableObject.CreateInstance<T>()
    UnityEngine.Object.GetInstanceID()
    UnityEngine.Object.GetHashCode()
    UnityEngine.Object.Equals(System.Object)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
    UnityEngine.Object.Instantiate(UnityEngine.Object)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)
    UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)
    UnityEngine.Object.Instantiate<T>(T)
    UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion)
    UnityEngine.Object.Instantiate<T>(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)
    UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform)
    UnityEngine.Object.Instantiate<T>(T, UnityEngine.Transform, System.Boolean)
    UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)
    UnityEngine.Object.Destroy(UnityEngine.Object)
    UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)
    UnityEngine.Object.DestroyImmediate(UnityEngine.Object)
    UnityEngine.Object.FindObjectsOfType(System.Type)
    UnityEngine.Object.FindObjectsOfType(System.Type, System.Boolean)
    UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)
    UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)
    UnityEngine.Object.DestroyObject(UnityEngine.Object)
    UnityEngine.Object.FindSceneObjectsOfType(System.Type)
    UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)
    UnityEngine.Object.FindObjectsOfType<T>()
    UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
    UnityEngine.Object.FindObjectOfType<T>()
    UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
    UnityEngine.Object.FindObjectsOfTypeAll(System.Type)
    UnityEngine.Object.FindObjectOfType(System.Type)
    UnityEngine.Object.FindObjectOfType(System.Type, System.Boolean)
    UnityEngine.Object.ToString()
    UnityEngine.Object.name
    UnityEngine.Object.hideFlags
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: UnityEditor.XR.ARCore
    Syntax
    [Serializable]
    [XRConfigurationData("Google ARCore", "UnityEditor.XR.ARCore.ARCoreSettings")]
    public class ARCoreSettings : ScriptableObject

    Properties

    currentSettings

    The ARCoreSettings for the Project.

    Declaration
    public static ARCoreSettings currentSettings { get; set; }
    Property Value
    Type Description
    ARCoreSettings
    Remarks

    The current settings object, if one exists, is saved in the Project's XR Settings folder. You can also view and modify these settings in the XR Plug-in Management section of your Project Settings window.

    depth

    Specifies whether depth is required or optional for this app.

    Declaration
    public ARCoreSettings.Requirement depth { get; set; }
    Property Value
    Type Description
    ARCoreSettings.Requirement
    Remarks

    Set to Required if the app should only be downloadable by devices with depth support.

    ignoreGradleVersion

    Whether to validate the Gradle version during a Player build.

    Declaration
    public bool ignoreGradleVersion { get; set; }
    Property Value
    Type Description
    Boolean
    Remarks

    When building an Android Player with ARCore enabled, this ARCore package checks the Gradle version and warns if it determines the Gradle version to be too low. You can suppress this check (and resulting warning notification) by setting ignoreGradleVersion to true.

    requirement

    Specifies whether ARCore is required or optional for this app.

    Declaration
    public ARCoreSettings.Requirement requirement { get; set; }
    Property Value
    Type Description
    ARCoreSettings.Requirement
    Remarks

    Set to Required if the app should only be downloadable by devices with ARCore support.

    Methods

    GetOrCreateSettings()

    Gets the currently selected settings, or creates a default one if no ARCoreSettings has been set in Project Settings.

    Declaration
    public static ARCoreSettings GetOrCreateSettings()
    Returns
    Type Description
    ARCoreSettings

    The ARCore settings to use for the current Player build.

    Remarks

    The current settings object, if one exists, is saved in the Project's XR Settings folder. You can also view and modify these settings in the XR Plug-in Management section of your Project Settings window.

    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