VR Expansion Plugin

https://vreue4.com/
Admin
VR Expansion Plugin provides modular virtual reality tools for Unreal Engine 4 and 5, including...
Tokens:83,076
Snippets:988
Trust Score:8.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Setup Welded Bone Driver

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VREPhysicalAnimationComponent/VREPhysicalAnimationComponent.html

Initializes the welded bone driver.

```APIDOC
## Setup Welded Bone Driver

### Description
Performs the initial setup and configuration for the welded bone driver.
```

--------------------------------

### Get VR Device Model and Texture

Source: https://vreue4.com/documentation?section=vr-expansion-function-library

Gets the OpenVR model and texture of the designated device type currently in a tracking state.

```APIDOC
## Get VR Device Model and Texture

### Description
Gets the OpenVR model / texture of the designated device type currently in a tracking state. Returns true/false if it succeeded and a valid texture2D pointer to the models texture.

### Parameters
- **DeviceType** (Enum) - Device type to get the model for.
- **ProceduralMeshComponentsToFill** (Array) - List of ProceduralMeshComponents to fill with the mesh data.
- **bCreateCollision** (Boolean) - If it should set the mesh components to create collision when generating them.

### Returns
- **UTexture2D** - A valid UTexture2D if successful.
- **Status** (Enum) - Succeeded, Failed, or AsyncLoading.
```

--------------------------------

### Get Game Viewport Client

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRExpansionFunctionLibrary/nodes/GetGameViewportClient.html

Retrieves the Game Viewport Client object reference.

```APIDOC
## Get Game Viewport Client

### Description
Retrieves the Game Viewport Client object reference from the VRExpansion Function Library.

### Returns
- **Game Viewport Client** (Object Reference) - The Game Viewport Client object.
```

--------------------------------

### Get Controller Profiles

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGlobalSettings/nodes/GetControllerProfiles.html

Retrieves the array of configured controller profiles.

```APIDOC
## Get Controller Profiles

### Description
Retrieves an array of BPVRController Profile structures defined in the VRGlobal Settings.

### Outputs
- **Return Value** (Array of BPVRController Profile Structures) - The list of available controller profiles.
```

--------------------------------

### GetVRDeviceProperty

Source: https://vreue4.com/documentation?section=vr-expansion-function-library

Gets OpenVR built-in information properties about specific tracked devices.

```APIDOC
## GetVRDeviceProperty

### Description
Gets OpenVR built-in information properties about specific tracked devices. Each function has an Enum for available properties for the device type / return type that it handles.
```

--------------------------------

### Get Virtual Stock Global Settings

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGlobalSettings/nodes/GetVirtualStockGlobalSettings.html

Retrieves the current virtual stock settings as a BPVirtual Stock Settings structure.

```APIDOC
## Get Virtual Stock Global Settings

### Description
Retrieves the current values of the virtual stock settings from the global VR settings configuration.

### Inputs
- **In Exec** (Execution) - Triggers the retrieval of settings.

### Outputs
- **Out Exec** (Execution) - Continues execution after retrieval.
- **Out Virtual Stock Settings** (BPVirtual Stock Settings Structure) - The retrieved virtual stock configuration data.
```

--------------------------------

### Get Widget

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRFullScreenUserWidgetActor/nodes/GetWidget.html

Retrieves the User Widget object reference from the VRFull Screen User Widget Actor.

```APIDOC
## Get Widget

### Description
Retrieves the User Widget object reference associated with the target VRFull Screen User Widget Actor.

### Inputs
- **Target** (VRFull Screen User Widget Actor Object Reference) - The actor instance to query.

### Outputs
- **Return Value** (User Widget Object Reference) - The widget object associated with the actor.
```

--------------------------------

### Get Preview Widget Comp

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRFullScreenUserWidgetActor/nodes/GetPreviewWidgetComp.html

Retrieves the preview widget component associated with the VRFull Screen User Widget Actor.

```APIDOC
## Get Preview Widget Comp

### Description
Retrieves the VRFull Screen User Widget Object Reference from the target VRFull Screen User Widget Actor.

### Inputs
- **Target** (VRFull Screen User Widget Actor Object Reference) - The actor instance to query.

### Outputs
- **Return Value** (VRFull Screen User Widget Object Reference) - The widget component associated with the actor.
```

--------------------------------

### Get Post Process Render Target

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRFullScreenUserWidget/nodes/GetPostProcessRenderTarget.html

Retrieves the Texture Render Target 2D object reference from a VR Full Screen User Widget.

```APIDOC
## Get Post Process Render Target

### Description
Retrieves the Texture Render Target 2D object reference from a VR Full Screen User Widget.

### Inputs
- **Target** (VRFull Screen User Widget Object Reference) - The widget instance to query.

### Outputs
- **Return Value** (Texture Render Target 2D Object Reference) - The render target associated with the widget.
```

--------------------------------

### Get Grip by Component

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GetGripByComponent.html

Retrieves grip information for a specified component within the Grip Motion Controller Component.

