EQ2Emu
Discord Log in

Lua functions

AddQuestStepLocation

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

Historical signature: AddQuestStepLocation(quest, step, description, max_variation, str_taskgroup, icon, dest_x, dest_y, dest_z)

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

Function: AddQuestStepLocation(quest, step, description, max_variation, str_taskgroup, icon, dest_x, dest_y, dest_z)

Description: Adds a quest step to the player's journal requiring a location be reached for the complete action to be performed. The dest_x, dest_y, dest_z can be repeated in sequence to add multiple potential locations to reach.

Parameters:

  • quest (Quest) - Quest object representing quest.
  • step (int32) - Integer value step.
  • description (int32) - Integer value description.
  • max_variation (int32) - Integer value max_variation.
  • str_taskgroup (string) - String str_taskgroup.
  • icon (int32) - Integer value icon.
  • dest_x (float) - Float value dest_x.
  • dest_y (float) - Float value dest_y.
  • dest_z (float) - Float value dest_z.

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. Arguments seven through nine provide one location coordinate triple. The binding also handles arguments dynamically. This is a contextual call pattern, not a tested standalone script.

AddQuestStepLocation(Quest, 3, "Visit 'Dog Pond'", 15, "I am searching for 'Dog Pond' in the Commonlands.", 0, -1054, -47, -219)

Evidence: server/Quests/TheCommonlands/a_tour_of_the_commonlands_.lua:16; binding EQ2Emu_lua_AddQuestStepLocation.

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