UEVR

https://docs.uevr.io/
Admin
UEVR is a powerful tool that transforms Unreal Engine games into 6DOF VR experiences with full...
Tokens:63,356
Snippets:692
Trust Score:7.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### UEVR User Script Example

Source: https://docs.uevr.io/usage/overview.html

This example shows how to create a user_script.txt file to execute console commands at startup. It includes commands for displaying FPS and disabling anti-aliasing.

```plaintext
stat fps
r.DefaultFeature.AntiAliasing 0
```

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

### UEVR ImGui UI Example

Source: https://docs.uevr.io/print.html

This example demonstrates how to use ImGui bindings within the `on_draw_ui` callback to create interactive UI elements like buttons and combo boxes.

```lua
__
local thing = 1
local things = { "hi", "hello", "howdy", "hola", "aloha" }

uevr.sdk.callbacks.on_draw_ui(function()
    if imgui.button("Whats up") then 
        thing = 1
    end

    local changed, new_thing = imgui.combo("Greeting", thing, things) 
    if changed then thing = new_thing end
end)

```

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

### C++ Example Plugin

Source: https://docs.uevr.io/print.html

An example C++ plugin demonstrating how to inherit from uevr::Plugin and override virtual functions for event handling and logging. Ensure the project is compiled as a DLL.

```cpp
#include <memory>

#include "uevr/Plugin.hpp"

using namespace uevr;

#define PLUGIN_LOG_ONCE(...) {\
    static bool _logged_ = false; \
    if (!_logged_) { \
        _logged_ = true; \
        API::get()->log_info(__VA_ARGS__); \
    }}

class ExamplePlugin : public uevr::Plugin {
public:
    ExamplePlugin() = default;

    void on_dllmain() override {}

    void on_initialize() override {
        // Logs to the appdata UnrealVRMod log.txt file
        API::get()->log_error("%s %s", "Hello", "error");
        API::get()->log_warn("%s %s", "Hello", "warning");
        API::get()->log_info("%s %s", "Hello", "info");
    }

    void on_pre_engine_tick(UEVR_UGameEngineHandle engine, float delta) override {
        PLUGIN_LOG_ONCE("Pre Engine Tick: %f", delta);
    }

    void on_post_engine_tick(UEVR_UGameEngineHandle engine, float delta) override {
        PLUGIN_LOG_ONCE("Post Engine Tick: %f", delta);
    }

    void on_pre_slate_draw_window(UEVR_FSlateRHIRendererHandle renderer, UEVR_FViewportInfoHandle viewport_info) override {
        PLUGIN_LOG_ONCE("Pre Slate Draw Window");
    }

    void on_post_slate_draw_window(UEVR_FSlateRHIRendererHandle renderer, UEVR_FViewportInfoHandle viewport_info) override {
        PLUGIN_LOG_ONCE("Post Slate Draw Window");
    }
};

// Actually creates the plugin. Very important that this global is created.
// The fact that it's using std::unique_ptr is not important, as long as the constructor is called in some way.
std::unique_ptr<ExamplePlugin> g_plugin{new ExamplePlugin()};

```

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

### UEVR C++ Plugin Example

Source: https://docs.uevr.io/plugins/getting_started.html

This example demonstrates how to create a basic UEVR plugin by inheriting from `uevr::Plugin`. It overrides several virtual functions to log messages at different stages of the plugin lifecycle. Ensure the project is compiled as a DLL.

```cpp
#include <memory>

#include "uevr/Plugin.hpp"

using namespace uevr;

#define PLUGIN_LOG_ONCE(...)
    static bool _logged_ = false; \
    if (!_logged_) { \
        _logged_ = true; \
        API::get()->log_info(__VA_ARGS__); \
    }}

class ExamplePlugin : public uevr::Plugin {
public:
    ExamplePlugin() = default;

    void on_dllmain() override {}

    void on_initialize() override {
        // Logs to the appdata UnrealVRMod log.txt file
        API::get()->log_error("%s %s", "Hello", "error");
        API::get()->log_warn("%s %s", "Hello", "warning");
        API::get()->log_info("%s %s", "Hello", "info");
    }

    void on_pre_engine_tick(UEVR_UGameEngineHandle engine, float delta) override {
        PLUGIN_LOG_ONCE("Pre Engine Tick: %f", delta);
    }

    void on_post_engine_tick(UEVR_UGameEngineHandle engine, float delta) override {
        PLUGIN_LOG_ONCE("Post Engine Tick: %f", delta);
    }

    void on_pre_slate_draw_window(UEVR_FSlateRHIRendererHandle renderer, UEVR_FViewportInfoHandle viewport_info) override {
        PLUGIN_LOG_ONCE("Pre Slate Draw Window");
    }

    void on_post_slate_draw_window(UEVR_FSlateRHIRendererHandle renderer, UEVR_FViewportInfoHandle viewport_info) override {
        PLUGIN_LOG_ONCE("Post Slate Draw Window");
    }
};

// Actually creates the plugin. Very important that this global is created.
// The fact that it's using std::unique_ptr is not important, as long as the constructor is called in some way.
std::unique_ptr<ExamplePlugin> g_plugin{new ExamplePlugin()};

```

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

### Execute Console Commands on Startup

Source: https://docs.uevr.io/print.html

Place console commands in `user_script.txt` to have them executed automatically when the game starts. Ensure this file is created manually in the game's configuration directory.

```plaintext
__
stat fps
r.DefaultFeature.AntiAliasing 0

```

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

### Basic ImGui UI with Button and Combo

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

This example demonstrates how to use `imgui.button` and `imgui.combo` within the `uevr.sdk.callbacks.on_draw_ui` callback to create interactive UI elements. The button resets a variable, and the combo box allows selection from a list of strings.

