joystickController.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file joystickController.h
//! \brief Defines Lua bindings for joystick controller functionality
//!
//! This file contains the function for registering joystick controller functionality
//! with Lua. It allows Lua scripts to access and manipulate joystick input devices,
//! enabling scripts to handle user input from physical controllers in the VREngage system.
 
#pragma once
 
#include "vreLuaBindings/export.h"
 
struct lua_State;
 
namespace makVre
{
//! \brief Registers joystick controller functions with a Lua state
//! \param L Pointer to the Lua state to register with
//! \return Number of values pushed onto the Lua stack
//!
//! This function registers joystick controller functionality with the specified
//! Lua state. It creates a JoystickController table in Lua with functions for
//! accessing and manipulating joystick input devices, allowing scripts to respond
//! to button presses, axis movements, and other controller events.
int VRELUABINDING_DLL luaopen_JoystickController(lua_State* L);
} // namespace makVre