Lua functions

GetServerVariable

Registered in this checkout as EQ2Emu_lua_GetServerVariable; implementation found at WorldServer/Lua/LuaFunctions.cpp:11429.

Historical signature: GetServerVariable(name)

Parameter and behavior details in the historical explanation are under review against the current implementation.

Function: GetServerVariable(name)

Description: Reads a copied string for the lua_-prefixed server variable corresponding to name. Later updates do not change the string selected for this call.

Parameters:

  • name (string) - Variable name without the lua_ prefix.

Returns: The stored string, or the literal string "NULL" when a valid name is missing. An empty name logs an error and returns no value.

Checked example

No checked example is published for this function yet. No active script call with the current C++ argument count was found.

Current registration: WorldServer/Lua/LuaInterface.cpp. Historical explanation: EQ2Emu Lua documentation.