Classes
class	PlayerControllerClass
class	SocialComponentClass

Enumerations
enum	EUserInteraction { Chat , Invitation , UserGeneratedContent , VoiceChat , Chat , Invitation , UserGeneratedContent , VoiceChat }
	Interaction type between two players. More...
enum	EUserInteraction { Chat , Invitation , UserGeneratedContent , VoiceChat , Chat , Invitation , UserGeneratedContent , VoiceChat }
enum	PermissionState { ALLOWED , DISALLOWED , DISABLED , ALLOWED , DISALLOWED , DISABLED }
enum	PermissionState { ALLOWED , DISALLOWED , DISABLED , ALLOWED , DISALLOWED , DISABLED }
enum	SCR_EReportReason { CHEATING , INTENTIONAL_DYING_AFK , NEGATIVE_ATTITUDE , OFFENSIVE_NAME , CHEATING , INTENTIONAL_DYING_AFK , NEGATIVE_ATTITUDE , OFFENSIVE_NAME }
	Player report reason. More...
enum	SCR_EReportReason { CHEATING , INTENTIONAL_DYING_AFK , NEGATIVE_ATTITUDE , OFFENSIVE_NAME , CHEATING , INTENTIONAL_DYING_AFK , NEGATIVE_ATTITUDE , OFFENSIVE_NAME }

Functions
PlayerControllerClass GenericControllerClass	GetControlledEntity ()
proto external bool	SetControlledEntity (IEntity entity)
proto external PlayerCamera	GetPlayerCamera ()
proto external bool	CanRequestRespawn ()
proto external void	RequestRespawn ()
	Send request to the server to spawn a playable controller for us.
proto external ActionManager	GetActionManager ()
	Returns the Action Manager associated to this player controller.
proto external RespawnComponent	GetRespawnComponent ()
proto external HUDManagerComponent	GetHUDManagerComponent ()
proto external bool	IsChatAllowed ()
	Returns text communication privilege.
proto external bool	IsVonAllowed ()
	Returns voice communication privilege.
proto external bool	HasRole (EPlayerRole role)
	Returns True if the user has given role assigned.
proto external bool	SetCharacterCameraRenderActive (bool active)
proto external int	GetPlayerId ()
proto external int	GetRplIdentity ()
proto external GamepadIOHandlerComponent	GetGamepadIOHandlerComponent ()
proto external void	ResetGamepadIOHandler ()
proto external void	ApplyGamepadEffectImmediate (GamepadEffect effect)
void	OnInit (IEntity owner)
void	OnOwnershipChanged (bool changing, bool becameOwner)
void	OnControlledEntityChanged (IEntity from, IEntity to)
	Runs every time the controlled entity has been changed.
void	OnDestroyed (notnull Instigator killer)
	Runs every time the controlled entity die.
event void	OnUpdate (float timeSlice)
proto external bool	IsRestricted (int otherPlayerID, EUserInteraction interaction)
proto external bool	IsBlocked (int otherPlayerID)
proto external bool	CanUnblock (int otherPlayerID)
proto external bool	IsMuted (int otherPlayerID)
proto external void	SetMuted (int otherPlayerID, bool mute)
proto external void	ReportPlayer (int reportedPlayerID, SCR_EReportReason reason)
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.

Variables
SocialComponentClass	m_OnBlockedPlayerJoinedInvoker = new ScriptInvoker<int>()
ref ScriptInvoker< int, bool >	m_OnReportPlayerFinishInvoker = new ScriptInvoker<int, bool>()

Detailed Description

Enumeration Type Documentation

◆ EUserInteraction [1/2]

enum EUserInteraction

Interaction type between two players.

Enumerator
Chat
Invitation
UserGeneratedContent
VoiceChat
Chat
Invitation
UserGeneratedContent
VoiceChat

Definition at line 13 of file EUserInteraction.c.

◆ EUserInteraction [2/2]

enum EUserInteraction

Enumerator
Chat
Invitation
UserGeneratedContent
VoiceChat
Chat
Invitation
UserGeneratedContent
VoiceChat

Definition at line 13 of file EUserInteraction.c.

◆ PermissionState [1/2]

enum PermissionState

