FOmniMultiplayerService

Description

The Multiplayer service handles game invites and Omni Online status.

#include <OmniMultiplayerService.h>

Inherits FOmniPlatformServiceBase.

Public Member Functions
void	InvitePlayer (const FString &UserId, const FString &LaunchData, const FSendGameInviteDelegate &InvitePlayerCallback)
	Sends an invite to a player in the game.
void	InvitePlayers (const FString &LaunchData, const FSendGameInviteDelegate &InvitePlayersCallback)
	Displays a system pop-up that allows a user to invite people to the game.
bool	HasOmniOnline (const FHasOmniOnlineDelegate &OnOmniOnlineStatusResultCallback) const
	Retrieves user status of OmniOnline subscription.

Methods

HasOmniOnline()

bool FOmniMultiplayerService::HasOmniOnline

(

const FHasOmniOnlineDelegate &

OnOmniOnlineStatusResultCallback

)

const

Retrieves user status of OmniOnline subscription.

Parameters

OnOmniOnlineStatusResultCallback

A callback that will be executed when the service has retrieved the information. bool bIsError, const FString& ErrorMessage, bool status are parameters.

Returns

True if the request was successfully sent, false otherwise.

InvitePlayer()

void FOmniMultiplayerService::InvitePlayer	(	const FString &	UserId,
		const FString &	LaunchData,
		const FSendGameInviteDelegate &	InvitePlayerCallback
	)

Sends an invite to a player in the game.

To use this function, you can get a userId for a player by looking at the current player's friends. You can then pass that ID into this function along with the data required for the invited player to join the game. The invited player will receive this data through the launch details when they accept the invite.

Parameters

UserId	The user identifier. Example auth0|61fd28a7b6467400698f1ca2
LaunchData	This data will be passed into the invited user's game when it starts.
InvitePlayerCallback	A callback that will be executed when the method has finished. bool bWasSuccessfulis the parameter. Indicates whether the request was made successfully, not whether anyone accepted.

InvitePlayers()

void FOmniMultiplayerService::InvitePlayers	(	const FString &	LaunchData,
		const FSendGameInviteDelegate &	InvitePlayersCallback
	)

Displays a system pop-up that allows a user to invite people to the game.

To use this function, pass the data required for the invited player(s) to join the game. The invited player(s) will receive this data through the launch details when they accept the invite.

Parameters

LaunchData	This data will be passed into the invited user's game when it starts.
InvitePlayersCallback	A callback that will be executed when the method has finished. bool bWasSuccessfulis the parameter. Indicates whether the request was made successfully, not whether anyone accepted.