OnlinePicoMatchmaking Blueprint Function class. More...

#include <Pico_Matchmaking.h>

Static Public Member Functions
static void	ReportResultsInsecure (UObject *WorldContextObject, const FString &RoomID, const TMap< FString, int > &Data, FMatchmakingReportResultsInsecure InDelegate)
	Reports the result of a skill-rating match. More...

static void	GetStats (UObject *WorldContextObject, const FString &Pool, int32 MaxLevel, EMatchmakingStatApproach approach, FMatchmakingGetStats InDelegate)
	Gets the matchmaking statistics for the current user. More...

static void	Browse2 (UObject *WorldContextObject, const FString &Pool, FPicoMatchmakingOptions MatchmakingOptions, FMatchmakingBrowse2 InDelegate)
	Gets rooms by matchmakinging pool name. The user can join the room with `RoomService.Join2 to`or cancel the retrieval with `MatchmakingService.Cancel`. More...

static void	Browse2CustomPage (UObject *WorldContextObject, const FString &Pool, FPicoMatchmakingOptions MatchmakingOptions, int PageIndex, int PageSize, FMatchmakingBrowse2CustomPage InDelegate)
	Gets rooms by matchmakinging pool name and specify the page number and the number of pages per page. More...

static void	Cancel (UObject *WorldContextObject, FMatchmakingCancel InDelegate)
	Cancels a matchmaking request. Call this function to cancel an enqueue request before a match is made. This is typically triggered when a user gives up waiting. If you do not cancel the request but the user goes offline, the user/room will be timed out according to the setting of reserved period on the PICO Developer Platform. More...

static void	CreateAndEnqueueRoom2 (UObject *WorldContextObject, const FString &Pool, FPicoMatchmakingOptions MatchmakingOptions, FMatchmakingCreateAndEnqueueRoom2 InDelegate)
	Creates a matchmaking room, then enqueues and joins it. More...

static void	Enqueue2 (UObject *WorldContextObject, const FString &Pool, FPicoMatchmakingOptions MatchmakingOptions, FMatchmakingEnqueue2 InDelegate)
	Enqueues for an available matchmaking room to join. When the server finds a match, it will return a message of type `MessageType.Notification_Matchmaking_MatchFound`. You can join found matching rooms by calling `RoomService.Join2`. If you want to cancel the match early, you can use `MatchmakingService.Cancel`. More...

static void	GetAdminSnapshot (UObject *WorldContextObject, FMatchmakingGetAdminSnapshot InDelegate)
	Debugs the state of the current matchmaking pool queue. More...

static void	StartMatch (UObject *WorldContextObject, const FString &RoomId, FMatchmakingStartMatch InDelegate)
	Reports that a skill-rating match has started. You can use this method after joining the room. More...

Detailed Description

OnlinePicoMatchmaking Blueprint Function class.

Member Function Documentation

◆ Browse2()

static void Browse2	(	UObject *	WorldContextObject,
		const FString &	Pool,
		FPicoMatchmakingOptions	MatchmakingOptions,
		FMatchmakingBrowse2	InDelegate
	)

static

Gets rooms by matchmakinging pool name. The user can join the room with RoomService.Join2 toor cancel the retrieval with MatchmakingService.Cancel.

Note: Applicable to the following matchmaking mode: Browse

Parameters

WorldContextObject	Used to get the information about the current world.
Pool	The matchmaking pool name you want to browse.
MatchmakingOptions	(Optional) The matchmaking configuration of the browse request.
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_MatchmakingBrowseResult *, MatchmakingBrowseResult).

◆ Browse2CustomPage()

static void Browse2CustomPage	(	UObject *	WorldContextObject,
		const FString &	Pool,
		FPicoMatchmakingOptions	MatchmakingOptions,
		int	PageIndex,
		int	PageSize,
		FMatchmakingBrowse2CustomPage	InDelegate
	)

static

Gets rooms by matchmakinging pool name and specify the page number and the number of pages per page.

Parameters

WorldContextObject	Used to get the information about the current world.
Pool	The matchmaking pool name you want to browse.
MatchmakingOptions	The matchmaking configuration of the browse request.
PageIndex	Start page index.
PageSize	The number of pages per page.
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_MatchmakingBrowseResult *, MatchmakingBrowseResult).

◆ Cancel()

static void Cancel	(	UObject *	WorldContextObject,
		FMatchmakingCancel	InDelegate
	)

static

