Historical signature: InstructionWindow(player, duration, text, voice, voice_key1, voice_key2, signal, goal1, task1, goal2, task2, goal3, task3, goal4, task4)
Parameter and behavior details in the historical explanation are under review against the current implementation.
Function: InstructionWindow(player, duration, text, voice, voice_key1, voice_key2, signal, goal1, task1, goal2, task2, goal3, task3, goal4, task4)
Description:
Provides an instruction window for the player.
Parameters:
player (Spawn) - Spawn object representing player.duration (float) - Float value duration.text (string) - String text.voice (string) - String voice.voice_key1 (uint32) - Integer value voice_key1.voice_key2 (uint32) - Integer value voice_key2.signal (string) - String signal.goal1 (string) - String goal1.task1 (string) - String task1.goal2 (string) - String goal2.task2 (string) - String task2.goal3 (string) - String goal3.task3 (string) - String task3.goal4 (string) - String goal4.task4 (string) - String task4.
Returns: None.
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.
InstructionWindow(player, -1.0, "Use the A, S, W, and D keys for basic movement. These keys cause you to turn left and right as well as to move forward and back.", "voiceover/english/narrator/boat_06p_tutorial02/narrator_004_ff730a9b.mp3", 825281976, 127545929, "tutorial_stage_5", "Turn left. (press the A key)", "move turnleft", "Turn right. (press the D key)", "move turnright", "Move forward. (press the W key)", "move forward", "Move backward. (press the S key)", "move back")
Evidence: server/ZoneScripts/FarJourneyFreeport.lua:61; binding EQ2Emu_lua_InstructionWindow.
Current registration: WorldServer/Lua/LuaInterface.cpp. Historical explanation: EQ2Emu Lua documentation.