Editor Main

Core editor bootstrap module. Sets up the global editor object, manages extension loading, preferences, edit modes, window registration, selection system, history/undo, and the editor activate/deactivate lifecycle.

Module Overview

Key State

Public Functions - Lifecycle

Public Functions - Extensions

Public Functions - Preferences

Public Functions - Logging

Extension Discovery

-- Extensions are discovered from:
local extensionFiles = FS:findFiles('/lua/ge/extensions/editor/', '*.lua', 0, false, false)

-- A file is an editor extension if it contains:
-- M.onEditor* or M.onExtension* function declarations

-- Safe mode only loads these extensions:
local safeModeExtensionNames = {
  "editor_extensionsEditor", "editor_fileDialog", "editor_worldEditorHelper",
  "editor_createObjectTool", "editor_gizmoHelper", "editor_logHelper",
  "editor_mainMenu", "editor_mainToolbar", "editor_mainUpdate",
  "editor_preferences", "editor_objectTool", "editor_sceneTree",
  "editor_inspector", "editor_layoutManager"
}

Configuration Paths

Hook System

The editor broadcasts hooks to all loaded extensions:

• onEditorInitialized, onEditorActivated, onEditorDeactivated
• onEditorGui, onEditorMainMenuBar
• onEditorObjectSelectionChanged, onEditorInspectorFieldChanged
• onEditorRegisterPreferences, onEditorPreferenceValueChanged
• onEditorHeadlessMainMenuBar, onEditorHeadlessChange

Module Variables

• M.dependencies (table) - {"core_camera"}.
• M.additionalActionMaps (table) - Extra action maps to push when editor activates.
• M.extensionsSettings (any) - Extension enable/disable settings.
• M.guiModule (any) - Reference to editor/api/gui module.
• M.coreModule (any) - Reference to editor/api/core module.
• M.assetsModule (any) - Reference to editor/api/assets module.
• M.cameraModule (any) - Reference to editor/api/camera module.
• M.dataBlockModule (any) - Reference to editor/api/dataBlock module.
• M.decalModule (any) - Reference to editor/api/decal module.
• M.gizmoModule (any) - Reference to editor/api/gizmo module.
• M.materialModule (any) - Reference to editor/api/material module.
• M.navigationModule (any) - Reference to editor/api/navigation module.
• M.objectModule (any) - Reference to editor/api/object module.
• M.roadRiverModule (any) - Reference to editor/api/roadRiver module.
• M.sketchModule (any) - Reference to editor/api/sketch module.
• M.terrainModule (any) - Reference to editor/api/terrain module.
• M.forestModule (any) - Reference to editor/api/forest module.
• M.modulesInitialized (boolean) - Whether API modules have been initialized.

Functions

M.logInfo(msg)

Info-level editor log (alias for M.log).

• msg (string)

M.initializeModules()

Initializes all editor API modules (gui, core, assets, camera, etc.).

M.setEditorActive(activate, safeMode)

Sets the editor active or inactive.

• activate (boolean)
• safeMode (boolean)

M.isEditorActive()

Checks if editor is currently active.

Returns: boolean

M.saveState(filePath)

Saves editor state to file.

• filePath (string)

M.loadState(filePath)

Loads editor state from file.

• filePath (string)

Returns: table

M.loadExtensionsSettings()

Loads extension enable/disable settings from settings/editor/extensions.json.

M.saveExtensionsSettings()

Saves extension enable/disable settings to settings/editor/extensions.json.

M.loadEditorExtensions(names)

Loads multiple editor extensions by name.

• names (table)

M.shutdown()

Shuts down the editor, unloads extensions.

M.onClientStartMission()

Callback for client start mission event.

M.onClientEndMission()

Callback for client end mission event.

M.onExit()

Callback for exit event.

M.onPreWindowClose()

Callback for pre window close event.

M.onExtensionLoaded()

Callback for extension loaded event.

M.onExtensionUnloaded()

Callback for extension unloaded event.

M.onSerialize()

Callback for serialize event.

Returns: table

M.onDeserialized(data)

Callback for deserialized event.

• data (table)

M.onFirstUpdate()

Callback for first update event.

M.onUpdate()

Callback for update event.

M.toggleActive()

Toggles editor active/inactive state.

M.loadEditorExtension(name)

Loads a single editor extension by name.

• name (string)

M.savePreferences()

Saves preferences to settings/editor/preferences.json.

M.loadPreferences()

Loads preferences from settings/editor/preferences.json.

See Also

• Editor AI Tests - Related reference
• Editor AI Visualization - Related reference
• Editor – Assembly Spline Tool - Related reference
• World Editor Guide - Guide