Api Input
class

Input

public class Input : Parameter<T>

A named input of a node. Inputs can connect to outputs of other nodes, or have a constant value. Use !:SetLink(LinkSource) to set which output this input links to, or !:SetLinks(LinkSource[]) if this input can accept an array of values.

Constructors

Input()

Properties

Name Type Description
IsArray Boolean If true, this input accepts an array of values. Each element can be connected to a different output with Int32) or !:SetLinks(Output[]).
IsSignal Boolean If true, this input receives a signal that will cause the parent node to act.
IsPrimarySignal Boolean
IsTarget Boolean
IsLinked Boolean If true, this input is linked to an output.
SourceType Type Gets the type arriving in this input. Returns null if unlinked.
Link Link If this is linked to a single output, gets that link.
LinkArray IReadOnlyList<Link> If this is linked to an array of outputs, gets the connecting links.
Links IEnumerable<Link> Gets any links connected to this input.
ElementType Type For array input types, the type of an element of the array.
Value Object Constant source value for this input.

Methods

Int32 IndexOfLink(Link link)

If this input is connected to an array of outputs, gets the index of the given link in that array. Returns -1 if not found.

link — Link to get the index of.
Void ClearLinks()

Removes all links from this input.

Link SetLink(ILinkSource source)

Clears any existing links or constant value, and sets this input to be linked to the given output.

source — Output to link to.
Link SetLink(ILinkSource source, Int32 index)

If this input accepts an array of links, replaces a link in that array to the given output.

source — Output to link to.
index — Index into the link array to set the link.
Link InsertLink(ILinkSource source, Int32 index)

If this input accepts an array of links, inserts a link in that array to the given output.

source — Output to link to.
index — Index into the link array to insert the link.
IReadOnlyList<Link> SetLinks(ILinkSource[] sources)

If this input accepts an array of links, clears any existing links or constant value and sets this input to be linked to the given array of outputs.

sources — Array of outputs to link to.
IReadOnlyList<Link> SetLinks(IReadOnlyList<ILinkSource> sources)
Assembly: Facepunch.ActionGraphs Declaring Type: Node Full Name: Facepunch.ActionGraphs.Node.Input