SocialComponent Interface Reference

Component responsible for handling social interactions b/w 2 players. More...

Inheritance diagram for SocialComponent:

Public Member Functions
proto external bool	IsRestricted (int otherPlayerID, EUserInteraction interaction)
	Is the given interaction b/w this and otherPlayer allowed?
proto external bool	IsBlocked (int otherPlayerID)
	Determines if otherPlayer is blocked by this player.
proto external bool	CanUnblock (int otherPlayerID)
	Determines if the player can be unblocked from within game - it is on game block list.
proto external bool	IsMuted (int otherPlayerID)
	Determines if otherPlayer is muted by this player for the duration of the game session.
proto external void	SetMuted (int otherPlayerID, bool mute)
	Mutes/unmutes otherPlayer for the duration of the game session.
proto external void	ReportPlayer (int reportedPlayerID, SCR_EReportReason reason)
	Reports inappropriate player behaviour into BackendApi.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Static Public Member Functions
static proto bool	IsPrivilegedTo (EUserInteraction interaction)
	Is local user privileged to participate in given interaction?
static proto bool	RequestSocialPrivilege (EUserInteraction interaction, PrivilegeCallback cb)
	Requests the local user privilege associated with given interaction.
static proto bool	IsMultiplayerAllowed ()
	Is local user allowed to participate in multiplayer?
static proto bool	RequestMultiplayerPrivilege (PrivilegeCallback cb)
	Requests the local user privilege to participate in multiplayer games.

Public Attributes
ref ScriptInvoker< int >	m_OnBlockedPlayerJoinedInvoker = new ScriptInvoker<int>()
ref ScriptInvoker< int, bool >	m_OnReportPlayerFinishInvoker = new ScriptInvoker<int, bool>()

Protected Member Functions
void	OnBlockedPlayerJoined (int joinedPlayerID)
	Event invoked when player present on a platform or game blocklist joins the server.
void	OnReportPlayerFinish (int reportedPlayerID, bool success)
	Event invoked as a result of ReportPlayer.

Detailed Description

Component responsible for handling social interactions b/w 2 players.

Gathers restrictions from different sources like platform user permissions/privileges. This component is meant to be on the Player Controller.

Member Function Documentation

CanUnblock()

proto external bool SocialComponent.CanUnblock

(

int

otherPlayerID

)

Determines if the player can be unblocked from within game - it is on game block list.

Returns

true if player can be unblocked, or false when player is not blocked throught a game block list.

IsBlocked()

proto external bool SocialComponent.IsBlocked

(

int

otherPlayerID

)

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.

IsMultiplayerAllowed()

static proto bool SocialComponent.IsMultiplayerAllowed ( )

static

Is local user allowed to participate in multiplayer?

IsMuted()

proto external bool SocialComponent.IsMuted

(

int

otherPlayerID

)

Determines if otherPlayer is muted by this player for the duration of the game session.

Only VoiceChat UserInteraction is affected. Returns false in case of invalid argument.

IsPrivilegedTo()

static proto bool SocialComponent.IsPrivilegedTo ( EUserInteraction interaction )

static

Is local user privileged to participate in given interaction?

IsRestricted()

proto external bool SocialComponent.IsRestricted	(	int	otherPlayerID,
		EUserInteraction	interaction )

Is the given interaction b/w this and otherPlayer allowed?

Returns false in case of invalid arguments.

OnBlockedPlayerJoined()

void SocialComponent.OnBlockedPlayerJoined ( int joinedPlayerID )

protected

Event invoked when player present on a platform or game blocklist joins the server.

OnReportPlayerFinish()

void SocialComponent.OnReportPlayerFinish ( int reportedPlayerID, bool success )

protected

Event invoked as a result of ReportPlayer.

ReportPlayer()

proto external void SocialComponent.ReportPlayer	(	int	reportedPlayerID,
		SCR_EReportReason	reason )

Reports inappropriate player behaviour into BackendApi.

RequestMultiplayerPrivilege()

static proto bool SocialComponent.RequestMultiplayerPrivilege ( PrivilegeCallback cb )

static

Requests the local user privilege to participate in multiplayer games.

Parameters

callback

Callback object used to obtain result.

Returns

Returns true on successful request placement.

RequestSocialPrivilege()

static proto bool SocialComponent.RequestSocialPrivilege ( EUserInteraction interaction, PrivilegeCallback cb )

static

Requests the local user privilege associated with given interaction.

Parameters

interaction	Requested interaction.
callback	Callback object used to obtain result.

Returns

Returns true on successful request placement.

SetMuted()

proto external void SocialComponent.SetMuted	(	int	otherPlayerID,
		bool	mute )

Mutes/unmutes otherPlayer for the duration of the game session.

Only VoiceChat interaction is affected.

Member Data Documentation

m_OnBlockedPlayerJoinedInvoker

ref ScriptInvoker<int> SocialComponent.m_OnBlockedPlayerJoinedInvoker = new ScriptInvoker<int>()

m_OnReportPlayerFinishInvoker

ref ScriptInvoker<int, bool> SocialComponent.m_OnReportPlayerFinishInvoker = new ScriptInvoker<int, bool>()

---

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

• Game/generated/Player/SocialComponent.c