```APIDOC
## Get Grip by Component

### Description
Retrieves the grip information structure for a specific component associated with a Grip Motion Controller Component.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference) - The controller component to query.
- **Component to Look for** (Primitive Component Object Reference) - The specific component to search for within the grip data.

### Outputs
- **On Succeeded** (Exec) - Triggered if the grip is found.
- **On Failed** (Exec) - Triggered if the grip is not found.
- **Grip** (BPActor Grip Information Structure) - The resulting grip information if the operation succeeds.
```

--------------------------------

### Get Grip Stiffness and Damping

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripInterface/nodes/GetGripStiffnessAndDamping.html

Retrieves the physics constraint stiffness and damping values for a VRGrip Interface.

```APIDOC
## Get Grip Stiffness and Damping

### Description
Retrieves the grip stiffness and damping values to be used if the grip is utilizing a physics constraint.

### Inputs
- **Target** (VRGrip Interface) - The interface instance to query.

### Outputs
- **Grip Stiffness** (Float) - The stiffness value for the physics constraint.
- **Grip Damping** (Float) - The damping value for the physics constraint.
```

--------------------------------

### Get Post Process Render Target

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRFullScreenUserWidgetActor/nodes/GetPostProcessRenderTarget.html

Retrieves the Texture Render Target 2D object reference from a VR Full Screen User Widget Actor.

```APIDOC
## Get Post Process Render Target

### Description
Retrieves the Texture Render Target 2D object reference from a VR Full Screen User Widget Actor.

### Inputs
- **Target** (VRFull Screen User Widget Actor Object Reference) - The actor instance to query.

### Outputs
- **Return Value** (Texture Render Target 2D Object Reference) - The render target used for post-processing.
```

--------------------------------

### Get Grip Mass

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GetGripMass.html

Retrieves the mass of the root component for a given grip information structure.

```APIDOC
## Get Grip Mass

### Description
Get the root components mass of a grip.

### Inputs
- **Grip** (BPActor Grip Information Structure) - Required - The grip information structure to query.

### Outputs
- **Mass** (Float) - The mass of the root component.
```

--------------------------------

### Get Widget

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRFullScreenUserWidget/nodes/GetWidget.html

Retrieves a pointer to the inner widget of the VRFull Screen User Widget. Note: The returned pointer should not be stored.

```APIDOC
## Get Widget

### Description
Retrieves a pointer to the inner widget of the VRFull Screen User Widget. Note: This pointer should not be stored.

### Inputs
- **Target** (VRFull Screen User Widget Object Reference)

### Outputs
- **Return Value** (User Widget Object Reference) - A pointer to the inner widget.
```

--------------------------------

### Get Melee Surface Global Settings

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGlobalSettings/nodes/GetMeleeSurfaceGlobalSettings.html

Retrieves the global melee surface settings as an array of BPHit Surface Properties structures.

```APIDOC
## Get Melee Surface Global Settings

### Description
Retrieves the values of the virtual stock settings from the VR Global Settings.

### Inputs
- **In Exec** (Execution) - Triggers the retrieval of settings.

### Outputs
- **Out Exec** (Execution) - Continues execution after retrieval.
- **Out Melee Surface Settings** (Array of BPHit Surface Properties) - The retrieved array of surface property structures.
```

--------------------------------

### SetSeatedMode

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRBaseCharacter/nodes/Server_SetSeatedMode.html

Sets seated mode on the character and fires an event for setup. It handles teleport locations, relative camera transforms, and movement mode switching.

```APIDOC
## SetSeatedMode

### Description
Sets seated mode on the character and then fires off an event to handle any special setup. Target Transform is for teleport location if standing up, or relative camera location when sitting down.

### Inputs
- **Target VRBase Character** (Object Reference) - The character to set seated mode on.
- **Seat Parent** (Scene Component Object Reference) - The component to parent the character to.
- **Set Seated Mode** (Boolean) - Whether to enable or disable seated mode.
- **Target Transform** (Transform Net Quantize) - Teleport location or relative camera location.
- **Initial Rel Camera Transform** (Transform Net Quantize) - The relative transform of the camera at the time of requesting to sit.
- **Allowed Radius** (Float) - Radius for seating constraints.
- **Allowed Radius Threshold** (Float) - Threshold for the allowed radius.
- **Zero to Head** (Boolean) - If true, places central point on head; if false, uses foot location and ignores Z values.
- **Post Seated Movement Mode** (EVRConjoinedMovementModes) - The movement mode to switch to after seating is canceled.
```

--------------------------------

### Get Animation Sequence as Pose Snap Shot

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/HandSocketComponent/nodes/GetAnimationSequenceAsPoseSnapShot.html

Converts an animation sequence into a pose snapshot for use in skeletal mesh animations.

```APIDOC
## Get Animation Sequence as Pose Snap Shot

### Description
Converts an animation sequence into a pose snapshot. This is useful for capturing specific animation frames as data structures that can be applied to skeletal meshes.

### Inputs
- **In Animation Sequence** (Anim Sequence Object Reference) - Sequence to convert to a pose snapshot
- **Target Mesh** (Skeletal Mesh Component Object Reference) - Target mesh to check the skeleton of
- **Skip Root Bone** (Boolean) - If true, skips the root bone (e.g., Hand_r) and only applies the children poses
- **Flip Hand** (Boolean) - If true, mirrors the pose, primarily used to apply a right-hand pose to a left hand

### Outputs
- **Out Pose Snap Shot** (Pose Snapshot Structure) - The resulting snapshot returned by the function
- **Return Value** (Boolean) - Status of the operation
```

