UE3:PlayerController instance functions (UDK)

Object >> Actor >> Controller >> PlayerController (instance functions)

PlayerController instance functions in other games:

U2, U2XMP, UE2Runtime, UT2003, UT2004, UT3

Other member categories for this class:

events, exec functions, internal variables, native functions, states

Instance functions

AcknowledgePossession

function AcknowledgePossession (Pawn P)

AddCheats

function AddCheats ()

AdjustFOV

function AdjustFOV (float DeltaTime)

AdjustFOV() FOVAngle smoothly interpolates to DesiredFOV

AimHelpDot

function float AimHelpDot (bool bInstantHit)

AimHelpDot()

Returns:

the dot product corresponding to the maximum deflection of target for which aiming help should be applied

AimingHelp

function bool AimingHelp (bool bInstantHit)

AllowTextMessage

function bool AllowTextMessage (string Msg)

AllowTTSMessageFrom

simulated private function bool AllowTTSMessageFrom (PlayerReplicationInfo PRI)

AskForPawn

reliable server function AskForPawn ()

BugItGoString

function BugItGoString (string TheLocation, string TheRotation)

This will move the player and set their rotation to the passed in values. We have this version of the BugIt family strings can be passed in from the game ?options easily

BugItWorker

function BugItWorker (Object.Vector TheLocation, Object.Rotator TheRotation)

This will move the player and set their rotation to the passed in values. This actually does the location / rotation setting. Additionally it will set you as ghost as the level may have changed since the last time you were here. And the bug may actually be inside of something.

CallServerMove

function CallServerMove (SavedMove NewMove, Object.Vector ClientLoc, byte ClientRoll, int View, SavedMove OldMove)

CanAllPlayersPlayOnline

function bool CanAllPlayersPlayOnline ()

Validates that each local player can play online

Returns:

true if there is sufficient space, false if not

CanCommunicate

simulated private function bool CanCommunicate ()

Overridden by specific games

CanRestartPlayer

function bool CanRestartPlayer ()

CanUnpauseControllerConnected

function bool CanUnpauseControllerConnected ()

Callback that checks to see if the controller is connected before unpausing

CanUnpauseExternalUI

function bool CanUnpauseExternalUI ()

Callback that checks the external UI state before allowing unpause

CanViewUserCreatedContent

function bool CanViewUserCreatedContent ()

Checks for parental controls blocking user created content

CheckJumpOrDuck

function CheckJumpOrDuck ()

CleanOutSavedMoves

function CleanOutSavedMoves ()

CleanupPawn

function CleanupPawn ()

When the Controller is destroyed, the controlled pawn will need to be killed, but not the vehicle

CleanupPRI

function CleanupPRI ()

Overrides: Controller.CleanupPRI

ClearAckedMoves

function ClearAckedMoves ()

ClearDoubleClick

function ClearDoubleClick ()

ClearInviteDelegates

function ClearInviteDelegates ()

Clears all of the invite delegates

ClientAckGoodMove

unreliable client function ClientAckGoodMove (float TimeStamp)

ClientAdjustPosition

unreliable client function ClientAdjustPosition (float TimeStamp, name newState, Actor.EPhysics newPhysics, float NewLocX, float NewLocY, float NewLocZ, float NewVelX, float NewVelY, float NewVelZ, Actor NewBase)

ClientAdminMessage

reliable client function ClientAdminMessage (string Msg)

ClientArbitratedMatchEnded

reliable client function ClientArbitratedMatchEnded ()

Called when an arbitrated match has ended and we need to disconnect

ClientCapBandwidth

reliable client function ClientCapBandwidth (int Cap)

ClientClearKismetText

reliable client final function ClientClearKismetText (Object.Vector2D MessageOffset)

Stop drawing a kismet message on the HUD

ClientControlMovieTexture

reliable client function ClientControlMovieTexture (TextureMovie MovieTexture, SeqAct_ControlMovieTexture.EMovieControlType Mode)

ClientDrawCoordinateSystem

