EQ2Emu
Discord Log in

Lua functions

ClearChoice

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

Historical signature: ClearChoice(spawn, commandToClear, clearDecline)

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

Function: ClearChoice(spawn, commandToClear, clearDecline)

Description:

Clear's a choice previously set on the Player with a command.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • commandToClear (string) - String commandToClear.
  • clearDecline (uint8) - Integer value clearDecline.

Returns: None.

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

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.

ClearChoice(Spawn, "create guild", 0)

Evidence: server/SpawnScripts/QeynosHarbor/RoyalAccountantFowler.lua:37; binding EQ2Emu_lua_ClearChoice.

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