EQ2Emu
Discord Log in

Lua functions

ToggleCharacterFlag

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

Historical signature: ToggleCharacterFlag(player, flag_id)

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

Function: ToggleCharacterFlag(player, flag_id)

Description: Toggles a character flag, auto consume, hide hood, helm, etc. Refer to player.h #define CF_... flags.

Parameters:

  • player (Spawn) - Spawn object representing player.
  • flag_id (uint32) - Integer value flag_id.

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.