Once I get that upgrade to 36-hour days, I will tackle that. – Mychaeel

UE3:UTEntryPlayerController (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Revision as of 02:06, 26 July 2008 by Wormbo (Talk | contribs) (1 revision)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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[edit]

EntryPostProcessChain[edit]

Type: PostProcessChain


Default value: PostProcessChain'FX_HitEffects.UTMenuPostProcess'

OldPlayer[edit]

Type: LocalPlayer


OldPostProcessChain[edit]

Type: array<PostProcessChain>


Default values[edit]

Property Value
bInitialProcessingComplete True

Subobjects[edit]

CollisionCylinder[edit]

Class: Engine.CylinderComponent

Inherits from: UTPlayerController.CollisionCylinder

No new values.

Sprite[edit]

Class: Engine.SpriteComponent

Inherits from: UTPlayerController.Sprite

No new values.

Functions[edit]

Exec functions[edit]

OnConnectionStatusChange[edit]

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[edit]

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[edit]

exec function UnlockChapter (int ChapterIndex)


Events[edit]

Destroyed[edit]

simulated event Destroyed ()

Overrides: UTPlayerController.Destroyed

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

InitInputSystem[edit]

event InitInputSystem ()

Overrides: UTPlayerController.InitInputSystem


OnCharacterUnlocked[edit]

event OnCharacterUnlocked ()

Overrides: UTPlayerController.OnCharacterUnlocked

Callback for when a character has been unlocked.

Other instance functions[edit]

LoadCharacterFromProfile[edit]

function LoadCharacterFromProfile (UTProfileSettings Profile)

Overrides: UTPlayerController.LoadCharacterFromProfile

Loads the player's custom character from their profile.

OnControllerChanged[edit]

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[edit]

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[edit]

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

Overrides: UTPlayerController.OnFriendInviteReceived

Callback for when a friend request has been received.

OnFriendMessageReceived[edit]

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[edit]

function OnGameInviteReceived (byte LocalUserNum, string RequestingNick)

Overrides: UTPlayerController.OnGameInviteReceived

Callback for when a game invite has been received.

QuitToMainMenu[edit]

function QuitToMainMenu ()

Overrides: UTPlayerController.QuitToMainMenu

Called when returning to the main menu.

RestorePostProcessing[edit]

simulated function RestorePostProcessing ()


SetPawnConstructionScene[edit]

function SetPawnConstructionScene (bool bShow)

Overrides: UTPlayerController.SetPawnConstructionScene


ShowMidGameMenu[edit]

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

Overrides: UTPlayerController.ShowMidGameMenu


ShowScoreboard[edit]

function ShowScoreboard ()

Overrides: UTPlayerController.ShowScoreboard