reliable client function ClientDrawCoordinateSystem (Object.Vector AxisLoc, Object.Rotator AxisRot, float Scale, optional bool bPersistentLines)

ClientDrawKismetText

reliable client final function ClientDrawKismetText (HUD.KismetDrawTextInfo DrawTextInfo, float DisplayTime)

Start drawing a kismet message on the HUD

ClientEndOnlineGame

reliable client function ClientEndOnlineGame ()

Ends the online game using the session name in the PRI

ClientGameEnded

reliable client function ClientGameEnded (Actor EndGameFocus, bool bIsWinner)

ClientGotoState

reliable client function ClientGotoState (name NewState, optional name NewLabel)

ClientIgnoreLookInput

client reliable function ClientIgnoreLookInput (bool bIgnore)

calls IgnoreLookInput on client

ClientIgnoreMoveInput

client reliable function ClientIgnoreMoveInput (bool bIgnore)

calls IgnoreMoveInput on client

ClientInitializeDataStores

reliable client function ClientInitializeDataStores ()

Initializes this client's Player data stores after seamless map travel

ClientPlayActorFaceFXAnim

reliable client function ClientPlayActorFaceFXAnim (Actor SourceActor, FaceFXAnimSet AnimSet, string GroupName, string SeqName, SoundCue SoundCueToPlay)

plays a FaceFX anim on the specified actor for the client

ClientPlayCameraShake

unreliable client function ClientPlayCameraShake (CameraShake Shake, optional float Scale, optional bool bTryForceFeedback, optional Camera.ECameraAnimPlaySpace PlaySpace, optional Object.Rotator UserPlaySpaceRot)

Play Camera Shake

ClientRegisterForArbitration

reliable client function ClientRegisterForArbitration ()

Tells the client to register with arbitration. The client must notify the server once that is complete or it will be kicked from the match

ClientRegisterHostStatGuid

reliable client function ClientRegisterHostStatGuid (string StatGuid)

Registers the host's stat guid with the online subsystem

Parameters:

• StatGuid - the stat guid to register

ClientReset

reliable client function ClientReset ()

ClientRestart

reliable client function ClientRestart (Pawn NewPawn)

ClientReturnToParty

reliable client function ClientReturnToParty ()

Used when a host is telling a client to return to their party host from the current session. It looks for the session named 'Party' and does a travel to it. If it's not available, it just does a "disconnect"

ClientSetCameraMode

reliable client function ClientSetCameraMode (name NewCamMode)

Replicated function to set camera style on client

Parameters:

• NewCamMode - name defining the new camera mode

ClientSetCinematicMode

reliable client function ClientSetCinematicMode (bool bInCinematicMode, bool bAffectsMovement, bool bAffectsTurning, bool bAffectsHUD)

called by the server to synchronize cinematic transitions with the client

ClientSetHostUniqueId

reliable client function ClientSetHostUniqueId (OnlineSubsystem.UniqueNetId InHostId)

Sets the host's net id for handling dropped arbitrated matches

Parameters:

• InHostId - the host's unique net id to report the drop for

ClientSetHUD

reliable client function ClientSetHUD (class<HUD> newHUDType, class<ScoreBoard> newScoringType)

ClientSetOnlineStatus

reliable client function 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

ClientStartNetworkedVoice

reliable client function ClientStartNetworkedVoice ()

Tells this client that it should send voice data over the network

ClientStartOnlineGame

reliable client function ClientStartOnlineGame ()

Starts the online game using the session name in the PRI

ClientStopCameraShake

unreliable client function ClientStopCameraShake (CameraShake Shake)

ClientStopNetworkedVoice

reliable client function ClientStopNetworkedVoice ()

Tells this client that it should not send voice data over the network

ClientTravelToSession

reliable client function ClientTravelToSession (name SessionName, class<OnlineGameSearch> SearchClass, byte PlatformSpecificInfo[68])

Used when a host is telling a client to go to a specific Internet session

Parameters:

• SessionName - the name of the session to register
• SearchClass - the search that should be populated with the session
• PlatformSpecificInfo - the binary data to place in the platform specific areas

