Class NodeTypeDefinition

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.soulfiremc.grpc.generated.NodeTypeDefinition
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NodeTypeDefinitionOrBuilder, Serializable
@Generated public final class NodeTypeDefinition extends com.google.protobuf.GeneratedMessage implements NodeTypeDefinitionOrBuilder
Complete definition of a node type.
Contains all metadata needed to render the node in an editor
and validate its connections without hardcoded client knowledge.
Protobuf type soulfire.v1.NodeTypeDefinition
See Also:

  • Field Details

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • CATEGORY_FIELD_NUMBER

      public static final int CATEGORY_FIELD_NUMBER
      See Also:

    • IS_TRIGGER_FIELD_NUMBER

      public static final int IS_TRIGGER_FIELD_NUMBER
      See Also:

    • INPUTS_FIELD_NUMBER

      public static final int INPUTS_FIELD_NUMBER
      See Also:

    • OUTPUTS_FIELD_NUMBER

      public static final int OUTPUTS_FIELD_NUMBER
      See Also:

    • ICON_FIELD_NUMBER

      public static final int ICON_FIELD_NUMBER
      See Also:

    • COLOR_FIELD_NUMBER

      public static final int COLOR_FIELD_NUMBER
      See Also:

    • KEYWORDS_FIELD_NUMBER

      public static final int KEYWORDS_FIELD_NUMBER
      See Also:

    • DEPRECATED_FIELD_NUMBER

      public static final int DEPRECATED_FIELD_NUMBER
      See Also:

    • DEPRECATION_MESSAGE_FIELD_NUMBER

      public static final int DEPRECATION_MESSAGE_FIELD_NUMBER
      See Also:

    • IS_LAYOUT_NODE_FIELD_NUMBER

      public static final int IS_LAYOUT_NODE_FIELD_NUMBER
      See Also:

    • SUPPORTS_MUTING_FIELD_NUMBER

      public static final int SUPPORTS_MUTING_FIELD_NUMBER
      See Also:

    • SUPPORTS_PREVIEW_FIELD_NUMBER

      public static final int SUPPORTS_PREVIEW_FIELD_NUMBER
      See Also:

    • IS_EXPENSIVE_FIELD_NUMBER

      public static final int IS_EXPENSIVE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getType

      public String getType()
      The unique type identifier for this node.
Examples: "trigger.on_tick", "action.pathfind", "math.add".
      string type = 1;
      Specified by:
      getType in interface NodeTypeDefinitionOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
      The unique type identifier for this node.
Examples: "trigger.on_tick", "action.pathfind", "math.add".
      string type = 1;
      Specified by:
      getTypeBytes in interface NodeTypeDefinitionOrBuilder
      Returns:
      The bytes for type.

    • getDisplayName

      public String getDisplayName()
      Human-readable name displayed in the UI.
Examples: "On Tick", "Pathfind To", "Add".
      string display_name = 2;
      Specified by:
      getDisplayName in interface NodeTypeDefinitionOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
      Human-readable name displayed in the UI.
Examples: "On Tick", "Pathfind To", "Add".
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface NodeTypeDefinitionOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
      Description of what this node does.
Displayed in tooltips and node palettes.
      string description = 3;
      Specified by:
      getDescription in interface NodeTypeDefinitionOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
      Description of what this node does.
Displayed in tooltips and node palettes.
      string description = 3;
      Specified by:
      getDescriptionBytes in interface NodeTypeDefinitionOrBuilder
      Returns:
      The bytes for description.

    • getCategory

      public String getCategory()
      Category ID for organizing nodes in the palette.
References CategoryDefinition.id from GetNodeTypesResponse.
Examples: "triggers", "actions", "math", "logic", "flow".
      string category = 4;
      Specified by:
      getCategory in interface NodeTypeDefinitionOrBuilder
      Returns:
      The category.

    • getCategoryBytes

      public com.google.protobuf.ByteString getCategoryBytes()
      Category ID for organizing nodes in the palette.
