Lua functions

DisplayText

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

Historical signature: DisplayText(player, type, text)

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

Function: DisplayText(player, type, text)

Description: Displays Channel Text on the Player's screen (without a Spawn attributed with a name, just a plain message). The type are based on channel types in https://github.com/emagi/eq2emu/blob/main/docs/data_types/channel_types.md and support will vary on client version.

Parameters:

  • player (Spawn) - Spawn object representing player.
  • type (uint8) - Integer value type.
  • text (string) - String text.

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.

DisplayText(Player, 12, "This box is empty.")

Evidence: server/SpawnScripts/FarJourneyFreeport/atreasurechest.lua:32; binding EQ2Emu_lua_DisplayText.

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