Lua functions

EnableGameEvent

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

Historical signature: EnableGameEvent(player, event_name, enabled)

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

Function: EnableGameEvent(player, event_name, enabled)

Description: Triggers a game event on the Player's interface/UI, all behavior depends on the event_name. The event_name options are defined in https://github.com/emagi/eq2emu/blob/main/docs/data_types/game_events.md

Parameters:

  • player (Spawn) - Spawn object representing player.
  • event_name (string) - String event_name.
  • enabled (uint8) - Integer value enabled.

Returns: None.

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.