PlayerController Interface Reference

Inheritance diagram for PlayerController:

Public Member Functions
proto external IEntity	GetControlledEntity ()
proto external bool	SetControlledEntity (IEntity entity)
	Set the new controlled entity for the player.
proto external PlayerCamera	GetPlayerCamera ()
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.
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 ()
	Returns the RespawnComponent attached to this PlayerController or null if none.
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 void	SetPlayerBlockedState (int playerId, bool blocked)
	Block specified player from any communication for the time of one gameplay session.
proto external void	SetPlayerMutedState (int playerId, bool blocked)
	Block specified player from voice communication for the time of one gameplay session.
proto external PermissionState	GetPlayerBlockedState (int playerId)
	Determine if the specified player is able to communicate with this PC in any means.
proto external PermissionState	GetPlayerMutedState (int playerId)
	Determine if the specified player is able to communicate with this PC using voice.
proto external bool	CanViewContentCreatedBy (int playerId)
	Determine if this PC can view content created by specified player.
proto external GamepadIOHandlerComponent	GetGamepadIOHandlerComponent ()
proto external void	ResetGamepadIOHandler ()
proto external void	ApplyGamepadEffectImmediate (GamepadEffect effect)
void	OnUpdate (float timeSlice)

Protected Member Functions
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.

Member Function Documentation

ApplyGamepadEffectImmediate()

proto external void PlayerController.ApplyGamepadEffectImmediate

(

GamepadEffect

effect

)

CanRequestRespawn()

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

(

int

playerId

)

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

GetActionManager()

proto external ActionManager PlayerController.GetActionManager

(

)

Returns the Action Manager associated to this player controller.

GetControlledEntity()

proto external IEntity PlayerController.GetControlledEntity

(

)

GetGamepadIOHandlerComponent()

proto external GamepadIOHandlerComponent PlayerController.GetGamepadIOHandlerComponent

(

)

GetHUDManagerComponent()

proto external HUDManagerComponent PlayerController.GetHUDManagerComponent

(

)

GetPlayerBlockedState()

proto external PermissionState PlayerController.GetPlayerBlockedState

(

int

playerId

)

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

GetPlayerCamera()

proto external PlayerCamera PlayerController.GetPlayerCamera

(

)

GetPlayerId()

proto external int PlayerController.GetPlayerId

(

)

GetPlayerMutedState()

proto external PermissionState PlayerController.GetPlayerMutedState

(

int

playerId

)

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

GetRespawnComponent()

proto external RespawnComponent PlayerController.GetRespawnComponent

(

)

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

Returns

RespawnComponent instance or null if none.

GetRplIdentity()

proto external int PlayerController.GetRplIdentity

(

)

HasRole()

proto external bool PlayerController.HasRole

(

EPlayerRole

role

)

Returns True if the user has given role assigned.

IsChatAllowed()

proto external bool PlayerController.IsChatAllowed

(

)

Returns text communication privilege.

IsVonAllowed()

proto external bool PlayerController.IsVonAllowed

(

)

Returns voice communication privilege.

OnControlledEntityChanged()

void PlayerController.OnControlledEntityChanged ( IEntity  from, IEntity  to  )

protected

Runs every time the controlled entity has been changed.

Implemented in SCR_PlayerController.

OnDestroyed()

void PlayerController.OnDestroyed ( notnull Instigator  killer )

protected

Runs every time the controlled entity die.

Implemented in SCR_PlayerController.

OnInit()

void PlayerController.OnInit ( IEntity  owner )

protected

OnOwnershipChanged()

void PlayerController.OnOwnershipChanged ( bool  changing, bool  becameOwner  )

protected

Implemented in SCR_PlayerController.

OnUpdate()

void PlayerController.OnUpdate

(

float

timeSlice

)

Implemented in SCR_PlayerController.

RequestRespawn()

proto external void PlayerController.RequestRespawn

(

)

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

ResetGamepadIOHandler()

proto external void PlayerController.ResetGamepadIOHandler

(

)

SetCharacterCameraRenderActive()

proto external bool PlayerController.SetCharacterCameraRenderActive

(

bool

active

)

SetControlledEntity()

proto external bool PlayerController.SetControlledEntity

(

IEntity

entity

)

Set the new controlled entity for the player.

Ignored if called from clients in MP.

SetPlayerBlockedState()

proto external void PlayerController.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 PlayerController.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)

---

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

• Game/generated/Player/PlayerController.c