Home

What is ScaleformUI?

ScaleformUI is a scaleform based library to help developers quickly and easily build Rockstar-like menus and pause menus, handle notifications, markers, and use some of the most used in-game HUD features as well.

warning

This documentation will explain the API and show examples in C#, Lua and possibly in future also JS (TypeScript). In Lua many functions return a value when no parameter is given or sent nil, so make sure to check the source code too when in doubt!

Where do I begin?

Take a look at our Getting Started page.

Documentation Sections

Explore the different parts of the ScaleformUI API:

• Getting Started: Learn how to install and set up ScaleformUI in your project.
• UIMenu API: Create and manage standard menus, items, panels, and windows.
• Scaleforms API: Use in-game scaleforms such as countdowns, feeds, and warning screens.
• HUD and Notifications API: Manage notifications, markers, and 3D text drawing.
• Radial Menu API: Create and customise radial menus.
• Radio Menu API: Create and customise radio menus.

Features

• Support for simple buttons, checkboxes and lists.
• Support for custom banners from game sprites and your own textures.
• Easy nested menus for fast and painless nested menu system.
• Controller support.
• Mouse controls.
• Support for all screen resolutions.
• Item descriptions.
• Rebindable keys and controls.
• Badges to decorate your items.
• Event-based callbacks for C#.
• Easy and painless PauseMenu creation.
• Custom instructional buttons.
• Custom warning screen.
• Custom big message and midsize message.
• Timer bars easy and for everyone!

Special Thanks

• @PhilippRendel for helping out on Lua and making it look a lot more easy to use, thanks man.
• @frflo for the new awesome and updated docs