View source for Game ui

:''Not to be confused with [[GameUI]].''
__NOTOC__
{{CD|CGameUI|file1=game_ui.cpp}}
{{this is a|point entity|name=game_ui|engine=Source}} It redirects important player key presses to a series of outputs, and can be used to make the player control vehicles built in a map. It can be activated with I/O, or by the player looking at it.
{{note|You must have one instance of game_ui per player in multiplayer as each game_ui only activates for one player at a time.}}
{{note|Bots can use this entity and fire its outputs.}}
{{bug|Due to an oversight, game_ui will disable client prediction causing laggy behavior on multiplayer.}}

== Keyvalues ==
{{KV Targetname}}
{{KV|FieldOfView|intn=FieldOfView|float|The amount of tolerance in the view checking when determining whether the player's input is still under control.}}
:*'''1.0''' = '''straight ahead'''
:*'''0.0''' = '''+/- 90 degrees'''
:*'''-1.0''' = '''all directions'''

== Flags ==
{{fl|32|Freeze Player - The player cannot move (they can still crouch though)}}
{{fl|64|Hide Weapon - Disables all the player's weapons
::{{note|This will cause the player to go into their reference (T) pose.}}}}
{{fl|128|+Use Deactivates}}
{{fl|256|Jump Deactivates}}

== Inputs ==
{{IO|Activate|The [[!activator]] will gain control upon this input being fired.}}
{{IO|Deactivate|The entity will only test FieldOfView if it is active.{{bug|The game will crash if the <code>Deactivate</code> input is fired on a game_ui that was activated by a player who has since disconnected. Fixed in {{tf2|2}}}}{{workaround|[[AddOutput]]ing OnUsers to a player and using a [[logic_branch]] together can be sufficient to workaround this. If the game supports it, [[VScript]] can also be used to check if the player entity still exists before firing the input.}}}}

== Outputs ==
The player is always the [[!activator]].
{{IO|PlayerOn}}
{{IO|PlayerOff|Fired when the entity starts or stops controlling the player's input.|since=}}
{{IO|PressedMoveLeft}}
{{IO|UnpressedMoveLeft|Fired on +moveleft/-moveleft|since=EP2}}
{{IO|PressedMoveRight}}
{{IO|UnpressedMoveRight|Fired on +moveright/-moveright|since=EP2}}
::{{bug|The left/right movement outputs do not fire when using a controller. {{elaborate|game this was tested in}} }}
{{IO|PressedForward}}
{{IO|UnpressedForward|Fired on +forward/-forward|since=EP2}}
{{IO|PressedBack}}
{{IO|UnpressedBack|Fired on +back/-back|since=EP2}}
{{IO|PressedAttack}}
{{IO|UnpressedAttack|Fired on +attack/-attack|since=EP2}}
{{IO|PressedAttack2}}
{{IO|UnpressedAttack2|Fired on +attack2/-attack2|since=EP2}}
{{IO|XAxis|param=float}}
{{IO|YAxis|param=float|Fired whenever the X/Y axis of the player's input changes.}}
:* -1.0 = +moveleft / +back at 100% speed
:* 0 = no movement in this axis
:* +1.0 = +moveright / +forward at 100% speed
{{IO|AttackAxis|param=float}}
{{IO|Attack2Axis|param=float|An output that fires whenever the state of the player's "attack" key changes.}}
:* 1.0 = trigger is 100% depressed
:* 0 = trigger is at rest
::{{note|These do not actually output analog values, even when using an analog stick; it will only be <code>1</code>, <code>0</code>, or <code>-1</code> depending on which keys are considered pressed. (Because of the above bug, this also means that <code>XAxis</code> never fires when using a controller.) {{elaborate|game this was tested in}} }}

[[Category:Level Design]]