API ReferenceGE Extensionsflowgraphnodesdebug
Comment
- **Name:** `Comment`
Overview
- Name:
Comment - Category:
logic - File:
lua/ge/extensions/flowgraph/nodes/debug/comment.lua - Pattern: Class-based (
C = {}, returns_flowgraph_createNode(C))
Description
Places a visual comment box into the flowgraph editor. Can group nodes together and supports customizable title, body text, colors, transparency, and move modes. This is a purely visual/organizational node with no pins or runtime logic.
Pin Schema
No pins - this node is editor-only.
Properties
| Property | Type | Description |
|---|---|---|
| Title | string | Comment header text |
| Alpha | float (0–1) | Transparency of the comment box |
| Background Color | color (RGBA) | Background fill color |
| Border Color | color (RGBA) | Border color |
| Text Color | color (RGBA) | Text color |
| Simple | bool | Simplified rendering (no grouping area) |
| Move Mode | enum | withNodes (grouped nodes move together) or withoutNodes |
Behavior
- No
work()function - purely a visual element. draw()renders the comment box using ImGui and the flowgraph editor API with customizable colors and grouping behavior.drawCustomProperties()provides the editor UI for modifying all properties.- Serialization preserves size, colors, alpha, title, text, simple mode, and move mode.
Tags
#flowgraph #node #ge #debug #editor #comment #group
Additional Exports
init()
showProperties()
hideProperties()
refreshColors()
updateEditorPosition()
-
name-string- (see source) -
description-string- (see source) -
category-string- (see source) -
tags-table- (see source) -
pinSchema-table- (see source)
See Also
- AI Debug Display - Related reference
- Camera Mouse Raycast - Related reference
- Debug Cylinder - Related reference
- FlowGraph Guide - Guide