Lua functions

RemoveItem

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

Historical signature: RemoveItem(spawn, item_id, quantity)

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

Function: RemoveItem(spawn, item_id, quantity)

Description: Removes an item_id of the quantity specified from the Player's inventory if possible.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • item_id (uint32) - Integer value item_id.
  • quantity (int32) - Integer value quantity.

Returns: True if able to remove the specified item_id and quantity, otherwise False if failed.

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.

RemoveItem(Spawn,9357,1)

Evidence: server/SpawnScripts/FarJourneyFreeport/HelmsmanNyles.lua:131; binding EQ2Emu_lua_RemoveItem.

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