Lua functions

GetMount

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

Historical signature: GetMount(spawn)

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

Function: GetMount(spawn)

Description: Gets the spawn object that represents the mount for the Spawn provided.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.

Returns: Mount Spawn object of the Spawn specified.

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.

if GetMount(Caster) > 0 then

Evidence: server/Spells/Commoner/AbyssalCarpet.lua:11; binding EQ2Emu_lua_GetMount.

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