Enumerator
ALLOWED	Allowed.
DISALLOWED	NOT allowed.
DISABLED	Disallowed by Platform - state could not be changed from the game.
ALLOWED	Allowed.
DISALLOWED	NOT allowed.
DISABLED	Disallowed by Platform - state could not be changed from the game.

Definition at line 12 of file PermissionState.c.

◆ PermissionState [2/2]

enum PermissionState

Enumerator
ALLOWED	Allowed.
DISALLOWED	NOT allowed.
DISABLED	Disallowed by Platform - state could not be changed from the game.
ALLOWED	Allowed.
DISALLOWED	NOT allowed.
DISABLED	Disallowed by Platform - state could not be changed from the game.

Definition at line 12 of file PermissionState.c.

◆ SCR_EReportReason [1/2]

enum SCR_EReportReason

Player report reason.

Enumerator
CHEATING
INTENTIONAL_DYING_AFK
NEGATIVE_ATTITUDE
OFFENSIVE_NAME
CHEATING
INTENTIONAL_DYING_AFK
NEGATIVE_ATTITUDE
OFFENSIVE_NAME

Definition at line 13 of file SCR_EReportReason.c.

◆ SCR_EReportReason [2/2]

enum SCR_EReportReason

Enumerator
CHEATING
INTENTIONAL_DYING_AFK
NEGATIVE_ATTITUDE
OFFENSIVE_NAME
CHEATING
INTENTIONAL_DYING_AFK
NEGATIVE_ATTITUDE
OFFENSIVE_NAME

Definition at line 13 of file SCR_EReportReason.c.

Function Documentation

◆ ApplyGamepadEffectImmediate()

proto external void ApplyGamepadEffectImmediate ( GamepadEffect effect )

◆ CanRequestRespawn()

proto external bool CanRequestRespawn ( )

When a PlayerController.RequestRespawn() is issued, the controller engages an internal lock that waits for response from the authority or timeout and drops any additional requests.

This method returns whether we can currently issue a request respawn or not.

Returns: True in case that we have no internal lock engaged and we can request, false otherwise.

◆ CanUnblock()

proto external bool 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.

◆ GetActionManager()

proto external ActionManager GetActionManager ( )

Returns the Action Manager associated to this player controller.

◆ GetControlledEntity()

PlayerControllerClass GenericControllerClass GetControlledEntity ( )

Get reference to editable entity controlled by the player this delegate represents.

Returns: Controlled entity

Definition at line 90 of file SCR_EditablePlayerDelegateComponent.c.

◆ GetGamepadIOHandlerComponent()

proto external GamepadIOHandlerComponent GetGamepadIOHandlerComponent ( )

◆ GetHUDManagerComponent()

proto external HUDManagerComponent GetHUDManagerComponent ( )

◆ GetPlayerCamera()

proto external PlayerCamera GetPlayerCamera ( )

◆ GetPlayerId()

proto external int GetPlayerId ( )

Returns

Definition at line 39 of file SCR_SpawnRequestComponent.c.

◆ GetRespawnComponent()

proto external RespawnComponent GetRespawnComponent ( )

Returns the RespawnComponent attached to this PlayerController or null if none.

Returns: RespawnComponent instance or null if none.

Definition at line 48 of file SCR_SpawnRequestComponent.c.

◆ GetRplIdentity()

proto external int GetRplIdentity ( )

◆ HasRole()

proto external bool HasRole ( EPlayerRole role )

Returns True if the user has given role assigned.

◆ IsBlocked()

proto external bool 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.

◆ IsChatAllowed()

proto external bool IsChatAllowed ( )

Returns text communication privilege.

◆ IsMuted()

proto external bool 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.

◆ IsRestricted()

proto external bool IsRestricted	(	int	otherPlayerID,
		EUserInteraction	interaction )

Is the given interaction b/w this and otherPlayer allowed? Returns false in case of invalid arguments.

◆ IsVonAllowed()

proto external bool IsVonAllowed ( )

Returns voice communication privilege.

◆ OnBlockedPlayerJoined()

void OnBlockedPlayerJoined ( int joinedPlayerID )

protected

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