--------------------------------

### Get Grip Slot In Range By Type Name

Source: https://vreue4.com/documentation?section=vr-expansion-function-library

Can be used with the VRGripInterface to get a default implementation of the grip slots.

```APIDOC
## Get Grip Slot In Range By Type Name

### Description
Can be used with the VRGripInterface to get a default implementation of the grip slots.
```

--------------------------------

### SetUpPhysicsHandle

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/SetUpPhysicsHandle_BP.html

Creates a physics handle for a specified grip.

```APIDOC
## SetUpPhysicsHandle

### Description
Creates a physics handle for the specified grip within the Grip Motion Controller Component.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference)
- **Grip** (BPActor Grip Information Structure) - Required

### Outputs
- **Return Value** (Boolean) - Returns true if the physics handle was successfully created.
```

--------------------------------

### Spawn and Grip Object on Server

Source: https://vreue4.com/bp-snippets

Spawns an actor on the server and initiates a grip. The client handles the grip initialization upon receiving the replicated object.

```Blueprint
Blueprint Paste of the nodes to perform this action
```

--------------------------------

### Get Physics Velocities

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GetPhysicsVelocities.html

Retrieves the physics velocities for a given grip.

```APIDOC
## Get Physics Velocities

### Description
Retrieves the angular and linear physics velocities for a specified grip information structure.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference)
- **Grip** (BPActor Grip Information Structure) - Required

### Outputs
- **Angular Velocity** (Vector)
- **Linear Velocity** (Vector)
```

--------------------------------

### Event On Begin Play

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripScriptBase/nodes/OnBeginPlay.html

Initializes the grip script. Must be called manually if spawning grip scripts during runtime or using custom interfaced grip objects.

```APIDOC
## Event On Begin Play

### Description
Initializes the grip script logic. This is required for scripts that utilize specific logic such as levers. While automatically handled for standard grippables, manual invocation is necessary when spawning scripts during play or using custom interfaced grip objects.

### Inputs
- None

### Outputs
- **Out Exec** (Exec) - Execution pin for flow control.
- **Calling Owner** (Object Reference) - Reference to the object that owns the grip script.
```

--------------------------------

### Begin Recording

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGestureComponent/nodes/BeginRecording.html

Initiates the recording of a gesture. This function allows users to specify whether to run detection, flatten the gesture, enable visual drawing, and configure sampling settings.

```APIDOC
## Begin Recording

### Description
Function to begin recording a gesture for detection or saving.

### Inputs
- **Target** (VRGesture Component Object Reference) - The component instance to record on.
- **Run Detection** (Boolean) - Should we detect gestures or only record them.
- **Flatten Gesture** (Boolean) - Should we flatten the gesture into 2 dimensions.
- **Draw Gesture** (Boolean) - Should we draw the gesture during recording.
- **Draw as Spline** (Boolean) - If true, use spline meshes; if false, draw as debug lines.
- **Sampling HTZ** (Integer) - How many times a second we will record a gesture point.
- **Sample Buffer Size** (Integer) - How many points we will store in history at a time.
- **Clamping Tolerance** (Float) - If larger than 0.0, we will clamp points to a grid of this size.
```

--------------------------------

### SetupWeldedBoneDriver

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VREPhysicalAnimationComponent/nodes/SetupWeldedBoneDriver.html

Initializes the welded body driver for the VREPhysical Animation Component.

```APIDOC
## SetupWeldedBoneDriver

### Description
Call to setup the welded body driver, initializes all mappings and caches shape contexts. Requires that SetSkeletalMesh be called first.

### Inputs
- **Target** (VREPhysical Animation Component Object Reference) - The component to initialize.
- **Base Bone Names** (Array of Names) - The list of bone names to be used for the driver.

### Outputs
- **Exec** - Output execution pin.
```

--------------------------------

### Get Is HMD Connected

Source: https://vreue4.com/documentation?section=vr-expansion-function-library

Calls the C++ IsHMDConnected() function and returns the value.

```APIDOC
## Get Is HMD Connected

### Description
Calls the C++ IsHMDConnected() function and returns the value.
```

--------------------------------

### Set Widget and Init

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRStereoWidgetRenderComponent/nodes/SetWidgetAndInit.html

Initializes a new widget class for the VRStereo Widget Render Component.

```APIDOC
## Set Widget and Init

### Description
Sets the widget class for the VRStereo Widget Render Component and performs initialization.

### Inputs
- **Target** (VRStereo Widget Render Component Object Reference) - The component instance to operate on.
- **New Widget Class** (User Widget Class Reference) - The class of the widget to be set and initialized.

### Outputs
- **Out Exec** (Exec) - Execution pin for flow control.
```

--------------------------------

