API ReferenceGE Extensionseditorflowgraph
Flowgraph Welcome Window
Displays the welcome/start screen for the flowgraph editor with recent files, examples, and demo projects.
Displays the welcome/start screen for the flowgraph editor with recent files, examples, and demo projects.
Overview
A flowgraph manager window that serves as the landing page when the flowgraph editor opens. Features a header image, a left column with project actions and recent files, and a right column with introduction text, beginner examples, and advanced demo projects.
Window Properties
| Property | Value |
|---|---|
C.windowName | "fg_welcome" |
C.windowDescription | "Welcome" |
Key Functions
| Function | Description |
|---|---|
C:init() | Registers window, loads header/side images, initializes demo project list |
C:attach(mgr) | Binds to flowgraph manager |
C:draw() | Main draw; focuses window on first display |
C:drawContent() | Renders the full layout: header image, side image, left/right columns |
C:drawLeftColumn() | New Project, Open Project, and Recent Files buttons |
C:drawRightColumn() | Introduction text, beginner examples, advanced demo projects |
Local Helper Functions
| Function | Description |
|---|---|
headerText(txt) | Renders large colored header text |
fancyIconButton(id, icon, iconHover, txt, lowerTxt) | Renders a styled icon button with hover color change and optional description |
Layout Structure
+-------------------------+
| <header image> |
+--------+----------------+
| <side | Left | Right |
| img> | Column | Col |
| | | |
+--------+--------+-------+- Left Column: New Project, Open Project, Recent Files (up to 10)
- Right Column: Introduction, Basic Examples (sorted by
exampleOrder), Advanced Examples
Demo Projects
Pre-loaded demo projects defined in C:init():
| Name | Description |
|---|---|
| Simple Race | Compete in a short race versus an AI-controlled vehicle |
Demo data loaded from /lua/ge/extensions/flowgraph/examples/scenarios/simpleRace/race.flow.json.
Usage Example
-- The welcome window opens automatically when the flowgraph editor starts.
-- Users can:
-- Click "New Project" to create an empty flowgraph
-- Click "Open Project..." to browse for .flow.json files
-- Click any recent file to reopen it
-- Click a beginner example to load it as a new unsaved projectSee Also
- Flowgraph Editor - Parent editor module
- Flowgraph Search - Search within projects