Definition at line 81 of file SocialComponent.c.

◆ OnControlledEntityChanged()

void OnControlledEntityChanged	(	IEntity	from,
		IEntity	to )

protected

Runs every time the controlled entity has been changed.

Definition at line 174 of file SCR_ItemPlacementComponent.c.

◆ OnDestroyed()

void OnDestroyed ( notnull Instigator killer )

protected

Runs every time the controlled entity die.

◆ OnInit()

void OnInit ( IEntity owner )

protected

Called during EOnInit.

Parameters

owner Entity this component is attached to.

Definition at line 493 of file SCR_CharacterCommandHandler_Tests.c.

◆ OnOwnershipChanged()

void OnOwnershipChanged	(	bool	changing,
		bool	becameOwner )

protected

Parameters

[in]	changing
[in]	becameOwner

Definition at line 2273 of file SCR_CampaignFeedbackComponent.c.

◆ OnReportPlayerFinish()

void OnReportPlayerFinish	(	int	reportedPlayerID,
		bool	success )

protected

Event invoked as a result of ReportPlayer.

Definition at line 83 of file SocialComponent.c.

◆ OnUpdate()

event void OnUpdate ( float timeSlice )

protected

Definition at line 260 of file WidgetAnimation.c.

◆ ReportPlayer()

proto external void ReportPlayer	(	int	reportedPlayerID,
		SCR_EReportReason	reason )

Reports inappropriate player behaviour into BackendApi

◆ RequestRespawn()

proto external void RequestRespawn ( )

Send request to the server to spawn a playable controller for us.

Sends a respawn request based on assigned loadout and selected spawn point.

Definition at line 760 of file SCR_DeployMenuBase.c.

◆ ResetGamepadIOHandler()

proto external void ResetGamepadIOHandler ( )

◆ SetCharacterCameraRenderActive()

proto external bool SetCharacterCameraRenderActive ( bool active )

◆ SetControlledEntity()

proto external bool SetControlledEntity ( IEntity controlledEntity )

Set the new controlled entity for the player. Ignored if called from clients in MP.

Update reference to editable entity controlled by the player this delegate represents.

Parameters

[in] controlledEntity New controlled entity

Definition at line 70 of file SCR_EditablePlayerDelegateComponent.c.

◆ SetMuted()

proto external void SetMuted	(	int	otherPlayerID,
		bool	mute )

Mutes/unmutes otherPlayer for the duration of the game session. Only VoiceChat interaction is affected.

Variable Documentation

◆ m_OnBlockedPlayerJoinedInvoker

SocialComponentClass m_OnBlockedPlayerJoinedInvoker = new ScriptInvoker<int>()

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.

◆ m_OnReportPlayerFinishInvoker

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

Definition at line 24 of file SocialComponent.c.

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ EUserInteraction [1/2]

◆ EUserInteraction [2/2]

◆ PermissionState [1/2]

◆ PermissionState [2/2]

◆ SCR_EReportReason [1/2]

◆ SCR_EReportReason [2/2]

Function Documentation

◆ ApplyGamepadEffectImmediate()

◆ CanRequestRespawn()

◆ CanUnblock()

◆ GetActionManager()

◆ GetControlledEntity()

◆ GetGamepadIOHandlerComponent()

◆ GetHUDManagerComponent()

◆ GetPlayerCamera()

◆ GetPlayerId()

◆ GetRespawnComponent()

◆ GetRplIdentity()

◆ HasRole()

◆ IsBlocked()

◆ IsChatAllowed()

◆ IsMuted()

◆ IsRestricted()

◆ IsVonAllowed()

◆ OnBlockedPlayerJoined()

◆ OnControlledEntityChanged()

◆ OnDestroyed()

◆ OnInit()

◆ OnOwnershipChanged()

◆ OnReportPlayerFinish()

◆ OnUpdate()

◆ ReportPlayer()

◆ RequestRespawn()

◆ ResetGamepadIOHandler()

◆ SetCharacterCameraRenderActive()

◆ SetControlledEntity()

◆ SetMuted()

Variable Documentation

◆ m_OnBlockedPlayerJoinedInvoker

◆ m_OnReportPlayerFinishInvoker