RocketRogue Lua API

Getting started

To get started, create a new Lua script in your script folder, then read about how to interact with Rocket League using our RL SDK or the LuaJIT ffi library. When you're ready to share your script, publish it to our Lua workshop to reach the RocketRogue community.

Tags

The Lua API reference makes extensive use of labels to describe each member.

TagPurpose
functionFunctions invoked with a period (.)
methodMethods invoked with a colon (:)
fieldProperties accessed with a period (.)
eventEvents callbacks or Unreal events
constUnreal constants
enumUnreal enums
read onlyRead only properties

Guides

Events & callbacks

Learn how to use event listeners and callbacks in your script.

Read more

Resources

Client

Interact with the software, add/remove event listeners, and more.

Logger

Write log messages to the in-game RocketRogue console.

UI

Add/remove UI controls, read/set config items, and more.

Renderer

Draw things on the screen. The possibilities are endless.