Lua functions

GetCoinMessage

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

Historical signature: GetCoinMessage(total_coins)

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

Function: GetCoinMessage(total_coins)

Description: Gets the translated string message of the total coins in copper to copper, silver, gold and platinum.

Parameters:

  • total_coins (uint32) - Integer value total_coins.

Returns: String representation of the coins.

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_GetCoinMessage.

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