Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.PlayerInput

Extends
Input
Modifiers
within PlayerController config ( Input ) transient native ( UserInterface )

Core.Object
|   
+-- Engine.UIRoot
   |   
   +-- Engine.Interaction
      |   
      +-- Engine.Input
         |   
         +-- Engine.PlayerInput

Direct Known Subclasses:

DebugCameraInput, GamePlayerInput

Variables Summary
floataBaseX
floataBaseY
floataBaseZ
floataForward
floataLookUp
floataMouseX
floataMouseY
floataPS3AccelX
floataPS3AccelY
floataPS3AccelZ
floataPS3Gyro
floataStrafe
floataTurn
floataUp
boolbEdgeBack
boolbEdgeForward
boolbEdgeLeft
boolbEdgeRight
boolbEnableFOVScaling
boolbEnableMouseSmoothing
boolbInvertMouse
boolbInvertTurn
bytebStrafe
boolbUsingGamepad
boolbWasBack
boolbWasForward
boolbWasLeft
boolbWasRight
bytebXAxis
bytebYAxis
floatDoubleClickTime
floatDoubleClickTimer
NameLastAxisKeyName
intMouseSamples
floatMouseSamplingTotal
floatMouseSensitivity
floatRawJoyLookRight
floatRawJoyLookUp
floatRawJoyRight
floatRawJoyUp
floatSmoothedMouse[2]
floatZeroTime[2]
PlayerInput
floatLookRightScale
floatLookUpScale
floatMoveForwardSpeed
floatMoveStrafeSpeed
Inherited Variables from Engine.Input
AxisArray, Bindings, CurrentDelta, CurrentDeltaTime, CurrentEvent, NameToPtr, PressedKeys

Structures Summary
Inherited Structures from Engine.Input
KeyBind

Functions Summary
function AdjustMouseSensitivity (float FOVScale))
function CatchDoubleClickInput ()))
functionActor.EDoubleClickDir CheckForDoubleClickMove (float DeltaTime))
function ClearSmoothing ()))
function DrawHUD (HUD H)
functionbool InvertMouse ()))
functionbool InvertTurn ()))
function Jump ()))
event PlayerInput (float DeltaTime ))
function PostProcessInput (float DeltaTime)
function PreProcessInput (float DeltaTime)
function ProcessInputMatching (float DeltaTime))
function SetSensitivity (Float F))
function SmartJump ()))
functionfloat SmoothMouse (float aMouse, float DeltaTime, out byte SampleCount, int Index))
Inherited Functions from Engine.Input
GetBind, ResetInput, SetBind
Inherited Functions from Engine.Interaction
Init, Initialized, NotifyGameSessionEnded, NotifyPlayerAdded, NotifyPlayerRemoved, PostRender, Tick


Variables Detail

aBaseX Source code

var input float aBaseX;

aBaseY Source code

var input float aBaseY;

aBaseZ Source code

var input float aBaseZ;

aForward Source code

var input float aForward;

aLookUp Source code

var input float aLookUp;

aMouseX Source code

var input float aMouseX;

aMouseY Source code

var input float aMouseY;

aPS3AccelX Source code

var input float aPS3AccelX;

aPS3AccelY Source code

var input float aPS3AccelY;

aPS3AccelZ Source code

var input float aPS3AccelZ;

aPS3Gyro Source code

var input float aPS3Gyro;

aStrafe Source code

var input float aStrafe;

aTurn Source code

var input float aTurn;

aUp Source code

var input float aUp;

bEdgeBack Source code

var bool bEdgeBack;

bEdgeForward Source code

var bool bEdgeForward;

bEdgeLeft Source code

var bool bEdgeLeft;

bEdgeRight Source code

var bool bEdgeRight;

bEnableFOVScaling Source code

var bool bEnableFOVScaling;
if true, mouse smoothing is enabled

bEnableMouseSmoothing Source code

var globalconfig bool bEnableMouseSmoothing;

bInvertMouse Source code

var globalconfig bool bInvertMouse;

bInvertTurn Source code

var globalconfig bool bInvertTurn;
if true, mouse y axis is inverted from normal FPS mode

bStrafe Source code

var input byte bStrafe;

bUsingGamepad Source code

var const bool bUsingGamepad;
Player is giving input through a gamepad

bWasBack Source code

var bool bWasBack;

bWasForward Source code

var bool bWasForward;
if true, mouse x axis is inverted from normal FPS mode

bWasLeft Source code

var bool bWasLeft;

bWasRight Source code

var bool bWasRight;

bXAxis Source code

var input byte bXAxis;

bYAxis Source code

var input byte bYAxis;

DoubleClickTime Source code

var globalconfig float DoubleClickTime;
max double click interval for double click move

DoubleClickTimer Source code

var float DoubleClickTimer;

LastAxisKeyName Source code

var const Name LastAxisKeyName;

MouseSamples Source code

var int MouseSamples;
Current average mouse movement/sample

MouseSamplingTotal Source code

var float MouseSamplingTotal;
Number of mouse samples since mouse movement has been zero

MouseSensitivity Source code

var globalconfig float MouseSensitivity;
stores time of first click for potential double click

RawJoyLookRight Source code

var transient float RawJoyLookRight;
Joypad right thumbstick, horizontal axis. Range [-1,+1]

RawJoyLookUp Source code

var transient float RawJoyLookUp;
Joypad right thumbstick, vertical axis. Range [-1,+1]

RawJoyRight Source code

var transient float RawJoyRight;
Joypad left thumbstick, horizontal axis. Range [-1,+1]

RawJoyUp Source code

var transient float RawJoyUp;
Joypad left thumbstick, vertical axis. Range [-1,+1]

SmoothedMouse[2] Source code

var float SmoothedMouse[2];
How long received mouse movement has been zero.

ZeroTime[2] Source code

var float ZeroTime[2];

PlayerInput

LookRightScale Source code

var(PlayerInput) config float LookRightScale;
Yaw turn speed scaling

LookUpScale Source code

var(PlayerInput) config float LookUpScale;
pitch turn speed scaling

MoveForwardSpeed Source code

var(PlayerInput) config float MoveForwardSpeed;
move forward speed scaling

MoveStrafeSpeed Source code

var(PlayerInput) config float MoveStrafeSpeed;
strafe speed scaling


Functions Detail

AdjustMouseSensitivity Source code

function AdjustMouseSensitivity ( float FOVScale) )

CatchDoubleClickInput Source code

function CatchDoubleClickInput ( ) )

CheckForDoubleClickMove Source code

function Actor.EDoubleClickDir CheckForDoubleClickMove ( float DeltaTime) )

ClearSmoothing Source code

exec function ClearSmoothing ( ) )

DrawHUD Source code

function DrawHUD ( HUD H )
Hook called from HUD actor. Gives access to HUD and Canvas

InvertMouse Source code

exec function bool InvertMouse ( ) )
DirectInput's mouse sampling total time

InvertTurn Source code

exec function bool InvertTurn ( ) )

Jump Source code

exec function Jump ( ) )

PlayerInput Source code

event PlayerInput ( float DeltaTime ) )

PostProcessInput Source code

function PostProcessInput ( float DeltaTime )

PreProcessInput Source code

function PreProcessInput ( float DeltaTime )

ProcessInputMatching Source code

final function ProcessInputMatching ( float DeltaTime) )
Iterates through all InputRequests on the PlayerController and checks to see if a new input has been matched, or if the entire match sequence should be reset.
@param DeltaTime - time since last tick

SetSensitivity Source code

exec function SetSensitivity ( Float F) )

SmartJump Source code

exec function SmartJump ( ) )

SmoothMouse Source code