### Interactible On Grip Init

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRInteractibleFunctionLibrary/nodes/Interactible_OnGripInit.html

Initializes the calculated values of a VR Interactible Base Data Structure on a grip event.

```APIDOC
## Interactible On Grip Init

### Description
Inits the calculated values of a VR Interactible Base Data Structure on a grip event.

### Inputs
- **Interactible Comp** (Scene Component Object Reference) - The interactible component.
- **Grip Information** (BPActor Grip Information Structure) - The grip information structure (by ref).
- **Base Data to Init** (BPVRInteractible Base Data Structure) - The base data structure to initialize (by ref).
```

--------------------------------

### Get HMD Pure Yaw

Source: https://vreue4.com/documentation?section=vr-expansion-function-library

Returns the unwound Yaw of the given Rotator.

```APIDOC
## Get HMD Pure Yaw

### Description
Returns the unwound Yaw of the given Rotator.
```

--------------------------------

### Get Parent Scene Comp

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripScriptBase/nodes/GetParentSceneComp.html

Retrieves the scene component of the parent object.

```APIDOC
## Get Parent Scene Comp

### Description
Returns the scene component of the parent, either being the parent itself or the root component of it. Returns nullptr if there is no valid scene component.

### Inputs
- **Target** (VRGrip Script Base Object Reference) - The object to query.

### Outputs
- **Return Value** (Scene Component Object Reference) - The scene component of the parent or nullptr.
```

--------------------------------

### Interactible_BeginPlayInit

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRInteractibleFunctionLibrary/nodes/Interactible_BeginPlayInit.html

Initializes the initial relative transform of an interactible component on begin play.

```APIDOC
## Interactible_BeginPlayInit

### Description
Inits the initial relative transform of an interactible on begin play.

### Inputs
- **Interactible Comp** (Scene Component Object Reference) - The interactible component to initialize.
- **Base Data to Init** (BPVRInteractible Base Data Structure) - The base data structure used for initialization (passed by reference).

### Outputs
- **Out Exec** (Exec) - Execution pin for flow control.
```

--------------------------------

### Configure VRGlobalSettings in DefaultEngine.ini

Source: https://vreue4.com/documentation?section=migrating-example-template-content

Sets the global plugin settings required for proper hand alignment and controller profiles.

```ini
[/Script/VRExpansionPlugin.VRGlobalSettings]
```

--------------------------------

### Get Owner

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripScriptBase/nodes/GetOwner.html

Returns the owning actor of the VRGrip Script Base object.

```APIDOC
## Get Owner

### Description
Returns the owning actor of the VRGrip Script Base object.

### Inputs
- **Target** (VRGrip Script Base Object Reference) - The object to query.

### Outputs
- **Return Value** (Actor Object Reference) - The actor that owns the VRGrip Script Base.
```

--------------------------------

### Get VRLocation

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRBaseCharacter/nodes/GetVRLocation.html

Retrieves the location of the HMD offset capsule for a VRBase Character.

```APIDOC
## Get VRLocation

### Description
Gets the location of the HMD offset capsule. This value retains the Capsule HalfHeight offset.

### Inputs
- **Target** (VRBase Character Object Reference) - The character instance to query.

### Outputs
- **Return Value** (Vector) - The world location of the HMD offset capsule.
```

--------------------------------

### Configure VRTraceChannel in DefaultEngine.ini

Source: https://vreue4.com/documentation?section=migrating-example-template-content

Defines the custom trace channel used for grip checking, ensuring objects are correctly ignored or blocked.

```ini
[/Script/Engine.CollisionProfile]  
 
+DefaultChannelResponses=(Channel=ECC_GameTraceChannel1,Name="VRTraceChannel",DefaultResponse=ECR_Block,bTraceType=True,bStaticObject=False)  
 +EditProfiles=(Name="PhysicsActor",CustomResponses=((Channel="VRTraceChannel")))  
 +EditProfiles=(Name="BlockAllDynamic",CustomResponses=((Channel="VRTraceChannel")))
```

--------------------------------

### Get HMD Type

Source: https://vreue4.com/documentation?section=vr-expansion-function-library

Returns an Enum representing the current HMD type connected.

```APIDOC
## Get HMD Type

### Description
Returns an Enum representing the current HMD type connected.
```

--------------------------------

### Define Grip Movement Replication Settings

Source: https://vreue4.com/documentation?section=grip-motion-controller

Enumeration defining how movement replication is handled when an object is gripped.

```cpp
enum class EGripMovementReplicationSettings : uint8
```

--------------------------------

### UpdatePhysicsHandle

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/UpdatePhysicsHandle_BP.html

Re-creates a physics handle for a grip. If bFullyRecreate is true, it sets all handle properties; otherwise, it only resets the physics actors and COM positions.

```APIDOC
## UpdatePhysicsHandle

### Description
Re-creates a physics handle for this grip. If bFullyRecreate is true then it will set all of the handle properties, if not then it will only reset the physics actors and COM positions.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference)
- **Grip Information** (Grip BPActor Grip Information Structure) - Required
- **Fully Recreate** (Boolean) - Required

### Outputs
- **Return Value** (Boolean) - Returns true if the operation was successful.
```

