RSX Code Reference
    Preparing search index...
    • rsx
    • GraphNodeReflectionData

    Class GraphNodeReflectionData

    The GraphNodeReflectionData provides reflection information for a GraphNode.

    Index
    constructor
    category classType compatability description flags iconAttribute inputPins inspectableFields isHiddenInInspector name outputPins templateObject templateType arithmeticNodeBooleanSynonyms arithmeticNodeScalarSynonyms arithmeticNodeSynonyms fieldStoragePrefix
    friendlyCategory friendlyName hasConditionallyVisiblePins inputPinCount isMoveable isPersistent outputPinCount
    addInputPin addOutputPin createInstance createPinInstanceForNode findPin findPinByName getInputOfType getOutputOfType iterateAllPins toString updateFriendlyNameForTemplateObject
    category: string

    Category path for grouping nodes together in the search

    classType: Type

    The reflected system type. This is the type of the node that is instanced.

    compatability: GraphCompatibiltyName[]

    Compatability that determine what Graph types support this node.

    description: string

    Helpful information about the node, displayed in the UI at various places.

    flags: EnumValueTyped<GraphNodeFlags>

    The GraphNodeFlags.

    iconAttribute: IconAttribute

    An optional IconAttribute that was set on the node class.

    inputPins: GraphPinReflectionData[]

    Data for input pins, typically created through the GraphInputAttribute decorator.

    inspectableFields: GraphInspectableFieldReflectionData[]

    Reflection data for fields marked with the InspectableFieldAttribute.

    isHiddenInInspector: boolean

    Determines if the result should not be displayed in inspectors and user searches.

    name: string

    The name of the node being reflected.

    outputPins: GraphPinReflectionData[]

    Data for output pins, typically created through the GraphOutputAttribute decorator.

    templateObject: TemplatedGraphNodeSpecializationObject

    Additional data for the template specialization, such as input or output parameters.

    templateType: Type

    If set, the node is templated to the specified Type

    arithmeticNodeBooleanSynonyms: Const<Map<string, string>>

    A map that maps arithmetic math nodes from readable nodes to symbolic names.

    Return type must be Boolean

    arithmeticNodeScalarSynonyms: Const<Map<string, string>>

    A map that maps arithmetic math nodes from readable nodes to symbolic names.

    Second type must be Number.

    arithmeticNodeSynonyms: Const<Map<string, string>>

    A map that maps arithmetic math nodes from readable nodes to symbolic names.

    fieldStoragePrefix: "!"

    The prefix for internal field storage. The field storage is used when a parameter is not connected on a templated node.

    • get friendlyCategory(): string

      The friendly name of the node. Use for display in the UI.

      Returns string

    • get friendlyName(): string

      The friendly name of the node. Use for display in the UI.

      Returns string

    • get hasConditionallyVisiblePins(): boolean

      Determines if the node has conditionally visible pins.

      Returns boolean

    • get inputPinCount(): number

      Returns the number of input pins in the node.

      Returns number

    • get isMoveable(): boolean

      Determines if the node is movable by the user.

      Returns boolean

    • get isPersistent(): boolean

      Determines if the node is deletable by the user.

      Returns boolean

    • get outputPinCount(): number

      Returns the number of output pins out the node.

      Returns number

    • Creates an instance of for the reflection type. If the node is templated, the instance will be specialized for the type.

      Returns GraphNode

    • Returns string

    • Updates the friendly name for math nodes based on their pin types.

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods