MisterPixie
An API for managing ignore lists

Supported Games

This is an API plugin that doesnt do anything alone besides managing an ignore list. To make use of that, you need another plugin using it.

Commands

This plugin provides universal chat and console commands. When using a command in the chat, prefix it with a forward slash: /.

  • ignore [add( )/remove(-)] [name/steamID] -- Add or remove someone
  • ignore list -- Show your ignore list

Configuration

{
  "IgnoreLimit": 30
}

Localization

{
  "List": "Ignored {0}:\n{1}",
  "NoIngored": "Your ignore list is empty.",
  "NotOnIgnorelist": "{0} not found on your ignorelist.",
  "IgnoreRemoved": "{0} was removed from your ignorelist.",
  "PlayerNotFound": "Player '{0}' not found.",
  "CantAddSelf": "You cant add yourself.",
  "AlreadyOnList": "{0} is already ignored.",
  "IgnoreAdded": "{0} is now ignored.",
  "IgnorelistFull": "Your ignorelist is full.",
  "HelpText": "Use /ignore <add| |remove|-|list> <name/steamID> to add/remove/list ignores",
  "Syntax": "Syntax: /ignore <add/ /remove/-> <name/steamID> or /ignore list"
}

For Developers

(bool)AddIgnore(string playerSteamId, string targetSteamId)

Adds targetSteamId to playerSteamId ignore listreturns true if player was added, false if player couldnt be added

(bool)RemoveIgnore(string playerSteamId, string targetSteamId)

removes targetSteamId from playerSteamId ignore listreturns true if removed, false if not

(bool)HasIgnored(string playerSteamId, string targetSteamId)

returns true if playerSteamId has targetSteamId on ignore, false if not

(bool)IsIgnoredBy(string playerSteamId, string targetSteamId)

returns true if playerSteamId is ignored by targetSteamId, false if not

(bool)AreIgnored(string playerSteamId, string targetSteamId)

returns true if both have each other on their ignore list, false if not

(string[])GetIgnorelist(string playerSteamId)

returns a table with playerSteamId's ignore list.

Credits

  • Nogrod, for the original version of this plugin
MIT License

Copyright (c) 2021 MisterPixie

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.