References CategoryDefinition.id from GetNodeTypesResponse.
Examples: "triggers", "actions", "math", "logic", "flow".
      string category = 4;
      Specified by:
      getCategoryBytes in interface NodeTypeDefinitionOrBuilder
      Returns:
      The bytes for category.

    • getIsTrigger

      public boolean getIsTrigger()
      Whether this is a trigger node (entry point for execution).
Trigger nodes have no execution input and start script flows.
      bool is_trigger = 5;
      Specified by:
      getIsTrigger in interface NodeTypeDefinitionOrBuilder
      Returns:
      The isTrigger.

    • getInputsList

      public List<PortDefinition> getInputsList()
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;
      Specified by:
      getInputsList in interface NodeTypeDefinitionOrBuilder

    • getInputsOrBuilderList

      public List<? extends PortDefinitionOrBuilder> getInputsOrBuilderList()
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;
      Specified by:
      getInputsOrBuilderList in interface NodeTypeDefinitionOrBuilder

    • getInputsCount

      public int getInputsCount()
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;
      Specified by:
      getInputsCount in interface NodeTypeDefinitionOrBuilder

    • getInputs

      public PortDefinition getInputs(int index)
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;
      Specified by:
      getInputs in interface NodeTypeDefinitionOrBuilder

    • getInputsOrBuilder

      public PortDefinitionOrBuilder getInputsOrBuilder(int index)
      The input ports for this node type.
Includes both data inputs and execution inputs.
      repeated .soulfire.v1.PortDefinition inputs = 6;
      Specified by:
      getInputsOrBuilder in interface NodeTypeDefinitionOrBuilder

    • getOutputsList

      public List<PortDefinition> getOutputsList()
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;
      Specified by:
      getOutputsList in interface NodeTypeDefinitionOrBuilder

    • getOutputsOrBuilderList

      public List<? extends PortDefinitionOrBuilder> getOutputsOrBuilderList()
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;
      Specified by:
      getOutputsOrBuilderList in interface NodeTypeDefinitionOrBuilder

    • getOutputsCount

      public int getOutputsCount()
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;
      Specified by:
      getOutputsCount in interface NodeTypeDefinitionOrBuilder

    • getOutputs

      public PortDefinition getOutputs(int index)
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;
      Specified by:
      getOutputs in interface NodeTypeDefinitionOrBuilder

    • getOutputsOrBuilder

      public PortDefinitionOrBuilder getOutputsOrBuilder(int index)
      The output ports for this node type.
Includes both data outputs and execution outputs.
      repeated .soulfire.v1.PortDefinition outputs = 7;
      Specified by:
      getOutputsOrBuilder in interface NodeTypeDefinitionOrBuilder

    • getIcon

      public String getIcon()
      Optional icon identifier for rendering.
Can be an icon name or emoji.
      string icon = 8;
      Specified by:
      getIcon in interface NodeTypeDefinitionOrBuilder
      Returns:
      The icon.

    • getIconBytes

      public com.google.protobuf.ByteString getIconBytes()
      Optional icon identifier for rendering.
Can be an icon name or emoji.
      string icon = 8;
      Specified by:
      getIconBytes in interface NodeTypeDefinitionOrBuilder
      Returns:
      The bytes for icon.

    • getColor

      public String getColor()
      Optional color hint for the node (hex color code).
Used for visual distinction between node categories.
      string color = 9;
      Specified by:
      getColor in interface NodeTypeDefinitionOrBuilder
      Returns:
      The color.

    • getColorBytes

      public com.google.protobuf.ByteString getColorBytes()
      Optional color hint for the node (hex color code).