```lua
local thing = 1
local things = { "hi", "hello", "howdy", "hola", "aloha" }

uevr.sdk.callbacks.on_draw_ui(function()
    if imgui.button("Whats up") then 
        thing = 1
    end

    local changed, new_thing = imgui.combo("Greeting", thing, things) 
    if changed then thing = new_thing end
end)
```

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

### Example of a JSON-compatible sequence table

Source: https://docs.uevr.io/plugins/lua/additional-bindings/json.html

Demonstrates a Lua table that can be converted to and from JSON without data loss or key type changes.

```lua
{1, 3, 2, "this is a sequence"}
```

```lua
{foo="bar", baz=42}
```

```lua
{table1={1,2,3}, table2={foo=1,bar=2}}
```

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

### imgui.get_key_index

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Gets the index of an ImGui key.

```APIDOC
## imgui.get_key_index(imgui_key)

### Description
Returns the internal index for a given ImGui key constant.

### Parameters
- **imgui_key** (ImGuiKey enum) - The ImGui key constant.
```

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

### imgui.get_mouse

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Gets the current mouse position.

```APIDOC
## imgui.get_mouse()

### Description
Returns a `Vector2f` corresponding to the user's mouse position in window space.
```

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

### UEVR Lua Scripting Example

Source: https://docs.uevr.io/print.html

This script demonstrates various UEVR API functionalities including accessing plugin version, functions, VR data, and controller poses. It also shows how to register callbacks for engine events and modify camera parameters.

```lua
local LuaVR = require("LuaVR")

local function vr_print(text)
    print("[LuaVR Script] " .. text .. "\n")
end

local params = LuaVR.params
local callbacks = params.sdk.callbacks

local total_t = 0.0

-- Example usage of callbacks
callbacks.on_pre_engine_tick(function(engine, delta)
    total_t = total_t + delta
end)

-- Modifies the camera position
callbacks.on_post_calculate_stereo_view_offset(function(device, view_index, world_to_meters, position, rotation, is_double)
    position.z = position.z + 100.0
    position.y = position.y - 100.0
end)



-- UEVR_PluginInitializeParam

-- UEVR_PluginVersion
vr_print("Major: " .. tostring(params.version.major))
vr_print("Minor: " .. tostring(params.version.minor))
vr_print("Patch: " .. tostring(params.version.patch))

-- UEVR_PluginFunctions
vr_print("Is drawing ui: " .. tostring(params.functions.is_drawing_ui()))
params.functions.log_info("Hello from LuaVR!")
params.functions.log_warn("Hello from LuaVR!")
params.functions.log_error("Hello from LuaVR!")

-- UEVR_VRData
vr_print("Runtime ready state: " .. tostring(params.vr.is_runtime_ready()))
vr_print("Is OpenVR: " .. tostring(params.vr.is_openvr()))
vr_print("Is OpenXR: " .. tostring(params.vr.is_openxr()))
vr_print("Is HMD Active: " .. tostring(params.vr.is_hmd_active()))

local standing_origin = UEVR_Vector3f.new()
params.vr.get_standing_origin(standing_origin)
vr_print("Standing Origin: " .. tostring(standing_origin.x) .. ", " .. tostring(standing_origin.y) .. ", " .. tostring(standing_origin.z))

local rotation_offset = UEVR_Vector3f.new()
params.vr.get_rotation_offset(rotation_offset)
vr_print("Rotation Offset: " .. tostring(rotation_offset.x) .. ", " .. tostring(rotation_offset.y) .. ", " .. tostring(rotation_offset.z))

local hmd_index = params.vr.get_hmd_index()
vr_print("HMD Index: " .. tostring(hmd_index))

local left_controller_index = params.vr.get_left_controller_index()
vr_print("Left Controller Index: " .. tostring(left_controller_index))

local right_controller_index = params.vr.get_right_controller_index()
vr_print("Right Controller Index: " .. tostring(right_controller_index))

local hmd_position = UEVR_Vector3f.new()
local hmd_rotation = UEVR_Quaternionf.new()
params.vr.get_pose(hmd_index, hmd_position, hmd_rotation)

vr_print("HMD Position: " .. tostring(hmd_position.x) .. ", " .. tostring(hmd_position.y) .. ", " .. tostring(hmd_position.z))
vr_print("HMD Rotation: " .. tostring(hmd_rotation.x) .. ", " .. tostring(hmd_rotation.y) .. ", " .. tostring(hmd_rotation.z) .. ", " .. tostring(hmd_rotation.w))

if left_controller_index ~= -1 then
    local left_controller_position = UEVR_Vector3f.new()
    local left_controller_rotation = UEVR_Quaternionf.new()
    params.vr.get_pose(left_controller_index, left_controller_position, left_controller_rotation)

    vr_print("Left Controller Position: " .. tostring(left_controller_position.x) .. ", " .. tostring(left_controller_position.y) .. ", " .. tostring(left_controller_position.z))
    vr_print("Left Controller Rotation: " .. tostring(left_controller_rotation.x) .. ", " .. tostring(left_controller_rotation.y) .. ", " .. tostring(left_controller_rotation.z) .. ", " .. tostring(left_controller_rotation.w))        
end

if right_controller_index ~= -1 then
    local right_controller_position = UEVR_Vector3f.new()
    local right_controller_rotation = UEVR_Quaternionf.new()
    params.vr.get_pose(right_controller_index, right_controller_position, right_controller_rotation)

    vr_print("Right Controller Position: " .. tostring(right_controller_position.x) .. ", " .. tostring(right_controller_position.y) .. ", " .. tostring(right_controller_position.z))
    vr_print("Right Controller Rotation: " .. tostring(right_controller_rotation.x) .. ", " .. tostring(right_controller_rotation.y) .. ", " .. tostring(right_controller_rotation.z) .. ", " .. tostring(right_controller_rotation.w))        
end

local left_eye_offset = UEVR_Vector3f.new()
local right_eye_offset = UEVR_Vector3f.new()

params.vr.get_eye_offset(0, left_eye_offset)
params.vr.get_eye_offset(1, right_eye_offset)

vr_print("Left Eye Offset: " .. tostring(left_eye_offset.x) .. ", " .. tostring(left_eye_offset.y) .. ", " .. tostring(left_eye_offset.z))
vr_print("Right Eye Offset: " .. tostring(right_eye_offset.x) .. ", " .. tostring(right_eye_offset.y) .. ", " .. tostring(right_eye_offset.z))

local is_using_controllers = params.vr.is_using_controllers()
vr_print("Is Using Controllers: " .. tostring(is_using_controllers))

```

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

