s&box docs
API ReferenceFacepunch.ActionGraphs

public class Facepunch.ActionGraphs.Variable

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`.

Broader workflow and conceptual references connected to this API.

Attributes and Variables

Attributes are the bridge to pass information around the CPU to the GPU, like Variables, Textures or entire Buffers.

File System

Standard .NET file access is restricted to prevent rogue access to your files, this means you can not use System.IO.File or variants directly.

C# Shader Nodes

Just like Subgraphs, you can also create your own custom Nodes with C# (and shader code) to be used in Shader Graphs.

Dynamic Reflections

Much like SSAO, you can composite dynamic specular reflections on your object, whether they are SSR or eventually Raytraced Reflections

Editor Events

Editor Events are events that are broadcast globally throughout the editor and can be listened to/fired from any Editor Project. These are useful for creating your own custom Editor Tools and making sure they can work in tandem with existing systems.

Razor Panels

UI can also be created using Razor, which allows you to use web-like HTML/CSS to create and style each Panel while also being able to leverage C#.

Methods

Showing 1 methods

public void Remove()

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

Properties

Showing 8 properties

public virtual sealed Facepunch.ActionGraphs.ActionGraph Facepunch.ActionGraphs.Variable.ActionGraph { get; set; }

The action graph this variable belongs to.

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

Initial value of the variable before being assigned.

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

Becomes false when this variable is removed.

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

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

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

All node properties that currently reference this variable.

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

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

Value type stored in this variable.

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

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

Metadata

FieldValue
NamespaceFacepunch.ActionGraphs
Typeclass
AssemblyFacepunch.ActionGraphs
Doc IDT:Facepunch.ActionGraphs.Variable

ValidationMessage

Previous Page

VoidTaskFaultHandler

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