Fandom

Wikia Developers Wiki

CustomChatPings

846pages on
this wiki
Add New Page
Talk10 Share

CustomChatPings allows you to set pings in chat with extensive customization for main chat.

This script makes use of local storage, which all browsers may not support. This also means if you clear your cache, the values stored will be lost, and the pings are specific to the chat it is used on and stored values are specific to that wiki only.

Usage

For all text fields, separate each entry with a comma (,)

Mode

This is where you can choose to be pinged for messages, or alerts, or both.

Audio

This chooses the URL path for the sound file to play when you are pinged. If not specified, it will use a default noise.

Color

This is the color of the message to be changed to when pinged. If not specified, it will default to red.

Messages

List

This is the list of entries to ping you for messages received in chat.

Blacklist

This is the list of entries to not ping you for messages received in chat; false positives go here.

Ignored Users

This is the list of users who will not be able to ping you.

Alerts

List

This is the list of entries to ping you for alerts received in chat.

Blacklist

This is the list of entries to not ping you for alerts received in chat; false positives go here.

Installing

To install this script add the following to your chat.js on the wiki you want the script on:

importArticles( {
    type: 'script',
    articles: [
        'u:dev:MediaWiki:CustomChatPings/code.js',
    ]
} );

Note: Due to the nature of chat JavaScript, loading it may be tedious for personal use. You may have to use an extension such as GreaseMonkey/Tampermonkey to get it to load every time you enter chat. Thus, the above installation may not work.

importArticles — Best Practices for installing JavaScript on Fandom
The importArticles statement is designed to combine multiple HTTP requests into a single data transfer, allowing multiple scripts to load and execute faster. If you've been installing several different scripts, your JavaScript file has probably accumulated unnecessary import statements. Click "Expand" to learn how to efficiently batch import scripts to speed up performance and make your code look cleaner. One other approach is by using the MediaWiki:ImportJS.
If your JavaScript file has several lines of code that say importScript, importScriptPage, or importArticles, you may be able to combine them! By batch importing a collection of scripts with a single import, your JavaScript code will load faster and look cleaner. Consider the example below. On the left is an example of what your JavaScript file might currently look like. On the right is how you could improve that code.
Multiple imports — messy and slow One import — clean and efficient
importScriptPage('AjaxRC/code.js','dev');
 
importScript('MediaWiki:localScript.js');
 
importArticle({
  type: 'script',
  article: 'u:dev:FloatingToc/code.js'
});
 
importScriptPage('page1.js', 'wikiname');
 
importScriptPage('page2.js', 'wikiname');
importArticles({
    type: 'script',
    articles: [
        'u:dev:AjaxRC/code.js',
        'MediaWiki:localScript.js',
        'u:dev:FloatingToc/code.js',
        'u:wikiname:page1.js',
        'u:wikiname:page2.js'
    ]
});
Note: In this example, pay close attention to the placement of commas and other punctuation. For people who aren't familiar with programming (and even those who are!), a common mistake when writing code is to accidentally delete, forget, or misplace critical symbols like commas or quotation marks. This can cause a syntax error that breaks the code. Carefully follow the convention shown here when using importArticles.
But there's much more to importArticles than just this! For more examples and advanced usage, see the help page at Help:Including additional JavaScript and CSS.

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.