I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX
UE3:UTPlayerController instance functions (UT3)
Object >> Actor >> Controller >> PlayerController >> GamePlayerController >> UTPlayerController (instance functions) |
Contents
- 1 Instance functions
- 1.1 AchievementDone
- 1.2 AcknowledgePossession
- 1.3 AddModifierCard
- 1.4 AddOnlineDelegates
- 1.5 AdjustFOV
- 1.6 AdjustPersistentKey
- 1.7 AdminCmdOk
- 1.8 AimHelpModifier
- 1.9 AimingHelp
- 1.10 AllowTextMessage
- 1.11 AllowTTSMessageFrom
- 1.12 AlreadyInActionMusic
- 1.13 AtuallyShowQuickPickMenu
- 1.14 BullseyeMessage
- 1.15 CallServerMove
- 1.16 CancelPendingConnection
- 1.17 CanCommunicate
- 1.18 CanRestartPlayer
- 1.19 CharacterProcessingComplete
- 1.20 CheckAutoObjective
- 1.21 CheckBulletWhip
- 1.22 CheckJumpOrDuck
- 1.23 CheckPickedVehicle
- 1.24 CheckVehicleToDrive
- 1.25 CleanupOnlineSubsystemSession
- 1.26 ClearCameraEffect
- 1.27 ClearDoubleClick
- 1.28 ClearStringAliasBindingMapCache
- 1.29 ClientBecameActivePlayer
- 1.30 ClientEndZoom
- 1.31 ClientGameEnded
- 1.32 ClientIncrementAroundTheWorld
- 1.33 ClientIncrementLikeTheBackOfMyHand
- 1.34 ClientIncrementMixItUp
- 1.35 ClientMusicEvent
- 1.36 ClientPawnDied
- 1.37 ClientPlayAnnouncement
- 1.38 ClientPlayCameraAnim
- 1.39 ClientPlayTakeHit
- 1.40 ClientReset
- 1.41 ClientResetMapListPublish
- 1.42 ClientRestart
- 1.43 ClientRoundEnded
- 1.44 ClientSendNextMap
- 1.45 ClientSetAutoObjective
- 1.46 ClientSetBehindView
- 1.47 ClientSetGameHostNameAndId
- 1.48 ClientSetOnlineStatus
- 1.49 ClientSetProcessingComplete
- 1.50 ClientSetProgressMessage
- 1.51 ClientSetRequestedEntryWithFlag
- 1.52 ClientSetSpeechRecognitionObject
- 1.53 ClientSmartUse
- 1.54 ClientSpawnCameraEffect
- 1.55 ClientSpawnGoreCameraEffect
- 1.56 ClientStopCameraAnim
- 1.57 ClientUpdateAchievement
- 1.58 ClientUpdateGetALife
- 1.59 ClientUpdateSpiceOfLife
- 1.60 CommandMenuDeactivated
- 1.61 ConvolveTimeout
- 1.62 DamageShake
- 1.63 DisplayDebug
- 1.64 DrawHUD
- 1.65 EndZoom
- 1.66 EndZoomNonlinear
- 1.67 FindProgressMessageScene
- 1.68 FindVehicleToDrive
- 1.69 FinishQuitToMainMenu
- 1.70 FixFOV
- 1.71 ForceCloseProgressMessageScene
- 1.72 GetAdjustedAimFor
- 1.73 HasModifierCard
- 1.74 HasPersistentKey
- 1.75 LandingShake
- 1.76 LoadCharacterFromProfile
- 1.77 LoadSettingsFromProfile
- 1.78 LongClientAdjustPosition
- 1.79 NotifyConnectionError
- 1.80 NotifyInviteFailed
- 1.81 NotifyNotAllPlayersCanJoinInvite
- 1.82 NotifyNotEnoughSpaceInInvite
- 1.83 NotifyTakeHit
- 1.84 OnControllerChanged
- 1.85 OnDestroyOnlineGameComplete
- 1.86 OnEndOnlineGameComplete
- 1.87 OnFriendInviteReceived
- 1.88 OnFriendMessageReceived
- 1.89 OnGameInviteReceived
- 1.90 OnInviteJoinComplete
- 1.91 OnPlayCameraAnim
- 1.92 OnReadProfileSettingsComplete
- 1.93 OnStopCameraAnim
- 1.94 OnTTSAudioFinished
- 1.95 OnUnlockAchievement
- 1.96 OnUpdatePropertyFOVAngle
- 1.97 OpenProgressMessageScene
- 1.98 OpenUIScene
- 1.99 PawnDied
- 1.100 PerformedUseAction
- 1.101 PlayAnnouncement
- 1.102 PlayBeepSound
- 1.103 PlayCameraAnim
- 1.104 PlayStartupMessage
- 1.105 PlayWinMessage
- 1.106 ProjectileWarningTimer
- 1.107 PulseTeamColor
- 1.108 QuitToMainMenu
- 1.109 ReceiveBotVoiceMessage
- 1.110 ReceiveProjectileWarning
- 1.111 ReceiveTauntMessage
- 1.112 RegisterPlayerDataStores
- 1.113 RemoveCameraEffect
- 1.114 Restart
- 1.115 RoundHasEnded
- 1.116 SaveProfile
- 1.117 SaveServerToHistory
- 1.118 SendMessage
- 1.119 ServerAdmin
- 1.120 ServerAdminLogin
- 1.121 ServerAdminLogOut
- 1.122 ServerBecomeActivePlayer
- 1.123 ServerChangeMap
- 1.124 ServerChangeTeam
- 1.125 ServerDropFlag
- 1.126 ServerEndMapListPublish
- 1.127 ServerForceTextMute
- 1.128 ServerForceTextUnMute
- 1.129 ServerForceVoiceMute
- 1.130 ServerForceVoiceUnMute
- 1.131 ServerGetGameHostNameAndId
- 1.132 ServerKickBan
- 1.133 ServerPlayerPreferences
- 1.134 ServerPlayVehicleHorn
- 1.135 ServerProcessSpeechRecognition
- 1.136 ServerReceiveNextMap
- 1.137 ServerRestartMap
- 1.138 ServerSay
- 1.139 ServerSessionBan
- 1.140 ServerSetAlias
- 1.141 ServerSetAutoTaunt
- 1.142 ServerSetCharacterData
- 1.143 ServerSetClanTag
- 1.144 ServerSetHand
- 1.145 ServerSetProcessingComplete
- 1.146 ServerShowPathToBase
- 1.147 ServerSpectate
- 1.148 ServerStartMapListPublish
- 1.149 ServerTeamSay
- 1.150 ServerThrowWeapon
- 1.151 ServerTriggerHero
- 1.152 ServerUse
- 1.153 ServerViewingMap
- 1.154 ServerViewObjective
- 1.155 ServerViewPlayerByName
- 1.156 ServerViewSelf
- 1.157 SetAutoObjective
- 1.158 SetBehindView
- 1.159 SetCameraAnimStrength
- 1.160 SetCameraMode
- 1.161 SetFrontEndErrorMessage
- 1.162 SetFrontEndTravelRetryInfo
- 1.163 SetHand
- 1.164 SetPawnConstructionScene
- 1.165 SetViewTarget
- 1.166 ShortServerMove
- 1.167 ShowAchievementToast
- 1.168 ShowHudMap
- 1.169 ShowMidGameMenu
- 1.170 ShowScoreboard
- 1.171 SpawnCamera
- 1.172 SpeakTTS
- 1.173 SpeechRecognitionComplete
- 1.174 StartZoom
- 1.175 StartZoomNonlinear
- 1.176 StopCameraAnim
- 1.177 StopViewShaking
- 1.178 StopZoom
- 1.179 TriggerInteracted
- 1.180 Typing
- 1.181 UnregisterPlayerDataStores
- 1.182 UpdateAchievement
- 1.183 UpdateRotation
- 1.184 UpdateSex
- 1.185 UpdateVolumeAndBrightness
- 1.186 UseModifierCard
- 1.187 UsingFirstPersonCamera
- 1.188 ViewNextBot
- 1.189 ViewShake
- UTPlayerController instance functions in other games:
- UDK
- Other member categories for this class:
- constants, exec functions, internal variables, states
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Instance functions
AchievementDone
Shows the achievement UI so you can enjoy the new shiny achievement
AcknowledgePossession
Overrides: PlayerController.AcknowledgePossession
AddModifierCard
Add Modifier Card
Parameters:
- Card - The Modifier Card to Add
AddOnlineDelegates
Sets online delegates to respond to for this PC.
AdjustFOV
Overrides: PlayerController.AdjustFOV
Called each frame from PlayerTick this function is used to transition towards the DesiredFOV if not already at it.
Parameters:
- DeltaTime - Time since last update
AdjustPersistentKey
AdminCmdOk
AimHelpModifier
Returns:
- the a scaling factor for the distance from the collision box of the target to accept aiming help (for instant hit shots)
AimingHelp
Overrides: PlayerController.AimingHelp
AllowTextMessage
Overrides: PlayerController.AllowTextMessage
AllowTTSMessageFrom
AlreadyInActionMusic
return true if music manager is already playing action track return true if no music manager (no need to tell non-existent music manager to change tracks
AtuallyShowQuickPickMenu
This will show the QuickPick Menu! *
BullseyeMessage
CallServerMove
Overrides: PlayerController.CallServerMove
CancelPendingConnection
Handler for the ProgressMessageScene's OnSelection delegate. Kills any existing online game sessions.
CanCommunicate
Internal. Returns FALSE if we're restricted from commincating, TRUE otherwise.
CanRestartPlayer
Overrides: PlayerController.CanRestartPlayer
CharacterProcessingComplete
called when the GRI finishes processing custom character meshes
CheckAutoObjective
attempts to find an objective for the player to complete depending on their settings and tells the player about it
Parameters:
- bOnlyNotifyDifferent - if true, only send messages to the player if the selected objective is different from the previous one
Note: needs to be called on the server, not the client (because that's where the AI is)
CheckBulletWhip
CheckJumpOrDuck
Overrides: PlayerController.CheckJumpOrDuck
CheckPickedVehicle
returns the Vehicle passed in if it can be driven
CheckVehicleToDrive
Returns vehicle which can be driven
Parameters:
- bEnterVehicle - if true then player enters the found vehicle
CleanupOnlineSubsystemSession
Cleans up online subsystem game sessions and posts stats if the match is arbitrated.
ClearCameraEffect
ClearDoubleClick
Overrides: PlayerController.ClearDoubleClick
ClearStringAliasBindingMapCache
Clear the contents of the command to bind key cache
ClientBecameActivePlayer
ClientEndZoom
Allows the server to tell the client to end zoom
ClientGameEnded
Overrides: PlayerController.ClientGameEnded
ClientIncrementAroundTheWorld
ClientIncrementLikeTheBackOfMyHand
ClientIncrementMixItUp
ClientMusicEvent
ClientPawnDied
Client-side notification that the pawn has died.
ClientPlayAnnouncement
ClientPlayCameraAnim
ClientPlayTakeHit
ClientReset
Overrides: PlayerController.ClientReset
ClientResetMapListPublish
ClientRestart
Overrides: PlayerController.ClientRestart
ClientRoundEnded
ClientSendNextMap
sends a single map in the current gametype's maplist to the server for updating
ClientSetAutoObjective
client-side notification of the current auto objective
ClientSetBehindView
ClientSetGameHostNameAndId
Called by the server to tell the client what its OwningPlayerId and PlayerName is
ClientSetOnlineStatus
Overrides: PlayerController.ClientSetOnlineStatus
Looks at the current game state and uses that to set the rich presence strings
Licensees should override this in their player controller derived class
ClientSetProcessingComplete
this is used in seamless travel when the PlayerController class got replaced to force bInitialProcessingComplete to true
ClientSetProgressMessage
Overrides: PlayerController.ClientSetProgressMessage
Sets or updates the any current progress message being displayed.
Parameters:
- MessageType - the type of progress message
- Message - the message to display
- Title - the title to use for the progress message.
ClientSetRequestedEntryWithFlag
sets bRequestedEntryWithFlag on the given vehicle to update the HUD
ClientSetSpeechRecognitionObject
ClientSmartUse
ClientSpawnCameraEffect
Spawn ClientSide Camera Effects *
ClientSpawnGoreCameraEffect
Spawn ClientSide gory Camera Effects (so low gore client can ignore) *
ClientStopCameraAnim
ClientUpdateAchievement
Unlocks the achievement on the client (can only be done clientside)
Parameters:
- AchievementId - the achievement to unlock
ClientUpdateGetALife
ClientUpdateSpiceOfLife
CommandMenuDeactivated
ConvolveTimeout
Overrides: PlayerController.ConvolveTimeout
Called when the convolve response has timed out
DamageShake
Causes a view shake based on the amount of damage Should only be called on the owning client
DisplayDebug
Overrides: PlayerController.DisplayDebug
(Description copied from PlayerController.DisplayDebug)
list important PlayerController variables on canvas. HUD will call DisplayDebug() on the current ViewTarget when the ShowDebug exec is used
Parameters:
- HUD - HUD with canvas to draw on
- out_YL - Height of the current font
- out_YPos - Y position on Canvas. out_YPos += out_YL, gives position to draw text for next debug line.
DrawHUD
Overrides: PlayerController.DrawHUD
Hook called from HUD actor. Gives access to HUD and Canvas
EndZoom
This function will end a zoom and reset the FOV to the default value
EndZoomNonlinear
Ends a zoom, but interpolates nonlinearly back to the default value.
FindProgressMessageScene
Returns:
- a reference to the progress message scene, if it's already open.
FindVehicleToDrive
Overrides: PlayerController.FindVehicleToDrive
Tries to find a vehicle to drive within a limited radius. Returns true if successful
FinishQuitToMainMenu
Called after onlinesubsystem game cleanup has completed.
FixFOV
Overrides: PlayerController.FixFOV
ForceCloseProgressMessageScene
Manually closes the progress message scene, if open. Normally the progress message scene would be closed when the user clicks one of its buttons.
Parameters:
- bSimulateCancel - if TRUE, will set the message box's selection to the index of the Cancel button; otherwise, just closes the scene without touching the selection value.
GetAdjustedAimFor
Overrides: PlayerController.GetAdjustedAimFor
Adjusts weapon aiming direction. Gives controller a chance to modify the aiming of the pawn. For example aim error, auto aiming, adhesion, AI help... Requested by weapon prior to firing. UTPlayerController implementation doesn't adjust aim, but sets the shottarget (for warning enemies)
Parameters:
- W - weapon about to fire
- StartFireLoc - world location of weapon fire start trace, or projectile spawn loc.
- BaseAimRot - original aiming rotation without any modifications.
HasModifierCard
Returns:
- true if the player has any of these cards
HasPersistentKey
LandingShake
Overrides: Controller.LandingShake
LandingShake() returns true if controller wants landing view shake
LoadCharacterFromProfile
Loads the player's custom character from their profile.
LoadSettingsFromProfile
LongClientAdjustPosition
Overrides: PlayerController.LongClientAdjustPosition
NotifyConnectionError
Overrides: PlayerController.NotifyConnectionError
Notifies the player that an attempt to connect to a remote server failed, or an existing connection was dropped.
Parameters:
- Message - a description of why the connection was lost
- Title - the title to use in the connection failure message.
NotifyInviteFailed
Overrides: PlayerController.NotifyInviteFailed
Override to display a message to the user
NotifyNotAllPlayersCanJoinInvite
Overrides: PlayerController.NotifyNotAllPlayersCanJoinInvite
Override to display a message to the user
NotifyNotEnoughSpaceInInvite
Overrides: PlayerController.NotifyNotEnoughSpaceInInvite
Override to display a message to the user
NotifyTakeHit
Overrides: PlayerController.NotifyTakeHit
Notification from pawn that it has received damage via TakeDamage().
OnControllerChanged
Overrides: PlayerController.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
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
OnEndOnlineGameComplete
Called when the online game has finished ending.
OnFriendInviteReceived
Callback for when a friend request has been received.
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
Callback for when a game invite has been received.
OnInviteJoinComplete
Overrides: PlayerController.OnInviteJoinComplete
Once the join completes, use the platform specific connection information to connect to it
Parameters:
- bWasSuccessful - whether the join worked or not
OnPlayCameraAnim
OnReadProfileSettingsComplete
Callback for when the profile finishes reading for this PC.
OnStopCameraAnim
OnTTSAudioFinished
OnUnlockAchievement
Handles the Kismet action to unlock an achievement
Parameters:
- Action - the action containing which achievement to unlock
OnUpdatePropertyFOVAngle
called through camera anim code when it modifies FOVAngle
OpenProgressMessageScene
Opens the scene which is used to display connection/download progress & error messages. If the scene is already open, will return a reference to the existing scene rather than creating another one.
Returns:
- a reference to an instance of UTUIScene_ConnectionStatus which is fully initialized and ready to be used.
OpenUIScene
Attempts to open a UI Scene.
Parameters:
- Template - The Template of the scene to open.
Returns:
- the opened scene
PawnDied
Overrides: PlayerController.PawnDied
PerformedUseAction
Overrides: PlayerController.PerformedUseAction
return true if player the Use action was handled
PlayAnnouncement
PlayBeepSound
Overrides: PlayerController.PlayBeepSound
PlayCameraAnim
plays the specified camera animation with the specified weight (0 to 1) local client only
PlayStartupMessage
PlayWinMessage
ProjectileWarningTimer
PulseTeamColor
Called from the UTTeamGameMessage, this will cause all TeamColored Images on the hud to pulse.
QuitToMainMenu
Called when returning to the main menu.
ReceiveBotVoiceMessage
Receive a voice message from a bot - process locally, since character may be different on client
ReceiveProjectileWarning
Overrides: Controller.ReceiveProjectileWarning
ReceiveTauntMessage
Receive a taunt from a player - process locally, since character may be different on client
RegisterPlayerDataStores
Overrides: PlayerController.RegisterPlayerDataStores
Creates and initializes the "PlayerOwner" and "PlayerSettings" data stores. This function assumes that the PlayerReplicationInfo for this player has not yet been created, and that the PlayerOwner data store's PlayerDataProvider will be set when the PRI is registered.
Overloaded so we can initialize game specific player data stores.
RemoveCameraEffect
Parameters:
- CamEmitter - Clear the CameraEffect if it is the one passed in
Restart
Overrides: PlayerController.Restart
RoundHasEnded
Overrides: Controller.RoundHasEnded
SaveProfile
Saves the current profile complete with UI scene
SaveServerToHistory
Saves the UniqueNetId for the current server to the player's list of recently visited servers (server history).
SendMessage
Overrides: Controller.SendMessage
ServerAdmin
ServerAdminLogin
ServerAdminLogOut
ServerBecomeActivePlayer
ServerChangeMap
ServerChangeTeam
Overrides: PlayerController.ServerChangeTeam
Don't allow team changes if we are in single player, or too frequently
ServerDropFlag
ServerEndMapListPublish
indicates server has received all maps in the client's list
ServerForceTextMute
ServerForceTextUnMute
ServerForceVoiceMute
ServerForceVoiceUnMute
ServerGetGameHostNameAndId
ServerKickBan
Allows the local player or admin to kick a player
ServerPlayerPreferences
ServerPlayVehicleHorn
ServerProcessSpeechRecognition
ServerReceiveNextMap
server receives a single map list entry and asks client for the next one
ServerRestartMap
ServerSay
Overrides: PlayerController.ServerSay
ServerSessionBan
ServerSetAlias
ServerSetAutoTaunt
ServerSetCharacterData
tells the server about the character this player is using
ServerSetClanTag
Sets the ClanTag for this player.
Parameters:
- InClanTag - New clan tag for the player.
ServerSetHand
ServerSetProcessingComplete
called after any initial clientside processing is complete to allow the client to spawn in
ServerShowPathToBase
ServerSpectate
ServerStartMapListPublish
gets the server started for receiving a map list
ServerTeamSay
Overrides: PlayerController.ServerTeamSay
ServerThrowWeapon
Overrides: PlayerController.ServerThrowWeapon
ServerTriggerHero
ServerUse
Overrides: PlayerController.ServerUse
Limit use frequency
ServerViewingMap
ServerViewObjective
ServerViewPlayerByName
ServerViewSelf
Overrides: PlayerController.ServerViewSelf
SetAutoObjective
SetBehindView
SetCameraAnimStrength
Allows changing camera anim strength on the fly
SetCameraMode
Overrides: PlayerController.SetCameraMode
Set new camera mode
Parameters:
- NewCamMode - new camera mode.
SetFrontEndErrorMessage
Sets a error message in the registry datastore that will display to the user the next time they are in the frontend.
Parameters:
- Title - Title of the messagebox.
- Message - Message of the messagebox.
SetFrontEndTravelRetryInfo
Saves information to the registry about the last travel attempt, to allow the frontend to attempt a reconnect if necessary
SetHand
SetPawnConstructionScene
SetViewTarget
Overrides: PlayerController.SetViewTarget
ShortServerMove
ShowAchievementToast
ShowHudMap
ShowMidGameMenu
ShowScoreboard
SpawnCamera
SpeakTTS
SpeechRecognitionComplete
set to VoiceInterface's speech recognition delegate; called when words are recognized
StartZoom
This function will cause the PlayerController to begin zooming to a new FOV Level.
Parameters:
- NewDesiredFOV - The new FOV Value to head towards
- NewZoomRate - The rate of transition in degrees per second
StartZoomNonlinear
StopCameraAnim
Stops the currently playing camera animation.
StopViewShaking
Turns off any view shaking
StopZoom
This function will stop the zooming process keeping the current FOV Angle
TriggerInteracted
Overrides: PlayerController.TriggerInteracted
Examines the nearby enviroment and generates a priority sorted list of interactable actors, and then attempts to activate each of them until either one was successfully activated, or no more actors are available.
Typing
UnregisterPlayerDataStores
Overrides: PlayerController.UnregisterPlayerDataStores
Unregisters the "PlayerOwner" data store for this player. Called when this PlayerController is destroyed.
Overloaded so we can unregister game specific player data stores.
UpdateAchievement
UpdateRotation
Overrides: PlayerController.UpdateRotation
UpdateSex
Overrides: Controller.UpdateSex
Sex is set when mesh is set for pawn
UpdateVolumeAndBrightness
Updates sound volumes and screen brightness. Done in a seperate function so it can be called by the sliders to update these values in real time without doing a lot of extra work.
UseModifierCard
Use Modifier Card
Parameters:
- Card - The Modifier Card use
UsingFirstPersonCamera
Overrides: PlayerController.UsingFirstPersonCamera
return whether viewing in first person mode
ViewNextBot
ViewShake
Overrides: PlayerController.ViewShake
Sets ShakeOffset and ShakeRot to the current view shake that should be applied to the camera