UE3:PlayerController (UDK)

Object >> Actor >> Controller >> PlayerController

Package:

Engine

Implemented interfaces:

Interface_NavigationHandle

Known classes within PlayerController:

CheatManager, DebugCameraInput, ForceFeedbackManager, PlayerInput, UTCheatManager

Direct subclasses:

Admin, DebugCameraController, GamePlayerController

This class in other games:

U2, U2XMP, UE2Runtime, UT2003, UT2004, UT3

PlayerController

PlayerControllers are used by human players to control pawns.

This is a built-in Unreal class and it shouldn't be modified. for the change in Possess().

Constants

MAXPOSITIONERRORSQUARED

Value: 3.0

MAXPOSITIONERRORSQUARED is the square of the max position error that is accepted (not corrected) in net play

MAXNEARZEROVELOCITYSQUARED

Value: 9.0

MAXNEARZEROVELOCITYSQUARED is the square of the max velocity that is considered zero (not corrected) in net play

MAXVEHICLEPOSITIONERRORSQUARED

Value: 900.0

MAXVEHICLEPOSITIONERRORSQUARED is the square of the max position error that is accepted (not corrected) in net play when driving a vehicle

CLIENTADJUSTUPDATECOST

Value: 180.0

CLIENTADJUSTUPDATECOST is the bandwidth cost in bytes of sending a client adjustment update. 180 is greater than the actual cost, but represents a tweaked value reserving enough bandwidth for other updates sent to the client. Increase this value to reduce client adjustment update frequency, or if the amount of data sent in the clientadjustment() call increases

MAXCLIENTUPDATEINTERVAL

Value: 0.25

MAXCLIENTUPDATEINTERVAL is the maximum time between movement updates from the client before the server forces an update.

Properties

Property group 'Camera'

PlayerCamera

Type: Camera

Modifiers: editinline

Camera associated with this Player Controller

Property group 'PlayerController'

PlayerInput

Type: PlayerInput

Modifiers: transient, editinline

Object within playercontroller that manages player input.

Internal variables

See PlayerController internal variables.

Default values

Property	Value
bCanDoSpecial	True
bIsPlayer	True
CollisionComponent	CylinderComponent'CollisionCylinder'
Components[1]	CylinderComponent'CollisionCylinder'
NetPriority	3.0

Subobjects

CollisionCylinder

Class: Engine.CylinderComponent

Property	Value
ReplacementPrimitive	None

Sprite

Class: Engine.SpriteComponent

Inherits from: Controller.Sprite

Property	Value
ReplacementPrimitive	None

Enums

EInputMatchAction

How to match an input action

IMA_GreaterThan

IMA_LessThan

EInputTypes

Type of inputs the matching code recognizes

IT_XAxis

IT_YAxis

EProgressMessageType

Different types of progress messages

PMT_Clear

Clears existing progress messages

PMT_Information

No change in connection status - simply update the text being displayed

PMT_AdminMessage

Message from the server admin

PMT_DownloadProgress

Updates the amount remaining on a package download

PMT_ConnectionFailure

Indicates that the connection to the server was lost

PMT_SocketFailure

Indicates that an unrecoverable error was encountered by an open network socket. In cases where the socket in question was

the endpoint for the connection to the server, a PMT_ConnectionFailure event will generally be fired as well, probably during the next frame.

Structs

ClientAdjustment

Modifiers: native

float TimeStamp

Actor.EPhysics newPhysics

Object.Vector NewLoc

Object.Vector NewVel

Actor NewBase

Object.Vector NewFloor

byte bAckGoodMove

DebugTextInfo

Modifiers: native

List of actors and debug text to draw,

See: AddDebugText(), RemoveDebugText(), and DrawDebugTextList()

Actor SrcActor

Actor to draw DebugText over

Object.Vector SrcActorOffset

Offset from SrcActor.Location to apply

Object.Vector SrcActorDesiredOffset

Desired offset to interpolate to

string DebugText

Text to display

float TimeRemaining

Time remaining for the debug text, -1.f == infinite

float Duration

Duration used to lerp desired offset

Object.Color TextColor

Text color

bool bAbsoluteLocation

whether the offset should be treated as absolute world location of the string

InputEntry

Modifiers: native

Individual entry to input matching sequences

EInputTypes Type

Type of input to match

float Value

Min value required to consider as a valid match

float TimeDelta

Max amount of time since last match before sequence resets

EInputMatchAction Action

What type of match is this?

InputMatchRequest

Modifiers: native

Contains information to match a series of a inputs and call the given function upon a match. Processed by PlayerInput, defined in the PlayerController.

array<InputEntry> Inputs

Number of inputs to match, in sequence

Actor MatchActor

Actor to call below functions on

name MatchFuncName

Name of function to call upon successful match

delegate<InputMatchDelegate> MatchDelegate

name FailedFuncName

Name of function to call upon a failed partial match

name RequestName

Name of this input request, mainly for debugging

int MatchIdx

Current index into Inputs that is being matched

float LastMatchTime

Last time an input entry in Inputs was matched

Delegates

CanUnpause

delegate bool CanUnpause ()

Callback the server uses to determine if the unpause can happen

InputMatchDelegate

delegate InputMatchDelegate ()

Functions

Static native functions

GetPlayerControllerFromNetId

native static function PlayerController GetPlayerControllerFromNetId (OnlineSubsystem.UniqueNetId PlayerNetId)

Returns the player controller associated with this net id

Parameters:

• PlayerNetId - the id to search for

Returns:

the player controller if found, otherwise none

Other static functions

GetPartyGameTypeName

static function string GetPartyGameTypeName ()

Returns the party game info name for this game

GetPartyMapName

static function string GetPartyMapName ()

Returns the party map name for this game

Exec functions

See PlayerController exec functions.

Native functions

See PlayerController native functions.

Events

See PlayerController events.

Other instance functions

See PlayerController instance functions.

States

See PlayerController states.