CLuaService Class Reference

Lua service component. More...

#include <lua_service.hpp>

Inheritance diagram for CLuaService:

Collaboration diagram for CLuaService:

Public Member Functions
	CLuaService ()
void	Init () override
	Initialize the Lua service.
sol::protected_function_result	ExecuteScript (std::string script)
	Execute a script.
void	ExecuteScriptFile (std::string path)
	Execute a script file.
void	Update () override
	Update the Lua service.
Public Member Functions inherited from CComponent
virtual void	UpdateCurrentTarget (TargetProfile *target)
	If Update loop enabled, this function will be executed every frame for each target.
virtual	~CComponent ()=default

Additional Inherited Members
Public Attributes inherited from CComponent
std::shared_ptr< Xenon >	g_pXenon
std::shared_ptr< XenonVariables >	g_pXenonVariables
std::shared_ptr< XenonConfig >	g_pXenonConfigs

Detailed Description

Lua service component.

This component is responsible for executing Lua scripts.

Constructor & Destructor Documentation

CLuaService()

CLuaService::CLuaService ( )

inline

Member Function Documentation

ExecuteScript()

sol::protected_function_result CLuaService::ExecuteScript

(

std::string

script

)

Execute a script.

Parameters

script

Script to execute.

Returns

Result of the script.

ExecuteScriptFile()

void CLuaService::ExecuteScriptFile

(

std::string

path

)

Execute a script file.

Parameters

path	Path to the script file.

Init()

void CLuaService::Init ( )

inlineoverridevirtual

Initialize the Lua service.

Reimplemented from CComponent.

Update()

void CLuaService::Update ( )

overridevirtual

Update the Lua service.

Reimplemented from CComponent.

---

The documentation for this class was generated from the following file:

• xenon/includes/xenon/components/services/lua_service.hpp