I love the smell of UnrealEd crashing in the morning. – tarquin
Difference between revisions of "UE3:UTPlayerController (UT3)"
(Talk) |
m (added missing members) |
||
| Line 10: | Line 10: | ||
UTPlayerController | UTPlayerController | ||
| − | Copyright 1998- | + | Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. |
==Constants== | ==Constants== | ||
| Line 188: | Line 188: | ||
====ClientHearSound==== | ====ClientHearSound==== | ||
| − | {{code|unreliable client event '''ClientHearSound''' ({{cl|SoundCue}} '''ASound''', {{cl|Actor}} '''SourceActor''', {{tl|Vector|Object|structs}} '''SourceLocation''', [[bool]] '''bStopWhenOwnerDestroyed''', optional [[bool]] '''bIsOccluded''')}} | + | {{code|unreliable client event '''ClientHearSound''' ({{cl|SoundCue}} '''ASound''', {{cl|Actor}} '''SourceActor''', {{tl|Vector|Object|structs}} '''SourceLocation''', [[bool]] '''bStopWhenOwnerDestroyed''', optional [[bool]] '''bIsOccluded''', optional [[bool]] '''bIsUISound''')}} |
'''Overrides:''' {{tl|ClientHearSound|PlayerController|events}} | '''Overrides:''' {{tl|ClientHearSound|PlayerController|events}} | ||
| Line 332: | Line 332: | ||
Overloaded to implement TTS. | Overloaded to implement TTS. | ||
| + | |||
| + | ====TriggerProfileSave==== | ||
| + | {{code|event '''TriggerProfileSave''' ()}} | ||
| + | |||
| + | <!-- enter event description --> | ||
===Other instance functions=== | ===Other instance functions=== | ||
Latest revision as of 05:12, 16 August 2009
 |
