RLS Studios
ProjectsPatreonCommunityDocsAbout
Join Patreon
BeamNG Modding Docs

Guides

Reference

Server CommandsGE UtilitiesGame Engine MainNavigation GraphScreenshot CaptureServerServer ConnectionSpawnpoint ManagerSimulation TimeVehicle SpawningSuspension Frequency Tester
Flowgraph Base ModuleFlowgraph Base NodeFlowgraph Base State NodeFlowgraph Node BuilderFlowgraph GraphFlowgraph Group HelperFlowgraph LinkFlowgraph ManagerNew Node TemplateFlowgraph PinFlowgraph States ManagerFlowgraph UtilsFlowgraph Variable Storage
Medal / Auto Medal (Flowgraph Node)Clear Messages (Flowgraph Node)Context Translation (Flowgraph Node)ConvertUnit (Flowgraph Node)Set UI Timer / Corner Timer (Flowgraph Node)Custom Button TEST (Flowgraph Node)Custom UI Layout (Flowgraph Node)End Screen (Flowgraph Node)End Stats (Flowgraph Node)Fade From Black (Flowgraph Node)Fade Sequence (Flowgraph Node)Fade To Black (Flowgraph Node)Flash Message (Flowgraph Node)Generic Mission Text (Flowgraph Node)Get Gamestate (Flowgraph Node)Show Editor (Flowgraph Node)Hide Game UI (Flowgraph Node)Message (Flowgraph Node)Mission End Screen (Flowgraph Node)Popup (Flowgraph Node)Monologue (Flowgraph Node)Multi Description (Flowgraph Node)On Bigmap Poi (Flowgraph Node)On Bigmap State Change (Flowgraph Node)Set UI Race Checkpoints (Flowgraph Node)Set UI Race Laps (Flowgraph Node)Set UI Race Recovery (Flowgraph Node)RT Message (Flowgraph Node)Select Buttons (Flowgraph Node)Set UI Layout (Flowgraph Node)Show Apps (Flowgraph Node)Show Monitor (Flowgraph Node)Start Screen (Flowgraph Node)Clear Goals (Flowgraph Node)Tasklist Message (Flowgraph Node)Tasklist Task (Flowgraph Node)Three Element Select (Flowgraph Node)Vehicle Selector (Flowgraph Node)

UI

Resources

BeamNG Game Engine Lua Cheat SheetGE Developer RecipesMCP Server Setup

// RLS.STUDIOS=true

Premium Mods for BeamNG.drive. Career systems, custom vehicles, and immersive gameplay experiences.

Index

HomeProjectsPatreon

Socials

DiscordPatreon (RLS)Patreon (Vehicles)

© 2026 RLS Studios. All rights reserved.

Modding since 2024

API ReferenceGE Extensionsflowgraphnodesui

Custom Button TEST (Flowgraph Node)

- **Node Name:** `Custom Button TEST`

Overview

  • Node Name: Custom Button TEST
  • Category: once_instant
  • File: extensions/flowgraph/nodes/ui/customButtonTEST.lua
  • Status: TEST node - experimental/example

Demonstrates how to create custom UI buttons that trigger flowgraph actions via guihooks and core_flowgraphManager callbacks.

Pin Schema

Output Pins

PinTypeDescription
btn_1flowFires once when the button is pressed

Dependencies

  • core_input_bindings

How It Works

  1. _executionStarted() - Sets open = false.
  2. workOnce() - Sends button data to the UI via guihooks.trigger('CustomFGButtons', data).
  3. Each button entry contains a name and a fun string - a Lua command that calls back into the node:
    core_flowgraphManager.getManagerByID(mgrId).graphs[graphId].nodes[nodeId]:buttonPushed("btn_1")
  4. buttonPushed(action) - Sets the matching output pin to true and all others to false.
  5. _executionStopped() / onNodeReset() - Closes the dialogue by sending an empty button list.
  6. closeDialogue() - Triggers guihooks.trigger('CustomFGButtons', {}) to hide all custom buttons.

Callback Pattern

The key pattern here is generating a Lua command string that the UI can execute to call back into a specific flowgraph node:

function C:getCmd(action)
  return 'core_flowgraphManager.getManagerByID('..self.mgr.id
    ..').graphs['..self.graph.id
    ..'].nodes['..self.id
    ..']:buttonPushed("'..action..'")'
end

Example Usage

-- This is a test/example node showing the custom button pattern.
-- For production use, prefer the simpleButton or createButton nodes.
-- The pattern is useful when you need fully custom UI button behavior.
guihooks.trigger('CustomFGButtons', {
  { name = "Click me!", fun = callbackCommand }
})

Previously Undocumented (Added by Audit)

  • C:openDialogue() - Function handling openDialogue logic

See Also

  • Medal / Auto Medal (Flowgraph Node) - Related reference
  • Clear Messages (Flowgraph Node) - Related reference
  • Context Translation (Flowgraph Node) - Related reference
  • FlowGraph Guide - Guide

Set UI Timer / Corner Timer (Flowgraph Node)

- **Node Name:** `Set UI Timer`

Custom UI Layout (Flowgraph Node)

- **Node Name:** `Custom UI Layout`

On this page

OverviewPin SchemaOutput PinsDependenciesHow It WorksCallback PatternExample UsagePreviously Undocumented (Added by Audit)See Also