Lua functions

MovementLoopAdd

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

Historical signature: MovementLoopAdd(spawn, x, y, z, speed, delay, function, heading, exclude_heading, use_nav_path)

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

Function: MovementLoopAdd(spawn, x, y, z, speed, delay, function, heading, exclude_heading, use_nav_path)

Description: Adds a waypoint for the NPC to reach in order of the supplied waypoints. Calls function when arriving at the waypoint destination.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • x (int32) - Integer value x.
  • y (int32) - Integer value y.
  • z (int32) - Integer value z.
  • speed (int32) - Integer value speed.
  • delay (int32) - Integer value delay.
  • function (int32) - Integer value function.
  • heading (int32) - Integer value heading.
  • exclude_heading (int32) - Integer value exclude_heading.
  • use_nav_path (int32) - Integer value use_nav_path.

Returns: None.

Checked example

Active call in a local runtime Lua script. Callback, heading, and path flags default empty or false. The binding also handles arguments dynamically. This is a contextual call pattern, not a tested standalone script.

MovementLoopAdd(NPC, 3.94, -2.07, 0.66, 5, 1)

Evidence: server/SpawnScripts/FarJourneyFreeport/agoblin.lua:90; binding EQ2Emu_lua_MovementLoopAdd.

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