Lua functions

GetCharacterFlag

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

Historical signature: GetCharacterFlag(player, flag_id)

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

Function: GetCharacterFlag(player, flag_id)

Description: Gets the current character flag value for the flag_id specified. Refer to the CF_.. flags in the Player.h

Parameters:

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

Returns: Boolean return's true if the flag is enabled or false if disabled.

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.