more ai generated doc with human review
This commit is contained in:
@@ -1,9 +1,13 @@
|
||||
/*! \file piluaprogram.h
|
||||
* \ingroup Lua
|
||||
* \~\brief
|
||||
* \~english Lua Program
|
||||
* \~russian Программа Lua
|
||||
*/
|
||||
//! \addtogroup Lua
|
||||
//! \{
|
||||
//! \file piluaprogram.h
|
||||
//! \brief
|
||||
//! \~english Lua Program wrapper
|
||||
//! \~russian Обёртка программы Lua
|
||||
//! \details
|
||||
//! \~english Provides interface for loading and executing Lua scripts using LuaBridge
|
||||
//! \~russian Предоставляет интерфейс для загрузки и выполнения скриптов Lua с использованием LuaBridge
|
||||
//! \}
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
PILuaProgram
|
||||
@@ -29,21 +33,46 @@
|
||||
#include "pip_lua.h"
|
||||
#include "pip_lua_export.h"
|
||||
|
||||
//! \~english Lua Program class provides interface for loading and executing Lua scripts
|
||||
//! \~russian Класс PILuaProgram предоставляет интерфейс для загрузки и выполнения скриптов Lua
|
||||
class PIP_LUA_EXPORT PILuaProgram {
|
||||
public:
|
||||
//! Constructs an empty PILuaProgram, initialize Lua context
|
||||
//! \~english Constructs an empty PILuaProgram and initializes Lua context
|
||||
//! \~russian Создаёт пустой PILuaProgram и инициализирует контекст Lua
|
||||
PILuaProgram();
|
||||
|
||||
//! Load Lua script from PIString
|
||||
//! \~english Loads Lua script from PIString
|
||||
//! \~russian Загружает скрипт Lua из PIString
|
||||
//! \param script
|
||||
//! \~english The Lua script to load
|
||||
//! \~russian Загружаемый скрипт Lua
|
||||
//! \return
|
||||
//! \~english true if script loaded successfully
|
||||
//! \~russian true, если скрипт успешно загружен
|
||||
bool load(const PIString & script);
|
||||
|
||||
//! Execute script
|
||||
//! \~english Prepares the loaded script for execution
|
||||
//! \~russian Подготавливает загруженный скрипт к выполнению
|
||||
//! \return
|
||||
//! \~english true if preparation successful
|
||||
//! \~russian true, если подготовка успешна
|
||||
bool prepare();
|
||||
|
||||
//! Get Lua Object or Function
|
||||
//! \~english Gets a global Lua object or function by name
|
||||
//! \~russian Получает глобальный объект или функцию Lua по имени
|
||||
//! \param name
|
||||
//! \~english Name of the global object or function
|
||||
//! \~russian Имя глобального объекта или функции
|
||||
//! \return
|
||||
//! \~english LuaRef to the global object or function
|
||||
//! \~russian LuaRef на глобальный объект или функцию
|
||||
luabridge::LuaRef getGlobal(const PIString & name);
|
||||
|
||||
//! Return Lua global namespace
|
||||
//! \~english Returns the global namespace of the Lua state
|
||||
//! \~russian Возвращает глобальное пространство имён состояния Lua
|
||||
//! \return
|
||||
//! \~english Namespace object representing global scope
|
||||
//! \~russian Объект Namespace, представляющий глобальную область видимости
|
||||
luabridge::Namespace getGlobalNamespace();
|
||||
|
||||
private:
|
||||
|
||||
Reference in New Issue
Block a user