s&box docs
API ReferenceFacepunch.ActionGraphs

Variableclass

Variables have a name and type, and are local to each invocation of an `Facepunch.ActionGraphs.Variable.ActionGraph`. They are assigned with a `!:NodeLibrary.SetVar` node, and read with `!:NodeLibrary.GetVar`.

object→Variable
Namespace
Facepunch.ActionGraphs
Assembly
Facepunch.ActionGraphs
Declaration
public class Facepunch.ActionGraphs.Variable

Methods1

Showing 1 methods

public void Remove()PUBLIC

Remove this variable from its action graph. This will clear any references to it.

Returns:void—

Properties8

Showing 8 properties

public object Facepunch.ActionGraphs.Variable.DefaultValue { get; set; }PUBLICGETSET

Initial value of the variable before being assigned.

Returns:object—

public virtual sealed bool Facepunch.ActionGraphs.Variable.IsValid { get; set; }PUBLICVIRTUALGETSET

Becomes false when this variable is removed.

Returns:bool—

public string Facepunch.ActionGraphs.Variable.Name { get; set; }PUBLICGETSET

The name of this variable, unique in its action graph.

Returns:string—

public System.Collections.Generic.IEnumerable`1<Facepunch.ActionGraphs.Node.Property> Facepunch.ActionGraphs.Variable.References { get; set; }PUBLICGETSET

All node properties that currently reference this variable.

Returns:IEnumerable<Property>—

public virtual sealed string Facepunch.ActionGraphs.Variable.StackTraceIdentifier { get; set; }PUBLICVIRTUALGETSET

Returns:string—

public System.Type Facepunch.ActionGraphs.Variable.Type { get; set; }PUBLICGETSET

Value type stored in this variable.

Returns:Type—

public System.Text.Json.Nodes.JsonObject Facepunch.ActionGraphs.Variable.UserData { get; set; }PUBLICGETSET

Arbitrary named values stored in this variable, which will be included during serialization. Values must be serializable to JSON.

Returns:JsonObject—

Related Guides

→Attributes and Variables→File System→C# Shader Nodes→Dynamic Reflections→Editor Events→IsValid

ValidationMessage.ctor()

Previous Page

ActionGraph

Next Page

On this page

Methodspublic System.Void Remove()Propertiespublic virtual sealed Facepunch.ActionGraphs.ActionGraph Facepunch.ActionGraphs.Variable.ActionGraph { get; set; }public System.Object Facepunch.ActionGraphs.Variable.DefaultValue { get; set; }public virtual sealed System.Boolean Facepunch.ActionGraphs.Variable.IsValid { get; set; }public System.String Facepunch.ActionGraphs.Variable.Name { get; set; }public System.Collections.Generic.IEnumerable`1<Facepunch.ActionGraphs.Node.Property> Facepunch.ActionGraphs.Variable.References { get; set; }public virtual sealed System.String Facepunch.ActionGraphs.Variable.StackTraceIdentifier { get; set; }public System.Type Facepunch.ActionGraphs.Variable.Type { get; set; }public System.Text.Json.Nodes.JsonObject Facepunch.ActionGraphs.Variable.UserData { get; set; }Metadata