Used for visual distinction between node categories.
      string color = 9;
      Specified by:
      getColorBytes in interface NodeTypeDefinitionOrBuilder
      Returns:
      The bytes for color.

    • getKeywordsList

      public com.google.protobuf.ProtocolStringList getKeywordsList()
      Keywords for searching/filtering nodes in the palette.
      repeated string keywords = 10;
      Specified by:
      getKeywordsList in interface NodeTypeDefinitionOrBuilder
      Returns:
      A list containing the keywords.

    • getKeywordsCount

      public int getKeywordsCount()
      Keywords for searching/filtering nodes in the palette.
      repeated string keywords = 10;
      Specified by:
      getKeywordsCount in interface NodeTypeDefinitionOrBuilder
      Returns:
      The count of keywords.

    • getKeywords

      public String getKeywords(int index)
      Keywords for searching/filtering nodes in the palette.
      repeated string keywords = 10;
      Specified by:
      getKeywords in interface NodeTypeDefinitionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The keywords at the given index.

    • getKeywordsBytes

      public com.google.protobuf.ByteString getKeywordsBytes(int index)
      Keywords for searching/filtering nodes in the palette.
      repeated string keywords = 10;
      Specified by:
      getKeywordsBytes in interface NodeTypeDefinitionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the keywords at the given index.

    • getDeprecated

      public boolean getDeprecated()
      Whether this node is deprecated and should be avoided.
      bool deprecated = 11;
      Specified by:
      getDeprecated in interface NodeTypeDefinitionOrBuilder
      Returns:
      The deprecated.

    • getDeprecationMessage

      public String getDeprecationMessage()
      If deprecated, message explaining what to use instead.
      string deprecation_message = 12;
      Specified by:
      getDeprecationMessage in interface NodeTypeDefinitionOrBuilder
      Returns:
      The deprecationMessage.

    • getDeprecationMessageBytes

      public com.google.protobuf.ByteString getDeprecationMessageBytes()
      If deprecated, message explaining what to use instead.
      string deprecation_message = 12;
      Specified by:
      getDeprecationMessageBytes in interface NodeTypeDefinitionOrBuilder
      Returns:
      The bytes for deprecationMessage.

    • getIsLayoutNode

      public boolean getIsLayoutNode()
      Whether this is a layout node (reroute, frame, etc.).
Layout nodes have special minimal rendering and don't execute logic.
      bool is_layout_node = 13;
      Specified by:
      getIsLayoutNode in interface NodeTypeDefinitionOrBuilder
      Returns:
      The isLayoutNode.

    • getSupportsMuting

      public boolean getSupportsMuting()
      Whether this node can be muted (bypassed during execution).
When muted, inputs pass through to outputs unchanged.
      bool supports_muting = 14;
      Specified by:
      getSupportsMuting in interface NodeTypeDefinitionOrBuilder
      Returns:
      The supportsMuting.

    • getSupportsPreview

      public boolean getSupportsPreview()
      Whether this node supports inline preview of its output.
      bool supports_preview = 15;
      Specified by:
      getSupportsPreview in interface NodeTypeDefinitionOrBuilder
      Returns:
      The supportsPreview.

    • getIsExpensive

      public boolean getIsExpensive()
      Whether this node is expensive (slow, may block).
Used for visual warnings in tick-path analysis.
      bool is_expensive = 16;
      Specified by:
      getIsExpensive in interface NodeTypeDefinitionOrBuilder
      Returns:
      The isExpensive.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static NodeTypeDefinition parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NodeTypeDefinition parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NodeTypeDefinition parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NodeTypeDefinition parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NodeTypeDefinition parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NodeTypeDefinition parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NodeTypeDefinition parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NodeTypeDefinition parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NodeTypeDefinition parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static NodeTypeDefinition parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NodeTypeDefinition parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static NodeTypeDefinition parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public NodeTypeDefinition.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static NodeTypeDefinition.Builder newBuilder()

    • newBuilder

      public static NodeTypeDefinition.Builder newBuilder(NodeTypeDefinition prototype)

    • toBuilder

      public NodeTypeDefinition.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected NodeTypeDefinition.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static NodeTypeDefinition getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<NodeTypeDefinition> parser()

    • getParserForType

      public com.google.protobuf.Parser<NodeTypeDefinition> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public NodeTypeDefinition getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder