Lua functions

GetChoiceSpawnID

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

Historical signature: GetChoiceSpawnID(spawn, commandMatch, declineValue)

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

Function: GetChoiceSpawnID(spawn, commandMatch, declineValue)

Description: Spawn represents the Player with the choice window. Return's the spawn_id if the choice was determined from a previously provided CreateChoiceWindow. This remains until ClearChoice is called.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • commandMatch (string) - String commandMatch.
  • declineValue (uint8) - Integer value declineValue.

Returns: UInt32 of the spawn_id the Player is using the choice dialog with.

Connection lifetime: Each player or group-member connection resolved by this function is retained through the native call. A disconnect or reconnect during a callback cannot destroy that retained connection or switch the ongoing call to a replacement. A later Lua call resolves the current connection. This does not extend the lifetime of unrelated spawn or item userdata.

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.