Lua functions

GetArchetypeName

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

Historical signature: GetArchetypeName(spawn)

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

Function: GetArchetypeName(spawn)

Description: Gets the base class of the Spawn and then determines the archetype name of the Spawn. The C++ code calls GetClassNameCase which changes the case sensitivity in that only the first letter is upper case for the classname. See https://github.com/emagi/eq2emu/blob/main/docs/data_types/classes.md and use the Display Name.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.

Returns: The class name in string format. As listed under Display Name in classes https://github.com/emagi/eq2emu/blob/main/docs/data_types/classes.md

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 Class = GetArchetypeName(Target)

Evidence: server/Spells/Mage/Enchanter/Illusionist/Synergism.lua:21; binding EQ2Emu_lua_GetArchetypeName.

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