vreLuaExtensions.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file vreLuaExtensions.h
//! \ingroup vreVrfobjcore
//! \brief Lua extension management functions for VREngage
//!
//! This file provides functions for registering and removing VREngage-specific
//! Lua extensions with the simulation environment. These extensions provide
//! additional Lua functions that can be called from scenario scripts to control
//! VREngage-specific functionality.
 
#pragma once
 
#include "vreVrfobjcore/export.h"
 
class DtVrfParameterDb;
 
namespace makVre
{
//! \brief Registers VREngage Lua extensions with the simulation
//! \param db Pointer to the VRF parameter database
//!
//! This function registers all VREngage-specific Lua extensions with the
//! simulation environment. It should be called during initialization to make
//! VREngage Lua functions available to scenario scripts. The functions are
//! registered with the provided parameter database.
VREVRFOBJCORE_DLL void addVreLuaExtensions(DtVrfParameterDb* db);
 
//! \brief Removes previously registered VREngage Lua extensions
//!
//! This function removes all VREngage-specific Lua extensions that were
//! previously registered with addVreLuaExtensions(). It should be called
//! during shutdown to clean up registered extensions.
VREVRFOBJCORE_DLL void removeVreLuaExtensions();
} // namespace makVre