API ReferenceGE Extensionseditor
Editor News Message
Displays a one-time news/release-notes modal dialog when the World Editor opens after a new version.
Displays a one-time news/release-notes modal dialog when the World Editor opens after a new version.
Overview
Shows a modal window containing editor release notes for the current BeamNG version. Uses a preference-based versioning system to ensure the dialog only appears once per version.
Public Functions
| Function | Signature | Description |
|---|---|---|
M.onEditorGui | () | Renders the news modal dialog if not yet shown for current version |
M.onEditorRegisterPreferences | (prefsRegistry) | Registers hidden prefs: newsMessageShown (bool) and newsMessageVersion (int) |
M.onEditorInitialized | () | Registers the modal window with the editor |
Key Constants
| Constant | Value | Description |
|---|---|---|
EditorNewsMessageVersion | 5 | Incremented each release to re-trigger the dialog |
newsDlgName | "newsModalDlg" | Modal window identifier |
Usage Example
-- The module is auto-loaded as an editor extension.
-- To bump the news version, increment EditorNewsMessageVersion
-- and update newsText with the new release notes.Notes
- The modal auto-opens on first editor activation after a version bump.
- Links to the BeamNG support portal and World Editor forum are embedded in the dialog.
- News text content is stored in the
newsTextlocal variable (currently empty).
See Also
- Editor AI Tests - Related reference
- Editor AI Visualization - Related reference
- Editor – Assembly Spline Tool - Related reference
- World Editor Guide - Guide
Navigation Mesh Editor
Editor extension providing a **Navigation Mesh** editor window and edit mode. Currently a minimal scaffold with a "Hello world" placeholder.
Object Tool (Object Select Edit Mode)
The primary object manipulation edit mode - handles selection, transform gizmos, copy/paste, duplication, rectangle selection, and surface alignment.