Lua functions

Evac

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

Historical signature: Evac(player, x, y, z, heading)

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

Function: Evac(player, x, y, z, heading)

Description: Evacuates the Player (optional field) or their group (No fields) to a safe spot, typically the zone’s designated evacuation point (e.g., the zone entrance). This mimics the effect of an evac spell.

Parameters:

  • player (Spawn) - Spawn object reference. The player (usually the caster of the evac or the one whose group to evac). This is optional, if Player is set Evac is self only. Otherwise Evac() is for a spell script against all spell targets.
  • x (float) - Optional X Coordinate (must supply X,Y,Z,Heading). If for group set Player to nil.
  • y (float) - Optional Y Coordinate (must supply X,Y,Z,Heading). If for group set Player to nil.
  • z (float) - Optional Z Coordinate (must supply X,Y,Z,Heading). If for group set Player to nil.
  • heading (float) - Optional Heading Coordinate (must supply X,Y,Z,Heading). If for group set Player to nil.

Returns: None.

Checked example

No checked example is published for this function yet. The binding reads Lua arguments dynamically; static argument verification is incomplete.

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