API ReferenceGE Extensionscore
Game Context
Provides game context information for the UI, including mission state change notifications and WIP (Work In Progress) warning labels for experimental features.
Provides game context information for the UI, including mission state change notifications and WIP (Work In Progress) warning labels for experimental features.
Public API
| Function | Signature | Description |
|---|---|---|
M.getGameContext | (...) → table | Proxies to gameplay_markerInteraction.getGameContext(...). Loads the extension if not already loaded. Returns {} on failure. |
M.toggleMenues | () | Placeholder/no-op function for menu toggle. |
M.onAnyMissionChanged | (state, mission) | Hook: triggers onAnyMissionChanged guihook with state and mission ID. |
M.getWIPWarningLabel | () → string|nil | Returns a localization key for experimental feature banners (rally stages, career mode) or nil if none applies. |
WIP Warning Conditions
| Condition | Label Key |
|---|---|
| Active rally mission (unless banner hidden in settings) | ui.rally.experimentalWarning |
| Career mode active | ui.career.experimentalWarning |
| Neither | nil |
Usage Example
-- Check if a WIP warning should be displayed
local warning = core_gameContext.getWIPWarningLabel()
if warning then
guihooks.trigger('ShowWIPWarning', warning)
endSee Also
- Activity Manager - Related reference
- Audio Bank Manager - Related reference
- Audio Ribbon System - Related reference
- Core Systems Guide - Guide
Fun Stuff
Provides sandbox "fun" actions accessible from the radial quick-access menu: vehicle destruction, physics forces, color randomization, random vehicles, and more.
Game State
Manages the high-level game state (freeroam, campaign, etc.), loading screen lifecycle, and main menu visibility. Coordinates between Lua systems and the UI layer during level transitions.