Lua functions

GetVariableValue

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

Historical signature: GetVariableValue(variable_name)

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

Function: GetVariableValue(variable_name)

Description: Get the variable value by name of the server.

Parameters:

  • variable_name (string) - String variable_name.

Returns: String value based on the name.

Checked example

Active call in a local runtime Lua script. Argument count matches current fixed C++ readers. This is a contextual call pattern, not a tested standalone script.

StartConversation(conversation, NPC, Spawn, "The current jackpot is " .. GetCoinMessage(GetVariableValue("gambling_current_jackpot")) .. ".")

Evidence: server/SpawnScripts/Generic/aGigglegibberGoblinGamblinGameVendor.lua:28; binding EQ2Emu_lua_GetVariableValue.

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