> 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_v_r_events.md).
# VREvents
**Usage:** `api.VREvents.OnTrigger(true)`
VR controller input helpers. Every method takes `ctrl` where true = left controller and false = right controller, and returns false when that controller is null.
## Public Functions
| | Name |
| ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| bool | OnSqueeze(bool ctrl)
True on the single frame the squeeze (grip/select) button is first pressed.
|
| bool | Squeezing(bool ctrl)
True for every frame the squeeze button is held down.
|
| bool | OnUnsqueeze(bool ctrl)
True on the single frame the squeeze button is released.
|
| bool | OnTrigger(bool ctrl)
True on the single frame the trigger (activate) button is first pressed.
|
| bool | Triggering(bool ctrl)
True for every frame the trigger is held down.
|
| bool | OnUntrigger(bool ctrl)
True on the single frame the trigger is released.
|
| void | AddOnGrab(XRGrabInteractable grabInteractable, Action< SelectEnterEventArgs > callback)
Registers a script callback fired when the interactable is grabbed (selectEntered).
|
| void | AddOnReleased(XRGrabInteractable grabInteractable, Action< SelectExitEventArgs > callback)
Registers a script callback fired when the interactable is released (selectExited).
|
| void | ToggleMovement(bool enable)
Enables or disables the player's continuous-movement locomotion component.
|
| void | ToggleTeleport(bool enable)
Enables or disables the player's teleport locomotion component.
|
## Public Functions Documentation
### function OnSqueeze
```csharp
static bool OnSqueeze(
bool ctrl
)
```
True on the single frame the squeeze (grip/select) button is first pressed.
**Parameters**:
* **ctrl** True for the left controller, false for the right.
**Return**: Whether squeeze was pressed this frame.
### function Squeezing
```csharp
static bool Squeezing(
bool ctrl
)
```
True for every frame the squeeze button is held down.
**Parameters**:
* **ctrl** True for the left controller, false for the right.
**Return**: Whether squeeze is currently held.
### function OnUnsqueeze
```csharp
static bool OnUnsqueeze(
bool ctrl
)
```
True on the single frame the squeeze button is released.
**Parameters**:
* **ctrl** True for the left controller, false for the right.
**Return**: Whether squeeze was released this frame.
### function OnTrigger
```csharp
static bool OnTrigger(
bool ctrl
)
```
True on the single frame the trigger (activate) button is first pressed.
**Parameters**:
* **ctrl** True for the left controller, false for the right.
**Return**: Whether the trigger was pressed this frame.
### function Triggering
```csharp
static bool Triggering(
bool ctrl
)
```
True for every frame the trigger is held down.
**Parameters**:
* **ctrl** True for the left controller, false for the right.
**Return**: Whether the trigger is currently held.
### function OnUntrigger
```csharp
static bool OnUntrigger(
bool ctrl
)
```
True on the single frame the trigger is released.
**Parameters**:
* **ctrl** True for the left controller, false for the right.
**Return**: Whether the trigger was released this frame.
### function AddOnGrab
```csharp
static void AddOnGrab(
XRGrabInteractable grabInteractable,
Action< SelectEnterEventArgs > callback
)
```
Registers a script callback fired when the interactable is grabbed (selectEntered).
**Parameters**:
* **grabInteractable** The interactable to listen on.
* **callback** Callback receiving the select-enter event args.
### function AddOnReleased
```csharp
static void AddOnReleased(
XRGrabInteractable grabInteractable,
Action< SelectExitEventArgs > callback
)
```
Registers a script callback fired when the interactable is released (selectExited).
**Parameters**:
* **grabInteractable** The interactable to listen on.
* **callback** Callback receiving the select-exit event args.
### function ToggleMovement
```csharp
static void ToggleMovement(
bool enable
)
```
Enables or disables the player's continuous-movement locomotion component.
**Parameters**:
* **enable** True to allow movement, false to lock it.
### function ToggleTeleport
```csharp
static void ToggleTeleport(
bool enable
)
```
Enables or disables the player's teleport locomotion component.
**Parameters**:
* **enable** True to allow teleporting, false to lock it.
***
Updated on 2026-07-22 at 12:00:00 +0800