ScriptedOverlay Class Reference

#include <ScriptedOverlay.h>

Inheritance diagram for ScriptedOverlay:

Public Member Functions
	ScriptedOverlay (std::string_view name, sol::state_view &solState, sol::table luaOverlay)
virtual	~ScriptedOverlay () override
virtual void	update () override
Public Member Functions inherited from Overlay
virtual	~Overlay ()=default
virtual void	update ()=0

Private Member Functions
void	_addFunctionToRegistry (sol::table &table, sol::reference &ref, std::string_view functionName)
sol::protected_function	_prepareFunction (sol::reference &functionReference)
void	_setErrorHandler (sol::protected_function &function)
void	_logMissingFunctionWarning (std::string_view functionName)

Private Attributes
std::string	_name
sol::state_view	_solState
sol::reference	_updateFunctionReference
sol::reference	_closeFunctionReference

Constructor & Destructor Documentation

ScriptedOverlay()

ScriptedOverlay::ScriptedOverlay	(	std::string_view	name,
		sol::state_view &	solState,
		sol::table	luaOverlay
	)

~ScriptedOverlay()

ScriptedOverlay::~ScriptedOverlay ( )

overridevirtual

Member Function Documentation

_addFunctionToRegistry()

void ScriptedOverlay::_addFunctionToRegistry ( sol::table &  table, sol::reference &  ref, std::string_view  functionName  )

private

_logMissingFunctionWarning()

void ScriptedOverlay::_logMissingFunctionWarning ( std::string_view  functionName )

private

_prepareFunction()

sol::protected_function ScriptedOverlay::_prepareFunction ( sol::reference &  functionReference )

private

_setErrorHandler()

void ScriptedOverlay::_setErrorHandler ( sol::protected_function &  function )

private

update()

void ScriptedOverlay::update ( )

overridevirtual

Implements Overlay.

Member Data Documentation

_closeFunctionReference

sol::reference ScriptedOverlay::_closeFunctionReference

private

_name

std::string ScriptedOverlay::_name

private

_solState

sol::state_view ScriptedOverlay::_solState

private

_updateFunctionReference

sol::reference ScriptedOverlay::_updateFunctionReference

private

---

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

• src/GUI/Overlay/ScriptedOverlay.h
• src/GUI/Overlay/ScriptedOverlay.cpp