Public Member Functions
proto external void	UpdateBlockList ()
	Requests update of block list using BlockListApi.

proto external void	CheckBlockedPlayersInRoom (notnull Room room)
	Requests to check blokced players in a room.

proto external int	GetBlockedPlayers (notnull array< BlockListItem > outItems)
	Fills the provided array with the informations about blocked players.

proto external void	Block (BackendCallback callback, int otherPlayerID)
	Blocks given player using BlockListApi.

proto external bool	Unblock (BackendCallback callback, int otherPlayerID)
	Removes given player from game block list.

proto external bool	IsBlockedIdentity (string identity, PlatformKind platform, string platformIdHash)
	Determines if otherPlayer is blocked by this player.

Public Attributes
ref ScriptInvoker< bool >	OnBlockListUpdateInvoker = new ScriptInvoker<bool>()

ref ScriptInvoker< Room, array< BlockedRoomPlayer > >	OnGetBlockedPlayersInRoomInvoker = new ScriptInvoker<Room, array<BlockedRoomPlayer>>()

Protected Member Functions
void	OnBlockListUpdate (bool success)
	Event invoked as a result of UpdateBlockList.

void	OnCheckedBlockedPlayersInRoom (Room room, array< BlockedRoomPlayer > blockedPlayers)
	Event invoked as a result of CheckBlockedPlayersInRoom.

Member Function Documentation

◆ Block()

proto external void GameBlocklist.Block	(	BackendCallback	callback,
		int	otherPlayerID )

Blocks given player using BlockListApi.

Uses provided callback as result. In case of full block list, error EBERR_STORAGE_IS_FULL is reported.

◆ CheckBlockedPlayersInRoom()

proto external void GameBlocklist.CheckBlockedPlayersInRoom ( notnull Room room )

Requests to check blokced players in a room.

Invokes OnGetBlockedPlayersInRoom when finished. Deleting a Room parameter or calling before completion cancels previous request

◆ GetBlockedPlayers()

proto external int GameBlocklist.GetBlockedPlayers ( notnull array< BlockListItem > outItems )

Fills the provided array with the informations about blocked players.

Returns: Number of blocked players

◆ IsBlockedIdentity()

proto external bool GameBlocklist.IsBlockedIdentity	(	string	identity,
		PlatformKind	platform,
		string	platformIdHash )

Determines if otherPlayer is blocked by this player.

All player interactions are restricted if one player is blocked. Returns false in case of invalid argument.

Parameters

identity	Game backend identity id
platform	Platform of other player
platformIdHash	Hash of platform specific identifier

◆ OnBlockListUpdate()

void GameBlocklist.OnBlockListUpdate ( bool success )

protected

Event invoked as a result of UpdateBlockList.

◆ OnCheckedBlockedPlayersInRoom()

void GameBlocklist.OnCheckedBlockedPlayersInRoom	(	Room	room,
		array< BlockedRoomPlayer >	blockedPlayers )

protected

Event invoked as a result of CheckBlockedPlayersInRoom.

Parameters

blockedPlayers is null in case of failed request

◆ Unblock()

proto external bool GameBlocklist.Unblock	(	BackendCallback	callback,
		int	otherPlayerID )

Removes given player from game block list.

Invokes callback when requestt completes.

Returns: false on failure or when player is not blocked throught a game block list.

◆ UpdateBlockList()

proto external void GameBlocklist.UpdateBlockList ( )

Requests update of block list using BlockListApi.

Invokes OnBlockListUpdate when finished.

Member Data Documentation

◆ OnBlockListUpdateInvoker

ref ScriptInvoker<bool> GameBlocklist.OnBlockListUpdateInvoker = new ScriptInvoker<bool>()

◆ OnGetBlockedPlayersInRoomInvoker

ref ScriptInvoker<Room, array<BlockedRoomPlayer> > GameBlocklist.OnGetBlockedPlayersInRoomInvoker = new ScriptInvoker<Room, array<BlockedRoomPlayer>>()

The documentation for this interface was generated from the following file:

Game/generated/GameBlocklist.c

Public Member Functions

Public Attributes

Protected Member Functions