merged AI doc, some new pages
This commit is contained in:
@@ -1,9 +1,8 @@
|
||||
/*! \file piluaprogram.h
|
||||
* \ingroup Lua
|
||||
* \~\brief
|
||||
* \~english Lua Program
|
||||
* \~russian Программа Lua
|
||||
*/
|
||||
//! \~\file piluaprogram.h
|
||||
//! \~\ingroup Lua
|
||||
//! \~\brief
|
||||
//! \~english Lua Program
|
||||
//! \~russian Программа Lua
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
PILuaProgram
|
||||
@@ -29,21 +28,33 @@
|
||||
#include "pip_lua.h"
|
||||
#include "pip_lua_export.h"
|
||||
|
||||
//! \~\ingroup Lua
|
||||
//! \~\brief
|
||||
//! \~english Helper object for loading scripts and exposing the embedded Lua state through LuaBridge.
|
||||
//! \~russian Вспомогательный объект для загрузки скриптов и доступа к встроенному состоянию Lua через LuaBridge.
|
||||
//! \details
|
||||
//! \~english Provides interface for loading and executing Lua scripts using LuaBridge
|
||||
//! \~russian Предоставляет интерфейс для загрузки и выполнения скриптов Lua с использованием LuaBridge
|
||||
class PIP_LUA_EXPORT PILuaProgram {
|
||||
public:
|
||||
//! Constructs an empty PILuaProgram, initialize Lua context
|
||||
//! \~english Constructs a Lua program object and opens the standard Lua libraries.
|
||||
//! \~russian Создает объект Lua-программы и открывает стандартные библиотеки Lua.
|
||||
PILuaProgram();
|
||||
|
||||
//! Load Lua script from PIString
|
||||
//! \~english Loads and executes Lua source code from \a script.
|
||||
//! \~russian Загружает и выполняет исходный код Lua из \a script.
|
||||
bool load(const PIString & script);
|
||||
|
||||
//! Execute script
|
||||
//! \~english Calls \c lua_pcall() for the current Lua stack state.
|
||||
//! \~russian Вызывает \c lua_pcall() для текущего состояния стека Lua.
|
||||
bool prepare();
|
||||
|
||||
//! Get Lua Object or Function
|
||||
//! \~english Returns a global Lua value by name.
|
||||
//! \~russian Возвращает глобальное значение Lua по имени.
|
||||
luabridge::LuaRef getGlobal(const PIString & name);
|
||||
|
||||
//! Return Lua global namespace
|
||||
//! \~english Returns the LuaBridge namespace bound to the global Lua table.
|
||||
//! \~russian Возвращает пространство имен LuaBridge, связанное с глобальной таблицей Lua.
|
||||
luabridge::Namespace getGlobalNamespace();
|
||||
|
||||
private:
|
||||
|
||||
Reference in New Issue
Block a user