Lua functions

CreateChoiceWindow

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

Historical signature: CreateChoiceWindow(npc, spawn, windowTextPrompt, acceptText, acceptCommand, declineText, declineCommand, time, textBox, textBoxRequired, maxLength)

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

Function: CreateChoiceWindow(npc, spawn, windowTextPrompt, acceptText, acceptCommand, declineText, declineCommand, time, textBox, textBoxRequired, maxLength)

Description:

Create's a choice display window for the client to provide a accept/decline prompt window and input box support (for text field).

Parameters:

  • npc (Spawn) - Spawn object representing npc.
  • spawn (Spawn) - Spawn object representing spawn.
  • windowTextPrompt (string) - String windowTextPrompt.
  • acceptText (string) - String acceptText.
  • acceptCommand (string) - String acceptCommand.
  • declineText (string) - String declineText.
  • declineCommand (string) - String declineCommand.
  • time (uint32) - Integer value time.
  • textBox (uint8) - Integer value textBox.
  • textBoxRequired (uint8) - Integer value textBoxRequired.
  • maxLength (uint32) - Integer value maxLength.

Returns: None.

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.

CreateChoiceWindow(NPC, Spawn, "Create Guild Name:", "OK", "create guild", "Cancel", "", 0, 1, 1, 41)

Evidence: server/SpawnScripts/QeynosHarbor/RoyalAccountantFowler.lua:39; binding EQ2Emu_lua_CreateChoiceWindow.

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