docs.unity3d.com
    Show / Hide Table of Contents

    Class BaseSetting<T>

    Base class for implementing Tutorial Framework settings.

    Inheritance
    Object
    UserSetting<T>
    BaseSetting<T>
    ProjectSetting<T>
    UserSetting<T>
    Inherited Members
    UserSetting<T>.GetDefaultValue()
    UserSetting<T>.GetValue()
    UserSetting<T>.SetValue(Object, Boolean)
    UserSetting<T>.SetValue(T, Boolean)
    UserSetting<T>.Delete(Boolean)
    UserSetting<T>.ApplyModifiedProperties()
    UserSetting<T>.Reset(Boolean)
    UserSetting<T>.ToString()
    UserSetting<T>.key
    UserSetting<T>.settingsRepositoryName
    UserSetting<T>.type
    UserSetting<T>.scope
    UserSetting<T>.settings
    UserSetting<T>.defaultValue
    UserSetting<T>.value
    Namespace: Unity.InteractiveTutorials
    Syntax
    public class BaseSetting<T> : UserSetting<T>, IUserSetting
    Type Parameters
    Name Description
    T

    Constructors

    BaseSetting(String, String, T, SettingsScope, String)

    Constructs the setting.

    Declaration
    public BaseSetting(string key, string name, T value, SettingsScope scope, string tooltip = null)
    Parameters
    Type Name Description
    String key

    Key for EditorPrefs (User) or JSON file (Project).

    String name

    Use Tr() in order to have localization support.

    T value
    SettingsScope scope
    String tooltip

    Use Tr() in order to have localization support.

    Properties

    Name

    Name of the setting.

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

    Tooltip

    Tooltip for the setting.

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

    Methods

    GetGuiContent()

    Returns Name and Tooltip as GUIContent.

    Declaration
    public GUIContent GetGuiContent()
    Returns
    Type Description
    GUIContent
    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