Unity - Scripting API: Input (2024)

Description

Interface into the Input system.

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.

using UnityEngine;using System.Collections;

public class ExampleClass : MonoBehaviour{ public void Update() { if (Input.GetButtonDown("Fire1")) { Debug.Log(Input.mousePosition); } }}

This component relates to legacy methods for drawing UI textures and images tothe screen. You should instead use UI system. This is alsounrelated to the IMGUI system.

Static Properties

accelerationLast measured linear acceleration of a device in three-dimensional space. (Read Only)
accelerationEventCountNumber of acceleration measurements which occurred during last frame.
accelerationEventsReturns list of acceleration measurements which occurred during the last frame. (Read Only) (Allocates temporary variables).
anyKeyIs any key or mouse button currently held down? (Read Only)
anyKeyDownReturns true the first frame the user hits any key or mouse button. (Read Only)
backButtonLeavesAppShould Back button quit the application?Only usable on Android, Windows Phone or Windows Tablets.
compassProperty for accessing compass (handheld devices only). (Read Only)
compensateSensorsThis property controls if input sensors should be compensated for screen orientation.
compositionCursorPosThe current text input position used by IMEs to open windows.
compositionStringThe current IME composition string being typed by the user.
deviceOrientationDevice physical orientation as reported by OS. (Read Only)
gyroReturns default gyroscope.
imeCompositionModeControls enabling and disabling of IME input composition.
imeIsSelectedDoes the user have an IME keyboard input source selected?
inputStringReturns the keyboard input entered this frame. (Read Only)
locationProperty for accessing device location (handheld devices only). (Read Only)
mousePositionThe current mouse position in pixel coordinates. (Read Only).
mousePresentIndicates if a mouse device is detected.
mouseScrollDeltaThe current mouse scroll delta. (Read Only)
multiTouchEnabledProperty indicating whether the system handles multiple touches.
penEventCountReturns the number of queued pen events that can be accessed by calling [[GetPenEvent()]].
simulateMouseWithTouchesEnables/Disables mouse simulation with touches. By default this option is enabled.
stylusTouchSupportedReturns true when Stylus Touch is supported by a device or platform.
touchCountNumber of touches. Guaranteed not to change throughout the frame. (Read Only)
touchesReturns list of objects representing status of all touches during last frame. (Read Only) (Allocates temporary variables).
touchPressureSupportedBool value which let's users check if touch pressure is supported.
touchSupportedReturns whether the device on which application is currently running supports touch input.

Static Methods

ClearLastPenContactEventClears the last stored pen event.Calling this function may impact event handling for UIToolKit elements.
GetAccelerationEventReturns specific acceleration measurement which occurred during last frame. (Does not allocate temporary variables).
GetAxisReturns the value of the virtual axis identified by axisName.
GetAxisRawReturns the value of the virtual axis identified by axisName with no smoothing filtering applied.
GetButtonReturns true while the virtual button identified by buttonName is held down.
GetButtonDownReturns true during the frame the user pressed down the virtual button identified by buttonName.
GetButtonUpReturns true the first frame the user releases the virtual button identified by buttonName.
GetJoystickNamesRetrieves a list of input device names corresponding to the index of an Axis configured within Input Manager.
GetKeyReturns true while the user holds down the key identified by name.
GetKeyDownReturns true during the frame the user starts pressing down the key identified by name.
GetKeyUpReturns true during the frame the user releases the key identified by name.
GetLastPenContactEventReturns the PenData for the last stored pen up or down event.
GetMouseButtonReturns whether the given mouse button is held down.
GetMouseButtonDownReturns true during the frame the user pressed the given mouse button.
GetMouseButtonUpReturns true during the frame the user releases the given mouse button.
GetPenEventReturns the PenData for the pen event at the given index in the pen event queue.
GetTouchCall Input.GetTouch to obtain a Touch struct.
IsJoystickPreconfiguredDetermine whether a particular joystick model has been preconfigured by Unity. (Linux-only).
ResetInputAxesResets all input. After ResetInputAxes all axes return to 0 and all buttons return to 0 for one frame.
ResetPenEventsClears the pen event queue.
Unity - Scripting API: Input (2024)
Top Articles
Latest Posts
Article information

Author: Sen. Ignacio Ratke

Last Updated:

Views: 5541

Rating: 4.6 / 5 (76 voted)

Reviews: 91% of readers found this page helpful

Author information

Name: Sen. Ignacio Ratke

Birthday: 1999-05-27

Address: Apt. 171 8116 Bailey Via, Roberthaven, GA 58289

Phone: +2585395768220

Job: Lead Liaison

Hobby: Lockpicking, LARPing, Lego building, Lapidary, Macrame, Book restoration, Bodybuilding

Introduction: My name is Sen. Ignacio Ratke, I am a adventurous, zealous, outstanding, agreeable, precious, excited, gifted person who loves writing and wants to share my knowledge and understanding with you.