Player

Data Structures
class	PlayerControllerClass

Enumerations
enum	PermissionState {   ALLOWED, DISALLOWED, DISABLED, ALLOWED,   DISALLOWED, DISABLED }
enum	PermissionState {   ALLOWED, DISALLOWED, DISABLED, ALLOWED,   DISALLOWED, DISABLED }

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. More...
proto external ActionManager	GetActionManager ()
	Returns the Action Manager associated to this player controller. More...
proto external RespawnComponent	GetRespawnComponent ()
proto external HUDManagerComponent	GetHUDManagerComponent ()
proto external bool	IsChatAllowed ()
	Returns text communication privilege. More...
proto external bool	IsVonAllowed ()
	Returns voice communication privilege. More...
proto external bool	HasRole (EPlayerRole role)
	Returns True if the user has given role assigned. More...
proto external bool	SetCharacterCameraRenderActive (bool active)
proto external int	GetPlayerId ()
proto external int	GetRplIdentity ()
proto external void	SetPlayerBlockedState (int playerId, bool blocked)
proto external void	SetPlayerMutedState (int playerId, bool blocked)
proto external PermissionState	GetPlayerBlockedState (int playerId)
proto external PermissionState	GetPlayerMutedState (int playerId)
proto external bool	CanViewContentCreatedBy (int playerId)
event protected void	OnInit (IEntity owner)
event protected void	OnOwnershipChanged (bool changing, bool becameOwner)
event protected void	OnControlledEntityChanged (IEntity from, IEntity to)
	Runs every time the controlled entity has been changed. More...
event protected void	OnDestroyed (notnull Instigator killer)
	Runs every time the controlled entity die. More...
event void	OnUpdate (float timeSlice)

Detailed Description

Enumeration Type Documentation

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.

Function Documentation

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.

CanViewContentCreatedBy()

proto external bool CanViewContentCreatedBy

(

int

playerId

)

Determine if this PC can view content created by specified player.

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 86 of file SCR_EditablePlayerDelegateComponent.c.

GetHUDManagerComponent()

proto external HUDManagerComponent GetHUDManagerComponent

(

)

GetPlayerBlockedState()

proto external PermissionState GetPlayerBlockedState

(

int

playerId

)

Determine if the specified player is able to communicate with this PC in any means.

GetPlayerCamera()

proto external PlayerCamera GetPlayerCamera

(

)

GetPlayerId()

proto external int GetPlayerId

(

)

Returns

Definition at line 39 of file SCR_SpawnRequestComponent.c.

GetPlayerMutedState()

proto external PermissionState GetPlayerMutedState

(

int

playerId

)

Determine if the specified player is able to communicate with this PC using voice.

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 45 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.

IsChatAllowed()

proto external bool IsChatAllowed

(

)

Returns text communication privilege.

IsVonAllowed()

proto external bool IsVonAllowed

(

)

Returns voice communication privilege.

OnControlledEntityChanged()

event protected void OnControlledEntityChanged	(	IEntity	from,
		IEntity	to
	)

Runs every time the controlled entity has been changed.

SCR_PlayerController Event Used to reinit Task manager Component when new entity is controlled

SCR_PlayerController Event Used to reinit VON when new entity is controlled

Definition at line 113 of file SCR_ItemPlacementComponent.c.

OnDestroyed()

event protected void OnDestroyed

(

notnull Instigator

killer

)

Runs every time the controlled entity die.

OnInit()

event protected void OnInit

(

IEntity

owner

)

Called during EOnInit.

Parameters

owner

Entity this component is attached to.

Definition at line 523 of file SCR_CharacterCommandHandler_Tests.c.

OnOwnershipChanged()

event protected void OnOwnershipChanged	(	bool	changing,
		bool	becameOwner
	)

Parameters

[in]	changing
[in]	becameOwner

Definition at line 1334 of file SCR_CampaignFeedbackComponent.c.

OnUpdate()

event void OnUpdate

(

float

timeSlice

)

RequestRespawn()

proto external void RequestRespawn

(

)

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

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

Definition at line 694 of file SCR_DeployMenuBase.c.

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 68 of file SCR_EditablePlayerDelegateComponent.c.

SetPlayerBlockedState()

proto external void SetPlayerBlockedState	(	int	playerId,
		bool	blocked
	)

Block specified player from any communication for the time of one gameplay session. It does not invoke blocking on the platform level (eg XBox Live)

SetPlayerMutedState()

proto external void SetPlayerMutedState	(	int	playerId,
		bool	blocked
	)

Block specified player from voice communication for the time of one gameplay session. It does not invoke blocking on the platform level (eg XBox Live)