Lua functions

GetTutorialStep

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

Historical signature: GetTutorialStep(player)

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

Function: GetTutorialStep(player)

Description: Get the current tutorial step for the player.

Parameters:

  • player (Spawn) - Spawn object representing player.

Returns: UInt32 step of the tutorial progress.

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.

if GetTutorialStep(player) == 24 then

Evidence: server/SpawnScripts/FarJourneyFreeport/Vim.lua:33; binding EQ2Emu_lua_GetTutorialStep.

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