Shared helpers used by every Lua primitive API module - and, for s_LuaMutex specifically, by LuaEngine itself too (the orchestrator, not one of the primitive API modules - see s_LuaMutex's own comment for why it lives here rather than on LuaEngine). More...

#include <luaengineutil.h>

Static Public Member Functions
static Engine::IRendererProvider *	GetRendererProvider (lua_State *pLuaState)
	Fetch the renderer provider stashed as a Lua light userdata global - the one object every renderer-needing primitive reaches the renderer through, since the renderer does not exist yet when the Lua engine is built (see IRendererProvider).

static void	EnsureRenderer (lua_State *pLuaState)
	Make sure a renderer exists, creating the default one (and opening its window) if the script hasn't - for primitives that need a live window/GL context but don't go through GetTileMap()/GetDrawSurface() (eg. sprite_configure_texture, which loads a GPU texture).

static SunLight::TileMap::ITileMap *	GetTileMap (lua_State *pLuaState)
	The engine's ITileMap - creating the default renderer first if the script has not created one yet (see IRendererProvider::GetTileMap).

static SunLight::DrawSurface::IDrawSurface *	GetDrawSurface (lua_State *pLuaState)
	The engine's IDrawSurface - screen-space text/rectangle drawing and window-state primitives (see sunlight's own IDrawSurface header comment), a separate interface from GetTileMap()'s since sunlight v0.12.0 split those off ITileMap. Both address the same underlying TileMapRenderer object today (it implements both), but callers should reach for whichever interface actually matches what they're doing, not assume that always holds. Creates the default renderer first if the script has not created one yet.

static SunLight::Sound::SoundManager *	GetSoundManager (lua_State *pLuaState)
	Fetch the engine's SoundManager instance stashed as a Lua light userdata global.

static Engine::SpritePool *	GetSpritePool (lua_State *pLuaState)
	Fetch the engine's SpritePool instance stashed as a Lua light userdata global.

static SunLight::Scripting::ScriptProcessor *	GetScriptProcessor (lua_State *pLuaState)
	Fetch the engine's ScriptProcessor instance stashed as a Lua light userdata global.

static void	AddOneParmCommandScript (lua_State *pLuaState, SunLight ::Scripting ::Commands cmd)
	Add an one parameter command to the ScriptProcessor's queue; shared by every Lua primitive that queues a command rather than acting immediately (sp_wait, sp_move_sprites_to_screen, sp_play_song, ...).

static void	RegisterConstants (lua_State pLuaState, const stNamedConstant pTable, size_t nCount)
	Register a table of named integer constants as Lua globals.

static void	RegisterRealConstants (lua_State pLuaState, const stNamedRealConstant pTable, size_t nCount)
	Register a table of named real-valued constants as Lua globals (see stNamedRealConstant).

Static Public Attributes
static std::mutex	s_LuaMutex

Detailed Description

Shared helpers used by every Lua primitive API module - and, for s_LuaMutex specifically, by LuaEngine itself too (the orchestrator, not one of the primitive API modules - see s_LuaMutex's own comment for why it lives here rather than on LuaEngine).

Member Function Documentation

◆ AddOneParmCommandScript()

void Scarab::Engine::Lua::LuaEngineUtil::AddOneParmCommandScript	(	lua_State *	pLuaState,
		SunLight ::Scripting ::Commands	cmd
	)

static

Add an one parameter command to the ScriptProcessor's queue; shared by every Lua primitive that queues a command rather than acting immediately (sp_wait, sp_move_sprites_to_screen, sp_play_song, ...).

Parameters

pLuaState	Lua state to be used by engine call.
cmd	The command to add to queue;

◆ EnsureRenderer()

void Scarab::Engine::Lua::LuaEngineUtil::EnsureRenderer ( lua_State * pLuaState )

static

Make sure a renderer exists, creating the default one (and opening its window) if the script hasn't - for primitives that need a live window/GL context but don't go through GetTileMap()/GetDrawSurface() (eg. sprite_configure_texture, which loads a GPU texture).

Parameters