### Device Pose and Transform

Source: https://docs.uevr.io/plugins/lua/cwrappers/UEVR_VRData.html

Functions to get the pose and transform of VR devices.

```APIDOC
## vr.get_pose(index: number, out position: UEVR_Vector3f, out rotation: UEVR_Quaternionf)

### Description
Returns the pose of the specified device.

### Method
`vr.get_pose`

### Parameters
#### Path Parameters
- **index** (number) - The index of the device.
#### Out Parameters
- **position** (UEVR_Vector3f) - The position of the device.
- **rotation** (UEVR_Quaternionf) - The rotation of the device.
```

```APIDOC
## vr.get_transform(index: number, out transform: UEVR_Transform)

### Description
Returns the transform of the specified device.

### Method
`vr.get_transform`

### Parameters
#### Path Parameters
- **index** (number) - The index of the device.
#### Out Parameters
- **transform** (UEVR_Transform) - The transform of the device.
```

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

### UEVR Engine Tick Callbacks

Source: https://docs.uevr.io/print.html

Demonstrates the use of `on_post_engine_tick` and `on_pre_engine_tick` callbacks. The `on_pre_engine_tick` example includes logic to find game objects, check world and level changes, and access pawn and controller properties.

```lua
local once = true
local last_world = nil
local last_level = nil

uevr.sdk.callbacks.on_post_engine_tick(function(engine, delta)

end)

local spawn_once = true

uevr.sdk.callbacks.on_pre_engine_tick(function(engine, delta)
    --[[if spawn_once then
        local cheat_manager_c = api:find_uobject("Class /Script/Engine.CheatManager")
        local cheat_manager = UEVR_UObjectHook.get_first_object_by_class(cheat_manager_c)

        print(tostring(cheat_manager_c))

        cheat_manager:Summon("Something_C")

        spawn_once = false
    end]]

    local game_engine_class = api:find_uobject("Class /Script/Engine.GameEngine")
    local game_engine = UEVR_UObjectHook.get_first_object_by_class(game_engine_class)

    local viewport = game_engine.GameViewport
    if viewport == nil then
        print("Viewport is nil")
        return
    end
    local world = viewport.World

    if world == nil then
        print("World is nil")
        return
    end

    if world ~= last_world then
        print("World changed")
    end

    last_world = world

    local level = world.PersistentLevel

    if level == nil then
        print("Level is nil")
        return
    end

    if level ~= last_level then
        print("Level changed")
        print("Level name: " .. level:get_full_name())

        local game_instance = game_engine.GameInstance

        if game_instance == nil then
            print("GameInstance is nil")
            return
        end

        local local_players = game_instance.LocalPlayers

        for i in ipairs(local_players) do
            local player = local_players[i]
            local player_controller = player.PlayerController
            local pawn = player_controller.Pawn
    
            if pawn ~= nil then
                print("Pawn: " .. pawn:get_full_name())
                --pawn.BaseEyeHeight = 0.0
                --pawn.bActorEnableCollision = not pawn.bActorEnableCollision

                local actor_component_c = api:find_uobject("Class /Script/Engine.ActorComponent");
                print("actor_component_c class: " .. tostring(actor_component_c))
                local test_component = pawn:GetComponentByClass(actor_component_c)

                print("TestComponent: " .. tostring(test_component))

                local controller = pawn.Controller

                if controller ~= nil then
                    print("Controller: " .. controller:get_full_name())

                    local velocity = controller:GetVelocity()
                    print("Velocity: " .. tostring(velocity.x) .. ", " .. tostring(velocity.y) .. ", " .. tostring(velocity.z))

                    local test = Vector3d.new(1.337, 1.0, 1.0)
                    print("Test: " .. tostring(test.x) .. ", " .. tostring(test.y) .. ", " .. tostring(test.z))

                    controller:SetActorScale3D(Vector3d.new(1.337, 1.0, 1.0))

                    local actor_scale_3d = controller:GetActorScale3D()
                    print("ActorScale3D: " .. tostring(actor_scale_3d.x) .. ", " .. tostring(actor_scale_3d.y) .. ", " .. tostring(actor_scale_3d.z))

                    
                    local control_rotation = controller:GetControlRotation()

                    print("ControlRotation: " .. tostring(control_rotation.Pitch) .. ", " .. tostring(control_rotation.Yaw) .. ", " .. tostring(control_rotation.Roll))
                    control_rotation.Pitch = 1.337

                    controller:SetControlRotation(control_rotation)
                    control_rotation = controller:GetControlRotation()

                    print("New ControlRotation: " .. tostring(control_rotation.Pitch) .. ", " .. tostring(control_rotation.Yaw) .. ", " .. tostring(control_rotation.Roll))
                end

                local primary_actor_tick = pawn.PrimaryActorTick

                if primary_actor_tick ~= nil then
                    print("PrimaryActorTick: " .. tostring(primary_actor_tick))

                    -- Print various properties, this is testing of StructProperty as PrimaryActorTick is a struct
                    local tick_interval = primary_actor_tick.TickInterval
                    print("TickInterval: " .. tostring(tick_interval))

                    print("bAllowTickOnDedicatedServer: " .. tostring(primary_actor_tick.bAllowTickOnDedicatedServer))
                    print("bCanEverTick: " .. tostring(primary_actor_tick.bCanEverTick))
                    print("bStartWithTickEnabled: " .. tostring(primary_actor_tick.bStartWithTickEnabled))
                    print("bTickEvenWhenPaused: " .. tostring(primary_actor_tick.bTickEvenWhenPaused))
                end
            end
        end
    end

    last_level = level
end)
```

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

