Lua functions

GetRuleFlagBool

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

Historical signature: GetRuleFlagBool(category, name)

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

Function: GetRuleFlagBool(category, name)

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

Parameters:

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

Returns: Boolean value true/false depending on the rule setting.

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.

if GetRuleFlagBool("R_Combat", "ShardRecoveryByRadius") == true then

Evidence: server/SpawnScripts/Generic/SpiritShard.lua:9; binding EQ2Emu_lua_GetRuleFlagBool.

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