Lua functions

StartTransmute

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

Historical signature: StartTransmute(spawn)

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

Function: StartTransmute(spawn)

Description: Show the transmutation item-selection prompt for a connected player in the current scene.

Parameters:

  • spawn (Player spawn): the player who will select and confirm an input item.

Returns: None.

Behavior: The prompt records original item allocations from available carried inventory. Selection and confirmation must match that prompt, player, connection generation, and scene. Cancelling or replacing a prompt cannot confirm its old selection. A confirmed cast keeps its own item identity when a later prompt starts.

Prompt metadata does not own the player or input items. Removing or replacing an input invalidates that choice. Items whose unique IDs exceed the prompt's 32-bit wire field are omitted rather than truncated. No item is consumed by opening or confirming the prompt; CompleteTransmute performs the inventory transaction from the bound Transmute Item cast.

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.

StartTransmute(Caster)

Evidence: server/Spells/Commoner/Transmute.lua:11; binding EQ2Emu_lua_StartTransmute.

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