### Initialize and Log UObjects in UEVR Lua

Source: https://docs.uevr.io/plugins/lua.html

This script initializes the UEVR UObject hook and logs the full names of the first 5 UObjects found in the game. It's a basic example to verify script execution and object access.

```lua
print("Initializing hello_world.lua")

UEVR_UObjectHook.activate()

local api = uevr.api;
local uobjects = uevr.types.FUObjectArray.get()

print("Printing first 5 UObjects")
for i=0, 5 do
    local uobject = uobjects:get_object(i)

    if uobject ~= nil then
        print(uobject:get_full_name())
    end
end
```

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

### UObject Core Methods

Source: https://docs.uevr.io/print.html

Core methods for interacting with UObject instances, including getting their class, outer object, and address, as well as checking type compatibility.

```APIDOC
### `UEVR_UObject.static_class()`

Returns the UEVR_UClass* descriptor for UObject.

### `obj:get_address()`

Returns the base address of the UObject.

### `obj:get_fname()`

Returns a UEVR_FName object.

### `obj:get_full_name()`

Returns the full name of the UObject as a Lua string.

### `obj:is_a(class: UClass*)`

Returns true if the UObject is an instance of the specified class.

### `obj:as_class()`

Returns the UObject as an instance of UEVR_UClass, or nil if it is not a class.

### `obj:as_struct()`

Returns the UObject as an instance of UEVR_UStruct, or nil if it is not a struct.

### `obj:as_function()`

Returns the UObject as an instance of UEVR_UFunction, or nil if it is not a function.

### `obj:get_class()`

Returns the UEVR_UClass* object of the UObject.

### `obj:get_outer()`

Returns the outer UEVR_UObject* of the UObject.
```

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

### ImGui Table Functions

Source: https://docs.uevr.io/print.html

Functions for creating, manipulating, and querying ImGui tables. These include starting and ending tables, navigating rows and columns, setting up column properties, and freezing scroll regions.

```lua
imgui.begin_table(str_id, column, flags, outer_size, inner_width)
```

```lua
imgui.end_table()
```

```lua
imgui.table_next_row(row_flags, min_row_height)
```

```lua
imgui.table_next_column()
```

```lua
imgui.table_set_column_index(column_index)
```

```lua
imgui.table_setup_column(label, flags, init_width_or_weight, user_id)
```

```lua
imgui.table_setup_scroll_freeze(cols, rows)
```

```lua
imgui.table_headers_row()
```

```lua
imgui.table_header(label)
```

```lua
imgui.table_get_sort_specs()
```

```lua
imgui.table_get_column_count()
```

```lua
imgui.table_get_column_index()
```

```lua
imgui.table_get_row_index()
```

```lua
imgui.table_get_column_name(column)
```

```lua
imgui.table_get_column_flags(column)
```

```lua
imgui.table_set_bg_color(target, color, column)
```

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

### Display and Layout Functions

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Functions for getting display size and managing item widths and cursor positions.

```APIDOC
## `imgui.get_display_size()`

### Description
Returns the size of the display as a `Vector2f`.
```

```APIDOC
## `imgui.push_item_width(item_width)`

### Description
Pushes the width of the next item to `item_width` pixels.

### Parameters
- **item_width** (float) - The width in pixels.
```

```APIDOC
## `imgui.pop_item_width()`

### Description
Pops the last item width off the stack.
```

```APIDOC
## `imgui.set_next_item_width(item_width)`

### Description
Sets the width of the next item to `item_width` pixels.

### Parameters
- **item_width** (float) - The width in pixels.
```

```APIDOC
## `imgui.calc_item_width()`

### Description
Calculates and returns the current item width.
```

```APIDOC
## `imgui.get_cursor_pos()`

### Description
Returns the current cursor position as a `Vector2f`.
```

```APIDOC
## `imgui.set_cursor_pos(pos)`

### Description
Sets the current cursor position to `pos`.

### Parameters
- **pos** (Vector2f) - The desired cursor position.
```

```APIDOC
## `imgui.get_cursor_start_pos()`

### Description
Returns the initial cursor position as a `Vector2f`.
```

```APIDOC
## `imgui.get_cursor_screen_pos()`

### Description
Returns the current cursor position in screen coordinates as a `Vector2f`.
```

```APIDOC
## `imgui.set_cursor_screen_pos(pos)`

### Description
Sets the current cursor position in screen coordinates to `pos`.

### Parameters
- **pos** (Vector2f) - The desired screen cursor position.
```

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

### Register XInput Get State Callback

Source: https://docs.uevr.io/print.html

Registers a function to be called whenever the XInput state is requested. The callback receives the return value, user index, and the state itself.

```lua
uevr.sdk.callbacks.on_xinput_get_state(fn)
```

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

### Get Current Window Dimensions

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Retrieves the current size (width and height) of the active ImGui window.

