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.

Connection lifetime: Each player or group-member connection resolved by this function is retained through the native call. A disconnect or reconnect during a callback cannot destroy that retained connection or switch the ongoing call to a replacement. A later Lua call resolves the current connection. This does not extend the lifetime of unrelated spawn or item userdata.

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.