Cogito, ergo sum

UE2:PlayerController (UT2003)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT2003 Object >> Actor >> Controller >> PlayerController
Package: 
Engine
Known classes within PlayerController:
Admin, AdminBase, AdminIni, CheatManager, PlayerInput, XBoxPlayerInput
Direct subclasses:
UnrealPlayer, Camera, MessagingSpectator
This class in other games:
U2XMP, U2, UE2Runtime, UT2004, UT3, UDK

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().

Properties[edit]

Property group 'ForceFeedback'[edit]

bEnableDamageForceFeedback[edit]

Type: bool

Modifiers: globalconfig


Default value: True

bEnableGUIForceFeedback[edit]

Type: bool

Modifiers: globalconfig


Default value: True

bEnablePickupForceFeedback[edit]

Type: bool

Modifiers: globalconfig


Default value: True

bEnableWeaponForceFeedback[edit]

Type: bool

Modifiers: globalconfig


Default value: True

bForceFeedbackSupported[edit]

Type: bool

true if a device is detected

Default value: True

Property group 'TeamBeacon'[edit]

LinkBeaconTexture[edit]

Type: Texture


TeamBeaconCustomColor[edit]

Type: Object.Color


Default value:

Member Value
A 255
B 0
G 255
R 255

TeamBeaconMaxDist[edit]

Type: float


Default value: 5000.0

TeamBeaconPlayerInfoMaxDist[edit]

Type: float


Default value: 1200.0

TeamBeaconTeamColors[edit]

Type: Object.Color

Array size: 2


Default value, index 0:

Member Value
A 255
B 0
G 0
R 180

Default value, index 1:

Member Value
A 255
B 200
G 80
R 80

TeamBeaconTexture[edit]

Type: Texture


Internal variables[edit]

See PlayerController internal variables.

Default values[edit]

Property Value
bCanDoSpecial True
bCanOpenDoors True
bIsPlayer True
bTravel True
FovAngle 85.0
Handedness 1.0
NetPriority 3.0

Structs[edit]

PlayerNameInfo[edit]

string mInfo 
Object.Color mColor 
float mXPos 
float mYPos 

Functions[edit]

Exec functions[edit]

See PlayerController exec functions.

Native functions[edit]

ClientHearSound[edit]

native event ClientHearSound (Actor Actor, int Id, Sound S, Object.Vector SoundLocation, Object.Vector Parameters, bool Attenuate)


ClientTravel[edit]

native event ClientTravel (string URL, Actor.ETravelType TravelType, bool bItems)


ClientValidate[edit]

private native event ClientValidate (string C)


ServerValidationResponse[edit]

private native event ServerValidationResponse (string R)


ChangeVoiceChatter[edit]

native final function ChangeVoiceChatter (int IpAddr, int Handle, bool Add)


ConsoleCommand[edit]

native function string ConsoleCommand (string Command)

Overrides: Actor.ConsoleCommand


CopyToClipboard[edit]

native function CopyToClipboard (string Text)


FindStairRotation[edit]

native(524) final function int FindStairRotation (float DeltaTime)


GetDefaultURL[edit]

native final function string GetDefaultURL (string Option)


GetEntryLevel[edit]

native final function LevelInfo GetEntryLevel ()


GetPlayerIDHash[edit]

native final function string GetPlayerIDHash ()


GetPlayerNetworkAddress[edit]

native final function string GetPlayerNetworkAddress ()


GetServerNetworkAddress[edit]

native final function string GetServerNetworkAddress ()


LeaveVoiceChat[edit]

native final function LeaveVoiceChat ()


PasteFromClipboard[edit]

native function string PasteFromClipboard ()


ResetKeyboard[edit]

native(544) final function ResetKeyboard ()


SetNetSpeed[edit]

native final function SetNetSpeed (int NewSpeed)


SetViewTarget[edit]

native final function SetViewTarget (Actor NewViewTarget)


Events[edit]

AddCameraEffect[edit]

event AddCameraEffect (CameraEffect NewEffect, optional bool RemoveExisting)


ClientCloseMenu[edit]

event ClientCloseMenu (optional bool bCloseAll, optional bool bCancel)


ClientMessage[edit]

event ClientMessage (coerce string S, optional name Type)


ClientOpenMenu[edit]

event ClientOpenMenu (string Menu, optional bool bDisconnect, optional string Msg1, optional string Msg2)


ClientReplaceMenu[edit]

event ClientReplaceMenu (string Menu, optional bool bDisconnect, optional string Msg1, optional string Msg2)


ClientSetViewTarget[edit]

event ClientSetViewTarget (Actor a)


Destroyed[edit]

simulated event Destroyed ()

Overrides: Controller.Destroyed


InitInputSystem[edit]

event InitInputSystem ()


NotifyLanded[edit]

event bool NotifyLanded (Object.Vector HitNormal)

Overrides: Controller.NotifyLanded


PlayerCalcView[edit]

event PlayerCalcView (out Actor ViewActor, out Object.Vector CameraLocation, out Object.Rotator CameraRotation)


PlayerTick[edit]

event PlayerTick (float DeltaTime)


PostBeginPlay[edit]

event PostBeginPlay ()

Overrides: Controller.PostBeginPlay


PreClientTravel[edit]

event PreClientTravel ()


ProgressCommand[edit]

event function ProgressCommand (string Cmd, string Msg1, string Msg2)


ReceiveLocalizedMessage[edit]

simulated event ReceiveLocalizedMessage (class<LocalMessageMessage, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)


RemoveCameraEffect[edit]

event RemoveCameraEffect (CameraEffect ExEffect)


ServerChangeVoiceChatter[edit]

event ServerChangeVoiceChatter (PlayerController Player, int IpAddr, int Handle, bool Add)


ServerGetVoiceChatters[edit]

event ServerGetVoiceChatters (PlayerController Player)


StartClientDemoRec[edit]

simulated event StartClientDemoRec ()


TeamMessage[edit]

event TeamMessage (PlayerReplicationInfo PRI, coerce string S, name Type)


TravelPostAccept[edit]

event TravelPostAccept ()

Overrides: Actor.TravelPostAccept


Other instance functions[edit]

See PlayerController instance functions.

States[edit]

See PlayerController states.