Lua functions

Shout

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

Historical signature: Shout(spawn, message, player, dist, language)

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

Function: Shout(spawn, message, player, dist, language)

Description: Send's a shout from the Spawn into the general vicinity based on the distance provided, or otherwise the player if specified.

Parameters:

  • spawn (Spawn) - Spawn object representing spawn.
  • message (string) - String message.
  • player (Spawn) - Spawn object representing player.
  • dist (int32) - Integer value dist.
  • language (int32) - Integer value language.

Returns: None.

Checked example

Active call in a local runtime Lua script. Player, range, and language are optional; range defaults to 30. This is a contextual call pattern, not a tested standalone script.

Shout(NPC,"Charge!")

Evidence: server/SpawnScripts/BloodSkullValleyMaulicsStronghold/LegioneerGorlak.lua:21; binding EQ2Emu_lua_Shout.

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