Welcome to DIS2RBED’s Lua Engine documentation!

Lua Engine is a DIS2RBED Menu feature for players who need more features than the built-in DIS2RBED Menu has. It offers straightforward functions to interact with the game and provides a lot of useful features for scripting.

Check out the General Information section for further information, as well as Getting Started.

Note

This project is under active development.

Special thanks to:

• Me (K1tty)

• MrDario

• Chiya

• Antrix

• DurtyFree for some useful parts of GTA V Dump data

This wouldn’t have been possible without you!

Code snippets

You can find code snippets for VS Code here: click

To install code snippets, drop the file into the C:\Users\%username%\AppData\Roaming\Code\User\snippets directory.

---

Dear other mod menus,

If you plan on stealing this documentation for yourselves, please give us some credit! We’ve put efforts in this!

---

Contents

LUA Engine

• General Information
  • Installation path
  • Found a mistake in documentation?
• Getting Started
  • A Minimal script
• DIS2RBED LUA reference
  • Types in the LUA Engine
  • Global Variables
  • Namespaces in LUA Engine
  • Scripting functions
  • RAGE Functions
• WIP New RAGE API
  • System namespace
  • App namespace
  • Audio namespace
  • Brain namespace
  • Cam namespace
  • Clock namespace
  • Cutscene namespace
  • Datafile namespace
  • Decorator namespace
  • Dlc namespace
  • Entity namespace
  • Event namespace
  • Files namespace
  • Fire namespace
  • Graphics namespace
  • Hud namespace
  • Interior namespace
  • Itemset namespace
  • Loadingscreen namespace
  • Localization namespace
  • Gameplay namespace
  • Mobile namespace
  • Money namespace
  • Netshopping namespace
  • Network namespace
  • Object namespace
  • Pad namespace
  • Pathfind namespace
  • Ped namespace
  • Physics namespace
  • Player namespace
  • Recording namespace
  • Replay namespace
  • Script namespace
  • Security namespace
  • Shapetest namespace
  • Socialclub namespace
  • Stats namespace
  • Streaming namespace
  • Task namespace
  • Vehicle namespace
  • Water namespace
  • Weapon namespace
  • Zone namespace

GTA V Dump data

• Ammo info parameters
• Ammo types
• List of screen FX effects
• Animation types
• App properties
• Bones
• Clouds Types
• Combat attributes
• Combat movement rules
• Combat ranges
• Cutscene Names
• Decorator types & examples
• Doors Index
• Explosion types
• Ped eye colors
• Firing patterns
• Group formations
• Vehicle handling parameters
• Headlights Colors
• Interior Types
• Vehicle modification types
• Ped Component IDs
• Ped configuration flags
• Ped movement clipsets
• Ped head overlay IDs
• Ped Prop IDs
• Particle Effects
• Relationship groups
• Vehicle roof states
• Rounding Flags
• Decompiled Scaleforms
• Scenario groups
• Scenario types
• Script List
• Seat types
• Secret Page
• Task Index
• Text Flags
• Vehicle classes
• Vehicle engine health
• Weapon Info parameters
• Weather Types
• Vehicle wheel types
• Window tints
• Windows Index
• Window Titles
• Zones