state.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file state.h
//! \brief Defines Lua bindings for state management functionality
//!
//! This file contains the function for registering state management functionality
//! with Lua. It allows Lua scripts to access and manipulate application state within
//! the VREngage system, providing capabilities for storing and retrieving persistent
//! data across script executions.
 
#pragma once
 
#include "vreLuaBindings/export.h"
 
struct lua_State;
 
namespace makVre
{
//! \brief Registers state management 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 state management functionality with the specified
//! Lua state. It creates a State table in Lua with functions for storing and
//! retrieving persistent data, enabling scripts to maintain state across
//! different execution cycles. The state management system provides a way for
//! scripts to save settings, user preferences, and other data that should
//! persist even when scripts are reloaded.
int VRELUABINDING_DLL luaopen_State(lua_State* L);
} // namespace makVre