> 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_player_input.md).
# PlayerInput
**Usage:** `api.PlayerInput.EnablePlayer()`
Exposes player input state and control methods to the JavaScript API layer. Provides access to the current input platform, virtual axis sensitivities, the player transform, and methods to enable or disable player control.
## Public Classes
| | Name |
| ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| class | CurrentPlatform
Defines constants for the supported input platform types.
|
## Public Functions
| | Name |
| ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| void | EnablePlayer()
Activates player control, starts recording input and display ui for controls.
|
| void | DisablePlayer()
Deactivates player control,stops recording input and remove ui for controls.
|
## Public Properties
| | Name |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Platform | currentPlatform
Gets the currently active input platform (e.g. mouse/keyboard or touch).
|
| float | moveHorizontalAxis
Gets the sensitivity of the horizontal strafing (left/right movement) axis.
|
| float | moveVerticalAxis
Gets the sensitivity of the vertical movement (forward/back) axis.
|
| float | rotateHorizontalAxis
Gets the sensitivity of the horizontal camera/look rotation axis.
|
| float | rotateVerticalAxis
Gets the sensitivity of the vertical camera/look rotation axis.
|
| Transform | playerTransform
Gets the transform of the player object (position, rotation, scale).
|
| GameObject | player
Returns the local player.
|
## Public Functions Documentation
### function EnablePlayer
```csharp
static void EnablePlayer()
```
Activates player control, starts recording input and display ui for controls.
### function DisablePlayer
```csharp
static void DisablePlayer()
```
Deactivates player control,stops recording input and remove ui for controls.
## Public Property Documentation
### property currentPlatform
```csharp
static Platform currentPlatform;
```
Gets the currently active input platform (e.g. mouse/keyboard or touch).
### property moveHorizontalAxis
```csharp
static float moveHorizontalAxis;
```
Gets the sensitivity of the horizontal strafing (left/right movement) axis.
### property moveVerticalAxis
```csharp
static float moveVerticalAxis;
```
Gets the sensitivity of the vertical movement (forward/back) axis.
### property rotateHorizontalAxis
```csharp
static float rotateHorizontalAxis;
```
Gets the sensitivity of the horizontal camera/look rotation axis.
### property rotateVerticalAxis
```csharp
static float rotateVerticalAxis;
```
Gets the sensitivity of the vertical camera/look rotation axis.
### property playerTransform
```csharp
static Transform playerTransform;
```
Gets the transform of the player object (position, rotation, scale).
### property player
```csharp
static GameObject player;
```
Returns the local player.
***
Updated on 2026-07-22 at 12:00:00 +0800