EQ2Emu
Discord Log in

Lua functions

PlayAnimationString

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

Historical signature: PlayAnimationString(spawn, name, opt_target, set_no_target, use_all_spelltargets, ignore_self)

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

Function: PlayAnimationString(spawn, name, opt_target, set_no_target, use_all_spelltargets, ignore_self)

Description: Play an animation by using the string to all Player's or only a specific optional_target (Player). Review Appearance ID's in the Reference List https://eq2emu.com/index.php/developers/references by client for more details.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • name (string) - String name.
  • opt_target (int32) - Integer value opt_target.
  • set_no_target (int32) - Integer value set_no_target.
  • use_all_spelltargets (int32) - Integer value use_all_spelltargets.
  • ignore_self (int32) - Integer value ignore_self.

Returns: None.

Checked example

Active call in a local runtime Lua script. Target and optional targeting flags resolve to null or false. This is a contextual call pattern, not a tested standalone script.

PlayAnimationString(Target, "bow_knockedtoback")

Evidence: server/Spells/Priest/MastersSmite.lua:30; binding EQ2Emu_lua_PlayAnimationString.

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