ClientUpdatePosition

function ClientUpdatePosition ()

ClientVoiceHandshakeComplete

reliable client function ClientVoiceHandshakeComplete ()

Tells the client that the server has all the information it needs and that it is ok to start sending voice packets. The server will already send voice packets when this function is called, since it is set server side and then forwarded

NOTE: This is done as an RPC instead of variable replication because ordering matters

ClientVoiceMessage

function ClientVoiceMessage (PlayerReplicationInfo Sender, PlayerReplicationInfo Recipient, name messagetype, byte messageID)

ClientWriteLeaderboardStats

reliable client function ClientWriteLeaderboardStats (class<OnlineStatsWrite> OnlineStatsWriteClass)

Tells the clients to write the stats using the specified stats object

Parameters:

• OnlineStatsWriteClass - the stats class to write with

ClientWriteOnlinePlayerScores

reliable client function ClientWriteOnlinePlayerScores (int LeaderboardId)

Writes the scores for all active players. Override this in your playercontroller class to provide custom scoring

Parameters:

• LeaderboardId - the leaderboard the scores are being written to

CompressAccel

function int CompressAccel (int C)

DelayedPrepareMapChange

function DelayedPrepareMapChange ()

used to wait until a map change can be prepared when one was already in progress

DisableDebugAI

function DisableDebugAI ()

DisplayDebug

simulated function DisplayDebug (HUD HUD, out float out_YL, out float out_YPos)

Overrides: Controller.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.

DoForceFeedbackForScreenShake

simulated protected function DoForceFeedbackForScreenShake (CameraShake ShakeData, float ShakeScale)

Attempts to play force-feedback that matches the camera shake. To be implemented at a higher level (see GameFramework).

DrawDebugTextList

final simulated function DrawDebugTextList (Canvas Canvas, float RenderDelta)

Iterate through list of debug text and draw it over the associated actors in world space. Also handles culling null entries, and reducing the duration for timed debug text.

DrawHUD

function DrawHUD (HUD H)

Hook called from HUD actor. Gives access to HUD and Canvas

DualServerMove

unreliable server function DualServerMove (float TimeStamp0, Object.Vector InAccel0, byte PendingFlags, int View0, float TimeStamp, Object.Vector InAccel, Object.Vector ClientLoc, byte NewFlags, byte ClientRoll, int View)

EnterStartState

function EnterStartState ()

FindVehicleToDrive

function bool FindVehicleToDrive ()

Tries to find a vehicle to drive within a limited radius. Returns true if successful

FixFOV

function FixFOV ()

ForceClearUnpauseDelegates

function ForceClearUnpauseDelegates ()

Tells the game info to forcibly remove this player's CanUnpause delegates from its list of Pausers.

Called when the player controller is being destroyed to prevent the game from being stuck in a paused state when a PC that paused the game is destroyed before the game is unpaused.

ForceDeathUpdate

function ForceDeathUpdate ()

GameHasEnded

function GameHasEnded (optional Actor EndGameFocus, optional bool bIsWinner)

Overrides: Controller.GameHasEnded

GameplayMutePlayer

function GameplayMutePlayer (OnlineSubsystem.UniqueNetId PlayerNetId)

Mutes a remote player on the server and then tells the client to mute

Parameters:

• PlayerNetId - the remote player to mute

GameplayUnmutePlayer

function GameplayUnmutePlayer (OnlineSubsystem.UniqueNetId PlayerNetId)

Unmutes a remote player on the server and then tells the client to unmute

Parameters:

• PlayerNetId - the remote player to unmute

GetAdjustedAimFor

function Object.Rotator GetAdjustedAimFor (Weapon W, Object.Vector StartFireLoc)

Overrides: Controller.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.

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.

GetFreeMove

final function SavedMove GetFreeMove ()

GetOnlineSubsystem

simulated final function OnlineSubsystem GetOnlineSubsystem ()

Wrapper for getting reference to the OnlineSubsystem

GetRumbleScale

final function float GetRumbleScale ()

Returns the rumble scale (or 1 if none is specified)

