UE3:UTEntryPlayerController (UT3)

Object >> Actor >> Controller >> PlayerController >> GamePlayerController >> UTPlayerController >> UTEntryPlayerController

Package: 

UTGame

Direct subclasses:

UTCinematicPlayerController, UTMissionPlayerController

This class in other games:

UDK

UTEntryPlayerController

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties

EntryPostProcessChain

Type: PostProcessChain

Default value: PostProcessChain'FX_HitEffects.UTMenuPostProcess'

OldPlayer

Type: LocalPlayer

OldPostProcessChain

Type: array<PostProcessChain>

Default values

Property	Value
bInitialProcessingComplete	True

Subobjects

CollisionCylinder

Class: Engine.CylinderComponent

Inherits from: UTPlayerController.CollisionCylinder

No new values.

Sprite

Class: Engine.SpriteComponent

Inherits from: UTPlayerController.Sprite

No new values.

Functions

Exec functions

OnConnectionStatusChange

exec function OnConnectionStatusChange (OnlineSubsystem.EOnlineServerConnectionStatus ConnectionStatus)

Overrides: UTPlayerController.OnConnectionStatusChange

Called when a system level connection change notification occurs. If we are playing a match through the platform's online service, we may need to notify and go back to the menu. Otherwise silently ignore this.

Parameters:

• ConnectionStatus - the new connection status.

OnLinkStatusChanged

exec function OnLinkStatusChanged (bool bConnected)

Overrides: UTPlayerController.OnLinkStatusChanged

Called when the platform's network link status changes. If we are playing a match on a remote server, we need to go back to the front end menus and notify the player.

UnlockChapter

exec function UnlockChapter (int ChapterIndex)

Events

Destroyed

simulated event Destroyed ()

Overrides: UTPlayerController.Destroyed

Destroyed event for the PC, resets the post process chain to normal.

InitInputSystem

event InitInputSystem ()

Overrides: UTPlayerController.InitInputSystem

OnCharacterUnlocked

event OnCharacterUnlocked ()

Overrides: UTPlayerController.OnCharacterUnlocked

Callback for when a character has been unlocked.

Other instance functions

LoadCharacterFromProfile

function LoadCharacterFromProfile (UTProfileSettings Profile)

Overrides: UTPlayerController.LoadCharacterFromProfile

Loads the player's custom character from their profile.

OnControllerChanged

function OnControllerChanged (int ControllerId, bool bIsConnected)

Overrides: UTPlayerController.OnControllerChanged

Attempts to pause/unpause the game when a controller becomes disconnected/connected

Parameters:

• ControllerId - the id of the controller that changed
• bIsConnected - whether the controller is connected or not

OnDestroyOnlineGameComplete

function OnDestroyOnlineGameComplete (bool bWasSuccessful)

Overrides: UTPlayerController.OnDestroyOnlineGameComplete

Called when the destroy online game has completed. At this point it is safe to travel back to the menus

Parameters:

• bWasSuccessful - whether it worked ok or not

OnFriendInviteReceived

function OnFriendInviteReceived (byte LocalUserNum, OnlineSubsystem.UniqueNetId RequestingPlayer, string RequestingNick, string Message)

Overrides: UTPlayerController.OnFriendInviteReceived

Callback for when a friend request has been received.

OnFriendMessageReceived

function OnFriendMessageReceived (byte LocalUserNum, OnlineSubsystem.UniqueNetId SendingPlayer, string SendingNick, string Message)

Overrides: UTPlayerController.OnFriendMessageReceived

Called when a friend invite arrives for a local player

Parameters:

• LocalUserNum - the user that is receiving the invite
• SendingPlayer - the player sending the friend request
• SendingNick - the nick of the player sending the friend request
• Message - the message to display to the recipient

Returns:

true if successful, false otherwise

OnGameInviteReceived

function OnGameInviteReceived (byte LocalUserNum, string RequestingNick)

Overrides: UTPlayerController.OnGameInviteReceived

Callback for when a game invite has been received.

QuitToMainMenu

function QuitToMainMenu ()

Overrides: UTPlayerController.QuitToMainMenu

Called when returning to the main menu.

RestorePostProcessing

simulated function RestorePostProcessing ()

SetPawnConstructionScene

function SetPawnConstructionScene (bool bShow)

Overrides: UTPlayerController.SetPawnConstructionScene

ShowMidGameMenu

function UTUIScene_MidGameMenu ShowMidGameMenu (optional name TabTag, optional bool bEnableInput)

Overrides: UTPlayerController.ShowMidGameMenu

ShowScoreboard

function ShowScoreboard ()

Overrides: UTPlayerController.ShowScoreboard