Skip to content
Scriptable Values Logo Scriptable Values Documentation

ScriptableValue Class

Definition

Section titled “Definition”

Base class for all ScriptableValue<T>.

C#
[HelpURL("https://hertzole.github.io/scriptable-values/types/scriptable-value")]
public abstract class ScriptableValue : RuntimeScriptableObject, INotifyPropertyChanging, INotifyPropertyChanged, IStackTraceProvider, ICanBeReadOnly

Inheritance object → UnityEngine.Object → UnityEngine.ScriptableObject → RuntimeScriptableObject

Implements INotifyPropertyChanging, INotifyPropertyChanged, IStackTraceProvider, ICanBeReadOnly

Remarks

Section titled “Remarks”

You should probably inherit from ScriptableList<T> instead.

Fields

Section titled “Fields”

isReadOnlyChangingArgs

Section titled “isReadOnlyChangingArgs”
C#
public static readonly PropertyChangingEventArgs isReadOnlyChangingArgs

isReadOnlyChangedArgs

Section titled “isReadOnlyChangedArgs”
C#
public static readonly PropertyChangedEventArgs isReadOnlyChangedArgs

resetValueOnStartChangingArgs

Section titled “resetValueOnStartChangingArgs”
C#
public static readonly PropertyChangingEventArgs resetValueOnStartChangingArgs

resetValueOnStartChangedArgs

Section titled “resetValueOnStartChangedArgs”
C#
public static readonly PropertyChangedEventArgs resetValueOnStartChangedArgs

setEqualityCheckChangingArgs

Section titled “setEqualityCheckChangingArgs”
C#
public static readonly PropertyChangingEventArgs setEqualityCheckChangingArgs

setEqualityCheckChangedArgs

Section titled “setEqualityCheckChangedArgs”
C#
public static readonly PropertyChangedEventArgs setEqualityCheckChangedArgs

valueChangingArgs

Section titled “valueChangingArgs”
C#
public static readonly PropertyChangingEventArgs valueChangingArgs

valueChangedArgs

Section titled “valueChangedArgs”
C#
public static readonly PropertyChangedEventArgs valueChangedArgs

previousValueChangingArgs

Section titled “previousValueChangingArgs”
C#
public static readonly PropertyChangingEventArgs previousValueChangingArgs

previousValueChangedArgs

Section titled “previousValueChangedArgs”
C#
public static readonly PropertyChangedEventArgs previousValueChangedArgs

defaultValueChangingArgs

Section titled “defaultValueChangingArgs”
C#
public static readonly PropertyChangingEventArgs defaultValueChangingArgs

defaultValueChangedArgs

Section titled “defaultValueChangedArgs”
C#
public static readonly PropertyChangedEventArgs defaultValueChangedArgs

Properties

Section titled “Properties”

IsReadOnly

Section titled “IsReadOnly”

If read only, the value cannot be changed at runtime.

C#
[CreateProperty]
public bool IsReadOnly { get; set; }

ResetValueOnStart

Section titled “ResetValueOnStart”

If true, the value will be reset to the default value on play mode start/game boot.

C#
[CreateProperty]
public bool ResetValueOnStart { get; set; }

SetEqualityCheck

Section titled “SetEqualityCheck”

If true, an equality check will be run before setting the value to make sure the new value is not the same as the old one.

C#
[CreateProperty]
public bool SetEqualityCheck { get; set; }