Severity | What it means |
---|
fatal | Something has gone fatally wrong with the app, and you need to act on it. |
error | An error has occured within the app, that may require you to act on it. |
warning | A warning has occured within the app, you likely dont need to listen to these |
Listening to Issues
You can listen to these issues anywhere in your code directly on the overlayed
object
Fatal Issue List
Code | Description | Data |
---|
ELEVATION_MISMATCH | The game was launched with Admin mode, but the overlay was not, so therefore the overlay cannot do the actions it requires. | appElevated:boolean
gameElevated:boolean |
Error Issue List
Code | Description | Data |
---|
PIPE_SERVER_ERROR | An error occured with the communication between the overlay and the game. | error:unknown |
INVALID_CONFIG_FILE | A configuration file that the overlay manages was set incorrectly. An example of this is the keybinds. If you’re using Typescript, it’s unlikely you’ll run into this since types will validate what you set. | issues:string[]
filePath:string
data:unknown |
Warning Issue List
Code | Description | Data |
---|
INVALID_EVENT | The overlay received an invalid game event. It would be useful for you to log this, and if a user is experiencing weird app behavior, to forward those logs to us. | summary:string |