My program doesn't have bugs. It just develops random features.
Difference between revisions of "UE3:GamePlayerController (UDK)"
(Talk) |
(Talk) |
||
Line 5: | Line 5: | ||
| parent3 = Actor | | parent3 = Actor | ||
| parent4 = Object | | parent4 = Object | ||
+ | | interface1 = Interface_NavigationHandle | ||
| abstract = yes | | abstract = yes | ||
}} | }} | ||
Line 24: | Line 25: | ||
'''Default value:''' 200.0 | '''Default value:''' 200.0 | ||
+ | |||
+ | ====bIsWarmupPaused==== | ||
+ | '''Type:''' [[bool]] | ||
+ | |||
+ | '''[[Variables#Modifiers|Modifiers]]:''' transient | ||
+ | |||
+ | If true we are in 'warmup paused' state to allow textures to stream in, and should not allow unpausing. | ||
====bWarnCrowdMembers==== | ====bWarnCrowdMembers==== | ||
Line 65: | Line 73: | ||
==Functions== | ==Functions== | ||
+ | ===Static native functions=== | ||
+ | ====KeepPlayingLoadingMovie==== | ||
+ | {{code|native static final function '''KeepPlayingLoadingMovie''' ()}} | ||
+ | |||
+ | Keep playing the loading movie if it's currently playing and abort any StopMovie calls that may be pending through the FDelayedUnpauser. | ||
+ | |||
+ | ====ShowLoadingMovie==== | ||
+ | {{code|native static final function '''ShowLoadingMovie''' ([[bool]] '''bShowMovie''', optional [[bool]] '''bPauseAfterHide''', optional [[float]] '''PauseDuration''', optional [[float]] '''KeepPlayingDuration''', optional [[bool]] '''bOverridePreviousDelays''')}} | ||
+ | |||
+ | Starts/stops the loading movie | ||
+ | |||
+ | '''Parameters:''' | ||
+ | * ''bShowMovie'' - true to show the movie, false to stop it | ||
+ | * ''bPauseAfterHide'' - optional) If TRUE, this will pause the game/delay movie stop to let textures stream in | ||
+ | * ''PauseDuration'' - optional) allows overriding the default pause duration specified in .ini (only used if bPauseAfterHide is true) | ||
+ | * ''KeepPlayingDuration'' - optional) keeps playing the movie for a specified more seconds after it's supposed to stop | ||
+ | * ''bOverridePreviousDelays'' - optional) whether to cancel previous delayed StopMovie or not (defaults to FALSE) | ||
+ | |||
===Exec functions=== | ===Exec functions=== | ||
====CrowdDebug==== | ====CrowdDebug==== | ||
Line 70: | Line 96: | ||
<!-- enter function description --> | <!-- enter function description --> | ||
+ | |||
+ | ====CrowdFocus==== | ||
+ | {{code|exec function '''CrowdFocus''' ()}} | ||
+ | |||
+ | <!-- enter function description --> | ||
+ | |||
+ | ===Native functions=== | ||
+ | ====ClientPlayMovie==== | ||
+ | {{code|native final reliable client event '''ClientPlayMovie''' ([[string]] '''MovieName''', [[int]] '''InStartOfRenderingMovieFrame''', [[int]] '''InEndOfRenderingMovieFrame''')}} | ||
+ | |||
+ | starts playing the specified movie | ||
+ | |||
+ | ====ClientStopMovie==== | ||
+ | {{code|native final reliable client event '''ClientStopMovie''' ([[float]] '''DelayInSeconds''', [[bool]] '''bAllowMovieToFinish''', [[bool]] '''bForceStopNonSkippable''', [[bool]] '''bForceStopLoadingMovie''')}} | ||
+ | |||
+ | Stops the currently playing movie | ||
+ | |||
+ | '''Parameters:''' | ||
+ | * ''DelayInSeconds'' - number of seconds to delay before stopping the movie. | ||
+ | * ''bAllowMovieToFinish'' - indicates whether the movie should be stopped immediately or wait until it's finished. | ||
+ | * ''bForceStopNonSkippable'' - indicates whether a movie marked as non-skippable should be stopped anyway; only relevant if the specified movie is marked non-skippable (like startup movies). | ||
+ | * ''bForceStopLoadingMovie'' - If false then don't stop the movie if it's the loading movie. | ||
+ | |||
+ | ====GetCurrentMovie==== | ||
+ | {{code|native final function '''GetCurrentMovie''' (out [[string]] '''MovieName''')}} | ||
+ | |||
+ | returns the name of the currently playing movie, or an empty string if no movie is currently playing | ||
+ | |||
+ | '''Todo:''' add an out param for current time in playback for synchronizing clients that join in the middle | ||
===Events=== | ===Events=== | ||
Line 81: | Line 136: | ||
Hook to let player know a refresh of crowd agent info is coming | Hook to let player know a refresh of crowd agent info is coming | ||
+ | |||
+ | ====WarmupPause==== | ||
+ | {{code|event '''WarmupPause''' ([[bool]] '''bDesiredPauseState''')}} | ||
+ | |||
+ | Function used by loading code to pause and unpause the game during texture-streaming warm-up. | ||
===Other instance functions=== | ===Other instance functions=== | ||
+ | ====CanUnpauseWarmup==== | ||
+ | {{code|function [[bool]] '''CanUnpauseWarmup''' ()}} | ||
+ | |||
+ | Delegate used to control whether we can unpause during warmup. We never allow this. | ||
+ | |||
+ | ====ClientColorFade==== | ||
+ | {{code|reliable client function '''ClientColorFade''' ({{tl|Color|Object|structs}} '''FadeColor''', [[byte]] '''FromAlpha''', [[byte]] '''ToAlpha''', [[float]] '''FadeTime''')}} | ||
+ | |||
+ | <!-- enter function description --> | ||
+ | |||
====DoForceFeedbackForScreenShake==== | ====DoForceFeedbackForScreenShake==== | ||
{{code|simulated protected function '''DoForceFeedbackForScreenShake''' ({{cl|CameraShake}} '''ShakeData''', [[float]] '''Scale''')}} | {{code|simulated protected function '''DoForceFeedbackForScreenShake''' ({{cl|CameraShake}} '''ShakeData''', [[float]] '''Scale''')}} | ||
Line 89: | Line 159: | ||
Play forcefeedback to match the given screenshake. | Play forcefeedback to match the given screenshake. | ||
+ | |||
+ | ====GetCurrentSoundMode==== | ||
+ | {{code|simulated final function [[name]] '''GetCurrentSoundMode''' ()}} | ||
+ | |||
+ | Returns the CurrentSoundMode * | ||
====SetSoundMode==== | ====SetSoundMode==== |
Revision as of 06:24, 17 January 2010
Object >> Actor >> Controller >> PlayerController >> GamePlayerController |
- Package:
- GameFramework
- Implemented interfaces:
- Interface_NavigationHandle
- Known classes within GamePlayerController:
- GamePlayerInput
- Direct subclass:
- UTPlayerController
- This class in other games:
- UT3
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. |
GamePlayerController
Properties
Property group 'Debug'
bDebugCrowdAwareness
Type: bool
If TRUE, draw debug info for crowd awareness checks
Internal variables
AgentAwareRadius
Type: float
Controls how far around a player to warn agents.
Default value: 200.0
bIsWarmupPaused
Type: bool
Modifiers: transient
If true we are in 'warmup paused' state to allow textures to stream in, and should not allow unpausing.
bWarnCrowdMembers
Type: bool
If true, warn GameCrowdAgents to avoid pawn controlled by this player. Used when player will move through crowds
CurrentSoundMode
Type: name
Modifiers: transient, protected
Name of the current sound mode that is active for the audio system *
Subobjects
CollisionCylinder
Class: Engine.CylinderComponent
Inherits from: PlayerController.CollisionCylinder
Property | Value |
---|---|
ReplacementPrimitive | None |
Sprite
Class: Engine.SpriteComponent
Inherits from: PlayerController.Sprite
Property | Value |
---|---|
ReplacementPrimitive | None |
Functions
Static native functions
KeepPlayingLoadingMovie
Keep playing the loading movie if it's currently playing and abort any StopMovie calls that may be pending through the FDelayedUnpauser.
ShowLoadingMovie
Starts/stops the loading movie
Parameters:
- bShowMovie - true to show the movie, false to stop it
- bPauseAfterHide - optional) If TRUE, this will pause the game/delay movie stop to let textures stream in
- PauseDuration - optional) allows overriding the default pause duration specified in .ini (only used if bPauseAfterHide is true)
- KeepPlayingDuration - optional) keeps playing the movie for a specified more seconds after it's supposed to stop
- bOverridePreviousDelays - optional) whether to cancel previous delayed StopMovie or not (defaults to FALSE)
Exec functions
CrowdDebug
CrowdFocus
Native functions
ClientPlayMovie
starts playing the specified movie
ClientStopMovie
Stops the currently playing movie
Parameters:
- DelayInSeconds - number of seconds to delay before stopping the movie.
- bAllowMovieToFinish - indicates whether the movie should be stopped immediately or wait until it's finished.
- bForceStopNonSkippable - indicates whether a movie marked as non-skippable should be stopped anyway; only relevant if the specified movie is marked non-skippable (like startup movies).
- bForceStopLoadingMovie - If false then don't stop the movie if it's the loading movie.
GetCurrentMovie
returns the name of the currently playing movie, or an empty string if no movie is currently playing
Todo: add an out param for current time in playback for synchronizing clients that join in the middle
Events
NotifyCrowdAgentInRadius
Hook to let player know crowd member is in range
NotifyCrowdAgentRefresh
Hook to let player know a refresh of crowd agent info is coming
WarmupPause
Function used by loading code to pause and unpause the game during texture-streaming warm-up.
Other instance functions
CanUnpauseWarmup
Delegate used to control whether we can unpause during warmup. We never allow this.
ClientColorFade
DoForceFeedbackForScreenShake
Overrides: PlayerController.DoForceFeedbackForScreenShake
Play forcefeedback to match the given screenshake.
GetCurrentSoundMode
Returns the CurrentSoundMode *
SetSoundMode
Set the sound mode of the audio system for special EQing *