Cancels a matchmaking request. Call this function to cancel an enqueue request before a match is made. This is typically triggered when a user gives up waiting. If you do not cancel the request but the user goes offline, the user/room will be timed out according to the setting of reserved period on the PICO Developer Platform.

Note: Applicable to the following matchmaking modes: Quickmatch, Browse

Parameters

WorldContextObject	Used to get the information about the current world.
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).

◆ CreateAndEnqueueRoom2()

static void CreateAndEnqueueRoom2	(	UObject *	WorldContextObject,
		const FString &	Pool,
		FPicoMatchmakingOptions	MatchmakingOptions,
		FMatchmakingCreateAndEnqueueRoom2	InDelegate
	)

static

Creates a matchmaking room, then enqueues and joins it.

Note: Applicable to the following matchmaking modes: Quickmatch, Browse, Advanced (Can Users Create Rooms=true)

Parameters

WorldContextObject	Used to get the information about the current world.
Pool	The matchmaking pool to use, which is created on the PICO Developer Platform.
MatchmakingOptions	(Optional) Additional matchmaking configuration for this request.
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_MatchmakingEnqueueResultAndRoom *, MatchmakingEnqueueResultAndRoom).

◆ Enqueue2()

static void Enqueue2	(	UObject *	WorldContextObject,
		const FString &	Pool,
		FPicoMatchmakingOptions	MatchmakingOptions,
		FMatchmakingEnqueue2	InDelegate
	)

static

Enqueues for an available matchmaking room to join. When the server finds a match, it will return a message of type MessageType.Notification_Matchmaking_MatchFound. You can join found matching rooms by calling RoomService.Join2. If you want to cancel the match early, you can use MatchmakingService.Cancel.

Note: Applicable to the following matchmaking mode: Quickmatch

Parameters

WorldContextObject	Used to get the information about the current world.
Pool	The matchmaking pool to use, which is defined on the PICO Developer Platform.
MatchmakingOptions	(Optional) Match configuration for Enqueue.
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_MatchmakingEnqueueResult *, MatchmakingEnqueueResult).

◆ GetAdminSnapshot()

static void GetAdminSnapshot	(	UObject *	WorldContextObject,
		FMatchmakingGetAdminSnapshot	InDelegate
	)

static

Debugs the state of the current matchmaking pool queue.

Note

This function should not be used in production.
Applicable to the following matchmaking modes: Quickmatch, Browse

Parameters

WorldContextObject	Used to get the information about the current world.
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_MatchmakingAdminSnapshot *, MatchmakingAdminSnapshot).

◆ GetStats()

static void GetStats	(	UObject *	WorldContextObject,
		const FString &	Pool,
		int32	MaxLevel,
		EMatchmakingStatApproach	approach,
		FMatchmakingGetStats	InDelegate
	)

static

Gets the matchmaking statistics for the current user.

Note: Applicable to the following matchmaking modes: Quickmatch, Browse

Parameters

WorldContextObject	Used to get the information about the current world.
Pool	The pool to look in.
MaxLevel	(beta feature, don't use it)
approach	(beta feature, don't use it)
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage, UPico_MatchmakingStats *, MatchmakingStats).

◆ ReportResultsInsecure()

static void ReportResultsInsecure	(	UObject *	WorldContextObject,
		const FString &	RoomID,
		const TMap< FString, int > &	Data,
		FMatchmakingReportResultsInsecure	InDelegate
	)

static

Reports the result of a skill-rating match.

Note: Applicable to the following matchmaking modes: Quickmatch, Browse (+ Skill Pool)

Parameters

WorldContextObject	Used to get the information about the current world.
RoomID	The ID of the room.
Data	The key-value pairs.
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).

◆ StartMatch()

static void StartMatch	(	UObject *	WorldContextObject,
		const FString &	RoomId,
		FMatchmakingStartMatch	InDelegate
	)

static

Reports that a skill-rating match has started. You can use this method after joining the room.

Note

This function is only for pools with skill-based matching.
Applicable to the following matchmaking modes: Quickmatch, Browse (+ Skill Pool)

Parameters

WorldContextObject	Used to get the information about the current world.
RoomId	The ID of the room you want to match.
InDelegate	Will be executed when the request has been completed. Delegate will contain the requested object class (bool, bIsError, int, ErrorCode, const FString&, ErrorMessage).

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Browse2()

◆ Browse2CustomPage()

◆ Cancel()

◆ CreateAndEnqueueRoom2()

◆ Enqueue2()

◆ GetAdminSnapshot()

◆ GetStats()

◆ ReportResultsInsecure()

◆ StartMatch()