```lua
local window_size = imgui.get_window_size()
imgui.text(string.format("Window Size: %.0f x %.0f", window_size.x, window_size.y))
```

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

### Getting UObject Full Name

Source: https://docs.uevr.io/print.html

Get the complete, fully qualified name of the UObject as a Lua string.

```lua
obj:get_full_name()
```

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

### LuaVR Plugin Initialization and Callback Usage

Source: https://docs.uevr.io/plugins/lua.html

Demonstrates initializing LuaVR, setting up callbacks for engine ticks and view offsets, and accessing plugin version information. Use this to hook into VR events and modify VR behavior.

```lua
local LuaVR = require("LuaVR")

local function vr_print(text)
    print("[LuaVR Script] " .. text .. "\n")
end

local params = LuaVR.params
local callbacks = params.sdk.callbacks

local total_t = 0.0

-- Example usage of callbacks
callbacks.on_pre_engine_tick(function(engine, delta)
    total_t = total_t + delta
end)

-- Modifies the camera position
callbacks.on_post_calculate_stereo_view_offset(function(device, view_index, world_to_meters, position, rotation, is_double)
    position.z = position.z + 100.0
    position.y = position.y - 100.0
end)



-- UEVR_PluginInitializeParam

-- UEVR_PluginVersion
vr_print("Major: " .. tostring(params.version.major))
vr_print("Minor: " .. tostring(params.version.minor))
vr_print("Patch: " .. tostring(params.version.patch))
```

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

### LuaVR Get Pose and Eye Offset Information

Source: https://docs.uevr.io/plugins/lua.html

Retrieves and prints the pose (position and rotation) for the HMD and controllers, as well as eye offsets. Use this to get real-time tracking data for VR devices.

```lua
local hmd_position = UEVR_Vector3f.new()
local hmd_rotation = UEVR_Quaternionf.new()
params.vr.get_pose(hmd_index, hmd_position, hmd_rotation)

vr_print("HMD Position: " .. tostring(hmd_position.x) .. ", " .. tostring(hmd_position.y) .. ", " .. tostring(hmd_position.z))
vr_print("HMD Rotation: " .. tostring(hmd_rotation.x) .. ", " .. tostring(hmd_rotation.y) .. ", " .. tostring(hmd_rotation.z) .. ", " .. tostring(hmd_rotation.w))

if left_controller_index ~= -1 then
    local left_controller_position = UEVR_Vector3f.new()
    local left_controller_rotation = UEVR_Quaternionf.new()
    params.vr.get_pose(left_controller_index, left_controller_position, left_controller_rotation)

    vr_print("Left Controller Position: " .. tostring(left_controller_position.x) .. ", " .. tostring(left_controller_position.y) .. ", " .. tostring(left_controller_position.z))
    vr_print("Left Controller Rotation: " .. tostring(left_controller_rotation.x) .. ", " .. tostring(left_controller_rotation.y) .. ", " .. tostring(left_controller_rotation.z) .. ", " .. tostring(left_controller_rotation.w))        
end

if right_controller_index ~= -1 then
    local right_controller_position = UEVR_Vector3f.new()
    local right_controller_rotation = UEVR_Quaternionf.new()
    params.vr.get_pose(right_controller_index, right_controller_position, right_controller_rotation)

    vr_print("Right Controller Position: " .. tostring(right_controller_position.x) .. ", " .. tostring(right_controller_position.y) .. ", " .. tostring(right_controller_position.z))
    vr_print("Right Controller Rotation: " .. tostring(right_controller_rotation.x) .. ", " .. tostring(right_controller_rotation.y) .. ", " .. tostring(right_controller_rotation.z) .. ", " .. tostring(right_controller_rotation.w))        
end

local left_eye_offset = UEVR_Vector3f.new()
local right_eye_offset = UEVR_Vector3f.new()

params.vr.get_eye_offset(0, left_eye_offset)
params.vr.get_eye_offset(1, right_eye_offset)

vr_print("Left Eye Offset: " .. tostring(left_eye_offset.x) .. ", " .. tostring(left_eye_offset.y) .. ", " .. tostring(left_eye_offset.z))
vr_print("Right Eye Offset: " .. tostring(right_eye_offset.x) .. ", " .. tostring(right_eye_offset.y) .. ", " .. tostring(right_eye_offset.z))

local is_using_controllers = params.vr.is_using_controllers()
vr_print("Is Using Controllers: " .. tostring(is_using_controllers))
```

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

### Draw Path on ImGui Window

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Allows drawing custom lines and shapes on the ImGui window. Use `draw_list_path_clear()` to start a new path, `draw_list_path_line_to()` to add points, and `draw_list_path_stroke()` to render the path.

```lua
imgui.draw_list_path_clear()
imgui.draw_list_path_line_to(Vector2f.new(50, 50))
imgui.draw_list_path_line_to(Vector2f.new(100, 100))
imgui.draw_list_path_stroke(0xFFFFFFFF, false, 2.0)
```

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

### UObject Indexing and Property Access

Source: https://docs.uevr.io/print.html

Provides Lua-style access to UObject properties using `__index` for getting and `__newindex` for setting properties. It also demonstrates calling functions and handling struct properties.

```APIDOC
## object:__index(key: string)

Wrapper for `object:get_property(key)`. Can be used to call functions on the UObject.

### Example Usage:
```lua
-- Accessing a property
local asdf = obj.SomeProperty

-- Calling a function
obj:SomeFunction()
```

Struct property arguments can be passed via a table or `StructObject.new(class)`.
Out arguments can be retrieved by passing an empty table.

### Example with Struct and Out Arguments:
```lua
-- Passing a struct property
local color = {R = 0.0, G = 0.0, B = 1.0, A = 1.0}
obj:SomeColorFn(color)

