Lua functions

CreateWidgetRegion

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

Historical signature: CreateWidgetRegion(zone, version, region_name, env_name, grid_id, widget_id, dist)

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

Function: CreateWidgetRegion(zone, version, region_name, env_name, grid_id, widget_id, dist)

Description: Creates a new region to track a grid and/or widget id against a region_name and/or env_name.

Parameters:

  • zone (Zone) - Zone object representing zone.
  • version (uint32) - Integer value version.
  • region_name (string) - String region_name.
  • env_name (string) - String env_name.
  • grid_id (uint32) - Integer value grid_id.
  • widget_id (uint32) - Integer value widget_id.
  • dist (float) - float value dist.

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.

CreateWidgetRegion(Zone, 0, "TestRegion", "", 924281492, 4117633379, 2.0)

Evidence: server/ZoneScripts/IsleRefuge1.lua:32; binding EQ2Emu_lua_CreateWidgetRegion.

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