Universal - Overlayed

overlayed.universal.readyForGameEvents() must be called before any events will be emitted.

logged_in

The user’s account for that particular game. The shape depends on the game — narrow on game to reach the richer fields.

type LoggedInEvent =
	| {
			game: "siege" | "tft";
			content: { account_id: string };
	  }
	| {
			game: "sand";
			content: {
				account_id: string;
				display_name: string;
				platform_id: string;
				playfab_id: string;
			};
	  };

overlay.universal.on("logged_in", (event) => {
	if (event.game === "sand") {
		console.log(event.content.display_name);
	}

	console.log(event.content.account_id);
});

{
	"account_id": "1234567890"
}

For Sand Raiders you can also subscribe on the game module directly, where the type is already narrowed:

overlay.sand.on("logged_in", (event) => {
	console.log(event.content.display_name);
});

module_loaded

interface ModuleLoadedEvent {
	game_version: string;
	process_hash: string;
}

{
	"game_version": "157.0.1",
	"process_hash": "2413fb3709b05939f04cf2e92f7d0897fc2596f9ad0b8a9ea855c7bfebaae892"
}

module_unloaded

interface ModuleUnloadedEvent {
}

{}

unsupported_game_version

interface UnsupportedGameVersionEvent {
	game_version: string;
	process_hash: string;
}

{
	"game_version": "157.0.1",
	"process_hash": "2413fb3709b05939f04cf2e92f7d0897fc2596f9ad0b8a9ea855c7bfebaae892"
}