class in UnityEngine
/
Implemented in:UnityEngine.InputLegacyModule
Suggest a change Success!Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Close Submission failedFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Close Your name Your email Suggestion* DescriptionInterface into the Legacy Input system.
Note: The Input class is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, use the Input System package. To learn more about input, refer to Input.
KeyCode maps to physical keys only if "Use Physical Keys" is enabled in Input Manager settings, otherwise it maps to layout and platform dependent key mapping. Starting from 2022.1 "Use Physical Keys" is enabled by default.
Use this class to read the axes set up in the Conventional Game Input, and to access multi-touch/accelerometer data on mobile devices.
To read an axis use Input.GetAxis with one of the following default axes: "Horizontal" and "Vertical" are mapped to joystick, A, W, S, D and the arrow keys. "Mouse X" and "Mouse Y" are mapped to the mouse delta. "Fire1", "Fire2" "Fire3" are mapped to Ctrl, Alt, Cmd keys and three mouse or joystick buttons. New input axes can be added. See Input Manager for this.
If you are using input for any kind of movement behaviour use Input.GetAxis. It gives you smoothed and configurable input that can be mapped to a keyboard, joystick or mouse. Use Input.GetButton for action-like events only. Do not use it for movement. Input.GetAxis will make the script code smaller and simpler.
Note: Input flags are not reset until Update. You should make all the Input calls in the Update Loop.
Additional resources: KeyCode which lists all of the key press, mouse and joystick options.
Mobile Devices:
iOS and Android devices are capable of tracking multiple fingers touching the screen simultaneously. You can access data on the status of each finger touching screen during the last frame by using the Input.touches property array.
As a device moves, its accelerometer hardware reports linear acceleration changes along the three primary axes in three-dimensional space. You can use this data to detect both the current orientation of the device (relative to the ground) and any immediate changes to that orientation.
Acceleration along each axis is reported directly by the hardware as G-force values. A value of 1.0 represents a load of about +1g along a given axis while a value of -1.0 represents -1g. If you hold the device upright (with the home button at the bottom) in front of you, the X axis is positive along the right, the Y axis is positive directly up, and the Z axis is positive pointing toward you.
You can use the Input.acceleration property to get the accelerometer reading. You can also use the Input.deviceOrientation property to get a discrete evaluation of the device's orientation in three-dimensional space. Detecting a change in orientation can be useful if you want to create game behaviors when the user rotates the device to hold it differently.
Note that the accelerometer hardware can be polled more than once per frame. To access all accelerometer samples since the last frame, you can use the Input.accelerationEvents property array. This can be useful when reconstructing player motions, feeding acceleration data into a predictor, or implementing other precise motion analysis.
This component relates to legacy methods for drawing UI textures and images to the screen. You should instead use UI system. This is also unrelated to the IMGUI system.
Static Properties Property Description acceleration Last measured linear acceleration of a device in three-dimensional space. (Read Only) accelerationEventCount Number of acceleration measurements which occurred during last frame. accelerationEvents Returns list of acceleration measurements which occurred during the last frame. (Read Only) (Allocates temporary variables). anyKey Is any key or mouse button currently held down? (Read Only) anyKeyDown Returns true the first frame the user hits any key or mouse button. (Read Only) backButtonLeavesApp Should Back button quit the application? compass Property for accessing compass (handheld devices only). (Read Only) compensateSensors This property controls if input sensors should be compensated for screen orientation. compositionCursorPos The current text input position used by IMEs to open windows. compositionString The current IME composition string being typed by the user. deviceOrientation Device physical orientation as reported by OS. (Read Only) gyro Returns default gyroscope. imeCompositionMode Controls enabling and disabling of IME input composition. imeIsSelected Does the user have an IME keyboard input source selected? inputString Returns the keyboard input entered this frame. (Read Only) location Property for accessing device location (handheld devices only). (Read Only) mousePosition The current mouse position in pixel coordinates. (Read Only). mousePositionDelta The current mouse position delta in pixel coordinates. (Read Only). mousePresent Indicates if a mouse device is detected. mouseScrollDelta The current mouse scroll delta. (Read Only) multiTouchEnabled Property indicating whether the system handles multiple touches. penEventCount Returns the number of queued pen events that can be accessed by calling [[GetPenEvent()]]. simulateMouseWithTouches Enables/Disables mouse simulation with touches. By default this option is enabled. stylusTouchSupported Returns true when Stylus Touch is supported by a device or platform. touchCount Number of touches. Guaranteed not to change throughout the frame. (Read Only) touches Returns list of objects representing status of all touches during last frame. (Read Only) (Allocates temporary variables). touchPressureSupported Bool value which let's users check if touch pressure is supported. touchSupported Returns whether the device on which application is currently running supports touch input. Static Methods Method Description ClearLastPenContactEvent Clears the last stored pen event. Calling this function may impact event handling for UIToolKit elements. GetAccelerationEvent Returns specific acceleration measurement which occurred during last frame. (Does not allocate temporary variables). GetAxis Returns the value of the virtual axis identified by axisName. GetAxisRaw Returns the value of the virtual axis identified by axisName with no smoothing filtering applied. GetButton Returns true while the virtual button identified by buttonName is held down. GetButtonDown Returns true during the frame the user pressed down the virtual button identified by buttonName. GetButtonUp Returns true the first frame the user releases the virtual button identified by buttonName. GetJoystickNames Retrieves a list of input device names corresponding to the index of an Axis configured within Input Manager. GetKey Returns true while the user holds down the key identified by name. GetKeyDown Returns true during the frame the user starts pressing down the key identified by name. GetKeyUp Returns true during the frame the user releases the key identified by name. GetLastPenContactEvent Returns the PenData for the last stored pen up or down event. GetMouseButton Returns whether the given mouse button is held down. GetMouseButtonDown Returns true during the frame the user pressed the given mouse button. GetMouseButtonUp Returns true during the frame the user releases the given mouse button. GetPenEvent Returns the PenData for the pen event at the given index in the pen event queue. GetTouch Call Input.GetTouch to obtain a Touch struct. IsJoystickPreconfigured Determine whether a particular joystick model has been preconfigured by Unity. (Linux-only). ResetInputAxes Resets all input. After ResetInputAxes all axes return to 0 and all buttons return to 0 for one frame. ResetPenEvents Clears the pen event queue.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4