API ReferenceFacepunch.ActionGraphs

Linkclass

A link connects one `Facepunch.ActionGraphs.Node.Input` to a `Facepunch.ActionGraphs.Node.Output`. They can either transmit values or signals. A signal will trigger the receiving node to act when the sending node fires its output.

objectLink
Namespace
Facepunch.ActionGraphs
Assembly
Facepunch.ActionGraphs
Declaration
public sealed class Facepunch.ActionGraphs.Link

Methods3

Showing 3 methods

public void Remove()PUBLIC

Remove this link from the action graph, disconnecting it from the source and target.

Returns:void

public bool TryGetConstant(object value)PUBLIC

If this link is from a `Facepunch.ActionGraphs.Constant` source, return true and output the constant value.

ParameterTypeDescription
valueobject
Returns:bool

public bool TryGetVariable(Facepunch.ActionGraphs.Variable variable)PUBLIC

If this link is from a `Facepunch.ActionGraphs.Variable` source, return true and output the referenced variable.

ParameterTypeDescription
variableVariable
Returns:bool

Properties12

Showing 12 properties

public Facepunch.ActionGraphs.ActionGraph Facepunch.ActionGraphs.Link.ActionGraph { get; set; }PUBLICGETSET

The action graph containing this link.

Returns:ActionGraph

public int Facepunch.ActionGraphs.Link.ArrayIndex { get; set; }PUBLICGETSET

If `Facepunch.ActionGraphs.Link.IsArrayElement` is true, this is the index of the element in the receiving array.

Returns:int

public bool Facepunch.ActionGraphs.Link.IsArrayElement { get; set; }PUBLICGETSET

If true, this link is supplying one element of an input that accepts an array.

Returns:bool

public bool Facepunch.ActionGraphs.Link.IsNestedInput { get; set; }PUBLICGETSETINGEST

Returns:bool

public bool Facepunch.ActionGraphs.Link.IsSignal { get; set; }PUBLICGETSET

If true, this link will transmit a signal from an action node to another.

Returns:bool

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

Becomes false when this link is removed.

Returns:bool

public Facepunch.ActionGraphs.Node.Output Facepunch.ActionGraphs.Link.Source { get; set; }PUBLICGETSET

Where this link retrieves its value from.

Returns:Output

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

Returns:string

public Facepunch.ActionGraphs.Node.Input Facepunch.ActionGraphs.Link.Target { get; set; }PUBLICGETSET

The receiving node's input.

Returns:Input

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

The value type the target requires from this link.

Returns:Type

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

The value type being transmitted by the link.

Returns:Type

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

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

Returns:JsonObject

On this page