Events - Simpl

Events tell your game when something changes. In C++ you bind to them on USimplClientSubsystem. In Blueprints you can bind only OnLobbyUpdated and OnLobbyDeleted. See Blueprints.

How events arrive

The plugin opens a live event stream for your current lobby. It also reads the lobby on a timer: every 5 seconds when the stream is not working, and every 30 seconds when it is. So your game keeps getting updates if the stream drops. You can rely on this:

A change that arrives both as a live event and in a lobby read fires its event once.
Events run on the game thread.
A match found, a server ready and a lobby deleted all show up even without the stream, because the timer reads catch them.

Do not rely on this:

The order of two different events.
Extra details. For example, the player list in OnMatchFound and the reason in OnQueueCancelled can be empty. Read the lobby for the truth.

All events

Event	When it fires	What to do
`OnLobbyCreated`	After `CreateLobby` worked.	Show the lobby.
`OnLobbyJoined`	After a join or reconnect worked.	Show the lobby.
`OnLobbyLeft`	You left the lobby.	Go back to the menu.
`OnLobbyUpdated`	The lobby changed. It carries the whole lobby. Also fires when a server becomes ready.	Redraw your lobby screen. Bindable in Blueprints.
`OnLobbiesListed`	`BrowseLobbies` worked.	Show the list.
`OnPlayerJoined`	Another player joined.	Add them to the list.
`OnPlayerLeft`	Another player left, or you were removed. It has the handle and a reason.	Remove them from the list.
`OnHostChanged`	A new player is host.	Show or hide host-only buttons.
`OnSettingsChanged`	The lobby settings changed.	Update the settings screen.
`OnQueueEntered`	The lobby entered the queue.	Show “searching”.
`OnQueueCancelled`	The lobby left the queue. It has a reason that can be empty.	Stop showing “searching”.
`OnQueueStatsUpdated`	New queue numbers arrived.	Update your numbers.
`OnMatchFound`	A match was found.	Show “match found”. The server is not ready yet.
`OnServerReady`	The server is running. It has the host, the port and the match ID.	Connect. See Queues and matches.
`OnServerStopped`	The server stopped. It has an instance ID, a match ID and a reason.	Go back to the lobby screen.
`OnMatchEnded`	The match ended.	Go back to the lobby screen.
`OnLobbyDeleted`	The lobby is gone. It has a reason. Does not fire when you leave on purpose.	Go back to the menu. Bindable in Blueprints.
`OnQueueDeleted`	The queue of your lobby was deleted.	Tell the player and stop searching.
`OnStreamStateChanged`	The live stream turned on or off. It has a reason.	Optional. Show “live” or “polling”.
`OnShutdownComplete`	`ShutdownSimpl` finished.	Quit.
`OnSimplError`	An error with no call to report to. See Errors.	Log it. Show a message.

OnServerReady fires once for each server.