EQ2Emu
Discord Log in

Lua functions

AddQuestStep

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

Historical signature: AddQuestStep(quest, step, description, quantity, percentage, str_taskgroup, icon, usableitemid)

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

Function: AddQuestStep(quest, step, description, quantity, percentage, str_taskgroup, icon, usableitemid)

Description: Adds a displayable step in the players quest journal to help them determine their next action to Complete the step.

Parameters:

  • quest (Quest) - Quest object representing quest.
  • step (int32) - Integer value step.
  • description (int32) - Integer value description.
  • quantity (int32) - Integer value quantity.
  • percentage (int32) - Integer value percentage.
  • str_taskgroup (string) - String str_taskgroup.
  • icon (int32) - Integer value icon.
  • usableitemid (uint32) - Integer value usableitemid.

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. Usable item and trailing IDs default to zero or empty. This is a contextual call pattern, not a tested standalone script.

AddQuestStep(Quest, 3, "Burn the incense.", 1, 100, "I should perform the ceremony.", 0)

Evidence: server/Quests/BigBend/the_fume_and_fire_ceremony.lua:36; binding EQ2Emu_lua_AddQuestStep.

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