Skip to main content

Scaleforms API

ScaleformUI provides a static user-friendly API to manage different scaleforms within your game. This reference index lists all available scaleforms and their respective documentation pages.

Available Scaleforms​

  • Big Message Displays large, customisable messages on the screen, such as mission passed banners, rank up notifications, and weapon purchase alerts.

  • Countdown Handles in-game countdown sequences with customisable starting numbers, colours, and audio cues.

  • Feed Manages the customisable feed system for displaying notifications and updates.

  • Instructional Buttons Draws customisable instructional button prompts at the bottom of the screen to guide player inputs.

  • Midsize Message Displays medium-sized message banners, including coloured shards with custom text and backgrounds.

  • Minimap Overlays Manages custom overlays and elements drawn directly on the minimap.

  • Mission Selector Provides a customisable interface for selecting missions or activities.

  • Player List Displays a list of players in the session with customisable details and layouts.

  • Rank Bar Displays the player's rank progress bar with customisable experience limits, values, and animation speeds.

  • Warning Screen Displays a customisable warning screen with support for instructional buttons to handle player decisions.

New and Upcoming Scaleforms​

  • Multiplayer Chat Handles custom multiplayer chat interfaces and message rendering.

  • Scaleform Widescreen Manages widescreen-specific scaleform layouts and adjustments.

  • Pause Menu Provides a customisable pause menu interface with support for tabs, settings, and lists.