function float SmoothMouse ( float aMouse, float DeltaTime, out byte SampleCount, int Index) )
SmoothMouse() Smooth mouse movement, because mouse sampling doesn't match up with tick time.
@note: if we got sample event for zero mouse samples (so we didn't have to guess whether a 0 was caused by no sample occuring during the tick (at high frame rates) or because the mouse actually stopped)
@param: aMouse is the mouse axis movement received from DirectInput
@param: DeltaTime is the tick time
@param: SampleCount is the number of mouse samples received from DirectInput
@param: Index is 0 for X axis, 1 for Y axis
@return the smoothed mouse axis movement


Defaultproperties

defaultproperties
{
   bEnableMouseSmoothing=True
   DoubleClickTime=0.250000
   MouseSensitivity=25.000000
   MoveForwardSpeed=1200.000000
   MoveStrafeSpeed=1200.000000
   LookRightScale=300.000000
   LookUpScale=-250.000000
   MouseSamples=1
   MouseSamplingTotal=0.008300
   Bindings(0)=(Name="F8",Command="set D3DRenderDevice bUsePostProcessEffects True")
   Bindings(1)=(Name="F9",Command="shot")
   Bindings(2)=(Name="P",Command="TogglePhysicsMode")
   Bindings(3)=(Name="Delete",Command="Camera Default")
   Bindings(4)=(Name="End",Command="Camera FirstPerson")
   Bindings(5)=(Name="MouseX",Command="Count bXAxis | Axis aMouseX")
   Bindings(6)=(Name="LeftShift",Command="Walking")
   Bindings(7)=(Name="F7",Command="set D3DRenderDevice bUsePostProcessEffects False")
   Bindings(8)=(Name="MouseY",Command="Count bYAxis | Axis aMouseY")
   Bindings(9)=(Name="Duck",Command="Button bDuck | Axis aUp Speed=-1.0  AbsoluteAxis=100")
   Bindings(10)=(Name="Look",Command="Button bLook")
   Bindings(11)=(Name="Pause",Command="Pause")
   Bindings(12)=(Name="LookToggle",Command="Toggle bLook")
   Bindings(13)=(Name="LookUp",Command="Axis aLookUp Speed=+25.0 AbsoluteAxis=100")
   Bindings(14)=(Name="LookDown",Command="Axis aLookUp Speed=-25.0 AbsoluteAxis=100")
   Bindings(15)=(Name="CenterView",Command="Button bSnapLevel")
   Bindings(16)=(Name="Walking",Command="Button bRun")
   Bindings(17)=(Name="Strafe",Command="Button bStrafe")
   Bindings(18)=(Name="NextWeapon",Command="NextWeapon")
   Bindings(19)=(Name="ViewTeam",Command="ViewClass Pawn")
   Bindings(20)=(Name="TurnToNearest",Command="Button bTurnToNearest")
   Bindings(21)=(Name="Turn180",Command="Button bTurn180")
   Bindings(22)=(Name="GBA_MoveForward",Command="Axis aBaseY Speed=1.0")
   Bindings(23)=(Name="GBA_Backward",Command="Axis aBaseY Speed=-1.0")
   Bindings(24)=(Name="GBA_StrafeLeft",Command="Axis aStrafe Speed=-1.0")
   Bindings(25)=(Name="GBA_StrafeRight",Command="Axis aStrafe Speed=+1.0")
   Bindings(26)=(Name="GBA_TurnLeft",Command="Axis aBaseX Speed=-200.0 AbsoluteAxis=100")
   Bindings(27)=(Name="GBA_TurnRight",Command="Axis aBaseX  Speed=+200.0 AbsoluteAxis=100")
   Bindings(28)=(Name="GBA_Jump",Command="Jump | Axis aUp Speed=+1.0 AbsoluteAxis=100")
   Bindings(29)=(Name="GBA_Duck",Command="Duck | onrelease UnDuck | Axis aUp Speed=-1.0  AbsoluteAxis=100")
   Bindings(30)=(Name="GBA_Fire",Command="StartFire | OnRelease StopFire")
   Bindings(31)=(Name="GBA_AltFire",Command="StartAltFire | OnRelease StopAltFire")
   Bindings(32)=(Name="GBA_Use",Command="use")
   Bindings(33)=(Name="GBA_FeignDeath",Command="FeignDeath")
   Bindings(34)=(Name="GBA_SwitchToBestWeapon",Command="SwitchToBestWeapon")
   Bindings(35)=(Name="GBA_PrevWeapon",Command="PrevWeapon")
   Bindings(36)=(Name="GBA_NextWeapon",Command="NextWeapon")
   Bindings(37)=(Name="GBA_SwitchWeapon1",Command="switchweapon 1")
   Bindings(38)=(Name="GBA_SwitchWeapon2",Command="switchweapon 2")
   Bindings(39)=(Name="GBA_SwitchWeapon3",Command="switchweapon 3")
   Bindings(40)=(Name="GBA_SwitchWeapon4",Command="switchweapon 4")
   Bindings(41)=(Name="GBA_SwitchWeapon5",Command="switchweapon 5")
   Bindings(42)=(Name="GBA_SwitchWeapon6",Command="switchweapon 6")
   Bindings(43)=(Name="GBA_SwitchWeapon7",Command="switchweapon 7")
   Bindings(44)=(Name="GBA_SwitchWeapon8",Command="switchweapon 8")
   Bindings(45)=(Name="GBA_SwitchWeapon9",Command="switchweapon 9")
   Bindings(46)=(Name="GBA_SwitchWeapon10",Command="switchweapon 10")
   Bindings(47)=(Name="GBA_ToggleTranslocator",Command="ToggleTranslocator")
   Bindings(48)=(Name="GBA_ToggleSpeaking",Command="ToggleSpeaking true | OnRelease ToggleSpeaking false")
   Bindings(49)=(Name="GBA_Talk",Command="talk")
   Bindings(50)=(Name="GBA_TeamTalk",Command="teamtalk")
   Bindings(51)=(Name="GBA_Taunt1",Command="taunt 1")
   Bindings(52)=(Name="GBA_Taunt2",Command="taunt 2")
   Bindings(53)=(Name="GBA_Horn",Command="PlayVehicleHorn")
   Bindings(54)=(Name="GBA_ShowMenu",Command="CloseEditorViewport | onrelease ShowMenu")
   Bindings(55)=(Name="GBA_ShowCommandMenu",Command="ShowCommandMenu")
   Bindings(56)=(Name="GBA_ShowScores",Command="SetShowScores true | Onrelease SetShowScores false")
   Bindings(57)=(Name="GBA_ShowMap",Command="ShowMap")
   Bindings(58)=(Name="GBA_ToggleMinimap",Command="ToggleMinimap")
   Bindings(59)=(Name="GBA_TriggerHero",Command="TriggerHero")
   Bindings(60)=(Name="GBA_GrowHud",Command="GrowHud")
   Bindings(61)=(Name="GBA_ShrinkHud",Command="ShrinkHud")
   Bindings(62)=(Name="GBA_ToggleMelee",Command="ToggleMelee | Axis aUp Speed=-1.0 AbsoluteAxis=100")
   Bindings(63)=(Name="GBA_WeaponPicker",Command="ShowQuickPick | OnRelease HideQuickPick")
   Bindings(64)=(Name="GBA_Jump_Gamepad",Command="SmartJump | Axis aUp Speed=1.0 AbsoluteAxis=100")
   Bindings(65)=(Name="GBA_StrafeLeft_Gamepad",Command="Axis aStrafe Speed=1.0 DeadZone=0.2")
   Bindings(66)=(Name="GBA_MoveForward_Gamepad",Command="Axis aBaseY Speed=1.0 DeadZone=0.2")
   Bindings(67)=(Name="GBA_TurnLeft_Gamepad",Command="Axis aTurn Speed=1.0 DeadZone=0.2")
   Bindings(68)=(Name="GBA_Look_Gamepad",Command="Axis aLookup Speed=0.65 DeadZone=0.2")
   Bindings(69)=(Name="GBA_SwitchToBestWeapon_Gamepad",Command="SwitchToBestWeapon | Axis aUp Speed=-1.0 AbsoluteAxis=100")
   Bindings(70)=(Name="GBA_Use_Gamepad",Command="use")
   Bindings(71)=(Name="XboxTypeS_Start",Command="GBA_ShowMenu")
   Bindings(72)=(Name="XboxTypeS_LeftX",Command="GBA_StrafeLeft_Gamepad")
   Bindings(73)=(Name="XboxTypeS_LeftY",Command="GBA_MoveForward_Gamepad")
   Bindings(74)=(Name="XboxTypeS_RightX",Command="GBA_TurnLeft_Gamepad")
   Bindings(75)=(Name="XboxTypeS_RightY",Command="GBA_Look_Gamepad")
   Bindings(76)=(Name="XboxTypeS_RightShoulder",Command="GBA_NextWeapon")
   Bindings(77)=(Name="XboxTypeS_RightTrigger",Command="GBA_Fire")
   Bindings(78)=(Name="XboxTypeS_LeftShoulder",Command="GBA_WeaponPicker")
   Bindings(79)=(Name="XboxTypeS_LeftTrigger",Command="GBA_AltFire")
   Bindings(80)=(Name="XboxTypeS_RightThumbstick",Command="GBA_SwitchToBestWeapon_Gamepad")
   Bindings(81)=(Name="XboxTypeS_LeftThumbstick",Command="GBA_Duck")
   Bindings(82)=(Name="XboxTypeS_A",Command="GBA_Jump_Gamepad")
   Bindings(83)=(Name="XboxTypeS_B",Command="GBA_ToggleMelee")
   Bindings(84)=(Name="XboxTypeS_Y",Command="GBA_ShowMap")
   Bindings(85)=(Name="XboxTypeS_X",Command="GBA_Use_Gamepad")
   Bindings(86)=(Name="XboxTypeS_Back",Command="GBA_ShowScores")
   Bindings(87)=(Name="XboxTypeS_DPad_Up",Command="GBA_TriggerHero")
   Bindings(88)=(Name="XboxTypeS_DPad_Down",Command="GBA_FeignDeath")
   Bindings(89)=(Name="XboxTypeS_DPad_Left",Command="GBA_ShowCommandMenu")
   Bindings(90)=(Name="XboxTypeS_DPad_Right",Command="GBA_ToggleSpeaking")
   Bindings(91)=(Name="SIXAXIS_AccelX",Command="GBA_TurnLeft_Gamepad")
   Bindings(92)=(Name="SIXAXIS_AccelZ",Command="GBA_Look_Gamepad")
   Bindings(93)=(Name="Up",Command="GBA_MoveForward")
   Bindings(94)=(Name="Down",Command="GBA_Backward")
   Bindings(95)=(Name="Left",Command="GBA_TurnLeft")
   Bindings(96)=(Name="Right",Command="GBA_TurnRight")
   Bindings(97)=(Name="LeftControl",Command="GBA_Jump")
   Bindings(98)=(Name="Enter",Command="GBA_Use")
   Bindings(99)=(Name="SpaceBar",Command="GBA_Jump")
   Bindings(100)=(Name="W",Command="GBA_MoveForward")
   Bindings(101)=(Name="S",Command="GBA_Backward")
   Bindings(102)=(Name="A",Command="GBA_StrafeLeft")
   Bindings(103)=(Name="D",Command="GBA_StrafeRight")
   Bindings(104)=(Name="E",Command="GBA_Use")
   Bindings(105)=(Name="LeftMouseButton",Command="GBA_Fire")
   Bindings(106)=(Name="RightMouseButton",Command="GBA_AltFire")
   Bindings(107)=(Name="C",Command="GBA_Duck")
   Bindings(108)=(Name="Escape",Command="GBA_ShowMenu")
   Bindings(109)=(Name="MouseScrollUp",Command="GBA_PrevWeapon")
   Bindings(110)=(Name="MouseScrollDown",Command="GBA_NextWeapon")
   Bindings(111)=(Name="one",Command="GBA_SwitchWeapon1")
   Bindings(112)=(Name="two",Command="GBA_SwitchWeapon2")
   Bindings(113)=(Name="three",Command="GBA_SwitchWeapon3")
   Bindings(114)=(Name="four",Command="GBA_SwitchWeapon4")
   Bindings(115)=(Name="five",Command="GBA_SwitchWeapon5")
   Bindings(116)=(Name="six",Command="GBA_SwitchWeapon6")
   Bindings(117)=(Name="seven",Command="GBA_SwitchWeapon7")
   Bindings(118)=(Name="eight",Command="GBA_SwitchWeapon8")
   Bindings(119)=(Name="nine",Command="GBA_SwitchWeapon9")
   Bindings(120)=(Name="zero",Command="GBA_SwitchWeapon10")
   Bindings(121)=(Name="Q",Command="GBA_ToggleTranslocator")
   Bindings(122)=(Name="T",Command="GBA_Talk")
   Bindings(123)=(Name="Y",Command="GBA_TeamTalk")
   Bindings(124)=(Name="J",Command="GBA_Taunt1")
   Bindings(125)=(Name="K",Command="GBA_Taunt2")
   Bindings(126)=(Name="L",Command="GBA_Horn")
   Bindings(127)=(Name="F1",Command="GBA_ShowScores")
   Bindings(128)=(Name="F2",Command="GBA_ShowMap")
   Bindings(129)=(Name="F3",Command="GBA_ToggleMinimap")
   Bindings(130)=(Name="F6",Command="stat net")
   Bindings(131)=(Name="G",Command="GBA_SwitchToBestWeapon")
   Bindings(132)=(Name="F",Command="GBA_FeignDeath")
   Bindings(133)=(Name="Equals",Command="GBA_GrowHud")
   Bindings(134)=(Name="Minus",Command="GBA_ShrinkHud")
   Bindings(135)=(Name="V",Command="GBA_ShowCommandMenu")
   Bindings(136)=(Name="B",Command="GBA_ToggleSpeaking")
   Bindings(137)=(Name="R",Command="GBA_TriggerHero")
   Bindings(138)=(Name="M",Command="BasePath 0")
   Bindings(139)=(Name="N",Command="BasePath 1")
   Name="Default__PlayerInput"
   ObjectArchetype=Input'Engine.Default__Input'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:41.753 - Created with UnCodeX