API ReferenceFacepunch.ActionGraphs

OutputDefinitionclass

Describes an output of a node.

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

Constructors2

Showing 2 constructors

Methods7

Showing 7 methods

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

ParameterTypeDescription
Namestring—
TypeType—
FlagsOutputFlags—
DisplayDisplayInfo—
ProvidedByIReadOnlySet<string>—
AttributesIReadOnlyCollection<Attribute>—
Returns:void—

public static Facepunch.ActionGraphs.OutputDefinition PrimarySignal(string title = Done, string description = Fires when this node has finished executing.)PUBLICSTATIC

ParameterTypeDescription
title = Donestring—
description = Fires when this node has finished executing.string—
Returns:OutputDefinition—

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

ParameterTypeDescription
builderStringBuilder—
Returns:bool—

public static Facepunch.ActionGraphs.OutputDefinition SecondarySignal(string name, string title = null, string description = Fires when this node has finished executing., bool isNotAwaited = False)PUBLICSTATIC

ParameterTypeDescription
namestring—
title = nullstring—
description = Fires when this node has finished executing.string—
isNotAwaited = Falsebool—
Returns:OutputDefinition—

Properties13

Showing 13 properties

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

Returns:IReadOnlyCollection<Attribute>—

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

Optional title and description of the output.

Returns:DisplayInfo—

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

Returns:Type—

public bool Facepunch.ActionGraphs.OutputDefinition.IsAlwaysInvoked { get; set; }PUBLICGETSET

Returns:bool—

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

Returns:bool—

public bool Facepunch.ActionGraphs.OutputDefinition.IsNotAwaited { get; set; }PUBLICGETSET

Returns:bool—

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

Returns:bool—

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

Returns:bool—

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

If true, this output emits signals that can trigger other nodes to act.

Returns:bool—

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

Name used to reference this output.

Returns:string—

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

This output is only valid when one of these output signals fires. If empty, it's always valid.

Returns:IReadOnlySet<string>—

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

What type is returned by this output. For signals, this will be `Facepunch.ActionGraphs.Signal`.

Returns:Type—

On this page

Constructorsprotected OutputDefinition(Facepunch.ActionGraphs.OutputDefinition original)public OutputDefinition(System.String Name, System.Type Type, Facepunch.ActionGraphs.OutputFlags Flags, Facepunch.ActionGraphs.DisplayInfo Display, System.Collections.Generic.IReadOnlySet`1<System.String> ProvidedBy = null, System.Collections.Generic.IReadOnlyCollection`1<System.Attribute> Attributes = null)Methodspublic virtual Facepunch.ActionGraphs.OutputDefinition <Clone>$()public System.Void Deconstruct(System.String Name, System.Type Type, Facepunch.ActionGraphs.OutputFlags Flags, Facepunch.ActionGraphs.DisplayInfo Display, System.Collections.Generic.IReadOnlySet`1<System.String> ProvidedBy, System.Collections.Generic.IReadOnlyCollection`1<System.Attribute> Attributes)public System.Boolean IsProvidedBy(Facepunch.ActionGraphs.OutputDefinition outputDef)public static Facepunch.ActionGraphs.OutputDefinition Missing(System.String name)public static Facepunch.ActionGraphs.OutputDefinition PrimarySignal(System.String title = Done, System.String description = Fires when this node has finished executing.)protected virtual System.Boolean PrintMembers(System.Text.StringBuilder builder)public static Facepunch.ActionGraphs.OutputDefinition SecondarySignal(System.String name, System.String title = null, System.String description = Fires when this node has finished executing., System.Boolean isNotAwaited = False)Propertiespublic virtual sealed System.Collections.Generic.IReadOnlyCollection`1<System.Attribute> Facepunch.ActionGraphs.OutputDefinition.Attributes { get; set; }public virtual sealed Facepunch.ActionGraphs.DisplayInfo Facepunch.ActionGraphs.OutputDefinition.Display { get; set; }protected virtual System.Type Facepunch.ActionGraphs.OutputDefinition.EqualityContract { get; set; }public Facepunch.ActionGraphs.OutputFlags Facepunch.ActionGraphs.OutputDefinition.Flags { get; set; }public System.Boolean Facepunch.ActionGraphs.OutputDefinition.IsAlwaysInvoked { get; set; }public virtual sealed System.Boolean Facepunch.ActionGraphs.OutputDefinition.IsMissing { get; set; }public System.Boolean Facepunch.ActionGraphs.OutputDefinition.IsNotAwaited { get; set; }public System.Boolean Facepunch.ActionGraphs.OutputDefinition.IsPrimarySignal { get; set; }public virtual sealed System.Boolean Facepunch.ActionGraphs.OutputDefinition.IsRequired { get; set; }public System.Boolean Facepunch.ActionGraphs.OutputDefinition.IsSignal { get; set; }public virtual sealed System.String Facepunch.ActionGraphs.OutputDefinition.Name { get; set; }public System.Collections.Generic.IReadOnlySet`1<System.String> Facepunch.ActionGraphs.OutputDefinition.ProvidedBy { get; set; }public virtual sealed System.Type Facepunch.ActionGraphs.OutputDefinition.Type { get; set; }Metadata