⮞ Go to NeoFPS.com

    Show / Hide Table of Contents

    Class SettingsContextBase

    Inheritance
    Object
    SettingsContextBase
    SettingsContext<T>
    Namespace: NeoFPS
    Assembly: NeoFPS.dll
    Syntax
    public abstract class SettingsContextBase : ScriptableObject

    Properties

    contextName

    Declaration
    protected abstract string contextName { get; }
    Property Value
    Type Description
    System.String

    dirty

    Declaration
    public bool dirty { get; protected set; }
    Property Value
    Type Description
    System.Boolean

    displayTitle

    Declaration
    public abstract string displayTitle { get; }
    Property Value
    Type Description
    System.String

    tocID

    Declaration
    public abstract string tocID { get; }
    Property Value
    Type Description
    System.String

    tocName

    Declaration
    public abstract string tocName { get; }
    Property Value
    Type Description
    System.String

    Methods

    CheckIfCurrent()

    Declaration
    protected abstract bool CheckIfCurrent()
    Returns
    Type Description
    System.Boolean

    DeleteSaveFile()

    Declaration
    public void DeleteSaveFile()

    GetBool(String, Boolean)

    Declaration
    protected bool GetBool(string key, bool defaultValue)
    Parameters
    Type Name Description
    System.String key
    System.Boolean defaultValue
    Returns
    Type Description
    System.Boolean

    GetBoolArray(String, Boolean[])

    Declaration
    protected bool[] GetBoolArray(string key, bool[] defaultValue)
    Parameters
    Type Name Description
    System.String key
    System.Boolean[] defaultValue
    Returns
    Type Description
    System.Boolean[]

    GetColor(String, Color)

    Declaration
    protected Color GetColor(string key, Color defaultValue)
    Parameters
    Type Name Description
    System.String key
    Color defaultValue
    Returns
    Type Description
    Color

    GetColorArray(String, Color[])

    Declaration
    protected Color[] GetColorArray(string key, Color[] defaultValue)
    Parameters
    Type Name Description
    System.String key
    Color[] defaultValue
    Returns
    Type Description
    Color[]

    GetFloat(String, Single)

    Declaration
    protected float GetFloat(string key, float defaultValue)
    Parameters
    Type Name Description
    System.String key
    System.Single defaultValue
    Returns
    Type Description
    System.Single

    GetFloatArray(String, Single[])

    Declaration
    protected float[] GetFloatArray(string key, float[] defaultValue)
    Parameters
    Type Name Description
    System.String key
    System.Single[] defaultValue
    Returns
    Type Description
    System.Single[]

    GetInt(String, Int32)

    Declaration
    protected int GetInt(string key, int defaultValue)
    Parameters
    Type Name Description
    System.String key
    System.Int32 defaultValue
    Returns
    Type Description
    System.Int32

    GetIntArray(String, Int32[])

    Declaration
    protected int[] GetIntArray(string key, int[] defaultValue)
    Parameters
    Type Name Description
    System.String key
    System.Int32[] defaultValue
    Returns
    Type Description
    System.Int32[]

    GetString(String, String)

    Declaration
    protected string GetString(string key, string defaultValue)
    Parameters
    Type Name Description
    System.String key
    System.String defaultValue
    Returns
    Type Description
    System.String

    GetStringArray(String, String[])

    Declaration
    protected string[] GetStringArray(string key, string[] defaultValue)
    Parameters
    Type Name Description
    System.String key
    System.String[] defaultValue
    Returns
    Type Description
    System.String[]

    GetVector2(String, Vector2)

    Declaration
    protected Vector2 GetVector2(string key, Vector2 defaultValue)
    Parameters
    Type Name Description
    System.String key
    Vector2 defaultValue
    Returns
    Type Description
    Vector2

    GetVector2Array(String, Vector2[])

    Declaration
    protected Vector2[] GetVector2Array(string key, Vector2[] defaultValue)
    Parameters
    Type Name Description
    System.String key
    Vector2[] defaultValue
    Returns
    Type Description
    Vector2[]

    GetVector3(String, Vector3)

    Declaration
    protected Vector3 GetVector3(string key, Vector3 defaultValue)
    Parameters
    Type Name Description
    System.String key
    Vector3 defaultValue
    Returns
    Type Description
    Vector3

    GetVector3Array(String, Vector3[])

    Declaration
    protected Vector3[] GetVector3Array(string key, Vector3[] defaultValue)
    Parameters
    Type Name Description
    System.String key
    Vector3[] defaultValue
    Returns
    Type Description
    Vector3[]

    Load()

    Declaration
    public virtual void Load()

    OnLoad()

    Declaration
    public virtual void OnLoad()

    OnSave()

    Declaration
    public virtual void OnSave()

    Save()

    Declaration
    public virtual void Save()

    SetBool(String, Boolean)

    Declaration
    protected void SetBool(string key, bool to)
    Parameters
    Type Name Description
    System.String key
    System.Boolean to

    SetBoolArray(String, Boolean[])

    Declaration
    protected void SetBoolArray(string key, bool[] to)
    Parameters
    Type Name Description
    System.String key
    System.Boolean[] to

    SetColor(String, Color)

    Declaration
    protected void SetColor(string key, Color to)
    Parameters
    Type Name Description
    System.String key
    Color to

    SetColorArray(String, Color[])

    Declaration
    protected void SetColorArray(string key, Color[] to)
    Parameters
    Type Name Description
    System.String key
    Color[] to

    SetFloat(String, Single)

    Declaration
    protected void SetFloat(string key, float to)
    Parameters
    Type Name Description
    System.String key
    System.Single to

    SetFloatArray(String, Single[])

    Declaration
    protected void SetFloatArray(string key, float[] to)
    Parameters
    Type Name Description
    System.String key
    System.Single[] to

    SetInt(String, Int32)

    Declaration
    protected void SetInt(string key, int to)
    Parameters
    Type Name Description
    System.String key
    System.Int32 to

    SetIntArray(String, Int32[])

    Declaration
    protected void SetIntArray(string key, int[] to)
    Parameters
    Type Name Description
    System.String key
    System.Int32[] to

    SetString(String, String)

    Declaration
    protected void SetString(string key, string to)
    Parameters
    Type Name Description
    System.String key
    System.String to

    SetStringArray(String, String[])

    Declaration
    protected void SetStringArray(string key, string[] to)
    Parameters
    Type Name Description
    System.String key
    System.String[] to

    SetVector2(String, Vector2)

    Declaration
    protected void SetVector2(string key, Vector2 to)
    Parameters
    Type Name Description
    System.String key
    Vector2 to

    SetVector2Array(String, Vector2[])

    Declaration
    protected void SetVector2Array(string key, Vector2[] to)
    Parameters
    Type Name Description
    System.String key
    Vector2[] to

    SetVector3(String, Vector3)

    Declaration
    protected void SetVector3(string key, Vector3 to)
    Parameters
    Type Name Description
    System.String key
    Vector3 to

    SetVector3Array(String, Vector3[])

    Declaration
    protected void SetVector3Array(string key, Vector3[] to)
    Parameters
    Type Name Description
    System.String key
    Vector3[] to
    Back to top Copyright © 2019 Yondernauts Game Studios Ltd
    Generated with DocFX