⚠️ Not yet verified in-game β€” this page was drafted from source analysis and hasn't been confirmed by actually running it. Treat it as a strong draft, not gospel.

Core Engine & Utilities

Boot sequence, cross-cutting managers (player, faction, HQ, layers), and the base classes (Inheritable, Blippable, …) most other modules in this wiki build on. Less immediately useful for a first mod, but essential once you’re extending something instead of just calling into it.

Modules in this category

  • Blippable β€” The Blippable module is responsible for adding and removing radar objectives and off-screen world markers for game objects.
  • EnemyBlippable β€” The EnemyBlippable module extends the functionality of the Blippable module to manage radar objectives and off-screen world markers specifically for enemy vehicles.
  • GameBootstrap β€” The GameBootstrap module is responsible for initializing the game environment and playing introductory movies.
  • Inheritable β€” The Inheritable module serves as the base class for all world objects in the game.
  • Init β€” The Init module is responsible for initializing a global table to manage events and handling the activation and deactivation of world objects.
  • LevelBootstrap β€” The LevelBootstrap module is responsible for loading a game level and its associated master script.
  • MrxAchievements β€” The MrxAchievements module is responsible for managing and tracking player achievements in the game.
  • MrxActionHijack β€” The MrxActionHijack module is responsible for managing the action hijack sequence in the game.
  • MrxAi β€” The MrxAi module provides a thin, awake-gated shim over the engine Ai.* API.
  • MrxBootstrap β€” The MrxBootstrap module is responsible for initializing the game world by handling GUI loading and local player joining events.
  • MrxCinematic β€” The MrxCinematic module is a placeholder slideshow system used for displaying sequences of slides in the game’s HUD.
  • MrxFactionManager β€” The MrxFactionManager module is responsible for managing faction relations, attitudes, and reporting systems within the game.
  • MrxFollow β€” The MrxFollow module manages the escort/follow behavior for companion characters in the game.
  • mrxhq β€” The mrxhq module is responsible for managing the HQ portal in the game.
  • MrxHqManager β€” The MrxHqManager module is responsible for managing Headquarters (HQ) in the game.
  • MrxLayerManager β€” The MrxLayerManager module is responsible for managing dynamic and static layers in the game world.
  • MrxParkingLotManager β€” The MrxParkingLotManager module is responsible for managing parking lots in the game.
  • MrxPlayer β€” The MrxPlayer module is responsible for managing player characters in the game.
  • MrxPmc β€” The MrxPmc module manages the player’s economy and support items in Mercenaries 2.
  • mrxrewarddata β€” The mrxrewarddata module manages reward configurations and dispenses rewards for various game events, missions, and milestones.
  • MrxShop β€” The MrxShop module is responsible for managing the in-game store system, including generating and displaying shop lists, handling item purchases, and maintaining persistence of purchased items.
  • MrxSoundBootstrap β€” The MrxSoundBootstrap module is responsible for initializing and managing the sound system in the game.
  • MrxStatsManager β€” The MrxStatsManager module is responsible for tracking and managing various statistics and progress metrics for the player.
  • MrxTimer β€” The MrxTimer module is responsible for managing countdown and stopwatch timers in the game’s user interface.
  • MrxTransit β€” The MrxTransit module manages the transit system in the game, including handling player fast-travel to different landing zones.
  • MrxTutorial β€” The MrxTutorial module is responsible for managing in-game tutorials.
  • MrxTutorialManager β€” The MrxTutorialManager module is responsible for managing in-game tutorials.
  • MrxUnlockFanfare β€” The MrxUnlockFanfare module is responsible for displaying unlock banners on the HUD when players acquire new items or complete certain game objectives.
  • MrxUtil β€” The MrxUtil module is a comprehensive utility library providing a wide range of helper functions for various tasks in the game.
  • MrxUtilShell β€” The MrxUtilShell module provides utility functions for calling functions with optional arguments and processing callback tables.
  • MrxVoSequence β€” The MrxVoSequence module is responsible for playing voice-over (VO) sequences in the game.
  • Multi β€” The Multi module provides utility functions for spawning multiple game objects in the world.
  • OrientedBlippable β€” The OrientedBlippable module extends the functionality of the Blippable module by adding support for oriented blips, which rotate based on the object’s orientation.

Back to top

This site uses Just the Docs, a documentation theme for Jekyll.