-- Retrieving out arguments
local out = {}
obj:SomeOutFunction(out)
local result = out.result
```

## object:__newindex(key: string, value: any)

Wrapper for `object:set_property(key, value)`.

### Example Usage:
```lua
-- Setting a property
obj.SomeProperty = 123
```
```

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

### imgui.item_size and imgui.item_add

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Manages item layout and addition to the UI.

```APIDOC
## imgui.item_size(pos, size)

### Description
Sets the size of the current item.

### Parameters
- **pos** (Vector2f or table) - The position of the item.
- **size** (Vector2f or table) - The size of the item.

## imgui.item_add(pos, size)

### Description
Adds an item with the specified position and size to the current window.

### Parameters
- **pos** (Vector2f or table) - The position of the item.
- **size** (Vector2f or table) - The size of the item.
```

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

### Scroll Position

Source: https://docs.uevr.io/print.html

Functions for getting and setting scroll positions.

```APIDOC
## `imgui.get_scroll_x()`

### Description
Returns the horizontal scroll position.
```

```APIDOC
## `imgui.get_scroll_y()`

### Description
Returns the vertical scroll position.
```

```APIDOC
## `imgui.set_scroll_x(scroll_x)`

### Description
Sets the horizontal scroll position to `scroll_x`.

### Parameters
#### Path Parameters
- **scroll_x** (float) - Required - The desired horizontal scroll position.
```

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

### Get UObject Address

Source: https://docs.uevr.io/plugins/lua/types/UObject.html

Retrieves the memory address of the UObject.

```APIDOC
## `obj:get_address()`

### Description
Returns the base address of the UObject.

### Returns
- `number`: The memory address of the UObject.
```

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

### Window Management

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Functions for creating and managing ImGui windows.

```APIDOC
### `imgui.begin_window(name, open, flags)`
Creates a new window with the title of `name`.
`open` is a bool. Can be `nil`. If not `nil`, a close button will be shown in the top right of the window.
`flags` - ImGuiWindowFlags.
`begin_window` must have a corresponding `end_window` call.
This function may only be called in `on_frame`, not `on_draw_ui`.
Returns a bool. Returns `false` if the user wants to close the window.
### `imgui.end_window()`
Ends the last `begin_window` call. Required.
```

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

### Cursor Position Management

Source: https://docs.uevr.io/print.html

Functions for getting and setting the cursor position.

```APIDOC
## `imgui.get_cursor_pos()`

### Description
Returns the current cursor position as a `Vector2f`.
```

```APIDOC
## `imgui.set_cursor_pos(pos)`

### Description
Sets the current cursor position to `pos`.

### Parameters
#### Path Parameters
- **pos** (Vector2f) - Required - The desired cursor position.
```

```APIDOC
## `imgui.get_cursor_start_pos()`

### Description
Returns the initial cursor position as a `Vector2f`.
```

```APIDOC
## `imgui.get_cursor_screen_pos()`

### Description
Returns the current cursor position in screen coordinates as a `Vector2f`.
```

```APIDOC
## `imgui.set_cursor_screen_pos(pos)`

### Description
Sets the current cursor position in screen coordinates to `pos`.

### Parameters
#### Path Parameters
- **pos** (Vector2f) - Required - The desired screen cursor position.
```

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

### ImGui Bindings - Core Functions

Source: https://docs.uevr.io/print.html

Functions for creating and managing ImGui windows and basic UI elements.

```APIDOC
## `imgui.begin_window(name, open, flags)`
Creates a new window with the title of `name`.
`open` is a bool. Can be `nil`. If not `nil`, a close button will be shown in the top right of the window.
`flags` - ImGuiWindowFlags.
`begin_window` must have a corresponding `end_window` call.
This function may only be called in `on_frame`, not `on_draw_ui`.
Returns a bool. Returns `false` if the user wants to close the window.

## `imgui.end_window()`
Ends the last `begin_window` call. Required.

## `imgui.begin_child_window(size, border, flags)`
`size` - Vector2f
`border` - bool
`flags` - ImGuiWindowFlags

## `imgui.end_child_window()`

## `imgui.begin_group()`

## `imgui.end_group()`

## `imgui.begin_rect()`

## `imgui.end_rect(additional_size, rounding)`
These two methods draw a rectangle around the elements between `begin_rect` and `end_rect`

## `imgui.begin_disabled(disabled=true)`

## `imgui.end_disabled()`
These two methods will disable and darken elements in between it.

## `imgui.button(label, size)`
Draws a button with `label` text, and optional `size`.
`size` is a Vector2f or a size 2 array.
Returns `true` when the user presses the button.

## `imgui.small_button(label)`

## `imgui.invisible_button(id, size, flags)`
`size` is a Vector2f or a size 2 array.

## `imgui.arrow_button(id, dir)`
`dir` is an `ImguiDir`

## `imgui.text(text)`
Draws text.

## `imgui.text_colored(text, color)`
Draws text with color.
`color` is an integer color in the form ARGB.

## `imgui.checkbox(label, value)`
Returns a tuple of `changed`, `value`

## `imgui.drag_float(label, value, speed, min, max, display_format (optional))`
Returns a tuple of `changed`, `value`

## `imgui.drag_float2(label, value (Vector2f), speed, min, max, display_format (optional))`
Returns a tuple of `changed`, `value`

## `imgui.drag_float3(label, value (Vector3f), speed, min, max, display_format (optional))`
Returns a tuple of `changed`, `value`
```

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

### Getting UObject's Class

Source: https://docs.uevr.io/print.html

Retrieve the UEVR_UClass descriptor for the UObject.

```lua
obj:get_class()
```

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

### imgui.indent and imgui.unindent

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Manages indentation for UI elements.

