Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:AddTemporaryIgnore

From RoR Wiki

UI Lua API · Social functions
Version: WAR 1.4.8

Adds a player name to the client's temporary ignore list.

AddTemporaryIgnore(playerName)

Arguments

playerName
wstring – Name of the player to ignore.

Returns

Nothing.

Details

  • Names on the player's friends list are not added.
  • The temporary list holds at most 25 names. When it is full, the oldest name is dropped to make room.
  • The list is kept by the client only. Nothing is sent to the server, and the names do not appear in GetIgnoreList.
  • The stock UI calls this after reporting a player for gold selling, from the player menu and from a mail message.
  • If the Lua state is not available, nothing happens.

Errors

None besides the generic Invalid Parameters message when the argument is missing or not a wide string.

Example

From default/ea_playermenu/source/playermenuwindow.lua:

local offendingMessage = LogDisplayGetStringFromCursorPos(activeTabName.."TextLog", cursorX, cursorY)
HelpUtils.AutoReportGoldSeller(PlayerMenuWindow.curPlayer.name, offendingMessage)
AddTemporaryIgnore(PlayerMenuWindow.curPlayer.name)
PlayerMenuWindow.Done()

See also