API ReferenceFacepunch.ActionGraphs

InputDefinitionclass

Describes an input of a node.

objectInputDefinition
Namespace
Facepunch.ActionGraphs
Assembly
Facepunch.ActionGraphs
Declaration
public class Facepunch.ActionGraphs.InputDefinition

Constructors2

Showing 2 constructors

Methods7

Showing 7 methods

public void Deconstruct(string Name, System.Type Type, Facepunch.ActionGraphs.InputFlags Flags, Facepunch.ActionGraphs.DisplayInfo Display, System.Collections.Generic.IReadOnlySet`1<string> UsedBy, object Default, System.Collections.Generic.IReadOnlyCollection`1<System.Attribute> Attributes)PUBLIC

ParameterTypeDescription
Namestring
TypeType
FlagsInputFlags
DisplayDisplayInfo
UsedByIReadOnlySet<string>
Defaultobject
AttributesIReadOnlyCollection<Attribute>
Returns:void

public static Facepunch.ActionGraphs.InputDefinition PrimarySignal(string title = Run, string description = Triggers the execution of this node.)PUBLICSTATIC

ParameterTypeDescription
title = Runstring
description = Triggers the execution of this node.string
Returns:InputDefinition

protected virtual bool PrintMembers(System.Text.StringBuilder builder)PROTECTEDVIRTUAL

ParameterTypeDescription
builderStringBuilder
Returns:bool

public static Facepunch.ActionGraphs.InputDefinition SecondarySignal(string name, string title = null, string description = Triggers the execution of this node.)PUBLICSTATIC

ParameterTypeDescription
namestring
title = nullstring
description = Triggers the execution of this node.string
Returns:InputDefinition

public static Facepunch.ActionGraphs.InputDefinition Target(System.Type type, object defaultValue = null, string title = Target, string description = Object to call the method on.)PUBLICSTATIC

ParameterTypeDescription
typeType
defaultValue = nullobject
title = Targetstring
description = Object to call the method on.string
Returns:InputDefinition

Properties17

Showing 17 properties

public bool Facepunch.ActionGraphs.InputDefinition.AllowCaching { get; set; }PUBLICGETSET

Returns:bool

public virtual sealed System.Collections.Generic.IReadOnlyCollection`1<System.Attribute> Facepunch.ActionGraphs.InputDefinition.Attributes { get; set; }PUBLICVIRTUALGETSET

Returns:IReadOnlyCollection<Attribute>

public object Facepunch.ActionGraphs.InputDefinition.Default { get; set; }PUBLICGETSET

If `Facepunch.ActionGraphs.InputDefinition.IsRequired` is false, this value will be used when no value is provided.

Returns:object

public virtual sealed Facepunch.ActionGraphs.DisplayInfo Facepunch.ActionGraphs.InputDefinition.Display { get; set; }PUBLICVIRTUALGETSET

Optional title and description of the input.

Returns:DisplayInfo

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

For array input types, the type of an element of the array.

Returns:Type

protected virtual System.Type Facepunch.ActionGraphs.InputDefinition.EqualityContract { get; set; }PROTECTEDVIRTUALGETSET

Returns:Type

public bool Facepunch.ActionGraphs.InputDefinition.IsArray { get; set; }PUBLICGETSET

If true, this input accepts an array of values. Each element can be connected to a different output.

Returns:bool

public virtual sealed bool Facepunch.ActionGraphs.InputDefinition.IsMissing { get; set; }PUBLICVIRTUALGETSET

Returns:bool

public bool Facepunch.ActionGraphs.InputDefinition.IsNotAlwaysAccessed { get; set; }PUBLICGETSET

Returns:bool

public bool Facepunch.ActionGraphs.InputDefinition.IsPrimarySignal { get; set; }PUBLICGETSET

Returns:bool

public virtual sealed bool Facepunch.ActionGraphs.InputDefinition.IsRequired { get; set; }PUBLICVIRTUALGETSET

Returns:bool

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

If true, this input receives a signal that will cause the parent node to act.

Returns:bool

public bool Facepunch.ActionGraphs.InputDefinition.IsTarget { get; set; }PUBLICGETSET

Returns:bool

public virtual sealed string Facepunch.ActionGraphs.InputDefinition.Name { get; set; }PUBLICVIRTUALGETSET

Name used to reference this input.

Returns:string

public virtual sealed System.Type Facepunch.ActionGraphs.InputDefinition.Type { get; set; }PUBLICVIRTUALGETSET

What type is accepted in this input. For input signals, this will be `Facepunch.ActionGraphs.Signal`.

Returns:Type

public System.Collections.Generic.IReadOnlySet`1<string> Facepunch.ActionGraphs.InputDefinition.UsedBy { get; set; }PUBLICGETSET