```APIDOC
## imgui.indent(indent_width)

### Description
Indents the current line by the specified width.

### Parameters
- **indent_width** (float) - The amount to indent in pixels.

## imgui.unindent(indent_width)

### Description
Unindents the current line by the specified width.

### Parameters
- **indent_width** (float) - The amount to unindent in pixels.
```

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

### Get UObject Property

Source: https://docs.uevr.io/plugins/lua/types/UObject.html

Retrieves the value of a specified property of the UObject.

```APIDOC
## `obj:get_property(name: string)`

### Description
Returns the value of the specified property of the UObject.

### Parameters
- **name** (`string`) - Required - The name of the property to retrieve.

### Returns
- `any`: The value of the property.
```

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

### Get UObject Outer

Source: https://docs.uevr.io/plugins/lua/types/UObject.html

Retrieves the outer UEVR_UObject of the current UObject.

```APIDOC
## `obj:get_outer()`

### Description
Returns the outer UEVR_UObject* of the UObject.

### Returns
- `UEVR_UObject*` or `nil`: The outer UObject, or nil if it has no outer.
```

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

### imgui.set_next_window_size

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Sets the size for the next window.

```APIDOC
## imgui.set_next_window_size(size, condition)

### Description
Sets the size for the next window that is created.

### Parameters
- **size** (Vector2f or table) - The desired size for the window.
- **condition** (ImGuiCond enum) - The condition under which to set the size.
```

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

### Get UObject Class

Source: https://docs.uevr.io/plugins/lua/types/UObject.html

Retrieves the UEVR_UClass object associated with the UObject.

```APIDOC
## `obj:get_class()`

### Description
Returns the UEVR_UClass* object of the UObject.

### Returns
- `UEVR_UClass*`: The UEVR_UClass object of the UObject.
```

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

### Tooltip Management

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Allows creating and displaying tooltips that appear when hovering over UI elements. Use `imgui.begin_tooltip()`, `imgui.set_tooltip()`, and `imgui.end_tooltip()` to manage tooltips.

```lua
imgui.button("Hover Me")

if imgui.is_item_hovered() then
    imgui.begin_tooltip()
    imgui.set_tooltip("This is a custom tooltip!")
    imgui.end_tooltip()
end
```

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

### Load and Use Custom Fonts with ImGui

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Demonstrates how to load a custom font file and apply it to ImGui elements. Ensure the font file is placed in the 'reframework/fonts' directory. Use `imgui.push_font()` to apply the font and `imgui.pop_font()` to revert to the previous font.

```lua
local default_font_size = imgui.get_default_font_size()
local my_font = imgui.load_font("my_custom_font.ttf", default_font_size)

imgui.push_font(my_font)
-- Widgets using the custom font
imgui.text("This text uses the custom font!")
imgui.pop_font()

-- Widgets using the default font
imgui.text("This text uses the default font.")
```

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

### UEVR_UObjectHook.get_or_add_motion_controller_state

Source: https://docs.uevr.io/plugins/lua/types/UObjectHook.html

Gets or adds the motion controller state for a given UObject.

```APIDOC
## UEVR_UObjectHook.get_or_add_motion_controller_state(obj: UObject*)

### Description
Returns the motion controller state for the specified UObject. If the state does not exist, it is created.

### Method
Static function call

### Parameters
#### Path Parameters
- **obj** (UObject*) - Required - The UObject for which to get or add the motion controller state.
```

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

### imgui.same_line

Source: https://docs.uevr.io/print.html

Places subsequent widgets on the same line as the previous widget.

```APIDOC
## `imgui.same_line()`

### Description
Forces the next widget to appear on the same line as the previous widget, if there is enough horizontal space. Otherwise, it will wrap to the next line.
```

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

### Get ID

Source: https://docs.uevr.io/print.html

Retrieves the current ImGui ID based on the ID stack.

```lua
imgui.get_id()
```

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

### UEVR Lua API Introduction

Source: https://docs.uevr.io/print.html

UEVR provides a Lua API for creating plugins. Scripts can be loaded via LuaLoader or automatically from the game's script directory. A LuaVR.dll is included for use with environments like UE4SS.

```lua
-- Scripts can be loaded under LuaLoader, and are automatically loaded from <game config folder>/scripts/*.lua.
-- The Lua API can also be loaded in different environments, like UE4SS. UEVR comes with a LuaVR.dll for this purpose.
```

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

### Getting Super Struct

Source: https://docs.uevr.io/print.html

Retrieve the parent UEVR_UStruct object for the current struct.

```lua
struct:get_super_struct()
```

```lua
struct:get_super()
```

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

### execute

Source: https://docs.uevr.io/plugins/lua/types/IConsoleCommand.html

Executes the console command with the provided arguments.

```APIDOC
## cmd:execute(args: string)

### Description
Executes the console command with the provided arguments.

### Parameters
#### Path Parameters
- **args** (string) - Required - The arguments to pass to the command.
```

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

### Getting UObject Property Value

Source: https://docs.uevr.io/print.html

Retrieve the value of a specified property from a UObject.

```lua
obj:get_property(name)
```

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

### Popup Window Management

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Functions for creating and managing popup windows. Use `imgui.open_popup()` to trigger a popup, `imgui.begin_popup()` to define its content, and `imgui.end_popup()` to close it.

```lua
if imgui.button("Open Popup") then
    imgui.open_popup("MyPopup")
end

if imgui.begin_popup("MyPopup") then
    imgui.text("This is inside the popup.")
    if imgui.button("Close") then
        imgui.close_current_popup()
    end
    imgui.end_popup()
end
```

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

### Getting UObject's Outer

Source: https://docs.uevr.io/print.html

Retrieve the outer UEVR_UObject for the current UObject.

