message.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file message.h
//! \brief Defines Lua bindings for messaging functionality in VREngage
//!
//! This file contains the function for registering messaging functionality with Lua.
//! It allows Lua scripts to create, send, and receive messages within the VREngage
//! messaging system, enabling inter-component communication and event handling.
 
#pragma once
 
#include "vreLuaBindings/export.h"
 
struct lua_State;
 
namespace makVre
{
//! \brief Registers messaging 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 messaging functionality with the specified Lua state.
//! It creates a Message table in Lua with functions for creating, sending, and
//! receiving messages within the VREngage messaging system. This enables scripts
//! to participate in the application's event-driven communication architecture.
int VRELUABINDING_DLL luaopen_Message(lua_State* L);
} // namespace makVre