| Severity | What it means |
|---|---|
| fatal | Something has gone fatally wrong with the app, and you need to act on it. |
| error | An error has occurred within the app, that may require you to act on it. |
| warning | A warning has occurred within the app, you likely don’t need to listen to these |
Listening to Issues
You can listen to these issues anywhere in your code directly on theoverlayed object
overlay.on("fatal", (event) => {
if (event.code === "ELEVATION_MISMATCH") {
// Alert the user that the game and app must be on the same level of Windows privileges
}
});
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:booleangameElevated:boolean |
Error Issue List
| Code | Description | Data |
|---|---|---|
PIPE_SERVER_ERROR | An error occurred 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:stringdata: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 |
EVENT_BUFFER_FULL | The event buffer for a game module has reached its maximum capacity (1000 events). This occurs when events are queued but readyForGameEvents() hasn’t been called. Future events will be dropped. | summary:string |