Databindings

Overview

Databindings are a native UI system used to bridge the gap between game logic and the user interface. They function as a data-management layer, allowing developers to store, organize, and update information within "containers" that the game's UI components can access and display.

Interface Classification

The interface system is generally categorized into three primary areas:

• HUD Contexts: Various on-screen elements such as help text, honor, and various situational indicators.
• UI Apps: Various interfaces like the Satchel, Player Menu, or Crafting screens.
• Miscellaneous Components: Various UI elements that do not fall strictly into the above categories, like the bounty status, passive icon, or player rank.

Community Repositories

This section provides links to external UI-focused resources developed within the community. These resources offer additional implementation details that may be useful when implementing specific interfaces.

• 0xAhmedBero's Databinding research: Various databinding related research
• draobrehtom's RedM UI Apps: Various UI app implementations and research
• mikethemadkiwi's Fast Travel: Fast Travel specific research and implementation
• mikethemadkiwi's Player Menu: Player Menu specific research and implementation
• Sarbatore's RDR UIs: Various assorted UI components and implementations
• Senexis's Abilities: Complete implementation of the Abilities UI app
• Senexis's Emotes: Complete implementation of the emote wheel UI
• Senexis's Satchel: Complete implementation of the Satchel UI app
• Senexis's Shop Menu: Complete implementation of the Shop Menu UI app
• Cfx.re Discord #redm-research: A great place to find miscellaneous UI research

[!NOTE] If you have free, publically available research or implementations related to UI apps that you would like to share, please feel free to submit a pull request to this repository.

Global Container Reference

The following table lists common paths used when interacting with UI. Note that occasionally these may be (partially) set up by the UI apps themselves through streaming, and at other times require DATABINDING::_DATABINDING_ADD_DATA_CONTAINER_FROM_PATH to be used.