Creation/Dev/wordFilter

Introduction

The NPC server has a built-in word filter. This feature comes in handy for servers who want to implement a swear filter.

Functions

wordfiltertext(text, type) - returns integer - filters text with the rules defined in wordfilter/rules.txt, second parameter is the text type (chat, pm, toall or nick), result is a combination of 1 (log) + 2 (tell admins) + 4 (replace) + 8 (warn) + 16 (jail) + 32 (ban); use getWordFilterNewText(), getWordFilterMessage() and getWordFilterMatches() for more information about the filtered text

getwordfiltermatches(int) - returns object - returns an array of words which matched the word filter after calling wordFilterText(), parameter is the maximum number of matches you want

getwordfiltermessage() - returns string - returns the warn message after calling wordFilterText()

getwordfilternewtext() - returns string - returns the new text generated by the word filter after calling wordFilterText()

Example

The following example shows how the word filter can be used to implement a swear filter.