```lua
obj:get_outer()
```

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

### Getting UObject Address

Source: https://docs.uevr.io/print.html

Obtain the base memory address of a UObject instance.

```lua
obj:get_address()
```

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

### Set Next Window Size

Source: https://docs.uevr.io/print.html

Sets the size for the next ImGui window. Requires an `ImGuiCond` condition.

```lua
imgui.set_next_window_size(size (Vector2f or table), condition)
```

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

### Child Window Management

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Functions for creating and managing child ImGui windows.

```APIDOC
### `imgui.begin_child_window(size, border, flags)`
`size` - Vector2f
`border` - bool
`flags` - ImGuiWindowFlags
### `imgui.end_child_window()`
```

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

### Get UEVR_UClass for UFunction

Source: https://docs.uevr.io/plugins/lua/types/UFunction.html

Returns the UEVR_UClass descriptor for UFunction. This is a static method.

```lua
UEVR_UFunction.static_class()
```

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

### imgui.new_line

Source: https://docs.uevr.io/print.html

Forces the next widget to appear on a new line.

```APIDOC
## `imgui.new_line()`

### Description
Forces the next widget to start on a new line, regardless of available horizontal space.
```

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

### Text and Window Geometry

Source: https://docs.uevr.io/print.html

Functions for calculating text size and getting window dimensions.

```APIDOC
## `imgui.calc_text_size(text)`

### Description
Calculates and returns the size of the specified text as a Vector2f.

### Parameters
#### Path Parameters
- **text** (string) - Required - The text to calculate the size for.
```

```APIDOC
## `imgui.get_window_size()`

### Description
Returns the size of the current window as a Vector2f.
```

```APIDOC
## `imgui.get_window_pos()`

### Description
Returns the position of the current window as a Vector2f.
```

```APIDOC
## `imgui.get_display_size()`

### Description
Returns the size of the display as a `Vector2f.`
```

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

### Get Mouse Position

Source: https://docs.uevr.io/print.html

Returns the current mouse position within the window space.

```lua
imgui.get_mouse()
```

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

### Getting Class Default Object

Source: https://docs.uevr.io/print.html

Retrieve the default UEVR_UObject instance associated with a UClass.

```lua
class:get_class_default_object()
```

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

### imgui.progress_bar

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Displays a progress bar.

```APIDOC
## imgui.progress_bar(progress, size, overlay)

### Description
Displays a progress bar widget.

### Parameters
- **progress** (float) - The progress value, between 0.0 and 1.0.
- **size** (Vector2f or table) - The size of the progress bar.
- **overlay** (string, optional) - Text to display on top of the progress bar.
```

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

### Set Next Window Size with Condition

Source: https://docs.uevr.io/plugins/lua/additional-bindings/imgui.html

Defines the size for the next ImGui window. The `condition` parameter determines if and when the size is applied.

```lua
local window_size = Vector2f.new(300, 200)
imgui.set_next_window_size(window_size, ImGuiCond_.ImGuiCond_Once)
imgui.begin("My Resizable Window")
-- Window content
imgui.end()
```

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

### Getting UObject Name

Source: https://docs.uevr.io/print.html

Retrieve the UEVR_FName object representing the object's name.

```lua
obj:get_fname()
```

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

### Get UObject Array

Source: https://docs.uevr.io/print.html

Retrieves the UEVR_FUObjectArray instance, which provides access to all UObjects in the game.

```lua
uevr.api.get_uobject_array()
```

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

### class:get_first_object_matching(allow_default: bool)

Source: https://docs.uevr.io/plugins/lua/types/UClass.html

Returns the first UEVR_UObject* object that is an instance of the class. If `allow_default` is true, default objects are included in the search.

```APIDOC
## class:get_first_object_matching(allow_default: bool)

### Description
Returns the first UEVR_UObject* object that is an instance of the class. If `allow_default` is true, default objects are included in the search.

### Method
instance

### Parameters
#### Query Parameters
- **allow_default** (bool) - Required - Whether to include default objects in the search.

### Returns
- UEVR_UObject*: The first UEVR_UObject* instance found.
```

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

### Get Game Engine Object

Source: https://docs.uevr.io/print.html

Retrieves the global UGameEngine object for engine-level operations.

```lua
uevr.api.get_engine()
```

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

### cmd:execute(args: string)

Source: https://docs.uevr.io/print.html

Executes a console command with the specified arguments.

```APIDOC
## execute(args: string)

### Description
Executes a console command with the specified arguments.

### Parameters
- **args** (string) - Required - The arguments to pass to the command.
```

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

### Get UObject Full Name

Source: https://docs.uevr.io/plugins/lua/types/UObject.html

Retrieves the full name of the UObject as a Lua string.

```APIDOC
## `obj:get_full_name()`

### Description
Returns the full name of the UObject as a Lua string.

### Returns
- `string`: The full name of the UObject.
```

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

### imgui.color_picker

Source: https://docs.uevr.io/print.html

Creates a color picker widget (ABGR format). Returns a tuple of `changed` (boolean) and the new `value` (integer).

```APIDOC
## `imgui.color_picker(label, color, flags)`

### Description
Creates a color picker widget. The color is expected in ABGR format.

### Parameters
- **label** (string) - The label for the widget.
- **color** (integer) - The initial color value in ABGR format.
- **flags** (ImGuiColorEditFlags) - Flags to modify the behavior of the color picker.

### Returns
- **changed** (boolean) - True if the color was changed.
- **value** (integer) - The new color value in ABGR format.
```

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

### Item Add

Source: https://docs.uevr.io/print.html

Adds an item with specified position and size to the current window.

```lua
imgui.item_add(pos, size)
```
Tokens:
Raw