Lua functions

GetRuleFlagInt32

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

Historical signature: GetRuleFlagInt32(category, name)

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

Function: GetRuleFlagInt32(category, name)

Description: Gets the unsigned integer rule flag from the world based on the category and name.

Parameters:

  • category (string) - String category.
  • name (string) - String name.

Returns: UInt32 value of the rule category and name.

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.

serverType = GetRuleFlagInt32("R_World", "StartingZoneRuleFlag")

Evidence: server/SpawnScripts/FarJourneyFreeport/CaptainVarlos.lua:231; binding EQ2Emu_lua_GetRuleFlagInt32.

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