--------------------------------

### Get Is Actor Movable

Source: https://vreue4.com/documentation?section=vr-expansion-function-library

Returns if the actor given is movable (only movable actors can be gripped).

```APIDOC
## Get Is Actor Movable

### Description
Returns if the actor given is movable (only movable actors can be gripped).
```

--------------------------------

### VRGrip Script Base Methods and Events

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripScriptBase/VRGripScriptBase.html

A collection of events and functions available for interaction with the VRGrip Script Base.

```APIDOC
## Events
- **On Begin Play**: Triggered when the script begins play.
- **On End Play**: Triggered when the script ends play.
- **On Grip**: Triggered when the object is gripped.
- **On Grip Release**: Triggered when the object is released.
- **On Secondary Grip**: Triggered when a secondary grip is applied.
- **On Secondary Grip Release**: Triggered when a secondary grip is released.

## Functions
- **Force Grip to Drop**: Forces the current grip to release.
- **Get Grip Transform**: Returns the transform of the grip.
- **Get Owner**: Returns the owner of the script.
- **Get Parent**: Returns the parent object.
- **Get Parent Scene Comp**: Returns the parent scene component.
- **Get Parent Transform**: Returns the transform of the parent.
- **GetGripScriptByClass**: Retrieves a grip script by its class type.
- **Has Authority**: Checks if the current instance has network authority.
- **Is Server**: Checks if the current instance is running on the server.
- **Set Tick Enabled**: Enables or disables the tick function for the script.
- **Wants Deny Teleport**: Returns a boolean indicating if teleportation should be denied.
```

--------------------------------

### Get Priority

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRStereoWidgetComponent/nodes/GetPriority.html

Retrieves the render priority integer value from a VRStereo Widget Component.

```APIDOC
## Get Priority

### Description
Returns the render priority of the specified VRStereo Widget Component.

### Inputs
- **Target** (VRStereo Widget Component Object Reference) - Required

### Outputs
- **Return Value** (Integer) - The render priority value.
```

--------------------------------

### On Used

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripInterface/nodes/OnUsed.html

Triggers the use action on an object implementing the VRGrip Interface.

```APIDOC
## On Used

### Description
Triggers the use action on an object that implements the VRGrip Interface.

### Inputs
- **Target** (VRGrip Interface) - The object implementing the interface to be used.

### Outputs
- **Out Exec** (Exec) - The execution pin following the completion of the use action.
```

--------------------------------

### Get Controller Profile

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGlobalSettings/nodes/GetControllerProfile.html

Retrieves a controller profile structure based on the provided name.

```APIDOC
## Get Controller Profile

### Description
Retrieves a controller profile by its name from the VR Global Settings.

### Inputs
- **Controller Profile Name** (Name) - The name of the controller profile to retrieve.

### Outputs
- **Out Profile** (BPVRController Profile Structure) - The retrieved controller profile structure.
- **Return Value** (Boolean) - Returns true if the profile was found, false otherwise.
```

--------------------------------

### AddToClientReplicationBucket

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GrippableActor/nodes/AddToClientReplicationBucket.html

Adds a Grippable Actor to the client-side physics replication system.

```APIDOC
## AddToClientReplicationBucket

### Description
Adds the target Grippable Actor to client-side physics replication. The actor will remain in this state until it comes to rest or a timeout period is hit.

### Inputs
- **Target** (Grippable Actor Object Reference) - The actor to add to the replication bucket.

### Outputs
- **Return Value** (Boolean) - Returns true if the actor was successfully added to the replication bucket.
```

--------------------------------

### Get VRRotation

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRBaseCharacter/nodes/GetVRRotation.html

Retrieves the rotation of the HMD offset capsule for the specified VRBase Character.

```APIDOC
## Get VRRotation

### Description
Gets the rotation of the HMD offset capsule for a given VRBase Character object.

### Inputs
- **Target** (VRBase Character Object Reference) - The character instance to query.

### Outputs
- **Return Value** (Rotator) - The rotation of the HMD offset capsule.
```

--------------------------------

### Get Move Status

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRBaseCharacter/nodes/GetMoveStatus.html

Retrieves the current path following status of the VRBase Character.

```APIDOC
## Get Move Status

### Description
Returns the current movement status of the specified VRBase Character object.

### Inputs
- **Target** (VRBase Character Object Reference) - The character instance to query.

### Outputs
- **Return Value** (EPathFollowingStatus) - The current movement status of the character.
```

--------------------------------

### Grip Object by Interface

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GripObjectByInterface.html

Auto grips any UObject that is or has a root primitive component.

```APIDOC
## Grip Object by Interface

### Description
Auto grips any UObject that is or has a root primitive component.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference) - The controller component performing the grip.
- **Object to Grip** (Object Reference) - The object to be gripped.
- **World Offset Transform** (Transform) - The world offset transform.
- **World Offset Is Relative** (Boolean) - Whether the world offset is relative.
- **Optional Bone to Grip Name** (Name) - The name of the bone to grip, if applicable.
- **Optional Snap to Socket Name** (Name) - The name of the socket to snap to, if applicable.
- **Is Slot Grip** (Boolean) - Whether this is a slot grip.

### Outputs
- **Return Value** (Boolean) - Returns true if the grip was successful.
```

