Lua functions

GetInfoStructString

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

Historical signature: GetInfoStructString(spawn, field)

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

Function: GetInfoStructString(spawn, field)

Description: Retrieves a string field from the spawn’s info data structure. The info struct contains various attributes of a spawn (like name, last name, guild, etc.). FieldName is the identifier of the string field. See https://github.com/emagi/eq2emu/blob/main/docs/data_types/info_struct.md for a full list of options.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • field (string) - String field.

Returns: String – The value of that field, or an empty string if not set.

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.

local needsRefresh = GetInfoStructString(Player, "refresh_advspells")

Evidence: server/PlayerScripts/global.lua:54; binding EQ2Emu_lua_GetInfoStructString.

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