> For the complete documentation index, see [llms.txt](https://vc-docs.gitbook.io/engine/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://vc-docs.gitbook.io/engine/home/doxygen_synced/classes/class_input.md).
# Input
**Usage:** `api.Input.GetKeyDown(key)`
## Public Functions
| | Name |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| UnityEngine.GameObject | HoverMouse()
Raycasts from the main camera through the current mouse position and returns the first gameobject hit within range.
|
| bool | GetMouseButtonDown(int key)
Returns true during the frame the specified mouse button was pressed.
|
| bool | GetMouseButtonUp(int key)
Returns true during the frame the specified mouse button was released.
|
| bool | GetMouseButton(int key)
Returns true while the specified mouse button is held down.
|
| bool | GetKeyDown(KeyCode key)
Returns true during the frame the specified keyboard key was pressed.
|
| bool | GetKeyUp(KeyCode key)
Returns true during the frame the specified keyboard key was released.
|
## Public Properties
| | Name |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| UnityEngine.Vector3 | mousePosition
Current mouse position in screen coordinates (pixels). Origin is the bottom-left of the screen.
|
| float | mouseScrollDelta
Vertical scroll delta of the mouse wheel for the current frame. Positive values scroll up, negative values scroll down.
|
## Public Functions Documentation
### function HoverMouse
```csharp
static UnityEngine.GameObject HoverMouse()
```
Raycasts from the main camera through the current mouse position and returns the first gameobject hit within range.
**Return**: The gameobject under the mouse cursor, or `null` if nothing was hit.
### function GetMouseButtonDown
```csharp
static bool GetMouseButtonDown(
int key
)
```
Returns true during the frame the specified mouse button was pressed.
**Parameters**:
* **key** Mouse button index (0 = left, 1 = right, 2 = middle).
**Return**: True if the button was pressed this frame, otherwise false.
### function GetMouseButtonUp
```csharp
static bool GetMouseButtonUp(
int key
)
```
Returns true during the frame the specified mouse button was released.
**Parameters**:
* **key** Mouse button index (0 = left, 1 = right, 2 = middle).
**Return**: True if the button was released this frame, otherwise false.
### function GetMouseButton
```csharp
static bool GetMouseButton(
int key
)
```
Returns true while the specified mouse button is held down.
**Parameters**:
* **key** Mouse button index (0 = left, 1 = right, 2 = middle).
**Return**: True if the button is currently held, otherwise false.
### function GetKeyDown
```csharp
static bool GetKeyDown(
KeyCode key
)
```
Returns true during the frame the specified keyboard key was pressed.
**Parameters**:
* **key** The unity keycode of the key to check.
**Return**: True if the key was pressed this frame, otherwise false.
### function GetKeyUp
```csharp
static bool GetKeyUp(
KeyCode key
)
```
Returns true during the frame the specified keyboard key was released.
**Parameters**:
* **key** The unity keycode of the key to check.
**Return**: True if the key was released this frame, otherwise false.
## Public Property Documentation
### property mousePosition
```csharp
static UnityEngine.Vector3 mousePosition;
```
Current mouse position in screen coordinates (pixels). Origin is the bottom-left of the screen.
### property mouseScrollDelta
```csharp
static float mouseScrollDelta;
```
Vertical scroll delta of the mouse wheel for the current frame. Positive values scroll up, negative values scroll down.
***
Updated on 2026-07-22 at 12:00:00 +0800