--------------------------------

### Get Parent

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripScriptBase/nodes/GetParent.html

Returns the parent component or actor to the target VRGrip Script Base object.

```APIDOC
## Get Parent

### Description
Returns the parent component or actor to the target VRGrip Script Base object.

### Inputs
- **Target** (VRGrip Script Base Object Reference) - The object to query.

### Outputs
- **Return Value** (Object Reference) - The parent component or actor.
```

--------------------------------

### AddToClientReplicationBucket

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GrippableSkeletalMeshActor/nodes/AddToClientReplicationBucket.html

Adds the target Grippable Skeletal Mesh Actor to the client-side physics replication system.

```APIDOC
## AddToClientReplicationBucket

### Description
Adds the target Grippable Skeletal Mesh Actor to client-side physics replication. The object will remain in this state until it comes to rest or the defined timeout period is hit.

### Inputs
- **Target** (Grippable Skeletal Mesh Actor Object Reference) - The actor to add to the replication bucket.

### Outputs
- **Return Value** (Boolean) - Returns true if the actor was successfully added to the replication bucket.
```

--------------------------------

### Get Secondary Grip Type

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripInterface/nodes/SecondaryGripType.html

Retrieves the secondary grip type associated with a VRGrip Interface.

```APIDOC
## Get Secondary Grip Type

### Description
Retrieves the ESecondaryGripType enum value from the target VRGrip Interface.

### Inputs
- **Target** (VRGrip Interface) - Required - The VRGrip Interface instance to query.

### Outputs
- **Return Value** (ESecondaryGripType) - The current secondary grip type enum value.
```

--------------------------------

### AddToClientReplicationBucket

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GrippableStaticMeshActor/nodes/AddToClientReplicationBucket.html

Adds the target Grippable Static Mesh Actor to client-side physics replication.

```APIDOC
## AddToClientReplicationBucket

### Description
Adds the target Grippable Static Mesh Actor to client-side physics replication. The object will remain in this state until it comes to rest or the timeout period is hit.

### Inputs
- **Target** (Grippable Static Mesh Actor Object Reference) - The actor to add to the replication bucket.

### Outputs
- **Return Value** (Boolean) - Returns true if the operation was successful.
```

--------------------------------

### Get Angular Limits

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VREPhysicsConstraintComponent/nodes/GetAngularLimits.html

Retrieves the angular limit values for the specified VREPhysics Constraint Component.

```APIDOC
## Get Angular Limits

### Description
Retrieves the current angular limits defined for a VREPhysics Constraint Component.

### Inputs
- **Target** (VREPhysics Constraint Component Object Reference) - The component to query.

### Outputs
- **Swing 1 Limit** (Float) - The current Swing 1 limit value.
- **Swing 2 Limit** (Float) - The current Swing 2 limit value.
- **Twist Limit** (Float) - The current Twist limit value.
```

--------------------------------

### Get VRUp Vector

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRBaseCharacter/nodes/GetVRUpVector.html

Retrieves the up vector of the HMD offset capsule for the specified VRBase Character.

```APIDOC
## Get VRUp Vector

### Description
Gets the up vector of the HMD offset capsule for the target VRBase Character.

### Inputs
- **Target** (VRBase Character Object Reference) - The character instance to query.

### Outputs
- **Return Value** (Vector) - The up vector of the HMD offset capsule.
```

--------------------------------

### Display

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRFullScreenUserWidget/nodes/Display.html

Triggers the display functionality for the VRFullScreenUserWidget.

```APIDOC
## Display

### Description
Triggers the display state of the target VRFullScreenUserWidget within the provided world context.

### Inputs
- **Target** (VRFull Screen User Widget Object Reference) - The widget instance to display.
- **World** (World Object Reference) - The world context in which the widget exists.

### Outputs
- **Return Value** (Boolean) - Returns true if the display operation was successful.
```

--------------------------------

### Configure Gameplay Tags in DefaultGameplayTags.ini

Source: https://vreue4.com/documentation?section=migrating-example-template-content

Required configuration to enable gameplay tags used by the template for input flags and gripping switches.

```ini
[/Script/GameplayTags.GameplayTagsSettings]  
 
ImportTagsFromConfig=False  
 WarnOnInvalidTags=True  
 FastReplication=True  
 +GameplayTagTableList=/Game/VRExpansion/Vive/DefaultGameplayTags.DefaultGameplayTags
```

--------------------------------

### Get VRForward Vector

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRBaseCharacter/nodes/GetVRForwardVector.html

Retrieves the forward vector of the HMD offset capsule from a VRBase Character.

```APIDOC
## Get VRForward Vector

### Description
Gets the forward vector of the HMD offset capsule for the specified VRBase Character.

### Inputs
- **Target** (VRBase Character Object Reference) - The character instance to query.

### Outputs
- **Return Value** (Vector) - The forward vector of the HMD offset capsule.
```

--------------------------------

