WatchReference

WatchReference<T> is a struct type returned by most Watch methods, providing straightforward access to common operations for watch variables.

ChildCount

public int ChildCount

Returns the number of child variables. Returns 0 if there are none.

GetChildNames

public IEnumerable<string> GetChildNames()

Retrieves a collection containing the names of all child variables.

GetOrAdd

public WatchReference<V> GetOrAdd<V>(string path)

Retrieves an existing child variable or adds a new one with the specified name path and type V. This method is similar to GetOrAdd().

SetAlwaysCollapsable

public WatchReference<T> SetAlwaysCollapsable()

Configures the variable columns to always be collapsable. If Collapse button is enabled in the Watch window, values from these variables will behave as if they haven't changed. This is useful for constantly changing values, to prevent cluttering.

SetSortOrder

public WatchReference<T> SetSortOrder(int value)

Assigns a sorting order to the variable, determined by the specified value. This functions similarly to scripting execution order in Unity: a higher value places the variable lower in the display order and vice versa. If no sorting order is specified, it defaults to the creation order of the variables, with a float value expected between 0 and 1.

SetDecimalPlaces

public WatchReference<T> SetDecimalPlaces(int value)

Sets the number of decimal places for numeric values. The default is 2. If applied to a non-numeric variable, it has no effect.

SetTitleFormat

public WatchReference<T> SetTitleFormat(WatchTitleFormat format)

Overrides format for the variable's display area.

SetDefaultValueFormat

public WatchReference<T> SetDefaultValueFormat(WatchValueFormat format)

Overrides the default format for the variable's values.

AddConditionalValueFormat

public WatchReference<T> AddConditionalValueFormat(Func<T, bool> condition, WatchValueFormat format)

Defines a rule for formatting values with format based on a condition. condition is a delegate that takes a value of type T and returns whether the condition is met.

If multiple conditions are true for the same value

If multiple positive conditions are present, only the last one will take effect.

public WatchReference<T> AddConditionalValueFormat(Func<T, bool> condition, Func<T, WatchValueFormat> dynamicFormat)

Defines a rule for formatting values, similar to the previous method, but allows for dynamicFormat that determines the format based on the value.

PushValueFormat

public WatchReference<T> PushValueFormat(WatchValueFormat format)

Directly pushes value format to the variable. Pushing formats functions like pushing values and must be done before calling Watch.UpdateAll().

PushExtraText

public WatchReference<T> PushExtraText(string extraText)

Pushes additional text extraText to the variable. Similar to pushing values, this must also be done before Watch.UpdateAll() is called.

PushEmptyValue

public WatchReference<T> PushEmptyValue(bool withRoot = true, int maxRecursionDepth = 10)

Pushes an empty value to the variable and all of its children recursively, constrained by maxRecursionDepth. If withRoot is set to false, the empty value will not be pushed to the target variable itself, only to its children.

SetTraceable

public WatchReference<T> SetTraceable()

Marks variable as Traceable, automatically capturing the stack trace whenever its value is pushed.

Why I don't see the stack trace?

Note that SetTraceable() has no effect on auto-updating variables, as it would only capture the internal Watch.UpdateAll call. In such cases, you can manually push the stack trace using PushStackTrace() (or it's direct version) whenever you're certain the variable value has been changed.

PushStackTrace

public WatchReference<T> PushStackTrace()

Captures and attaches the current invocation stack trace to the variable. Works regardless of whether SetTraceable() is enabled. Like pushing values, this must be called before Watch.UpdateAll().

SetMinMaxModeAsGlobal

public WatchReference<T> SetMinMaxModeAsGlobal()

Sets the variable's min/max calculation mode to global, meaning the values min/max will be determined based on the entire history. By default, it's local, meaning the min/max is calculated only from the values currently visible on screen.

SetMinMaxModeAsCustom

public WatchReference<T> SetMinMaxModeAsCustom(double minValue, double maxValue)

Sets the variable's min/max calculation mode to custom, meaning the min/max values are manually set to the specified minValue and maxValue. By default, it's local, where min/max is calculated only from the values currently visible on screen.

What is min/max mode?

Min/max values are calculated for every variable to determine the fill level of the value cell's progress bar. It doesn't affect anything except the displayed cell visuals.

SetCustomAction

public WatchReference<T> SetCustomAction(string name, Action action)

Adds a custom button to the variable info area. name defines the button's text, and action specifies the function to execute when the button is clicked.