Lua functions

PlayFlavor

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

Historical signature: PlayFlavor(spawn, mp3_string, text_string, emote_string, key1, key2, player, language)

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

Function: PlayFlavor(spawn, mp3_string, text_string, emote_string, key1, key2, player, language)

Description: Allows Player/NPC to display a text bubble and/or mp3 voiceovers (with usually required key1/key2 values).

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • mp3_string (string) - String mp3_string.
  • text_string (string) - String text_string.
  • emote_string (string) - String emote_string.
  • key1 (int32) - Integer value key1.
  • key2 (int32) - Integer value key2.
  • player (Spawn) - Spawn object representing player.
  • language (int32) - Integer value language.

Returns: None.

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.

PlayFlavor(NPC, "", "That was very brave of you!  I need to leave soon, but I can offer my services in the meantime.", "applaude", 0, 0, Spawn, 0)

Evidence: server/SpawnScripts/antonica/agratifiedmerchant.lua:29; binding EQ2Emu_lua_PlayFlavor.

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