### GetAdvancedGripSettings

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGripInterface/nodes/AdvancedGripSettings.html

Retrieves the advanced physics settings structure for a given VRGrip Interface.

```APIDOC
## GetAdvancedGripSettings

### Description
Retrieves the advanced physics settings structure for a given VRGrip Interface.

### Inputs
- **Target** (VRGrip Interface) - Required - The interface instance to query.

### Outputs
- **Return Value** (BPAdv Grip Settings Structure) - The advanced physics settings associated with the grip.
```

--------------------------------

### IsInVREditorPreview

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRExpansionFunctionLibrary/nodes/IsInVREditorPreview.html

Checks if the current game instance is running in VR Preview mode.

```APIDOC
## IsInVREditorPreview

### Description
Returns a boolean value indicating whether the game is currently running in VR Preview mode within the editor.

### Return Value
- **Boolean** - True if the game is running in VR Preview, false otherwise.
```

--------------------------------

### VRButton Component Methods and Events

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRButtonComponent/VRButtonComponent.html

A collection of available events and functions for interacting with the VRButton component.

```APIDOC
## Events
- **Event Button Ended Interaction**: Triggered when the button interaction finishes.
- **Event Button Started Interaction**: Triggered when the button interaction begins.
- **Event Button State Changed**: Triggered when the state of the button changes.

## Methods
- **Is Button in Use**: Returns a boolean indicating if the button is currently being interacted with.
- **Is Valid Overlap**: Checks if the current overlap is valid for interaction.
- **Reset Initial Button Location**: Resets the button to its starting transform.
- **Set Button State**: Sets the current state of the button.
- **Set Button to Resting Position**: Moves the button to its defined resting position.
```

--------------------------------

### SetPhysicsHandleSettings

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/SetPhysicsHandleSettings.html

Sets the advanced physics handle settings for the Grip Motion Controller Component and automatically updates it.

```APIDOC
## SetPhysicsHandleSettings

### Description
Sets the advanced physics handle settings for the Grip Motion Controller Component and automatically updates it.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference) - The component to apply settings to.
- **Grip Information** (BP Actor Grip Information Structure) - The grip information structure.
- **Physics Handle Settings** (BP Advanced Physics Handle Settings Structure) - The advanced physics handle settings to apply.

### Outputs
- **Return Value** (Boolean) - Returns true if the settings were applied successfully.
```

--------------------------------

### Get Linear Limits

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VREPhysicsConstraintComponent/nodes/GetLinearLimits.html

Retrieves the linear limit value as a float from the specified VREPhysics Constraint Component.

```APIDOC
## Get Linear Limits

### Description
Retrieves the linear limit value from a VREPhysics Constraint Component.

### Inputs
- **Target** (VREPhysics Constraint Component Object Reference) - The component to query.

### Outputs
- **Linear Limit** (Float) - The linear limit value.
```

--------------------------------

### Get VRRight Vector

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRBaseCharacter/nodes/GetVRRightVector.html

Retrieves the right vector of the HMD offset capsule from a VRBase Character object.

```APIDOC
## Get VRRight Vector

### Description
Gets the right vector of the HMD offset capsule for the specified VRBase Character.

### Inputs
- **Target** (VRBase Character Object Reference) - The character instance to query.

### Outputs
- **Return Value** (Vector) - The right vector of the HMD offset capsule.
```

--------------------------------

### Add Controller Profile

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRGlobalSettings/nodes/AddControllerProfile.html

Adds a new controller profile to the system configuration.

```APIDOC
## Add Controller Profile

### Description
Adds a new controller profile to the VRGlobal Settings. Users can specify whether to save the profile to the configuration file.

### Inputs
- **In Exec** (Exec) - Execution pin to trigger the node.
- **New Profile** (BPVRController Profile Structure) - Required - The controller profile structure to be added.
- **Save Out to Config** (Boolean) - Required - If true, the profile will be saved to the configuration file.

### Outputs
- **Out Exec** (Exec) - Execution pin triggered after the profile is added.
```

--------------------------------

### Get Grip by Actor

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GetGripByActor.html

Retrieves grip information for a specified actor from the Grip Motion Controller Component.

```APIDOC
## Get Grip by Actor

### Description
Retrieves the grip information structure for a specific actor currently held or interacted with by the Grip Motion Controller Component.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference) - The component to query.
- **Actor to Look for** (Actor Object Reference) - The actor to search for within the grip list.

### Outputs
- **On Succeeded** (Exec) - Triggered if the actor is found.
- **On Failed** (Exec) - Triggered if the actor is not found.
- **Grip** (BPActor Grip Information Structure) - The returned grip information if the operation succeeds.
```

--------------------------------

### Get Physics Constraint Force

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GetPhysicsConstraintForce.html

Retrieves the physics constraint force data for a specific grip information structure.

```APIDOC
## Get Physics Constraint Force

### Description
Retrieves the angular and linear physics constraint forces of a simulating grip.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference) - The component instance.
- **Grip Information** (Grip BPActor Grip Information Structure) - The grip information to query.

### Outputs
- **Angular Force** (Vector) - The calculated angular force.
- **Linear Force** (Vector) - The calculated linear force.
- **Return Value** (Boolean) - Returns true if the force was successfully retrieved.
```

