Lua functions

RemoveRegion

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

Historical signature: RemoveRegion(zone, version, region_name)

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

Function: RemoveRegion(zone, version, region_name)

Description: Removes regions whose names contain region_name from the region map selected for the supplied zone and client version. Matching is case sensitive and uses a substring, so more than one region may be removed. The call retains the original zone and selected map throughout removal.

Parameters:

  • zone (Zone) - Zone whose loaded region map is modified.
  • version (uint32) - Client version used to select an inclusive version range, with the default map as fallback.
  • region_name (string) - Substring to match against region names. An empty string matches all names.

Returns: true when the removal operation completes, including when no names match. An invalid zone or unavailable region map logs an error and returns no values (nil in an assignment).

This function does not load a missing region map.

Checked example

No checked example is published for this function yet. No active script call with the current C++ argument count was found.

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