vreMessageManager.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreMessageManager.h
//! \brief Defines Lua bindings for the VREngage message manager
//!
//! This file contains the function for registering the VREngage message manager
//! functionality with Lua. It allows Lua scripts to access the central messaging
//! system of the VREngage application, enabling scripts to send, receive, and
//! process application-wide messages for event handling and component communication.
 
#pragma once
 
#include "vreLuaBindings/export.h"
 
struct lua_State;
 
namespace makVre
{
//! \brief Registers VREngage message manager 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 the VREngage message manager functionality with the
//! specified Lua state. It creates a VreMessageManager table in Lua with functions
//! for accessing the central messaging system of the VREngage application. This
//! allows scripts to send messages to other components, register handlers for
//! receiving messages, and participate in the application's event-driven
//! communication architecture.
int VRELUABINDING_DLL luaopen_VreMessageManager(lua_State* L);
} // namespace makVre