--------------------------------

### GetPhysicsHandleSettings

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GetPhysicsHandleSettings.html

Retrieves the advanced physics handle settings associated with a specific grip information structure.

```APIDOC
## GetPhysicsHandleSettings

### Description
Gets the advanced physics handle settings for a given grip.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference)
- **Grip Information** (BPActor Grip Information Structure) - Passed by reference.

### Outputs
- **Physics Handle Settings** (BPAdvanced Physics Handle Settings Structure)
- **Return Value** (Boolean) - Indicates success or failure of the operation.
```

--------------------------------

### Configure Standalone Compilation

Source: https://vreue4.com/ovri-howto

Modify the build configuration to compile the plugin without the VRExpansionPlugin dependency.

```C#
bool bCompileWithVRExpansion = true;
```

```C#
bool bCompileWithVRExpansion = false;
```

--------------------------------

### IsInVREditorPreviewOrGame

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRExpansionFunctionLibrary/nodes/IsInVREditorPreviewOrGame.html

Checks if the game is running in VRPreview or is a non-editor build.

```APIDOC
## IsInVREditorPreviewOrGame

### Description
Gets whether the game is running in VRPreview or is a non-editor build game. Returns true if either condition is met.

### Return Value
- **Boolean** - True if running in VRPreview or a non-editor build, otherwise false.
```

--------------------------------

### GetAllGrips

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GetAllGrips.html

Retrieves an array of BPActor Grip Information structures for all objects currently held by the Grip Motion Controller Component.

```APIDOC
## GetAllGrips

### Description
Retrieves a list of all gripped objects' grip info structures, including both local and normal data, from the Grip Motion Controller Component.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference) - The component instance to query.

### Outputs
- **Grip Array** (Array of BPActor Grip Information Structures) - The list of grip information for all currently held objects.
```

--------------------------------

### Get Global Pose

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VREPhysicsConstraintComponent/nodes/GetGlobalPose.html

Retrieves the global pose transform for a specific constraint frame within the VREPhysics Constraint Component.

```APIDOC
## Get Global Pose

### Description
Retrieves the global transform of the specified constraint frame for the target VREPhysics Constraint Component.

### Inputs
- **Target** (VREPhysics Constraint Component Object Reference) - The component to query.
- **Constraint Frame** (EConstraintFrame Enum) - The specific frame to retrieve the pose from.

### Outputs
- **Global Pose** (Transform) - The resulting global transform of the constraint frame.
```

--------------------------------

### Enable Simulated Object Collision

Source: https://vreue4.com/documentation?section=character-tips

Adjust these settings in the character's Root Component and movement component to allow interaction with physics-simulating objects.

```cpp
bool bAllowSimulatingCollision
```

```cpp
bool bIgnoreSimulatingComponentsInFloorCheck
```

--------------------------------

### Event On Begin Wall Pushback

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRBaseCharacter/nodes/OnBeginWallPushback.html

Triggered when the character begins to be pushed back from a wall. Provides the hit result, whether locomotion input was present, and the HMD input vector.

```APIDOC
## Event On Begin Wall Pushback

### Description
Event triggered when the character begins to be pushed back from a wall. This allows for custom logic based on the impact and the character's movement state.

### Outputs
- **Out Exec** (Delegate) - Execution pin.
- **Hit Result Of Impact** (Hit Result Structure) - The hit result of the wall impact.
- **Had Locomotion Input** (Boolean) - Indicates if the character was moving itself during the impact.
- **Hmd Input** (Vector) - The amount the HMD moved in that tick, used to compare sizes for decision making.
```

--------------------------------

### Get Grip by ID

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/GripMotionControllerComponent/nodes/GetGripByID.html

Retrieves a grip structure based on the provided grip ID from the target Grip Motion Controller Component.

```APIDOC
## Get Grip by ID

### Description
Gets a grip by its grip ID. Note: Grip IDs are only unique to their controller, do NOT use them as cross controller identifiers.

### Inputs
- **Target** (Grip Motion Controller Component Object Reference) - Required
- **IDTo Look for** (Byte) - Required

### Outputs
- **On Succeeded** (Exec) - Triggered if the grip is found
- **On Failed** (Exec) - Triggered if the grip is not found
- **Grip** (BPActor Grip Information Structure) - The retrieved grip information
```

--------------------------------

### VR Full Screen User Widget Nodes

Source: https://vreue4.com/GeneratedDocs/VRExpansionPlugin/VRFullScreenUserWidget/VRFullScreenUserWidget.html

A collection of available nodes for interacting with the VR Full Screen User Widget.

```APIDOC
## VR Full Screen User Widget Nodes

### Get Post Process Render Target
Retrieves the render target used for post-processing.

### Get Widget
Returns the underlying widget instance.

### Hide
Triggers the hide action for the widget.

### Is Display Requested
Returns a boolean indicating if the display of the widget has been requested.

### Set Is Hidden
Sets the visibility state of the widget.
```
Tokens:
Raw