Lua functions

UpdateQuestTaskGroupDescription

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

Historical signature: UpdateQuestTaskGroupDescription(quest, step, description)

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

Function: UpdateQuestTaskGroupDescription(quest, step, description, display_bullets = 0)

Description: Update the task group description of the quest.

Parameters:

  • quest (Quest) - Quest object representing quest.
  • step (int32) - Established task group ordinal; existing ordinals remain stable when another group is removed.
  • description (string) - New nonempty group description.
  • display_bullets (int8, optional) - Use 1 to keep grouped bullet rows; 0 presents the first step as a paragraph. Renaming to an existing group description preserves that group's peers.

Returns: None.

Checked example

Active call in a local runtime Lua script. Display-bullets flag defaults to false. This is a contextual call pattern, not a tested standalone script.

UpdateQuestTaskGroupDescription(Quest, 1, "I visited Crater Pond.")

Evidence: server/Quests/Antonica/a_tour_of_antonica.lua:32; binding EQ2Emu_lua_UpdateQuestTaskGroupDescription.

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