ScriptableValue<T> Class

Definition

A ScriptableValue<T> that holds a value of type T.

C#

public abstract class ScriptableValue<T> : ScriptableValue, INotifyPropertyChanging, INotifyPropertyChanged, IStackTraceProvider, ICanBeReadOnly

Type Parameters

T
The type of the value.

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

Implements INotifyPropertyChanging, INotifyPropertyChanged, IStackTraceProvider, ICanBeReadOnly

Properties

Value

The current value. This can be changed at runtime.

C#

[CreateProperty]
public T Value { get; set; }

PreviousValue

The previous value before the current value was set.

C#

[CreateProperty]
public T PreviousValue { get; }

DefaultValue

The default value. This is used when the value is reset.

C#

[CreateProperty]
public T DefaultValue { get; set; }

Methods

OnBeforeSetValue(T, T)

Called before the value is set. This can be used to prevent the value from being set.

C#

protected virtual bool OnBeforeSetValue(T oldValue, T newValue)

Parameters

oldValue T
The current value.

newValue T
The new value that is going to be set.

Returns

bool
true if the value can be set; otherwise, false.

Remarks

This is called before the OnValueChanging event. This is also called no matter what notify is set as.

OnAfterSetValue(T, T)

Called when the value is set. This can be used to do something when the value is set.

C#

protected virtual void OnAfterSetValue(T oldValue, T newValue)

Parameters

oldValue T
The old value that was set.

newValue T
The new value that was set.

Remarks

This is called before the OnValueChanged event. This is also called no matter what notify is set as.

IsSameValue(T, T)

Helper method to check if the new value is the same as the old value.

C#

protected bool IsSameValue(T newValue, T oldValue)

Parameters

newValue T
Thew new value.

oldValue T
The old value.

Returns

bool
true if the values are the same; otherwise, false.

SetValueWithoutNotify(T)

Sets the current value without invoking the OnValueChanging and OnValueChanged events.

C#

public void SetValueWithoutNotify(T newValue)

Parameters

newValue T
The new value.

OnPreStart()

Called when the game starts, before OnStart().

You should not subscribe to events in this method! Use OnStart() instead. OnPreStart() should be used for preparing the scriptable object.

C#

protected override void OnPreStart()

Remarks

If this isn’t called when the game starts, it’s called once this scriptable object is loaded and instantiated.

OnDisabled()

Called when the game is ending, after OnPreDisabled().

You should not unsubscribe from events in this method! Use OnPreDisabled() instead. OnDisabled() should be used for cleaning up the scriptable object.

C#

protected override void OnDisabled()

Remarks

This can also be called during the game is the scriptable object is destroyed and/or unloaded.

ResetValue()

Resets the value to the default value.

C#

public void ResetValue()

WarnIfLeftOverSubscribers()

Warns if there are any left-over subscribers to the events.

C#

protected override void WarnIfLeftOverSubscribers()

Remarks

This will only be called in the Unity editor and builds with the DEBUG flag.

ClearSubscribers(bool)

Removes any subscribers from the event.

C#

public void ClearSubscribers(bool warnIfLeftOver = false)

Parameters

warnIfLeftOver bool
If true, a warning will be printed in the console if there are any subscribers. The warning will only be printed in the editor and debug builds.

OnValidate()

C#

protected virtual void OnValidate()

Events

OnValueChanging

Called before the current value is set.

C#

public event ValueEventHandler<T>? OnValueChanging

Event Type

ValueEventHandler<T>

OnValueChanged

Called after the current value is set.

C#

public event ValueEventHandler<T>? OnValueChanged

Event Type

ValueEventHandler<T>