Object >> Actor >> Controller >> PlayerController >> GamePlayerController >> UTPlayerController |
Contents
- 1 Constants
- 2 Properties
- 3 Enums
- 4 Structs
- 5 Functions
- 5.1 Exec functions
- 5.2 Native functions
- 5.3 Events
- 5.3.1 ClearOnlineDelegates
- 5.3.2 ClientHearSound
- 5.3.3 ClientWasKicked
- 5.3.4 Destroyed
- 5.3.5 GetPlayerViewPoint
- 5.3.6 GetSeamlessTravelActorList
- 5.3.7 InitInputSystem
- 5.3.8 KickWarning
- 5.3.9 NotifyLoadedWorld
- 5.3.10 OnCharacterUnlocked
- 5.3.11 PlayerTick
- 5.3.12 Possess
- 5.3.13 ProcessConvolveResponse
- 5.3.14 ReceivedPlayer
- 5.3.15 ReceiveWarning
- 5.3.16 Reset
- 5.3.17 ResetCameraMode
- 5.3.18 SoakPause
- 5.3.19 TeamMessage
- 5.3.20 TriggerProfileSave
- 5.4 Other instance functions
- 6 States
- Package:
- UTGame
- Known classes within UTPlayerController:
- UTPlayerInput
- Direct subclasses:
- DemoRecSpectator, UTConsolePlayerController, UTEntryPlayerController
- This class in other games:
- UDK
| 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. |
UTPlayerController
Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.
Constants[edit]
See UTPlayerController constants.
Properties[edit]
Property group 'UTPlayerController'[edit]
bDisableQuickPick[edit]
Type: bool
If true, the quick pick menu will be disable and the key will act like PrevWeapon
Internal variables[edit]
See UTPlayerController internal variables.
Default values[edit]
| Property | Value |
|---|---|
| bCheckSoundOcclusion | True |
| CameraClass | None |
| CheatClass | Class'UTGame.UTCheatManager' |
| DefaultFOV | 90.0 |
| DesiredFOV | 90.0 |
| FOVAngle | 90.0 |
| InputClass | Class'UTGame.UTPlayerInput' |
| MinRespawnDelay | 1.5 |
Subobjects[edit]
CollisionCylinder[edit]
Class: Engine.CylinderComponent
Inherits from: GamePlayerController.CollisionCylinder
No new values.
Sprite[edit]
Class: Engine.SpriteComponent
Inherits from: GamePlayerController.Sprite
No new values.
Enums[edit]
EAutoObjectivePreference[edit]
enum for the various options for the game telling the player what to do next
- AOP_Disabled
- turned off
- AOP_NoPreference
- AOP_Attack
- tell what to do to attack
- AOP_Defend
- tell what to do to defend
- AOP_OrbRunner
- AOP_SpecialOps
EPawnShadowMode[edit]
- SHADOW_None
- SHADOW_Self
- SHADOW_All
EWeaponHand[edit]
- HAND_Right
- HAND_Left
- HAND_Centered
- HAND_Hidden
Structs[edit]
ObjectiveAnnouncementInfo[edit]
Modifiers: native
- SoundNodeWave AnnouncementSound
- the default announcement sound to play (can be None)
- string AnnouncementText
- text displayed onscreen for this announcement
PostProcessInfo[edit]
Modifiers: native
Struct to define values for different post processing presets.
Functions[edit]
Exec functions[edit]
See UTPlayerController exec functions.
Native functions[edit]
CreateTTSSoundCue[edit]
Constructs a SoundCue, performs text-to-wavedata conversion.
GetPlayerCustomCharData[edit]
Get the preferred custom character setup for this player (from player profile store).
GetUIPlayerIndex[edit]
Returns:
- Returns the index of this PC in the GamePlayers array.
IsEpicInternal[edit]
Returns:
- Returns whether or not we're in a epic internal build.
IsKeyboardAvailable[edit]
Overrides: PlayerController.IsKeyboardAvailable
Returns:
- Whether or not the user has a keyboard plugged-in.
IsMouseAvailable[edit]
Overrides: PlayerController.IsMouseAvailable
Returns:
- Whether or not the user has a mouse plugged-in.
ResetProfileToDefault[edit]
Resets the profile to its default state.
ServerAdminChangeOption[edit]
changes an option for the current gametype on the server - only works for .ini configurable options and only if this player is the admin
SetGamma[edit]
Sets the current gamma value.
Parameters:
- New - Gamma Value, must be between 0.0 and 1.0
SetHardwarePhysicsEnabled[edit]
Sets whether or not hardware physics are enabled.
Parameters:
- bEnabled - Whether to enable the physics or not.
Events[edit]
ClearOnlineDelegates[edit]
Overrides: PlayerController.ClearOnlineDelegates
Clears previously set online delegates.
ClientHearSound[edit]
Overrides: PlayerController.ClientHearSound
ClientWasKicked[edit]
Overrides: PlayerController.ClientWasKicked
Destroyed[edit]
Overrides: PlayerController.Destroyed
GetPlayerViewPoint[edit]
Overrides: PlayerController.GetPlayerViewPoint
(Description copied from PlayerController.GetPlayerViewPoint)
Returns Player's Point of View For the AI this means the Pawn's 'Eyes' ViewPoint For a Human player, this means the Camera's ViewPoint
Output: out_rotation, view rotation of player
GetSeamlessTravelActorList[edit]
Overrides: PlayerController.GetSeamlessTravelActorList
(Description copied from PlayerController.GetSeamlessTravelActorList)
called on client during seamless level transitions to get the list of Actors that should be moved into the new level PlayerControllers, Role < ROLE_Authority Actors, and any non-Actors that are inside an Actor that is in the list (i.e. Object.Outer == Actor in the list) are all autmoatically moved regardless of whether they're included here only dynamic (!bStatic and !bNoDelete) actors in the PersistentLevel may be moved (this includes all actors spawned during gameplay) this is called for both parts of the transition because actors might change while in the middle (e.g. players might join or leave the game)
Parameters:
- bToEntry - true if we are going from old level -> entry, false if we are going from entry -> new level
- ActorList - out) list of actors to maintain
See: also GameInfo::GetSeamlessTravelActorList() (the function that's called on servers)
InitInputSystem[edit]
Overrides: PlayerController.InitInputSystem
KickWarning[edit]
Overrides: PlayerController.KickWarning
NotifyLoadedWorld[edit]
Overrides: PlayerController.NotifyLoadedWorld
(Description copied from PlayerController.NotifyLoadedWorld)
called clientside when it is loaded a new world via seamless travelling
Parameters:
- WorldPackageName - the name of the world package that was loaded
- bFinalDest - whether this world is the destination map for the travel (i.e. not the transition level)
OnCharacterUnlocked[edit]
Callback for when a character has been unlocked.
PlayerTick[edit]
Overrides: PlayerController.PlayerTick
PlayerTick is only called if the PlayerController has a PlayerInput object. Therefore, it will not be called on servers for non-locally controlled playercontrollers
Possess[edit]
Overrides: PlayerController.Possess
ProcessConvolveResponse[edit]
Overrides: PlayerController.ProcessConvolveResponse
Called when the convolve response has returned
ReceivedPlayer[edit]
Overrides: PlayerController.ReceivedPlayer
Called after this PlayerController's viewport/net connection is associated with this player controller.
ReceiveWarning[edit]
Overrides: Controller.ReceiveWarning
Reset[edit]
Overrides: PlayerController.Reset
ResetCameraMode[edit]
Overrides: PlayerController.ResetCameraMode
Reset Camera Mode to default
SoakPause[edit]
Overrides: PlayerController.SoakPause
For AI debugging
TeamMessage[edit]
Overrides: PlayerController.TeamMessage
Overloaded to implement TTS.
TriggerProfileSave[edit]
Other instance functions[edit]
See UTPlayerController instance functions.
