Always snap to grid

UE2:PlayerController (UT2004)

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

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

AdminMenuClass[edit]

Type: string

Modifiers: config

Menu that is shown when adminmenu command is used

Default value: "GUI2K4.RemoteAdmin"

ChatPasswordMenuClass[edit]

Type: string

Modifiers: config

Menu that appears when attempting to join a chatroom that has a password

Default value: "GUI2K4.UT2K4ChatPassword"

DemoMenuClass[edit]

Type: string

Modifiers: config

Menu used for demos

MidGameMenuClass[edit]

Type: string

Modifiers: config

Menu that is shown when Escape is pressed

Default value: "GUI2K4.UT2K4DisconnectOptionPage"

Property group 'TeamBeacon'[edit]

LinkBeaconTexture[edit]

Type: Texture


SpeakingBeaconTexture[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: 6000.0

TeamBeaconPlayerInfoMaxDist[edit]

Type: float


Default value: 1800.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


Property group 'VoiceChat'[edit]

AutoJoinMask[edit]

Type: byte

Modifiers: globalconfig


Default value: 5

bEnableInitialChatRoom[edit]

Type: bool

Modifiers: globalconfig

Enables speaking on DefaultActiveChannel upon joining server

Default value: True

bVoiceChatEnabled[edit]

Type: bool

Whether voice chat is enabled on this client

Default value: True

ChatPassword[edit]

Type: string

Modifiers: globalconfig

Password for our personal chat room

ChatRoomMessageClass[edit]

Type: class<ChatRoomMessage>


Default value: Class'Engine.ChatRoomMessage'

DefaultActiveChannel[edit]

Type: string

Modifiers: globalconfig


LastActiveChannel[edit]

Type: string

Modifiers: globalconfig

Stores the currently active channel when switching maps

StoredChatPasswords[edit]

Type: array<StoredChatPassword>

Modifiers: globalconfig


VoiceChatCodec[edit]

Type: string

Modifiers: globalconfig

Which voice chat codec to request in internet games (will only be used if it exists on server)

Default value: "CODEC_48NB"

VoiceChatLANCodec[edit]

Type: string

Modifiers: globalconfig

Which voice chat codec to request in LAN games

Default value: "CODEC_96WB"

Internal variables[edit]

See PlayerController internal variables.

Default values[edit]

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

Structs[edit]

ClientAdjustment[edit]

float TimeStamp 
name newState 
Actor.EPhysics newPhysics 
Object.Vector NewLoc 
Object.Vector NewVel 
Actor NewBase 
Object.Vector NewFloor 

PlayerNameInfo[edit]

string mInfo 
Object.Color mColor 
float mXPos 
float mYPos 

StoredChatPassword[edit]

string ChatRoomName 
string ChatRoomPassword 

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)


CheckSpeedHack[edit]

native final function bool CheckSpeedHack (float DeltaTime)


ConsoleCommand[edit]

native function string ConsoleCommand (string Command, optional bool bWriteToLog)

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


GetURLProtocol[edit]

native final function string GetURLProtocol ()


PasteFromClipboard[edit]

native function string PasteFromClipboard ()


ResetInput[edit]

native final private function ResetInput ()


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]

See PlayerController events.

Other instance functions[edit]

See PlayerController instance functions.

States[edit]

See PlayerController states.