Input signals that use this input.

Returns:IReadOnlySet<string>

On this page

Constructorsprotected InputDefinition(Facepunch.ActionGraphs.InputDefinition original)public InputDefinition(System.String Name, System.Type Type, Facepunch.ActionGraphs.InputFlags Flags, Facepunch.ActionGraphs.DisplayInfo Display, System.Collections.Generic.IReadOnlySet`1<System.String> UsedBy = null, System.Object Default = null, System.Collections.Generic.IReadOnlyCollection`1<System.Attribute> Attributes = null)Methodspublic virtual Facepunch.ActionGraphs.InputDefinition <Clone>$()public System.Void Deconstruct(System.String Name, System.Type Type, Facepunch.ActionGraphs.InputFlags Flags, Facepunch.ActionGraphs.DisplayInfo Display, System.Collections.Generic.IReadOnlySet`1<System.String> UsedBy, System.Object Default, System.Collections.Generic.IReadOnlyCollection`1<System.Attribute> Attributes)public static Facepunch.ActionGraphs.InputDefinition Missing(System.String name)public static Facepunch.ActionGraphs.InputDefinition PrimarySignal(System.String title = Run, System.String description = Triggers the execution of this node.)protected virtual System.Boolean PrintMembers(System.Text.StringBuilder builder)public static Facepunch.ActionGraphs.InputDefinition SecondarySignal(System.String name, System.String title = null, System.String description = Triggers the execution of this node.)public static Facepunch.ActionGraphs.InputDefinition Target(System.Type type, System.Object defaultValue = null, System.String title = Target, System.String description = Object to call the method on.)Propertiespublic System.Boolean Facepunch.ActionGraphs.InputDefinition.AllowCaching { get; set; }public virtual sealed System.Collections.Generic.IReadOnlyCollection`1<System.Attribute> Facepunch.ActionGraphs.InputDefinition.Attributes { get; set; }public System.Object Facepunch.ActionGraphs.InputDefinition.Default { get; set; }public virtual sealed Facepunch.ActionGraphs.DisplayInfo Facepunch.ActionGraphs.InputDefinition.Display { get; set; }public System.Type Facepunch.ActionGraphs.InputDefinition.ElementType { get; set; }protected virtual System.Type Facepunch.ActionGraphs.InputDefinition.EqualityContract { get; set; }public Facepunch.ActionGraphs.InputFlags Facepunch.ActionGraphs.InputDefinition.Flags { get; set; }public System.Boolean Facepunch.ActionGraphs.InputDefinition.IsArray { get; set; }public virtual sealed System.Boolean Facepunch.ActionGraphs.InputDefinition.IsMissing { get; set; }public System.Boolean Facepunch.ActionGraphs.InputDefinition.IsNotAlwaysAccessed { get; set; }public System.Boolean Facepunch.ActionGraphs.InputDefinition.IsPrimarySignal { get; set; }public virtual sealed System.Boolean Facepunch.ActionGraphs.InputDefinition.IsRequired { get; set; }public System.Boolean Facepunch.ActionGraphs.InputDefinition.IsSignal { get; set; }public System.Boolean Facepunch.ActionGraphs.InputDefinition.IsTarget { get; set; }public virtual sealed System.String Facepunch.ActionGraphs.InputDefinition.Name { get; set; }public virtual sealed System.Type Facepunch.ActionGraphs.InputDefinition.Type { get; set; }public System.Collections.Generic.IReadOnlySet`1<System.String> Facepunch.ActionGraphs.InputDefinition.UsedBy { get; set; }Metadata