GetSplitscreenPlayerByIndex

simulated function PlayerReplicationInfo GetSplitscreenPlayerByIndex (optional int PlayerIndex)

Returns the PRI associated with the player at the specified index.

Parameters:

• PlayerIndex - the index [into the local player's GamePlayers array] for the player PRI to find

Returns:

the PRI associated with the player at the specified index, or None if the player is not a split-screen player or the index was out of range.

GetSplitscreenPlayerCount

simulated function int GetSplitscreenPlayerCount ()

Returns the number of split-screen players playing on this player's machine.

Returns:

the total number of players on the player's local machine, or 0 if this player isn't playing split-screen.

GetTriggerUseList

function GetTriggerUseList (float interactDistanceToCheck, float crosshairDist, float minDot, bool bUsuableOnly, out array<Trigger> out_useList)

Looks at all nearby triggers, looking for any that can be interacted with.

Parameters:

• interactDistanceToCheck - distance to search for nearby triggers
• crosshairDist - distance from the crosshair that triggers must be, else they will be filtered out
• minDot - minimum dot product between trigger and the camera orientation needed to make the list
• bUsuableOnly - if true, event must return true from SequenceEvent::CheckActivate()
• out_useList - the list of triggers found to be usuable

GetUIController

final function UIInteraction GetUIController ()

Returns the interaction that manages the UI system.

GivePawn

reliable client function GivePawn (Pawn NewPawn)

HandlePickup

function HandlePickup (Inventory Inv)

Overrides: Controller.HandlePickup

HandleWalking

function HandleWalking ()

HasSplitscreenPlayer

simulated function bool HasSplitscreenPlayer (PlayerReplicationInfo PRI)

Determines whether the PlayerReplicationInfo is associated with a split-screen player. Safe to use on client and server.

Parameters:

• PRI - the PlayerReplicationInfo to check

Returns:

TRUE if the player associated with the PRI is a split-screen player. FALSE if not.

HearSoundFinished

simulated function HearSoundFinished (AudioComponent AC)

hooked up to the OnAudioFinished delegate of AudioComponents created through PlaySound() to return them to the pool

IgnoreLookInput

function IgnoreLookInput (bool bNewLookInput)

Toggles look input. FALSE means look input is cleared.

IgnoreMoveInput

function IgnoreMoveInput (bool bNewMoveInput)

Toggles move input. FALSE means movement input is cleared.

IncrementNumberOfMatchesPlayed

function IncrementNumberOfMatchesPlayed ()

InviteHasEnoughSpace

function bool InviteHasEnoughSpace (OnlineGameSettings InviteSettings)

Counts the number of local players to verify there is enough space

Returns:

true if there is sufficient space, false if not

IsClosestLocalPlayerToActor

simulated function bool IsClosestLocalPlayerToActor (Actor TheActor)

IsForceFeedbackAllowed

simulated function bool IsForceFeedbackAllowed ()

Returns:

TRUE if starting a force feedback waveform is allowed; child classes should override this method to e.g. temporarily disable force feedback

IsPartyLeader

simulated function bool IsPartyLeader ()

Wrapper for determining whether a player is the party leader.

Returns:

TRUE if the player is the leader of the party; FALSE if not in a party or not the party leader.

IsPaused

final simulated function bool IsPaused ()

Returns whether the game is currently paused.

IsPrimaryPlayer

simulated function bool IsPrimaryPlayer ()

Wrapper for determining whether this player is the first player on their console.

Returns:

TRUE if this player is not using splitscreen, or is the first player in the split-screen layout.

IsSplitscreenPlayer

simulated function bool IsSplitscreenPlayer (optional out int out_SplitscreenPlayerIndex)

Determines whether this player is playing split-screen.

Parameters:

• out_SplitscreenPlayerIndex - receives the index [into the player's local GamePlayers array] for this player, if playing splitscreen. .

Returns:

TRUE if this player is playing splitscreen.

LongClientAdjustPosition

unreliable client function LongClientAdjustPosition (float TimeStamp, name newState, Actor.EPhysics newPhysics, float NewLocX, float NewLocY, float NewLocZ, float NewVelX, float NewVelY, float NewVelZ, Actor NewBase, float NewFloorX, float NewFloorY, float NewFloorZ)

MoveAutonomous

function MoveAutonomous (float DeltaTime, byte CompressedFlags, Object.Vector newAccel, Object.Rotator DeltaRot)

MoveLog

function MoveLog (name FunctionName, string Message, float TimeStamp, optional Object.Vector NewLoc, optional Object.Vector NewVel)

Use this for Debugging Move replication For FunctionName, use GetFuncName()

NotifyChangedWeapon

function NotifyChangedWeapon (Weapon PreviousWeapon, Weapon NewWeapon)

Overrides: Controller.NotifyChangedWeapon

NotifyInviteFailed

function NotifyInviteFailed ()

Override to display a message to the user

NotifyNotAllPlayersCanJoinInvite

function NotifyNotAllPlayersCanJoinInvite ()

Override to display a message to the user

NotifyNotEnoughSpaceInInvite

function NotifyNotEnoughSpaceInInvite ()

Override to display a message to the user

NotifyTakeHit

function NotifyTakeHit (Controller InstigatedBy, Object.Vector HitLocation, int Damage, class<DamageType> damageType, Object.Vector Momentum)

Overrides: Controller.NotifyTakeHit

Notification from pawn that it has received damage via TakeDamage().

OldServerMove

unreliable server function OldServerMove (float OldTimeStamp, byte OldAccelX, byte OldAccelY, byte OldAccelZ, byte OldMoveFlags)

OnArbitrationRegisterComplete

function OnArbitrationRegisterComplete (name SessionName, bool bWasSuccessful)

Delegate that is notified when registration is complete. Forwards the call to the server so that it can finalize processing

Parameters:

• SessionName - the name of the session this is for
• bWasSuccessful - whether registration worked or not

OnCameraShake

function OnCameraShake (SeqAct_CameraShake inAction)

Scripting hook for camera shakes.

OnConsoleCommand

function OnConsoleCommand (SeqAct_ConsoleCommand inAction)

Kismet hook to trigger console events

OnControllerChanged

function OnControllerChanged (int ControllerId, bool bIsConnected)

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

OnDestroy

simulated function OnDestroy (SeqAct_Destroy Action)

Overrides: Actor.OnDestroy

If this actor is not already scheduled for destruction, destroy it now.

OnDestroyForInviteComplete

function OnDestroyForInviteComplete (name SessionName, bool bWasSuccessful)

Delegate called once the destroy of an online game before accepting an invite is complete. From here, the game invite can be accepted

Parameters:

• SessionName - the name of the session being ended
• bWasSuccessful - whether the end completed ok or not

OnDrawText

function OnDrawText (SeqAct_DrawText inAction)

OnEndForInviteComplete

function OnEndForInviteComplete (name SessionName, bool bWasSuccessful)

Delegate called once the destroy of an online game before accepting an invite is complete. From here, the game invite can be accepted

Parameters:

• SessionName - the name of the session being ended
• bWasSuccessful - whether the end completed ok or not

OnExternalUIChanged

function OnExternalUIChanged (bool bIsOpening)

Attempts to pause/unpause the game when the UI opens/closes. Note: pausing only happens in standalone mode

Parameters:

• bIsOpening - whether the UI is opening or closing

OnFlyThroughHasEnded

simulated function OnFlyThroughHasEnded (SeqAct_FlyThroughHasEnded InAction)

This is used to notify the PlayerController that a fly through has ended and then quit if we are doing a Sentinel run *

OnForceFeedback

function OnForceFeedback (SeqAct_ForceFeedback Action)

Kismet interface for playing/stopping force feedback.

OnGameInviteAccepted

function OnGameInviteAccepted (const out OnlineGameSearch.OnlineGameSearchResult InviteResult)

Delegate called when the user accepts a game invite externally. This allows the game code a chance to clean up before joining the game via AcceptGameInvite() call.

NOTE: There must be space for all signed in players to join the game. All players must also have permission to play online too.

Parameters:

• InviteResult - the search/settings for the game we're to join

OnInviteJoinComplete

function OnInviteJoinComplete (name SessionName, bool bWasSuccessful)

Once the join completes, use the platform specific connection information to connect to it

Parameters:

• SessionName - the name of the session that was joined
• bWasSuccessful - whether the join worked or not

OnJoinTravelToSessionComplete

function OnJoinTravelToSessionComplete (name SessionName, bool bWasSuccessful)

Called when the join for the travel destination has completed

Parameters:

• SessionName - the name of the session the event is for
• bWasSuccessful - whether it worked or not

OnRegisterHostStatGuidComplete

function OnRegisterHostStatGuidComplete (bool bWasSuccessful)

Called once the host registration has completed. Sends the host this clients stat guid

Parameters:

• bWasSuccessful - true if the registration worked, false otherwise

OnSetCameraTarget

simulated function OnSetCameraTarget (SeqAct_SetCameraTarget inAction)

OnSetSoundMode

function OnSetSoundMode (SeqAct_SetSoundMode Action)

A trivial way to handle the SetSoundMode kismet action

OnToggleCinematicMode

function OnToggleCinematicMode (SeqAct_ToggleCinematicMode Action)

Handles switching the player in/out of cinematic mode.

OnToggleHUD

simulated function OnToggleHUD (SeqAct_ToggleHUD inAction)

OnToggleInput

function OnToggleInput (SeqAct_ToggleInput inAction)

PauseRumbleForAllPlayers

function PauseRumbleForAllPlayers (optional bool bShouldPauseRumble)

Pause force-feedback for all local players.

Parameters:

• bShouldPauseRumble - indicates whether force-feedback should be paused or unpaused.

PawnDied

function PawnDied (Pawn P)

Overrides: Controller.PawnDied

PerformedUseAction

function bool PerformedUseAction ()

return true if player the Use action was handled

PlayBeepSound

function PlayBeepSound ()

PlayerMove

function PlayerMove (float DeltaTime)

PostControllerIdChange

function PostControllerIdChange ()

Notification that the ControllerId for this PC's LocalPlayer has been changed. Re-register all player data stores and any delegates that require a ControllerId.

PreControllerIdChange

function PreControllerIdChange ()

Notification that the ControllerId for this PC LocalPlayer is about to change. Provides the PC a chance to cleanup anything that was associated with the old ControllerId. When this method is called, LocalPlayer.ControllerId is still the old value.

ProcessDrive

function ProcessDrive (float InForward, float InStrafe, float InUp, bool InJump)

ProcessMove

function ProcessMove (float DeltaTime, Object.Vector newAccel, Actor.EDoubleClickDir DoubleClickMove, Object.Rotator DeltaRot)

ProcessViewRotation

function ProcessViewRotation (float DeltaTime, out Object.Rotator out_ViewRotation, Object.Rotator DeltaRot)

Processes the player's ViewRotation adds delta rot (player input), applies any limits and post-processing returns the final ViewRotation set on PlayerController

Parameters:

• DeltaTime - time since last frame
• ViewRotation - current player ViewRotation
• DeltaRot - player input added to ViewRotation

RegisterCustomPlayerDataStores

simulated protected function RegisterCustomPlayerDataStores ()

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.

RegisterOnlineDelegates

function RegisterOnlineDelegates ()

Registers any handlers for delegates in the OnlineSubsystem. Called when a player is being created and/or ControllerId is changing.

RegisterPlayerDataStores

simulated final function RegisterPlayerDataStores ()

Register all player data stores.

RegisterStandardPlayerDataStores

simulated protected function RegisterStandardPlayerDataStores ()

Register any player data stores which do not require special initialization.

ReloadProfileSettings

simulated function ReloadProfileSettings ()

Refetches this player's profile settings.

ReplicateMove

function ReplicateMove (float DeltaTime, Object.Vector NewAccel, Actor.EDoubleClickDir DoubleClickMove, Object.Rotator DeltaRot)

ResetFOV

function ResetFOV ()

ResetPlayerMovementInput

function ResetPlayerMovementInput ()

reset input to defaults

ResetTimeMargin

function ResetTimeMargin ()

Restart

function Restart (bool bVehicleTransition)

Overrides: Controller.Restart

SeamlessTravelFrom

function SeamlessTravelFrom (PlayerController OldPC)

called when seamless travelling and the specified PC is being replaced by this one copy over data that should persist (not called if PlayerControllerClass is the same for the from and to gametypes)

SeamlessTravelTo

function SeamlessTravelTo (PlayerController NewPC)

called when seamless travelling and we are being replaced by the specified PC clean up any persistent state (post process chains on LocalPlayers, for example) (not called if PlayerControllerClass is the same for the from and to gametypes)

Sentinel_PostAcquireTravelTheWorldPoints

function Sentinel_PostAcquireTravelTheWorldPoints ()

This function is called after we acquire the travel points right before we start traveling.

Sentinel_PreAcquireTravelTheWorldPoints

function Sentinel_PreAcquireTravelTheWorldPoints ()

This function is called before we acquire the travel points.

Sentinel_SetupForGamebasedTravelTheWorld

function Sentinel_SetupForGamebasedTravelTheWorld ()

This is a function which is called when sentinel is able to start TravelTheWorld. This allows the specific game to do things such as turning off UI/HUD and to not enter some default starting the game state.

ServerAcknowledgePossession

reliable server function ServerAcknowledgePossession (Pawn P)

ServerCamera

reliable server function ServerCamera (name NewMode)

ServerCauseEvent

unreliable server function ServerCauseEvent (name EventName)

Attempts to match the name passed in to a SeqEvent_Console object and then activate it.

Parameters:

• eventName - name of the event to cause

ServerChangeName

reliable server function ServerChangeName (coerce string S)

ServerChangeTeam

reliable server function ServerChangeTeam (int N)

ServerDrive

unreliable server function ServerDrive (float InForward, float InStrafe, float aUp, bool InJump, int View)

ServerGivePawn

function ServerGivePawn ()

Overrides: Controller.ServerGivePawn

ServerMove

unreliable server function ServerMove (float TimeStamp, Object.Vector InAccel, Object.Vector ClientLoc, byte MoveFlags, byte ClientRoll, int View)

ServerMutate

reliable server function ServerMutate (string MutateString)

ServerPause

reliable server function ServerPause ()

ServerRegisterClientStatGuid

reliable server function ServerRegisterClientStatGuid (string StatGuid)

Registers the client's stat guid with the online subsystem

Parameters:

• StatGuid - the stat guid to register

ServerRegisteredForArbitration

reliable server function ServerRegisteredForArbitration (bool bWasSuccessful)

Notifies the server that the arbitration registration is complete

Parameters:

• bWasSuccessful - whether the registration with arbitration worked

ServerRestartGame

reliable server function ServerRestartGame ()

ServerSay

unreliable server function ServerSay (string Msg)

ServerSetNetSpeed

reliable server function ServerSetNetSpeed (int NewSpeed)

sets NetSpeed on the server, so it won't send the client more than this many bytes

ServerSetSpectatorLocation

unreliable server function ServerSetSpectatorLocation (Object.Vector NewLoc)

when spectating, tells server where the client is (client is authoritative on location when spectating)

ServerShortTimeout

reliable server function ServerShortTimeout ()

ServerSpeech

reliable server function ServerSpeech (name Type, int Index, string Callsign)

ServerSuicide

reliable server function ServerSuicide ()

ServerTeamSay

unreliable server function ServerTeamSay (string Msg)

ServerThrowWeapon

reliable server function ServerThrowWeapon ()

ServerUpdatePing

unreliable server function ServerUpdatePing (int NewPing)

ServerUse

unreliable server function ServerUse ()

Player pressed UseKey

ServerUTrace

reliable server function ServerUTrace ()

ServerVerifyViewTarget

reliable server function ServerVerifyViewTarget ()

ServerViewNextPlayer

unreliable server function ServerViewNextPlayer ()

ServerViewPrevPlayer

unreliable server function ServerViewPrevPlayer ()

ServerViewSelf

unreliable server function ServerViewSelf (optional Camera.ViewTargetTransitionParams TransitionParams)

SetCameraMode

function SetCameraMode (name NewCamMode)

Set new camera mode

Parameters:

• NewCamMode - new camera mode.

SetCinematicMode

function SetCinematicMode (bool bInCinematicMode, bool bHidePlayer, bool bAffectsHUD, bool bAffectsMovement, bool bAffectsTurning, bool bAffectsButtons)

Server/SP only function for changing whether the player is in cinematic mode. Updates values of various state variables, then replicates the call to the client to sync the current cinematic mode.

Parameters:

• bInCinematicMode - specify TRUE if the player is entering cinematic mode; FALSE if the player is leaving cinematic mode.
• bHidePlayer - specify TRUE to hide the player's pawn (only relevant if bInCinematicMode is TRUE)
• bAffectsHUD - specify TRUE if we should show/hide the HUD to match the value of bCinematicMode
• bAffectsMovement - specify TRUE to disable movement in cinematic mode, enable it when leaving
• bAffectsTurning - specify TRUE to disable turning in cinematic mode or enable it when leaving
• bAffectsButtons - specify TRUE to disable button input in cinematic mode or enable it when leaving.

SetFOV

function SetFOV (float NewFOV)

SetPause

function bool SetPause (bool bPause, optional delegate<CanUnpause> CanUnpauseDelegate)

SetPlayerDataProvider

simulated function SetPlayerDataProvider (PlayerDataProvider DataProvider)

Hooks up the PlayerDataProvider for this player to the PlayerOwner data store.

Parameters:

• DataProvider - the PlayerDataProvider to associate with this player.

SetRumbleScale

final function SetRumbleScale (float ScaleBy)

Scales the amount the rumble will play on the gamepad

Parameters:

• ScaleBy - The amount to scale the waveforms by

SetViewTargetWithBlend

final function SetViewTargetWithBlend (Actor NewViewTarget, optional float BlendTime, optional Camera.EViewTargetBlendFunction BlendFunc, optional float BlendExp)

Wrapper to SetViewTarget with useful defaults

ShortClientAdjustPosition

unreliable client function ShortClientAdjustPosition (float TimeStamp, name newState, Actor.EPhysics newPhysics, float NewLocX, float NewLocY, float NewLocZ, Actor NewBase)

SpawnCoverReplicator

function CoverReplicator SpawnCoverReplicator ()

spawns MyCoverReplicator and tells it to replicate any changes that have already occurred

SpawnDefaultHUD

function SpawnDefaultHUD ()

SpeakTTS

simulated function SpeakTTS (coerce string S, optional PlayerReplicationInfo PRI)

TriggerInteracted

function bool 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.

UnregisterPlayerDataStores

simulated function UnregisterPlayerDataStores ()

Unregisters the "PlayerOwner" data store for this player. Called when this PlayerController is destroyed.

UnregisterStandardPlayerDataStores

simulated function UnregisterStandardPlayerDataStores ()

Unregisters all player data stores that remain after unregistering all player data stores that require custom unregister logic.

UpdatePing

final function UpdatePing (float TimeStamp)

UpdateRotation

function UpdateRotation (float DeltaTime)

UpdateStateFromAdjustment

function UpdateStateFromAdjustment (name NewState)

Called by LongClientAdjustPosition()

Parameters:

• NewState - is the state recommended by the server

UsingFirstPersonCamera

function bool UsingFirstPersonCamera ()

return whether viewing in first person mode

VeryShortClientAdjustPosition

unreliable client function VeryShortClientAdjustPosition (float TimeStamp, float NewLocX, float NewLocY, float NewLocZ, Actor NewBase)

ViewAPlayer

function ViewAPlayer (int dir)

View next active player in PRIArray.

Parameters:

• dir - is the direction to go in the array

ViewShake

function ViewShake (float DeltaTime)

Updates any camera view shaking that is going on