Lua functions

Emote

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

Historical signature: Emote(spawn, message, spawn2, player)

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

Function: Emote(spawn, message, spawn2, player)

Description: The spawn sends an emote to the general area, spawn2 is whom the emote is targetted at. If player is defined then the emote will only be sent to that player.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • message (string) - String message.
  • spawn2 (Spawn) - Spawn object representing spawn2.
  • player (Spawn) - Spawn object representing player.

Returns: None.

Connection lifetime: Each player or group-member connection resolved by this function is retained through the native call. A disconnect or reconnect during a callback cannot destroy that retained connection or switch the ongoing call to a replacement. A later Lua call resolves the current connection. This does not extend the lifetime of unrelated spawn or item userdata.

Checked example

Active call in a local runtime Lua script. Target and specific player are optional. This is a contextual call pattern, not a tested standalone script.

Emote(NPC, "waves")

Evidence: server/SpawnScripts/FrostfangSea/FirionaVie.lua:69; binding EQ2Emu_lua_Emote.

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